Google Git
Sign in
chromium / external / gitster / git-htmldocs / 8fb66e5074d5cdeeb08e304be977374501a0787d / . / git-config.html
blob: 864bdcc51405cfbe39283a29fc3d382f04ccccb9 [file] [log] [blame]
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7<title>git-config(1)</title>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]30 color: navy;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]35 color: #083194;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]91}
92span#email {
93}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]137 color: #527bbd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]180 text-align: right;
181}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]182
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]211}
212
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]285
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286
287div.hdlist {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]293}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]298 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]299 font-style: normal;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]301 color: navy;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]302}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]303td.hdlist2 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]402 color: #527bbd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-config(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-config -
578 Get and set repository or global options
579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]584<div class="sectionbody">
585<div class="verseblock">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]586<div class="verseblock-content"><em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] name [value [value_regex]]
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]587<em>git config</em> [&lt;file-option&gt;] [type] --add name value
Junio C Hamano5217a272009-03-21 00:39:33[diff] [blame]588<em>git config</em> [&lt;file-option&gt;] [type] --replace-all name value [value_regex]
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]589<em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get name [value_regex]
590<em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get-all name [value_regex]
591<em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get-regexp name_regex [value_regex]
592<em>git config</em> [&lt;file-option&gt;] --unset name [value_regex]
593<em>git config</em> [&lt;file-option&gt;] --unset-all name [value_regex]
594<em>git config</em> [&lt;file-option&gt;] --rename-section old_name new_name
595<em>git config</em> [&lt;file-option&gt;] --remove-section name
596<em>git config</em> [&lt;file-option&gt;] [-z|--null] -l | --list
597<em>git config</em> [&lt;file-option&gt;] --get-color name [default]
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]598<em>git config</em> [&lt;file-option&gt;] --get-colorbool name [stdout-is-tty]
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]599<em>git config</em> [&lt;file-option&gt;] -e | --edit</div>
600<div class="verseblock-attribution">
601</div></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]602</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]603<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]604<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]605<div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]606actually the section and the key separated by a dot, and the value will be
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]607escaped.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]608<div class="paragraph"><p>Multiple lines can be added to an option by using the <em>--add</em> option.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]609If you want to update or unset an option which can occur on multiple
610lines, a POSIX regexp <tt>value_regex</tt> needs to be given. Only the
611existing values that match the regexp are updated or unset. If
612you want to handle the lines that do <strong>not</strong> match the regex, just
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]613prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>).</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]614<div class="paragraph"><p>The type specifier can be either <em>--int</em> or <em>--bool</em>, to make
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]615<em>git config</em> ensure that the variable(s) are of the given type and
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]616convert the value to the canonical form (simple decimal number for int,
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]617a "true" or "false" string for bool), or <em>--path</em>, which does some
618path expansion (see <em>--path</em> below). If no type specifier is passed, no
619checks or transformations are performed on the value.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]620<div class="paragraph"><p>The file-option can be one of <em>--system</em>, <em>--global</em> or <em>--file</em>
Junio C Hamano0ddc94d2007-08-01 08:42:39[diff] [blame]621which specify where the values will be read from or written to.
622The default is to assume the config file of the current repository,
623.git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]624(see <a href="#FILES">[FILES]</a>).</p></div>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]625<div class="paragraph"><p>This command will fail (with exit code ret) if:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]626<div class="olist arabic"><ol class="arabic">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]627<li>
628<p>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]629The config file is invalid (ret=3),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]630</p>
631</li>
632<li>
633<p>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]634can not write to the config file (ret=4),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]635</p>
636</li>
637<li>
638<p>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]639no section or name was provided (ret=2),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]640</p>
641</li>
642<li>
643<p>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]644the section or key is invalid (ret=1),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]645</p>
646</li>
647<li>
648<p>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]649you try to unset an option which does not exist (ret=5),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]650</p>
651</li>
652<li>
653<p>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]654you try to unset/set an option for which multiple lines match (ret=5),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]655</p>
656</li>
657<li>
658<p>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]659you try to use an invalid regexp (ret=6), or
660</p>
661</li>
662<li>
663<p>
664you use <em>--global</em> option without $HOME being properly set (ret=128).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]665</p>
666</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]667</ol></div>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]668<div class="paragraph"><p>On success, the command returns the exit code 0.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]669</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]670<h2 id="_options">OPTIONS</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]671<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]672<div class="dlist"><dl>
673<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]674--replace-all
675</dt>
676<dd>
677<p>
678 Default behavior is to replace at most one line. This replaces
679 all lines matching the key (and optionally the value_regex).
680</p>
681</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]682<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]683--add
684</dt>
685<dd>
686<p>
687 Adds a new line to the option without altering any existing
Junio C Hamano89bdb3b2009-05-10 06:48:14[diff] [blame]688 values. This is the same as providing <em>^$</em> as the value_regex
689 in <tt>--replace-all</tt>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]690</p>
691</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]692<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]693--get
694</dt>
695<dd>
696<p>
697 Get the value for a given key (optionally filtered by a regex
698 matching the value). Returns error code 1 if the key was not
699 found and error code 2 if multiple key values were found.
700</p>
701</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]702<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]703--get-all
704</dt>
705<dd>
706<p>
707 Like get, but does not fail if the number of values for the key
708 is not exactly one.
709</p>
710</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]711<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]712--get-regexp
713</dt>
714<dd>
715<p>
716 Like --get-all, but interprets the name as a regular expression.
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]717 Also outputs the key names.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]718</p>
719</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]720<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]721--global
722</dt>
723<dd>
724<p>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]725 For writing options: write to global ~/.gitconfig file rather than
726 the repository .git/config.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]727</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]728<div class="paragraph"><p>For reading options: read only from global ~/.gitconfig rather than
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]729from all available files.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]730<div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]731</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]732<dt class="hdlist1">
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]733--system
734</dt>
735<dd>
736<p>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]737 For writing options: write to system-wide $(prefix)/etc/gitconfig
738 rather than the repository .git/config.
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]739</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]740<div class="paragraph"><p>For reading options: read only from system-wide $(prefix)/etc/gitconfig
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]741rather than from all available files.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]742<div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]743</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]744<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]745-f config-file
746</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]747<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]748--file config-file
Junio C Hamano0ddc94d2007-08-01 08:42:39[diff] [blame]749</dt>
750<dd>
751<p>
752 Use the given config file instead of the one specified by GIT_CONFIG.
753</p>
754</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]755<dt class="hdlist1">
Junio C Hamanod15328a2007-03-09 09:06:40[diff] [blame]756--remove-section
757</dt>
758<dd>
759<p>
760 Remove the given section from the configuration file.
761</p>
762</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]763<dt class="hdlist1">
Junio C Hamanod15328a2007-03-09 09:06:40[diff] [blame]764--rename-section
765</dt>
766<dd>
767<p>
768 Rename the given section to a new name.
769</p>
770</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]771<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]772--unset
773</dt>
774<dd>
775<p>
776 Remove the line matching the key from config file.
777</p>
778</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]779<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]780--unset-all
781</dt>
782<dd>
783<p>
Junio C Hamano10557772007-03-15 07:12:30[diff] [blame]784 Remove all lines matching the key from config file.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]785</p>
786</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]787<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]788-l
789</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]790<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]791--list
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]792</dt>
793<dd>
794<p>
795 List all variables set in config file.
796</p>
797</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]798<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]799--bool
800</dt>
801<dd>
802<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]803 <em>git config</em> will ensure that the output is "true" or "false"
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]804</p>
805</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]806<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]807--int
808</dt>
809<dd>
810<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]811 <em>git config</em> will ensure that the output is a simple
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]812 decimal number. An optional value suffix of <em>k</em>, <em>m</em>, or <em>g</em>
813 in the config file will cause the value to be multiplied
814 by 1024, 1048576, or 1073741824 prior to output.
815</p>
816</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]817<dt class="hdlist1">
Junio C Hamano792c5a92009-03-08 08:45:13[diff] [blame]818--bool-or-int
819</dt>
820<dd>
821<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]822 <em>git config</em> will ensure that the output matches the format of
Junio C Hamano792c5a92009-03-08 08:45:13[diff] [blame]823 either --bool or --int, as described above.
824</p>
825</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]826<dt class="hdlist1">
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]827--path
828</dt>
829<dd>
830<p>
831 <em>git-config</em> will expand leading <em>&#126;</em> to the value of
832 <em>$HOME</em>, and <em>&#126;user</em> to the home directory for the
833 specified user. This option has no effect when setting the
834 value (but you can use <em>git config bla &#126;/</em> from the
835 command line to let your shell do the expansion).
836</p>
837</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]838<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]839-z
840</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]841<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]842--null
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]843</dt>
844<dd>
845<p>
846 For all options that output values and/or keys, always
Junio C Hamano1f511962008-01-30 08:28:52[diff] [blame]847 end values with the null character (instead of a
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]848 newline). Use newline instead as a delimiter between
849 key and value. This allows for secure parsing of the
850 output without getting confused e.g. by values that
851 contain line breaks.
852</p>
853</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]854<dt class="hdlist1">
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]855--get-colorbool name [stdout-is-tty]
856</dt>
857<dd>
858<p>
859 Find the color setting for <tt>name</tt> (e.g. <tt>color.diff</tt>) and output
860 "true" or "false". <tt>stdout-is-tty</tt> should be either "true" or
861 "false", and is taken into account when configuration says
862 "auto". If <tt>stdout-is-tty</tt> is missing, then checks the standard
863 output of the command itself, and exits with status 0 if color
864 is to be used, or exits with status 1 otherwise.
Junio C Hamanoe3ddb5b2008-04-21 00:48:07[diff] [blame]865 When the color setting for <tt>name</tt> is undefined, the command uses
866 <tt>color.ui</tt> as fallback.
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]867</p>
868</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]869<dt class="hdlist1">
Junio C Hamano89bdb3b2009-05-10 06:48:14[diff] [blame]870--get-color name [default]
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]871</dt>
872<dd>
873<p>
874 Find the color configured for <tt>name</tt> (e.g. <tt>color.diff.new</tt>) and
875 output it as the ANSI color escape sequence to the standard
876 output. The optional <tt>default</tt> parameter is used instead, if
877 there is no color configured for <tt>name</tt>.
878</p>
879</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]880<dt class="hdlist1">
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]881-e
882</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]883<dt class="hdlist1">
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]884--edit
885</dt>
886<dd>
887<p>
888 Opens an editor to modify the specified config file; either
889 <em>--system</em>, <em>--global</em>, or repository (default).
890</p>
891</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]892</dl></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]893</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]894<h2 id="FILES">FILES</h2>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]895<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]896<div class="paragraph"><p>If not set explicitly with <em>--file</em>, there are three files where
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]897<em>git config</em> will search for configuration options:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]898<div class="dlist"><dl>
899<dt class="hdlist1">
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]900$GIT_DIR/config
901</dt>
902<dd>
903<p>
904 Repository specific configuration file. (The filename is
905 of course relative to the repository root, not the working
906 directory.)
907</p>
908</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]909<dt class="hdlist1">
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]910~/.gitconfig
911</dt>
912<dd>
913<p>
914 User-specific configuration file. Also called "global"
915 configuration file.
916</p>
917</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]918<dt class="hdlist1">
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]919$(prefix)/etc/gitconfig
920</dt>
921<dd>
922<p>
923 System-wide configuration file.
924</p>
925</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]926</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]927<div class="paragraph"><p>If no further options are given, all reading options will read all of these
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]928files that are available. If the global or the system-wide configuration
929file are not available they will be ignored. If the repository configuration
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]930file is not available or readable, <em>git config</em> will exit with a non-zero
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]931error code. However, in neither case will an error message be issued.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]932<div class="paragraph"><p>All writing options will per default write to the repository specific
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]933configuration file. Note that this also affects options like <em>--replace-all</em>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]934and <em>--unset</em>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]935<div class="paragraph"><p>You can override these rules either by command line options or by environment
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]936variables. The <em>--global</em> and the <em>--system</em> options will limit the file used
937to the global or system-wide file respectively. The GIT_CONFIG environment
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]938variable has a similar effect, but you can specify any filename you want.</p></div>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]939</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]940<h2 id="_environment">ENVIRONMENT</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]941<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]942<div class="dlist"><dl>
943<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]944GIT_CONFIG
945</dt>
946<dd>
947<p>
948 Take the configuration from the given file instead of .git/config.
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]949 Using the "--global" option forces this to ~/.gitconfig. Using the
950 "--system" option forces this to $(prefix)/etc/gitconfig.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]951</p>
952</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]953</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]954<div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]955</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]956<h2 id="EXAMPLES">EXAMPLES</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]957<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]958<div class="paragraph"><p>Given a .git/config like this:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]959<div class="literalblock">
960<div class="content">
961<pre><tt>#
962# This is the config file, and
963# a '#' or ';' character indicates
964# a comment
965#</tt></pre>
966</div></div>
967<div class="literalblock">
968<div class="content">
969<pre><tt>; core variables
970[core]
971 ; Don't trust file modes
972 filemode = false</tt></pre>
973</div></div>
974<div class="literalblock">
975<div class="content">
976<pre><tt>; Our diff algorithm
977[diff]
Junio C Hamano85c71572008-07-28 00:03:31[diff] [blame]978 external = /usr/local/bin/diff-wrapper
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]979 renames = true</tt></pre>
980</div></div>
981<div class="literalblock">
982<div class="content">
983<pre><tt>; Proxy settings
984[core]
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]985 gitproxy="proxy-command" for kernel.org
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]986 gitproxy=default-proxy ; for all the rest</tt></pre>
987</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]988<div class="paragraph"><p>you can set the filemode to true with</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]989<div class="listingblock">
990<div class="content">
991<pre><tt>% git config core.filemode true</tt></pre>
992</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]993<div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]994what URL they apply to. Here is how to change the entry for kernel.org
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]995to "ssh".</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]996<div class="listingblock">
997<div class="content">
998<pre><tt>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</tt></pre>
999</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1000<div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
1001<div class="paragraph"><p>To delete the entry for renames, do</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1002<div class="listingblock">
1003<div class="content">
1004<pre><tt>% git config --unset diff.renames</tt></pre>
1005</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1006<div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1007you have to provide a regex matching the value of exactly one line.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1008<div class="paragraph"><p>To query the value for a given key, do</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1009<div class="listingblock">
1010<div class="content">
1011<pre><tt>% git config --get core.filemode</tt></pre>
1012</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1013<div class="paragraph"><p>or</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1014<div class="listingblock">
1015<div class="content">
1016<pre><tt>% git config core.filemode</tt></pre>
1017</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1018<div class="paragraph"><p>or, to query a multivar:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1019<div class="listingblock">
1020<div class="content">
1021<pre><tt>% git config --get core.gitproxy "for kernel.org$"</tt></pre>
1022</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1023<div class="paragraph"><p>If you want to know all the values for a multivar, do:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1024<div class="listingblock">
1025<div class="content">
1026<pre><tt>% git config --get-all core.gitproxy</tt></pre>
1027</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1028<div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1029new one with</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1030<div class="listingblock">
1031<div class="content">
1032<pre><tt>% git config --replace-all core.gitproxy ssh</tt></pre>
1033</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1034<div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1035i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1036<div class="listingblock">
1037<div class="content">
1038<pre><tt>% git config core.gitproxy ssh '! for '</tt></pre>
1039</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1040<div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1041<div class="listingblock">
1042<div class="content">
1043<pre><tt>% git config section.key value '[!]'</tt></pre>
1044</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1045<div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1046<div class="listingblock">
1047<div class="content">
Junio C Hamanoc71a8732007-08-04 00:27:26[diff] [blame]1048<pre><tt>% git config core.gitproxy '"proxy-command" for example.com'</tt></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1049</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1050<div class="paragraph"><p>An example to use customized color from the configuration in your
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1051script:</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1052<div class="listingblock">
1053<div class="content">
1054<pre><tt>#!/bin/sh
1055WS=$(git config --get-color color.diff.whitespace "blue reverse")
1056RESET=$(git config --get-color "" "reset")
1057echo "${WS}your whitespace color or blue reverse${RESET}"</tt></pre>
1058</div></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1059</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1060<h2 id="_configuration_file">CONFIGURATION FILE</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1061<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1062<div class="paragraph"><p>The git configuration file contains a number of variables that affect
1063the git command&#8217;s behavior. The <tt>.git/config</tt> file in each repository
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1064is used to store the configuration for that repository, and
1065<tt>$HOME/.gitconfig</tt> is used to store a per-user configuration as
1066fallback values for the <tt>.git/config</tt> file. The file <tt>/etc/gitconfig</tt>
1067can be used to store a system-wide default configuration.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1068<div class="paragraph"><p>The configuration variables are used by both the git plumbing
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1069and the porcelains. The variables are divided into sections, wherein
1070the fully qualified variable name of the variable itself is the last
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1071dot-separated segment and the section name is everything before the last
1072dot. The variable names are case-insensitive and only alphanumeric
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1073characters are allowed. Some variables may appear multiple times.</p></div>
1074<h3 id="_syntax">Syntax</h3><div style="clear:left"></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1075<div class="paragraph"><p>The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1076ignored. The <em>#</em> and <em>;</em> characters begin comments to the end of line,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1077blank lines are ignored.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1078<div class="paragraph"><p>The file consists of sections and variables. A section begins with
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1079the name of the section in square brackets and continues until the next
1080section begins. Section names are not case sensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]1081characters, <tt>-</tt> and <tt>.</tt> are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1082must belong to some section, which means that there must be a section
1083header before the first setting of a variable.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1084<div class="paragraph"><p>Sections can be further divided into subsections. To begin a subsection
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1085put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1086in the section header, like in the example below:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1087<div class="listingblock">
1088<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1089<pre><tt> [section "subsection"]</tt></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1090</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1091<div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1092newline (doublequote <tt>"</tt> and backslash have to be escaped as <tt>\"</tt> and <tt>\\</tt>,
1093respectively). Section headers cannot span multiple
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1094lines. Variables may belong directly to a section or to a given subsection.
1095You can have <tt>[section]</tt> if you have <tt>[section "subsection"]</tt>, but you
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1096don&#8217;t need to.</p></div>
1097<div class="paragraph"><p>There is also a case insensitive alternative <tt>[section.subsection]</tt> syntax.
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1098In this syntax, subsection names follow the same restrictions as for section
1099names.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1100<div class="paragraph"><p>All the other lines (and the remainder of the line after the section
Junio C Hamanoaa2cd762009-07-26 08:14:01[diff] [blame]1101header) are recognized as setting variables, in the form
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1102<em>name = value</em>. If there is no equal sign on the line, the entire line
1103is taken as <em>name</em> and the variable is recognized as boolean "true".
1104The variable names are case-insensitive and only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]1105characters and <tt>-</tt> are allowed. There can be more than one value
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1106for a given variable; we say then that variable is multivalued.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1107<div class="paragraph"><p>Leading and trailing whitespace in a variable value is discarded.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1108Internal whitespace within a variable value is retained verbatim.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1109<div class="paragraph"><p>The values following the equals sign in variable assign are all either
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1110a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano059bca52011-03-30 22:47:46[diff] [blame]11111/0, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1112converting value to the canonical form using <em>--bool</em> type specifier;
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1113<em>git config</em> will ensure that the output is "true" or "false".</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1114<div class="paragraph"><p>String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1115You need to enclose variable values in double quotes if you want to
1116preserve leading or trailing whitespace, or if the variable value contains
1117comment characters (i.e. it contains <em>#</em> or <em>;</em>).
1118Double quote <tt>"</tt> and backslash <tt>\</tt> characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]1119be escaped: use <tt>\"</tt> for <tt>"</tt> and <tt>\\</tt> for <tt>\</tt>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1120<div class="paragraph"><p>The following escape sequences (beside <tt>\"</tt> and <tt>\\</tt>) are recognized:
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]1121<tt>\n</tt> for newline character (NL), <tt>\t</tt> for horizontal tabulation (HT, TAB)
1122and <tt>\b</tt> for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1123char sequences are valid.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1124<div class="paragraph"><p>Variable values ending in a <tt>\</tt> are continued on the next line in the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1125customary UNIX fashion.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1126<div class="paragraph"><p>Some variables may require a special value format.</p></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1127<h3 id="_example">Example</h3><div style="clear:left"></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1128<div class="literalblock">
1129<div class="content">
1130<pre><tt># Core variables
1131[core]
1132 ; Don't trust file modes
1133 filemode = false</tt></pre>
1134</div></div>
1135<div class="literalblock">
1136<div class="content">
1137<pre><tt># Our diff algorithm
1138[diff]
Junio C Hamano85c71572008-07-28 00:03:31[diff] [blame]1139 external = /usr/local/bin/diff-wrapper
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1140 renames = true</tt></pre>
1141</div></div>
1142<div class="literalblock">
1143<div class="content">
1144<pre><tt>[branch "devel"]
1145 remote = origin
1146 merge = refs/heads/devel</tt></pre>
1147</div></div>
1148<div class="literalblock">
1149<div class="content">
1150<pre><tt># Proxy settings
1151[core]
Junio C Hamanoc71a8732007-08-04 00:27:26[diff] [blame]1152 gitProxy="ssh" for "kernel.org"
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1153 gitProxy=default-proxy ; for the rest</tt></pre>
1154</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1155<h3 id="_variables">Variables</h3><div style="clear:left"></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1156<div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1157For command-specific variables, you will find a more detailed description
1158in the appropriate manual page. You will find a description of non-core
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1159porcelain configuration variables in the respective porcelain documentation.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1160<div class="dlist"><dl>
1161<dt class="hdlist1">
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1162advice.*
1163</dt>
1164<dd>
1165<p>
1166 When set to <em>true</em>, display the given optional help message.
1167 When set to <em>false</em>, do not display. The configuration variables
1168 are:
1169</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1170<div class="dlist"><dl>
1171<dt class="hdlist1">
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1172pushNonFastForward
1173</dt>
1174<dd>
1175<p>
1176 Advice shown when <a href="git-push.html">git-push(1)</a> refuses
1177 non-fast-forward refs. Default: true.
1178</p>
1179</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1180<dt class="hdlist1">
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1181statusHints
1182</dt>
1183<dd>
1184<p>
1185 Directions on how to stage/unstage/add shown in the
1186 output of <a href="git-status.html">git-status(1)</a> and the template shown
1187 when writing commit messages. Default: true.
1188</p>
1189</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1190<dt class="hdlist1">
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1191commitBeforeMerge
1192</dt>
1193<dd>
1194<p>
1195 Advice shown when <a href="git-merge.html">git-merge(1)</a> refuses to
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]1196 merge to avoid overwriting local changes.
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1197 Default: true.
1198</p>
1199</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1200<dt class="hdlist1">
Junio C Hamanoa9701f02010-01-21 00:42:16[diff] [blame]1201resolveConflict
1202</dt>
1203<dd>
1204<p>
1205 Advices shown by various commands when conflicts
1206 prevent the operation from being performed.
1207 Default: true.
1208</p>
1209</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1210<dt class="hdlist1">
Junio C Hamanoa9701f02010-01-21 00:42:16[diff] [blame]1211implicitIdentity
1212</dt>
1213<dd>
1214<p>
1215 Advice on how to set your identity configuration when
1216 your information is guessed from the system username and
1217 domain name. Default: true.
1218</p>
1219</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1220<dt class="hdlist1">
Junio C Hamano74a198f2010-02-22 00:13:31[diff] [blame]1221detachedHead
1222</dt>
1223<dd>
1224<p>
1225 Advice shown when you used <a href=":git-checkout.html">:git-checkout(1)</a> to
1226 move to the detach HEAD state, to instruct how to create
1227 a local branch after the fact. Default: true.
1228</p>
1229</dd>
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1230</dl></div>
1231</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1232<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1233core.fileMode
1234</dt>
1235<dd>
1236<p>
1237 If false, the executable bit differences between the index and
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame^]1238 the working tree are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1239 See <a href="git-update-index.html">git-update-index(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1240</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1241<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>
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1242will probe and set core.fileMode false if appropriate when the
1243repository is created.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1244</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1245<dt class="hdlist1">
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1246core.ignoreCygwinFSTricks
1247</dt>
1248<dd>
1249<p>
1250 This option is only used by Cygwin implementation of Git. If false,
1251 the Cygwin stat() and lstat() functions are used. This may be useful
1252 if your repository consists of a few separate directories joined in
1253 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
1254 whenever it is possible and falls back to Cygwin functions only to
1255 handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]1256 normal Cygwin l/stat() functions. True by default, unless core.filemode
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1257 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin&#8217;s
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]1258 POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1259</p>
1260</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1261<dt class="hdlist1">
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1262core.ignorecase
1263</dt>
1264<dd>
1265<p>
1266 If true, this option enables various workarounds to enable
1267 git to work better on filesystems that are not case sensitive,
1268 like FAT. For example, if a directory listing finds
1269 "makefile" when git expects "Makefile", git will assume
1270 it is really the same file, and continue to remember it as
1271 "Makefile".
1272</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1273<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>
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1274will probe and set core.ignorecase true if appropriate when the repository
1275is created.</p></div>
1276</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1277<dt class="hdlist1">
Junio C Hamano90ccff32008-07-29 08:17:24[diff] [blame]1278core.trustctime
1279</dt>
1280<dd>
1281<p>
1282 If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame^]1283 working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24[diff] [blame]1284 is regularly modified by something outside Git (file system
1285 crawlers and some backup systems).
1286 See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
1287</p>
1288</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1289<dt class="hdlist1">
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]1290core.quotepath
1291</dt>
1292<dd>
1293<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1294 The commands that output paths (e.g. <em>ls-files</em>,
1295 <em>diff</em>), when not given the <tt>-z</tt> option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]1296 "unusual" characters in the pathname by enclosing the
1297 pathname in a double-quote pair and with backslashes the
1298 same way strings in C source code are quoted. If this
1299 variable is set to false, the bytes higher than 0x80 are
1300 not quoted but output as verbatim. Note that double
1301 quote, backslash and control characters are always
1302 quoted without <tt>-z</tt> regardless of the setting of this
1303 variable.
1304</p>
1305</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1306<dt class="hdlist1">
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]1307core.eol
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]1308</dt>
1309<dd>
1310<p>
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]1311 Sets the line ending type to use in the working directory for
1312 files that have the <tt>text</tt> property set. Alternatives are
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1313 <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s native
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]1314 line ending. The default value is <tt>native</tt>. See
1315 <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
1316 conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]1317</p>
1318</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1319<dt class="hdlist1">
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]1320core.safecrlf
1321</dt>
1322<dd>
1323<p>
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]1324 If true, makes git check if converting <tt>CRLF</tt> is reversible when
1325 end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]1326 modifies a file in the work tree either directly or indirectly.
1327 For example, committing a file followed by checking out the
1328 same file should yield the original file in the work tree. If
1329 this is not the case for the current setting of
1330 <tt>core.autocrlf</tt>, git will reject the file. The variable can
1331 be set to "warn", in which case git will only warn about an
1332 irreversible conversion but continue the operation.
1333</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1334<div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]1335When it is enabled, git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]1336CRLF during checkout. A file that contains a mixture of LF and
1337CRLF before the commit cannot be recreated by git. For text
1338files this is the right thing to do: it corrects line endings
1339such that we have only LF line endings in the repository.
1340But for binary files that are accidentally classified as text the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1341conversion can corrupt data.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1342<div class="paragraph"><p>If you recognize such corruption early you can easily fix it by
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]1343setting the conversion type explicitly in .gitattributes. Right
1344after committing you still have the original file in your work
1345tree and this file is not yet corrupted. You can explicitly tell
1346git that this file is binary and git will handle the file
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1347appropriately.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1348<div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]1349mixed line endings and the undesired effect of corrupting binary
1350files cannot be distinguished. In both cases CRLFs are removed
1351in an irreversible way. For text files this is the right thing
1352to do because CRLFs are line endings, while for binary files
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1353converting CRLFs corrupts data.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1354<div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]1355file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]1356<tt>core.eol</tt> and <tt>core.autocrlf</tt>, but only for the current one. For
1357example, a text file with <tt>LF</tt> would be accepted with <tt>core.eol=lf</tt>
1358and could later be checked out with <tt>core.eol=crlf</tt>, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]1359resulting file would contain <tt>CRLF</tt>, although the original file
1360contained <tt>LF</tt>. However, in both work trees the line endings would be
1361consistent, that is either all <tt>LF</tt> or all <tt>CRLF</tt>, but never mixed. A
1362file with mixed line endings would be reported by the <tt>core.safecrlf</tt>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1363mechanism.</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]1364</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1365<dt class="hdlist1">
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]1366core.autocrlf
1367</dt>
1368<dd>
1369<p>
1370 Setting this variable to "true" is almost the same as setting
1371 the <tt>text</tt> attribute to "auto" on all files except that text
1372 files are not guaranteed to be normalized: files that contain
1373 <tt>CRLF</tt> in the repository will not be touched. Use this
1374 setting if you want to have <tt>CRLF</tt> line endings in your
1375 working directory even though the repository does not have
1376 normalized line endings. This variable can be set to <em>input</em>,
1377 in which case no output conversion is performed.
1378</p>
1379</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1380<dt class="hdlist1">
Junio C Hamanoaa83a7d2007-03-05 02:37:29[diff] [blame]1381core.symlinks
1382</dt>
1383<dd>
1384<p>
1385 If false, symbolic links are checked out as small plain files that
1386 contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
1387 <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
1388 file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1389 symbolic links.
Junio C Hamanoaa83a7d2007-03-05 02:37:29[diff] [blame]1390</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1391<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>
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1392will probe and set core.symlinks false if appropriate when the repository
1393is created.</p></div>
Junio C Hamanoaa83a7d2007-03-05 02:37:29[diff] [blame]1394</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1395<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1396core.gitProxy
1397</dt>
1398<dd>
1399<p>
1400 A "proxy command" to execute (as <em>command host port</em>) instead
1401 of establishing direct connection to the remote server when
1402 using the git protocol for fetching. If the variable value is
1403 in the "COMMAND for DOMAIN" format, the command is applied only
1404 on hostnames ending with the specified domain string. This variable
1405 may be set multiple times and is matched in the given order;
1406 the first match wins.
1407</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1408<div class="paragraph"><p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1409(which always applies universally, without the special "for"
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1410handling).</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1411<div class="paragraph"><p>The special string <tt>none</tt> can be used as the proxy command to
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]1412specify that no proxy be used for a given domain pattern.
1413This is useful for excluding servers inside a firewall from
1414proxy use, while defaulting to a common proxy for external domains.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1415</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1416<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1417core.ignoreStat
1418</dt>
1419<dd>
1420<p>
Junio C Hamano054ea082008-06-01 08:26:34[diff] [blame]1421 If true, commands which modify both the working tree and the index
1422 will mark the updated paths with the "assume unchanged" bit in the
1423 index. These marked files are then assumed to stay unchanged in the
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame^]1424 working tree, until you mark them otherwise manually - Git will not
Junio C Hamano054ea082008-06-01 08:26:34[diff] [blame]1425 detect the file changes by lstat() calls. This is useful on systems
1426 where those are very slow, such as Microsoft Windows.
1427 See <a href="git-update-index.html">git-update-index(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1428 False by default.
1429</p>
1430</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1431<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1432core.preferSymlinkRefs
1433</dt>
1434<dd>
1435<p>
1436 Instead of the default "symref" format for HEAD
1437 and other symbolic reference files, use symbolic links.
1438 This is sometimes needed to work with old scripts that
1439 expect HEAD to be a symbolic link.
1440</p>
1441</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1442<dt class="hdlist1">
Junio C Hamano1025e752007-02-23 07:21:26[diff] [blame]1443core.bare
1444</dt>
1445<dd>
1446<p>
1447 If true this repository is assumed to be <em>bare</em> and has no
1448 working directory associated with it. If this is the case a
1449 number of commands that require a working directory will be
1450 disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
1451</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1452<div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
Junio C Hamano1025e752007-02-23 07:21:26[diff] [blame]1453<a href="git-init.html">git-init(1)</a> when the repository was created. By default a
1454repository that ends in "/.git" is assumed to be not bare (bare =
1455false), while all other repositories are assumed to be bare (bare
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1456= true).</p></div>
Junio C Hamano1025e752007-02-23 07:21:26[diff] [blame]1457</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1458<dt class="hdlist1">
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]1459core.worktree
1460</dt>
1461<dd>
1462<p>
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]1463 Set the path to the root of the working tree.
Junio C Hamano764a6672007-10-23 01:23:31[diff] [blame]1464 This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]1465 variable and the <em>--work-tree</em> command line option.
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]1466 The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]1467 the .git directory, which is either specified by --git-dir
1468 or GIT_DIR, or automatically discovered.
1469 If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27[diff] [blame]1470 --work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]1471 the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52[diff] [blame]1472 of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]1473</p>
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]1474<div class="paragraph"><p>Note that this variable is honored even when set in a configuration
1475file in a ".git" subdirectory of a directory and its value differs
1476from the latter directory (e.g. "/path/to/.git/config" has
1477core.worktree set to "/different/path"), which is most likely a
1478misconfiguration. Running git commands in the "/path/to" directory will
1479still use "/different/path" as the root of the work tree and can cause
1480confusion unless you know what you are doing (e.g. you are creating a
1481read-only snapshot of the same index to a location different from the
1482repository&#8217;s usual working tree).</p></div>
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]1483</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1484<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1485core.logAllRefUpdates
1486</dt>
1487<dd>
1488<p>
Junio C Hamanocae86272007-08-21 02:20:49[diff] [blame]1489 Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1490 "$GIT_DIR/logs/&lt;ref&gt;", by appending the new and old
1491 SHA1, the date/time and the reason of the update, but
1492 only when the file exists. If this configuration
1493 variable is set to true, missing "$GIT_DIR/logs/&lt;ref&gt;"
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]1494 file is automatically created for branch heads (i.e. under
1495 refs/heads/), remote refs (i.e. under refs/remotes/),
1496 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1497</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1498<div class="paragraph"><p>This information can be used to determine what commit
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1499was the tip of a branch "2 days ago".</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1500<div class="paragraph"><p>This value is true by default in a repository that has
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1501a working directory associated with it, and false by
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1502default in a bare repository.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1503</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1504<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1505core.repositoryFormatVersion
1506</dt>
1507<dd>
1508<p>
1509 Internal variable identifying the repository format and layout
1510 version.
1511</p>
1512</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1513<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1514core.sharedRepository
1515</dt>
1516<dd>
1517<p>
1518 When <em>group</em> (or <em>true</em>), the repository is made shareable between
1519 several users in a group (making sure all the files and objects are
1520 group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
1521 repository will be readable by all users, additionally to being
1522 group-shareable. When <em>umask</em> (or <em>false</em>), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37[diff] [blame]1523 reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
1524 files in the repository will have this mode value. <em>0xxx</em> will override
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1525 user&#8217;s umask value (whereas the other options will only override
1526 requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
Junio C Hamano83eded12009-04-20 08:18:00[diff] [blame]1527 the repo read/write-able for the owner and group, but inaccessible to
1528 others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
Junio C Hamano2f102bb2008-04-26 02:23:37[diff] [blame]1529 repository that is group-readable but not group-writable.
1530 See <a href="git-init.html">git-init(1)</a>. False by default.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1531</p>
1532</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1533<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1534core.warnAmbiguousRefs
1535</dt>
1536<dd>
1537<p>
1538 If true, git will warn you if the ref name you passed it is ambiguous
1539 and might match multiple refs in the .git/refs/ tree. True by default.
1540</p>
1541</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1542<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1543core.compression
1544</dt>
1545<dd>
1546<p>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1547 An integer -1..9, indicating a default compression level.
1548 -1 is the zlib default. 0 means no compression,
1549 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42[diff] [blame]1550 If set, this provides a default to other compression variables,
1551 such as <em>core.loosecompression</em> and <em>pack.compression</em>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1552</p>
1553</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1554<dt class="hdlist1">
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1555core.loosecompression
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1556</dt>
1557<dd>
1558<p>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1559 An integer -1..9, indicating the compression level for objects that
1560 are not in a pack file. -1 is the zlib default. 0 means no
1561 compression, and 1..9 are various speed/size tradeoffs, 9 being
1562 slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42[diff] [blame]1563 not set, defaults to 1 (best speed).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1564</p>
1565</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1566<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1567core.packedGitWindowSize
1568</dt>
1569<dd>
1570<p>
1571 Number of bytes of a pack file to map into memory in a
1572 single mapping operation. Larger window sizes may allow
1573 your system to process a smaller number of large pack files
1574 more quickly. Smaller window sizes will negatively affect
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1575 performance due to increased calls to the operating system&#8217;s
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1576 memory manager, but may improve performance when accessing
1577 a large number of large pack files.
1578</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1579<div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1580MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
1581be reasonable for all users/operating systems. You probably do
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1582not need to adjust this value.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1583<div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1584</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1585<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1586core.packedGitLimit
1587</dt>
1588<dd>
1589<p>
1590 Maximum number of bytes to map simultaneously into memory
1591 from pack files. If Git needs to access more than this many
1592 bytes at once to complete an operation it will unmap existing
1593 regions to reclaim virtual address space within the process.
1594</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1595<div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1596This should be reasonable for all users/operating systems, except on
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1597the largest projects. You probably do not need to adjust this value.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1598<div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1599</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1600<dt class="hdlist1">
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]1601core.deltaBaseCacheLimit
1602</dt>
1603<dd>
1604<p>
1605 Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]1606 that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]1607 entire decompressed base objects in a cache Git is able
1608 to avoid unpacking and decompressing frequently used base
1609 objects multiple times.
1610</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1611<div class="paragraph"><p>Default is 16 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]1612for all users/operating systems, except on the largest projects.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1613You probably do not need to adjust this value.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1614<div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]1615</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1616<dt class="hdlist1">
Junio C Hamano5c246f22010-02-03 07:34:53[diff] [blame]1617core.bigFileThreshold
1618</dt>
1619<dd>
1620<p>
1621 Files larger than this size are stored deflated, without
1622 attempting delta compression. Storing large files without
1623 delta compression avoids excessive memory usage, at the
1624 slight expense of increased disk usage.
1625</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1626<div class="paragraph"><p>Default is 512 MiB on all platforms. This should be reasonable
Junio C Hamano5c246f22010-02-03 07:34:53[diff] [blame]1627for most projects as source code and other text files can still
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1628be delta compressed, but larger binary media files won&#8217;t be.</p></div>
1629<div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
Junio C Hamano5c246f22010-02-03 07:34:53[diff] [blame]1630</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1631<dt class="hdlist1">
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]1632core.excludesfile
Junio C Hamano5e284b42007-05-22 07:23:37[diff] [blame]1633</dt>
1634<dd>
1635<p>
1636 In addition to <em>.gitignore</em> (per-directory) and
1637 <em>.git/info/exclude</em>, git looks into this file for patterns
Junio C Hamanobf984de2009-11-23 06:11:19[diff] [blame]1638 of files which are not meant to be tracked. "&#126;/" is expanded
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1639 to the value of <tt>$HOME</tt> and "&#126;user/" to the specified user&#8217;s
Junio C Hamanobf984de2009-11-23 06:11:19[diff] [blame]1640 home directory. See <a href="gitignore.html">gitignore(5)</a>.
Junio C Hamano5e284b42007-05-22 07:23:37[diff] [blame]1641</p>
1642</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1643<dt class="hdlist1">
Junio C Hamano3fd7b262010-09-08 22:44:20[diff] [blame]1644core.askpass
1645</dt>
1646<dd>
1647<p>
1648 Some commands (e.g. svn and http interfaces) that interactively
1649 ask for a password can be told to use an external program given
1650 via the value of this variable. Can be overridden by the <em>GIT_ASKPASS</em>
1651 environment variable. If not set, fall back to the value of the
1652 <em>SSH_ASKPASS</em> environment variable or, failing that, a simple password
1653 prompt. The external program shall be given a suitable prompt as
1654 command line argument and write the password on its STDOUT.
1655</p>
1656</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1657<dt class="hdlist1">
Junio C Hamano3b4609d2010-09-30 00:04:34[diff] [blame]1658core.attributesfile
1659</dt>
1660<dd>
1661<p>
1662 In addition to <em>.gitattributes</em> (per-directory) and
1663 <em>.git/info/attributes</em>, git looks into this file for attributes
1664 (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
1665 way as for <tt>core.excludesfile</tt>.
1666</p>
1667</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1668<dt class="hdlist1">
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]1669core.editor
1670</dt>
1671<dd>
1672<p>
1673 Commands such as <tt>commit</tt> and <tt>tag</tt> that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]1674 messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]1675 variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]1676 <tt>GIT_EDITOR</tt> is not set. See <a href="git-var.html">git-var(1)</a>.
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]1677</p>
1678</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1679<dt class="hdlist1">
Junio C Hamano28d8ede2007-07-05 05:51:38[diff] [blame]1680core.pager
1681</dt>
1682<dd>
1683<p>
Junio C Hamano0551f6a2008-08-25 00:33:33[diff] [blame]1684 The command that git will use to paginate output. Can
1685 be overridden with the <tt>GIT_PAGER</tt> environment
1686 variable. Note that git sets the <tt>LESS</tt> environment
1687 variable to <tt>FRSX</tt> if it is unset when it runs the
1688 pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1689 <tt>LESS</tt> variable to some other value. Alternately,
1690 these settings can be overridden on a project or
1691 global basis by setting the <tt>core.pager</tt> option.
1692 Setting <tt>core.pager</tt> has no affect on the <tt>LESS</tt>
1693 environment variable behaviour above, so if you want
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1694 to override git&#8217;s default settings this way, you need
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1695 to be explicit. For example, to disable the S option
1696 in a backward compatible manner, set <tt>core.pager</tt>
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]1697 to <tt>less -+$LESS -FRX</tt>. This will be passed to the
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1698 shell by git, which will translate the final command to
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]1699 <tt>LESS=FRSX less -+FRSX -FRX</tt>.
Junio C Hamano28d8ede2007-07-05 05:51:38[diff] [blame]1700</p>
1701</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1702<dt class="hdlist1">
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1703core.whitespace
1704</dt>
1705<dd>
1706<p>
1707 A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1708 notice. <em>git diff</em> will use <tt>color.diff.whitespace</tt> to
1709 highlight them, and <em>git apply --whitespace=error</em> will
Junio C Hamano3db8b412008-07-26 06:45:59[diff] [blame]1710 consider them as errors. You can prefix <tt>-</tt> to disable
1711 any of them (e.g. <tt>-trailing-space</tt>):
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1712</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1713<div class="ulist"><ul>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1714<li>
1715<p>
Junio C Hamanob71a22d2009-10-17 08:23:47[diff] [blame]1716<tt>blank-at-eol</tt> treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1717 as an error (enabled by default).
1718</p>
1719</li>
1720<li>
1721<p>
1722<tt>space-before-tab</tt> treats a space character that appears immediately
1723 before a tab character in the initial indent part of the line as an
1724 error (enabled by default).
1725</p>
1726</li>
1727<li>
1728<p>
1729<tt>indent-with-non-tab</tt> treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42[diff] [blame]1730 space characters as an error (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1731</p>
1732</li>
Junio C Hamano601f3e52008-02-25 08:40:42[diff] [blame]1733<li>
1734<p>
Junio C Hamanocb39aea2010-05-09 07:24:48[diff] [blame]1735<tt>tab-in-indent</tt> treats a tab character in the initial indent part of
1736 the line as an error (not enabled by default).
1737</p>
1738</li>
1739<li>
1740<p>
Junio C Hamanob71a22d2009-10-17 08:23:47[diff] [blame]1741<tt>blank-at-eof</tt> treats blank lines added at the end of file as an error
1742 (enabled by default).
1743</p>
1744</li>
1745<li>
1746<p>
1747<tt>trailing-space</tt> is a short-hand to cover both <tt>blank-at-eol</tt> and
1748 <tt>blank-at-eof</tt>.
1749</p>
1750</li>
1751<li>
1752<p>
Junio C Hamano601f3e52008-02-25 08:40:42[diff] [blame]1753<tt>cr-at-eol</tt> treats a carriage-return at the end of line as
1754 part of the line terminator, i.e. with it, <tt>trailing-space</tt>
1755 does not trigger if the character before such a carriage-return
1756 is not a whitespace (not enabled by default).
1757</p>
1758</li>
Junio C Hamanoeef01fe2010-12-13 08:31:58[diff] [blame]1759<li>
1760<p>
1761<tt>tabwidth=&lt;n&gt;</tt> tells how many character positions a tab occupies; this
1762 is relevant for <tt>indent-with-non-tab</tt> and when git fixes <tt>tab-in-indent</tt>
1763 errors. The default tab width is 8. Allowed values are 1 to 63.
1764</p>
1765</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1766</ul></div>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1767</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1768<dt class="hdlist1">
Junio C Hamano9eb57532008-06-26 06:33:46[diff] [blame]1769core.fsyncobjectfiles
1770</dt>
1771<dd>
1772<p>
1773 This boolean will enable <em>fsync()</em> when writing object files.
1774</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1775<div class="paragraph"><p>This is a total waste of time and effort on a filesystem that orders
Junio C Hamano9eb57532008-06-26 06:33:46[diff] [blame]1776data writes properly, but can be useful for filesystems that do not use
1777journalling (traditional UNIX filesystems) or that only journal metadata
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1778and not file contents (OS X&#8217;s HFS+, or Linux ext3 with "data=writeback").</p></div>
Junio C Hamano9eb57532008-06-26 06:33:46[diff] [blame]1779</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1780<dt class="hdlist1">
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]1781core.preloadindex
1782</dt>
1783<dd>
1784<p>
1785 Enable parallel index preload for operations like <em>git diff</em>
1786</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1787<div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]1788on filesystems like NFS that have weak caching semantics and thus
1789relatively high IO latencies. With this set to <em>true</em>, git will do the
1790index comparison to the filesystem data in parallel, allowing
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1791overlapping IO&#8217;s.</p></div>
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]1792</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1793<dt class="hdlist1">
Junio C Hamanoa9499de2009-04-30 03:38:48[diff] [blame]1794core.createObject
Junio C Hamanoe91ea772009-04-26 01:41:41[diff] [blame]1795</dt>
1796<dd>
1797<p>
Junio C Hamanoa9499de2009-04-30 03:38:48[diff] [blame]1798 You can set this to <em>link</em>, in which case a hardlink followed by
1799 a delete of the source are used to make sure that object creation
1800 will not overwrite existing objects.
Junio C Hamanoe91ea772009-04-26 01:41:41[diff] [blame]1801</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1802<div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
Junio C Hamanoa9499de2009-04-30 03:38:48[diff] [blame]1803Set this config setting to <em>rename</em> there; However, This will remove the
1804check that makes sure that existing object files will not get overwritten.</p></div>
Junio C Hamanoe91ea772009-04-26 01:41:41[diff] [blame]1805</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1806<dt class="hdlist1">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]1807core.notesRef
1808</dt>
1809<dd>
1810<p>
1811 When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]1812 the given ref. The ref must be fully qualified. If the given
1813 ref does not exist, it is not an error but means that no
1814 notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]1815</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1816<div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]1817the <em>GIT_NOTES_REF</em> environment variable. See <a href="git-notes.html">git-notes(1)</a>.</p></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]1818</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1819<dt class="hdlist1">
Junio C Hamano3c8d6702010-01-13 23:09:03[diff] [blame]1820core.sparseCheckout
1821</dt>
1822<dd>
1823<p>
1824 Enable "sparse checkout" feature. See section "Sparse checkout" in
1825 <a href="git-read-tree.html">git-read-tree(1)</a> for more information.
1826</p>
1827</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1828<dt class="hdlist1">
Junio C Hamano6371b0e2011-03-23 23:36:21[diff] [blame]1829core.abbrev
1830</dt>
1831<dd>
1832<p>
1833 Set the length object names are abbreviated to. If unspecified,
1834 many commands abbreviate to 7 hexdigits, which may not be enough
1835 for abbreviated object names to stay unique for sufficiently long
1836 time.
1837</p>
1838</dd>
1839<dt class="hdlist1">
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]1840add.ignore-errors
1841</dt>
Junio C Hamano60186642010-12-02 14:18:26[diff] [blame]1842<dt class="hdlist1">
1843add.ignoreErrors
1844</dt>
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]1845<dd>
1846<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1847 Tells <em>git add</em> to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]1848 added due to indexing errors. Equivalent to the <em>--ignore-errors</em>
Junio C Hamano60186642010-12-02 14:18:26[diff] [blame]1849 option of <a href="git-add.html">git-add(1)</a>. Older versions of git accept only
1850 <tt>add.ignore-errors</tt>, which does not follow the usual naming
1851 convention for configuration variables. Newer versions of git
1852 honor <tt>add.ignoreErrors</tt> as well.
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]1853</p>
1854</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1855<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1856alias.*
1857</dt>
1858<dd>
1859<p>
1860 Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
1861 after defining "alias.last = cat-file commit HEAD", the invocation
1862 "git last" is equivalent to "git cat-file commit HEAD". To avoid
1863 confusion and troubles with script usage, aliases that
1864 hide existing git commands are ignored. Arguments are split by
1865 spaces, the usual shell quoting and escaping is supported.
1866 quote pair and a backslash can be used to quote them.
1867</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1868<div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
Junio C Hamano9cb74f22007-02-12 04:15:05[diff] [blame]1869it will be treated as a shell command. For example, defining
1870"alias.new = !gitk --all --not ORIG_HEAD", the invocation
1871"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19[diff] [blame]1872"gitk --all --not ORIG_HEAD". Note that shell commands will be
1873executed from the top-level directory of a repository, which may
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]1874not necessarily be the current directory.
1875<em>GIT_PREFIX</em> is set as returned by running <em>git rev-parse --show-prefix</em>
1876from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1877</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1878<dt class="hdlist1">
Junio C Hamanocaa712a2010-03-11 01:17:35[diff] [blame]1879am.keepcr
1880</dt>
1881<dd>
1882<p>
1883 If true, git-am will call git-mailsplit for patches in mbox format
1884 with parameter <em>--keep-cr</em>. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]1885 not remove <tt>\r</tt> from lines ending with <tt>\r\n</tt>. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35[diff] [blame]1886 by giving <em>--no-keep-cr</em> from the command line.
1887 See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
1888</p>
1889</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1890<dt class="hdlist1">
Junio C Hamanofe24db02009-08-22 05:10:47[diff] [blame]1891apply.ignorewhitespace
1892</dt>
1893<dd>
1894<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1895 When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47[diff] [blame]1896 whitespace, in the same way as the <em>--ignore-space-change</em>
1897 option.
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1898 When set to one of: no, none, never, false tells <em>git apply</em> to
Junio C Hamanofe24db02009-08-22 05:10:47[diff] [blame]1899 respect all whitespace differences.
1900 See <a href="git-apply.html">git-apply(1)</a>.
1901</p>
1902</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1903<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1904apply.whitespace
1905</dt>
1906<dd>
1907<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1908 Tells <em>git apply</em> how to handle whitespaces, in the same way
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1909 as the <em>--whitespace</em> option. See <a href="git-apply.html">git-apply(1)</a>.
1910</p>
1911</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1912<dt class="hdlist1">
Junio C Hamano7fd84172007-05-24 07:00:32[diff] [blame]1913branch.autosetupmerge
1914</dt>
1915<dd>
1916<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1917 Tells <em>git branch</em> and <em>git checkout</em> to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]1918 so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
1919 starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32[diff] [blame]1920 this behavior can be chosen per-branch using the <tt>--track</tt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1921 and <tt>--no-track</tt> options. The valid settings are: <tt>false</tt>&#8201;&#8212;&#8201;no
1922 automatic setup is done; <tt>true</tt>&#8201;&#8212;&#8201;automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1923 starting point is a remote-tracking branch; <tt>always</tt>&#8201;&#8212;&#8201; automatic setup is done when the starting point is either a
1924 local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]1925 branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32[diff] [blame]1926</p>
1927</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1928<dt class="hdlist1">
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]1929branch.autosetuprebase
1930</dt>
1931<dd>
1932<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1933 When a new branch is created with <em>git branch</em> or <em>git checkout</em>
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]1934 that tracks another branch, this variable tells git to set
1935 up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
1936 When <tt>never</tt>, rebase is never automatically set to true.
1937 When <tt>local</tt>, rebase is set to true for tracked branches of
1938 other local branches.
1939 When <tt>remote</tt>, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1940 remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]1941 When <tt>always</tt>, rebase will be set to true for all tracking
1942 branches.
1943 See "branch.autosetupmerge" for details on how to set up a
1944 branch to track another branch.
1945 This option defaults to never.
1946</p>
1947</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1948<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1949branch.&lt;name&gt;.remote
1950</dt>
1951<dd>
1952<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1953 When in branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em> which
Junio C Hamano0706c802009-03-30 22:34:19[diff] [blame]1954 remote to fetch from/push to. It defaults to <tt>origin</tt> if no remote is
1955 configured. <tt>origin</tt> is also used if you are not on any branch.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1956</p>
1957</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1958<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1959branch.&lt;name&gt;.merge
1960</dt>
1961<dd>
1962<p>
Junio C Hamano0706c802009-03-30 22:34:19[diff] [blame]1963 Defines, together with branch.&lt;name&gt;.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02[diff] [blame]1964 for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1965 branch to merge and can also affect <em>git push</em> (see push.default).
1966 When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
Junio C Hamanoc2b47092007-10-25 06:50:31[diff] [blame]1967 refspec to be marked for merging in FETCH_HEAD. The value is
1968 handled like the remote part of a refspec, and must match a
1969 ref which is fetched from the remote given by
1970 "branch.&lt;name&gt;.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1971 The merge information is used by <em>git pull</em> (which at first calls
1972 <em>git fetch</em>) to lookup the default branch for merging. Without
1973 this option, <em>git pull</em> defaults to merge the first refspec fetched.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1974 Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1975 If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
Junio C Hamano6e149c02007-03-16 10:21:07[diff] [blame]1976 another branch in the local repository, you can point
1977 branch.&lt;name&gt;.merge to the desired branch, and use the special setting
1978 <tt>.</tt> (a period) for branch.&lt;name&gt;.remote.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1979</p>
1980</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1981<dt class="hdlist1">
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]1982branch.&lt;name&gt;.mergeoptions
1983</dt>
1984<dd>
1985<p>
1986 Sets default options for merging into branch &lt;name&gt;. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29[diff] [blame]1987 supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]1988 option values containing whitespace characters are currently not
1989 supported.
1990</p>
1991</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1992<dt class="hdlist1">
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1993branch.&lt;name&gt;.rebase
1994</dt>
1995<dd>
1996<p>
1997 When true, rebase the branch &lt;name&gt; on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]1998 instead of merging the default branch from the default remote when
1999 "git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]2000 <strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
2001 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
2002 for details).
2003</p>
2004</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2005<dt class="hdlist1">
Junio C Hamano8760ea62008-03-14 08:58:45[diff] [blame]2006browser.&lt;tool&gt;.cmd
2007</dt>
2008<dd>
2009<p>
2010 Specify the command to invoke the specified browser. The
2011 specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56[diff] [blame]2012 as arguments. (See <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.)
Junio C Hamano8760ea62008-03-14 08:58:45[diff] [blame]2013</p>
2014</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2015<dt class="hdlist1">
Junio C Hamanoe35a6fc2008-01-29 09:46:27[diff] [blame]2016browser.&lt;tool&gt;.path
2017</dt>
2018<dd>
2019<p>
2020 Override the path for the given tool that may be used to
2021 browse HTML help (see <em>-w</em> option in <a href="git-help.html">git-help(1)</a>) or a
2022 working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
2023</p>
2024</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2025<dt class="hdlist1">
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]2026clean.requireForce
2027</dt>
2028<dd>
2029<p>
Junio C Hamano422cfec2007-11-08 08:07:45[diff] [blame]2030 A boolean to make git-clean do nothing unless given -f
2031 or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]2032</p>
2033</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2034<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2035color.branch
2036</dt>
2037<dd>
2038<p>
2039 A boolean to enable/disable color in the output of
Junio C Hamano0fc8cd92007-12-06 03:26:21[diff] [blame]2040 <a href="git-branch.html">git-branch(1)</a>. May be set to <tt>always</tt>,
2041 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2042 only when the output is to a terminal. Defaults to false.
2043</p>
2044</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2045<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2046color.branch.&lt;slot&gt;
2047</dt>
2048<dd>
2049<p>
2050 Use customized color for branch coloration. <tt>&lt;slot&gt;</tt> is one of
2051 <tt>current</tt> (the current branch), <tt>local</tt> (a local branch),
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]2052 <tt>remote</tt> (a remote-tracking branch in refs/remotes/), <tt>plain</tt> (other
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2053 refs).
2054</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2055<div class="paragraph"><p>The value for these configuration variables is a list of colors (at most
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2056two) and attributes (at most one), separated by spaces. The colors
2057accepted are <tt>normal</tt>, <tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>,
2058<tt>magenta</tt>, <tt>cyan</tt> and <tt>white</tt>; the attributes are <tt>bold</tt>, <tt>dim</tt>, <tt>ul</tt>,
2059<tt>blink</tt> and <tt>reverse</tt>. The first color given is the foreground; the
2060second is the background. The position of the attribute, if any,
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2061doesn&#8217;t matter.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2062</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2063<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2064color.diff
2065</dt>
2066<dd>
2067<p>
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]2068 Whether to use ANSI escape sequences to add color to patches.
2069 If this is set to <tt>always</tt>, <a href="git-diff.html">git-diff(1)</a>,
2070 <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
2071 for all patches. If it is set to <tt>true</tt> or <tt>auto</tt>, those
2072 commands will only use color when output is to the terminal.
2073 Defaults to false.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2074</p>
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]2075<div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> nor the
2076<em>git-diff-&#42;</em> plumbing commands. Can be overridden on the
2077command line with the <tt>--color[=&lt;when&gt;]</tt> option.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2078</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2079<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2080color.diff.&lt;slot&gt;
2081</dt>
2082<dd>
2083<p>
2084 Use customized color for diff colorization. <tt>&lt;slot&gt;</tt> specifies
2085 which part of the patch to use the specified color, and is one
2086 of <tt>plain</tt> (context text), <tt>meta</tt> (metainformation), <tt>frag</tt>
Junio C Hamano2bd8a742009-12-01 21:16:59[diff] [blame]2087 (hunk header), <em>func</em> (function in hunk header), <tt>old</tt> (removed lines),
2088 <tt>new</tt> (added lines), <tt>commit</tt> (commit headers), or <tt>whitespace</tt>
2089 (highlighting whitespace errors). The values of these variables may be
2090 specified as in color.branch.&lt;slot&gt;.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2091</p>
2092</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2093<dt class="hdlist1">
Junio C Hamano7d449522010-07-01 00:08:51[diff] [blame]2094color.decorate.&lt;slot&gt;
2095</dt>
2096<dd>
2097<p>
2098 Use customized color for <em>git log --decorate</em> output. <tt>&lt;slot&gt;</tt> is one
2099 of <tt>branch</tt>, <tt>remoteBranch</tt>, <tt>tag</tt>, <tt>stash</tt> or <tt>HEAD</tt> for local
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]2100 branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51[diff] [blame]2101</p>
2102</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2103<dt class="hdlist1">
Junio C Hamanod257cff2009-03-18 05:27:16[diff] [blame]2104color.grep
2105</dt>
2106<dd>
2107<p>
2108 When set to <tt>always</tt>, always highlight matches. When <tt>false</tt> (or
2109 <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use color only
2110 when the output is written to the terminal. Defaults to <tt>false</tt>.
2111</p>
2112</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2113<dt class="hdlist1">
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2114color.grep.&lt;slot&gt;
Junio C Hamanod257cff2009-03-18 05:27:16[diff] [blame]2115</dt>
2116<dd>
2117<p>
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2118 Use customized color for grep colorization. <tt>&lt;slot&gt;</tt> specifies which
2119 part of the line to use the specified color, and is one of
Junio C Hamanod257cff2009-03-18 05:27:16[diff] [blame]2120</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2121<div class="dlist"><dl>
2122<dt class="hdlist1">
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2123<tt>context</tt>
2124</dt>
2125<dd>
2126<p>
2127 non-matching text in context lines (when using <tt>-A</tt>, <tt>-B</tt>, or <tt>-C</tt>)
2128</p>
2129</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2130<dt class="hdlist1">
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2131<tt>filename</tt>
2132</dt>
2133<dd>
2134<p>
2135 filename prefix (when not using <tt>-h</tt>)
2136</p>
2137</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2138<dt class="hdlist1">
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2139<tt>function</tt>
2140</dt>
2141<dd>
2142<p>
2143 function name lines (when using <tt>-p</tt>)
2144</p>
2145</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2146<dt class="hdlist1">
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2147<tt>linenumber</tt>
2148</dt>
2149<dd>
2150<p>
2151 line number prefix (when using <tt>-n</tt>)
2152</p>
2153</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2154<dt class="hdlist1">
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2155<tt>match</tt>
2156</dt>
2157<dd>
2158<p>
2159 matching text
2160</p>
2161</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2162<dt class="hdlist1">
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2163<tt>selected</tt>
2164</dt>
2165<dd>
2166<p>
2167 non-matching text in selected lines
2168</p>
2169</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2170<dt class="hdlist1">
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2171<tt>separator</tt>
2172</dt>
2173<dd>
2174<p>
2175 separators between fields on a line (<tt>:</tt>, <tt>-</tt>, and <tt>=</tt>)
2176 and between hunks (<tt>--</tt>)
2177</p>
2178</dd>
2179</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2180<div class="paragraph"><p>The values of these variables may be specified as in color.branch.&lt;slot&gt;.</p></div>
Junio C Hamanod257cff2009-03-18 05:27:16[diff] [blame]2181</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2182<dt class="hdlist1">
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]2183color.interactive
2184</dt>
2185<dd>
2186<p>
Junio C Hamano35738e82008-01-07 07:55:46[diff] [blame]2187 When set to <tt>always</tt>, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2188 and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]2189 When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use
2190 colors only when the output is to the terminal. Defaults to false.
2191</p>
2192</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2193<dt class="hdlist1">
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]2194color.interactive.&lt;slot&gt;
2195</dt>
2196<dd>
2197<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2198 Use customized color for <em>git add --interactive</em>
Junio C Hamanoe5bf6c12009-02-07 21:43:10[diff] [blame]2199 output. <tt>&lt;slot&gt;</tt> may be <tt>prompt</tt>, <tt>header</tt>, <tt>help</tt> or <tt>error</tt>, for
2200 four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00[diff] [blame]2201 commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]2202 in color.branch.&lt;slot&gt;.
2203</p>
2204</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2205<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2206color.pager
2207</dt>
2208<dd>
2209<p>
2210 A boolean to enable/disable colored output when the pager is in
2211 use (default is true).
2212</p>
2213</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2214<dt class="hdlist1">
Junio C Hamano52ba2952009-05-18 17:43:02[diff] [blame]2215color.showbranch
2216</dt>
2217<dd>
2218<p>
2219 A boolean to enable/disable color in the output of
2220 <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <tt>always</tt>,
2221 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
2222 only when the output is to a terminal. Defaults to false.
2223</p>
2224</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2225<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2226color.status
2227</dt>
2228<dd>
2229<p>
2230 A boolean to enable/disable color in the output of
Junio C Hamano0fc8cd92007-12-06 03:26:21[diff] [blame]2231 <a href="git-status.html">git-status(1)</a>. May be set to <tt>always</tt>,
2232 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2233 only when the output is to a terminal. Defaults to false.
2234</p>
2235</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2236<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2237color.status.&lt;slot&gt;
2238</dt>
2239<dd>
2240<p>
2241 Use customized color for status colorization. <tt>&lt;slot&gt;</tt> is
2242 one of <tt>header</tt> (the header text of the status message),
2243 <tt>added</tt> or <tt>updated</tt> (files which are added but not committed),
2244 <tt>changed</tt> (files which are changed but not added in the index),
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]2245 <tt>untracked</tt> (files which are not tracked by git),
2246 <tt>branch</tt> (the current branch), or
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]2247 <tt>nobranch</tt> (the color the <em>no branch</em> warning is shown in, defaulting
2248 to red). The values of these variables may be specified as in
2249 color.branch.&lt;slot&gt;.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2250</p>
2251</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2252<dt class="hdlist1">
Junio C Hamano83d46a22008-02-21 02:29:42[diff] [blame]2253color.ui
2254</dt>
2255<dd>
2256<p>
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]2257 This variable determines the default value for variables such
2258 as <tt>color.diff</tt> and <tt>color.grep</tt> that control the use of color
2259 per command family. Its scope will expand as more commands learn
2260 configuration to set a default for the <tt>--color</tt> option. Set it
2261 to <tt>always</tt> if you want all output not intended for machine
2262 consumption to use color, to <tt>true</tt> or <tt>auto</tt> if you want such
2263 output to use color when written to the terminal, or to <tt>false</tt> or
2264 <tt>never</tt> if you prefer git commands not to use color unless enabled
2265 explicitly with some other configuration or the <tt>--color</tt> option.
Junio C Hamano83d46a22008-02-21 02:29:42[diff] [blame]2266</p>
2267</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2268<dt class="hdlist1">
Junio C Hamanod0d892c2010-01-24 20:06:29[diff] [blame]2269commit.status
2270</dt>
2271<dd>
2272<p>
Junio C Hamano6ce6b6c2010-01-18 01:25:50[diff] [blame]2273 A boolean to enable/disable inclusion of status information in the
2274 commit message template when using an editor to prepare the commit
Junio C Hamanod0d892c2010-01-24 20:06:29[diff] [blame]2275 message. Defaults to true.
2276</p>
2277</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2278<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]2279commit.template
2280</dt>
2281<dd>
2282<p>
2283 Specify a file to use as the template for new commit messages.
Junio C Hamanobf984de2009-11-23 06:11:19[diff] [blame]2284 "&#126;/" is expanded to the value of <tt>$HOME</tt> and "&#126;user/" to the
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2285 specified user&#8217;s home directory.
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]2286</p>
2287</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2288<dt class="hdlist1">
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]2289diff.autorefreshindex
2290</dt>
2291<dd>
2292<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2293 When using <em>git diff</em> to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]2294 files, do not consider stat-only change as changed.
2295 Instead, silently run <tt>git update-index --refresh</tt> to
2296 update the cached stat information for paths whose
2297 contents in the work tree match the contents in the
2298 index. This option defaults to true. Note that this
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2299 affects only <em>git diff</em> Porcelain, and not lower level
2300 <em>diff</em> commands such as <em>git diff-files</em>.
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]2301</p>
2302</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2303<dt class="hdlist1">
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]2304diff.dirstat
2305</dt>
2306<dd>
2307<p>
2308 A comma separated list of <tt>--dirstat</tt> parameters specifying the
2309 default behavior of the <tt>--dirstat</tt> option to <a href="git-diff.html">git-diff(1)</a>`
2310 and friends. The defaults can be overridden on the command line
2311 (using <tt>--dirstat=&lt;param1,param2,&#8230;&gt;</tt>). The fallback defaults
2312 (when not changed by <tt>diff.dirstat</tt>) are <tt>changes,noncumulative,3</tt>.
2313 The following parameters are available:
2314</p>
2315<div class="dlist"><dl>
2316<dt class="hdlist1">
2317<tt>changes</tt>
2318</dt>
2319<dd>
2320<p>
2321 Compute the dirstat numbers by counting the lines that have been
2322 removed from the source, or added to the destination. This ignores
2323 the amount of pure code movements within a file. In other words,
2324 rearranging lines in a file is not counted as much as other changes.
2325 This is the default behavior when no parameter is given.
2326</p>
2327</dd>
2328<dt class="hdlist1">
2329<tt>lines</tt>
2330</dt>
2331<dd>
2332<p>
2333 Compute the dirstat numbers by doing the regular line-based diff
2334 analysis, and summing the removed/added line counts. (For binary
2335 files, count 64-byte chunks instead, since binary files have no
2336 natural concept of lines). This is a more expensive <tt>--dirstat</tt>
2337 behavior than the <tt>changes</tt> behavior, but it does count rearranged
2338 lines within a file as much as other changes. The resulting output
2339 is consistent with what you get from the other <tt>--*stat</tt> options.
2340</p>
2341</dd>
2342<dt class="hdlist1">
2343<tt>files</tt>
2344</dt>
2345<dd>
2346<p>
2347 Compute the dirstat numbers by counting the number of files changed.
2348 Each changed file counts equally in the dirstat analysis. This is
2349 the computationally cheapest <tt>--dirstat</tt> behavior, since it does
2350 not have to look at the file contents at all.
2351</p>
2352</dd>
2353<dt class="hdlist1">
2354<tt>cumulative</tt>
2355</dt>
2356<dd>
2357<p>
2358 Count changes in a child directory for the parent directory as well.
2359 Note that when using <tt>cumulative</tt>, the sum of the percentages
2360 reported may exceed 100%. The default (non-cumulative) behavior can
2361 be specified with the <tt>noncumulative</tt> parameter.
2362</p>
2363</dd>
2364<dt class="hdlist1">
2365&lt;limit&gt;
2366</dt>
2367<dd>
2368<p>
2369 An integer parameter specifies a cut-off percent (3% by default).
2370 Directories contributing less than this percentage of the changes
2371 are not shown in the output.
2372</p>
2373</dd>
2374</dl></div>
2375<div class="paragraph"><p>Example: The following will count changed files, while ignoring
2376directories with less than 10% of the total amount of changed files,
2377and accumulating child directory counts in the parent directories:
2378<tt>files,10,cumulative</tt>.</p></div>
2379</dd>
2380<dt class="hdlist1">
Junio C Hamano1fbbbc12007-12-18 07:01:27[diff] [blame]2381diff.external
2382</dt>
2383<dd>
2384<p>
2385 If this config variable is set, diff generation is not
2386 performed using the internal diff machinery, but using the
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2387 given command. Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
Junio C Hamano85c71572008-07-28 00:03:31[diff] [blame]2388 environment variable. The command is called with parameters
2389 as described under "git Diffs" in <a href="git.html">git(1)</a>. Note: if
2390 you want to use an external diff program only on a subset of
2391 your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27[diff] [blame]2392</p>
2393</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2394<dt class="hdlist1">
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]2395diff.ignoreSubmodules
2396</dt>
2397<dd>
2398<p>
2399 Sets the default value of --ignore-submodules. Note that this
2400 affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
2401 commands such as <em>git diff-files</em>. <em>git checkout</em> also honors
2402 this setting when reporting uncommitted changes.
2403</p>
2404</dd>
2405<dt class="hdlist1">
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]2406diff.mnemonicprefix
2407</dt>
2408<dd>
2409<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2410 If set, <em>git diff</em> uses a prefix pair that is different from the
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]2411 standard "a/" and "b/" depending on what is being compared. When
2412 this configuration is in effect, reverse diff output also swaps
2413 the order of the prefixes:
2414</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2415<div class="dlist"><dl>
2416<dt class="hdlist1">
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2417<tt>git diff</tt>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]2418</dt>
2419<dd>
2420<p>
2421 compares the (i)ndex and the (w)ork tree;
2422</p>
2423</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2424<dt class="hdlist1">
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2425<tt>git diff HEAD</tt>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]2426</dt>
2427<dd>
2428<p>
2429 compares a (c)ommit and the (w)ork tree;
2430</p>
2431</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2432<dt class="hdlist1">
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2433<tt>git diff --cached</tt>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]2434</dt>
2435<dd>
2436<p>
2437 compares a (c)ommit and the (i)ndex;
2438</p>
2439</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2440<dt class="hdlist1">
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2441<tt>git diff HEAD:file1 file2</tt>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]2442</dt>
2443<dd>
2444<p>
2445 compares an (o)bject and a (w)ork tree entity;
2446</p>
2447</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2448<dt class="hdlist1">
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2449<tt>git diff --no-index a b</tt>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]2450</dt>
2451<dd>
2452<p>
2453 compares two non-git things (1) and (2).
2454</p>
2455</dd>
2456</dl></div>
2457</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2458<dt class="hdlist1">
Junio C Hamano21c2d142010-09-10 18:09:27[diff] [blame]2459diff.noprefix
2460</dt>
2461<dd>
2462<p>
2463 If set, <em>git diff</em> does not show any source or destination prefix.
2464</p>
2465</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2466<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2467diff.renameLimit
2468</dt>
2469<dd>
2470<p>
2471 The number of files to consider when performing the copy/rename
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2472 detection; equivalent to the <em>git diff</em> option <em>-l</em>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2473</p>
2474</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2475<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2476diff.renames
2477</dt>
2478<dd>
2479<p>
2480 Tells git to detect renames. If set to any boolean value, it
2481 will enable basic rename detection. If set to "copies" or
2482 "copy", it will detect copies, as well.
2483</p>
2484</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2485<dt class="hdlist1">
Junio C Hamanobc4852e2009-01-21 10:51:14[diff] [blame]2486diff.suppressBlankEmpty
Junio C Hamanof1231492008-12-22 08:27:21[diff] [blame]2487</dt>
2488<dd>
2489<p>
2490 A boolean to inhibit the standard behavior of printing a space
2491 before each empty output line. Defaults to false.
2492</p>
2493</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2494<dt class="hdlist1">
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]2495diff.&lt;driver&gt;.command
2496</dt>
2497<dd>
2498<p>
2499 The custom diff driver command. See <a href="gitattributes.html">gitattributes(5)</a>
2500 for details.
2501</p>
2502</dd>
2503<dt class="hdlist1">
2504diff.&lt;driver&gt;.xfuncname
2505</dt>
2506<dd>
2507<p>
2508 The regular expression that the diff driver should use to
2509 recognize the hunk header. A built-in pattern may also be used.
2510 See <a href="gitattributes.html">gitattributes(5)</a> for details.
2511</p>
2512</dd>
2513<dt class="hdlist1">
2514diff.&lt;driver&gt;.binary
2515</dt>
2516<dd>
2517<p>
2518 Set this option to true to make the diff driver treat files as
2519 binary. See <a href="gitattributes.html">gitattributes(5)</a> for details.
2520</p>
2521</dd>
2522<dt class="hdlist1">
2523diff.&lt;driver&gt;.textconv
2524</dt>
2525<dd>
2526<p>
2527 The command that the diff driver should call to generate the
2528 text-converted version of a file. The result of the
2529 conversion is used to generate a human-readable diff. See
2530 <a href="gitattributes.html">gitattributes(5)</a> for details.
2531</p>
2532</dd>
2533<dt class="hdlist1">
2534diff.&lt;driver&gt;.wordregex
2535</dt>
2536<dd>
2537<p>
2538 The regular expression that the diff driver should use to
2539 split words in a line. See <a href="gitattributes.html">gitattributes(5)</a> for
2540 details.
2541</p>
2542</dd>
2543<dt class="hdlist1">
2544diff.&lt;driver&gt;.cachetextconv
2545</dt>
2546<dd>
2547<p>
2548 Set this option to true to make the diff driver cache the text
2549 conversion outputs. See <a href="gitattributes.html">gitattributes(5)</a> for details.
2550</p>
2551</dd>
2552<dt class="hdlist1">
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]2553diff.tool
2554</dt>
2555<dd>
2556<p>
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]2557 The diff tool to be used by <a href="git-difftool.html">git-difftool(1)</a>. This
2558 option overrides <tt>merge.tool</tt>, and has the same valid built-in
2559 values as <tt>merge.tool</tt> minus "tortoisemerge" and plus
2560 "kompare". Any other value is treated as a custom diff tool,
2561 and there must be a corresponding <tt>difftool.&lt;tool&gt;.cmd</tt>
2562 option.
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]2563</p>
2564</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2565<dt class="hdlist1">
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]2566difftool.&lt;tool&gt;.path
2567</dt>
2568<dd>
2569<p>
2570 Override the path for the given tool. This is useful in case
2571 your tool is not in the PATH.
2572</p>
2573</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2574<dt class="hdlist1">
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]2575difftool.&lt;tool&gt;.cmd
2576</dt>
2577<dd>
2578<p>
2579 Specify the command to invoke the specified diff tool.
2580 The specified command is evaluated in shell with the following
2581 variables available: <em>LOCAL</em> is set to the name of the temporary
2582 file containing the contents of the diff pre-image and <em>REMOTE</em>
2583 is set to the name of the temporary file containing the contents
2584 of the diff post-image.
2585</p>
2586</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2587<dt class="hdlist1">
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]2588difftool.prompt
2589</dt>
2590<dd>
2591<p>
2592 Prompt before each invocation of the diff tool.
2593</p>
2594</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2595<dt class="hdlist1">
Junio C Hamano20d47e32009-01-26 06:36:02[diff] [blame]2596diff.wordRegex
2597</dt>
2598<dd>
2599<p>
2600 A POSIX Extended Regular Expression used to determine what is a "word"
2601 when performing word-by-word difference calculations. Character
2602 sequences that match the regular expression are "words", all other
2603 characters are <strong>ignorable</strong> whitespace.
2604</p>
2605</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2606<dt class="hdlist1">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]2607fetch.recurseSubmodules
2608</dt>
2609<dd>
2610<p>
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]2611 This option can be either set to a boolean value or to <em>on-demand</em>.
2612 Setting it to a boolean changes the behavior of fetch and pull to
2613 unconditionally recurse into submodules when set to true or to not
2614 recurse at all when set to false. When set to <em>on-demand</em> (the default
2615 value), fetch and pull will only recurse into a populated submodule
2616 when its superproject retrieves a commit that updates the submodule&#8217;s
2617 reference.
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]2618</p>
2619</dd>
2620<dt class="hdlist1">
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame^]2621fetch.fsckObjects
2622</dt>
2623<dd>
2624<p>
2625 If it is set to true, git-fetch-pack will check all fetched
2626 objects. It will abort in the case of a malformed object or a
2627 broken link. The result of an abort are only dangling objects.
2628 Defaults to false. If not set, the value of <tt>transfer.fsckObjects</tt>
2629 is used instead.
2630</p>
2631</dd>
2632<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2633fetch.unpackLimit
2634</dt>
2635<dd>
2636<p>
2637 If the number of objects fetched over the git native
2638 transfer is below this
2639 limit, then the objects will be unpacked into loose object
2640 files. However if the number of received objects equals or
2641 exceeds this limit then the received pack will be stored as
2642 a pack, after adding any missing delta bases. Storing the
2643 pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]2644 especially on slow filesystems. If not set, the value of
2645 <tt>transfer.unpackLimit</tt> is used instead.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2646</p>
2647</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2648<dt class="hdlist1">
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]2649format.attach
2650</dt>
2651<dd>
2652<p>
2653 Enable multipart/mixed attachments as the default for
2654 <em>format-patch</em>. The value can also be a double quoted string
2655 which will enable attachments as the default and set the
2656 value as the boundary. See the --attach option in
2657 <a href="git-format-patch.html">git-format-patch(1)</a>.
2658</p>
2659</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2660<dt class="hdlist1">
Junio C Hamano8c5802d2007-11-15 00:13:36[diff] [blame]2661format.numbered
2662</dt>
2663<dd>
2664<p>
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]2665 A boolean which can enable or disable sequence numbers in patch
2666 subjects. It defaults to "auto" which enables it only if there
2667 is more than one patch. It can be enabled or disabled for all
2668 messages by setting it to "true" or "false". See --numbered
2669 option in <a href="git-format-patch.html">git-format-patch(1)</a>.
Junio C Hamano8c5802d2007-11-15 00:13:36[diff] [blame]2670</p>
2671</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2672<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2673format.headers
2674</dt>
2675<dd>
2676<p>
2677 Additional email headers to include in a patch to be submitted
2678 by mail. See <a href="git-format-patch.html">git-format-patch(1)</a>.
2679</p>
2680</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2681<dt class="hdlist1">
Junio C Hamano70664a02010-07-13 22:48:05[diff] [blame]2682format.to
2683</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2684<dt class="hdlist1">
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]2685format.cc
2686</dt>
2687<dd>
2688<p>
Junio C Hamano70664a02010-07-13 22:48:05[diff] [blame]2689 Additional recipients to include in a patch to be submitted
2690 by mail. See the --to and --cc options in
2691 <a href="git-format-patch.html">git-format-patch(1)</a>.
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]2692</p>
2693</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2694<dt class="hdlist1">
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]2695format.subjectprefix
2696</dt>
2697<dd>
2698<p>
2699 The default for format-patch is to output files with the <em>[PATCH]</em>
2700 subject prefix. Use this variable to change that prefix.
2701</p>
2702</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2703<dt class="hdlist1">
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]2704format.signature
2705</dt>
2706<dd>
2707<p>
2708 The default for format-patch is to output a signature containing
2709 the git version number. Use this variable to change that default.
2710 Set this variable to the empty string ("") to suppress
2711 signature generation.
2712</p>
2713</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2714<dt class="hdlist1">
Junio C Hamanod4c8e112007-03-04 10:32:38[diff] [blame]2715format.suffix
2716</dt>
2717<dd>
2718<p>
2719 The default for format-patch is to output files with the suffix
2720 <tt>.patch</tt>. Use this variable to change that suffix (make sure to
2721 include the dot if you want it).
2722</p>
2723</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2724<dt class="hdlist1">
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]2725format.pretty
2726</dt>
2727<dd>
2728<p>
2729 The default pretty format for log/show/whatchanged command,
2730 See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
2731 <a href="git-whatchanged.html">git-whatchanged(1)</a>.
2732</p>
2733</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2734<dt class="hdlist1">
Junio C Hamanoea6a7642009-03-11 23:56:19[diff] [blame]2735format.thread
2736</dt>
2737<dd>
2738<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2739 The default threading style for <em>git format-patch</em>. Can be
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]2740 a boolean value, or <tt>shallow</tt> or <tt>deep</tt>. <tt>shallow</tt> threading
2741 makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:19[diff] [blame]2742 where the head is chosen from the cover letter, the
2743 <tt>--in-reply-to</tt>, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]2744 <tt>deep</tt> threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:19[diff] [blame]2745 A true boolean value is the same as <tt>shallow</tt>, and a false
2746 value disables threading.
2747</p>
2748</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2749<dt class="hdlist1">
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]2750format.signoff
2751</dt>
2752<dd>
2753<p>
2754 A boolean value which lets you enable the <tt>-s/--signoff</tt> option of
2755 format-patch by default. <strong>Note:</strong> Adding the Signed-off-by: line to a
2756 patch should be a conscious act and means that you certify you have
2757 the rights to submit this work under the same open source license.
2758 Please see the <em>SubmittingPatches</em> document for further discussion.
2759</p>
2760</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2761<dt class="hdlist1">
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]2762filter.&lt;driver&gt;.clean
2763</dt>
2764<dd>
2765<p>
2766 The command which is used to convert the content of a worktree
2767 file to a blob upon checkin. See <a href="gitattributes.html">gitattributes(5)</a> for
2768 details.
2769</p>
2770</dd>
2771<dt class="hdlist1">
2772filter.&lt;driver&gt;.smudge
2773</dt>
2774<dd>
2775<p>
2776 The command which is used to convert the content of a blob
2777 object to a worktree file upon checkout. See
2778 <a href="gitattributes.html">gitattributes(5)</a> for details.
2779</p>
2780</dd>
2781<dt class="hdlist1">
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]2782gc.aggressiveWindow
2783</dt>
2784<dd>
2785<p>
2786 The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2787 algorithm used by <em>git gc --aggressive</em>. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:36[diff] [blame]2788 to 250.
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]2789</p>
2790</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2791<dt class="hdlist1">
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]2792gc.auto
2793</dt>
2794<dd>
2795<p>
2796 When there are approximately more than this many loose
2797 objects in the repository, <tt>git gc --auto</tt> will pack them.
2798 Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]2799 light-weight garbage collection from time to time. The
2800 default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]2801</p>
2802</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2803<dt class="hdlist1">
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]2804gc.autopacklimit
2805</dt>
2806<dd>
2807<p>
2808 When there are more than this many packs that are not
2809 marked with <tt>*.keep</tt> file in the repository, <tt>git gc
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]2810 --auto</tt> consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37[diff] [blame]2811 default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]2812</p>
2813</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2814<dt class="hdlist1">
Junio C Hamano9d52e572007-02-13 23:48:20[diff] [blame]2815gc.packrefs
2816</dt>
2817<dd>
2818<p>
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]2819 Running <tt>git pack-refs</tt> in a repository renders it
2820 unclonable by Git versions prior to 1.5.1.2 over dumb
2821 transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:00[diff] [blame]2822 <em>git gc</em> runs <tt>git pack-refs</tt>. This can be set to <tt>notbare</tt>
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]2823 to enable it within all non-bare repos or it can be set to a
2824 boolean value. The default is <tt>true</tt>.
Junio C Hamano9d52e572007-02-13 23:48:20[diff] [blame]2825</p>
2826</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2827<dt class="hdlist1">
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]2828gc.pruneexpire
2829</dt>
2830<dd>
2831<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2832 When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>.
Junio C Hamanoa3148f52009-01-14 08:49:57[diff] [blame]2833 Override the grace period with this config variable. The value
2834 "now" may be used to disable this grace period and always prune
2835 unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]2836</p>
2837</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2838<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2839gc.reflogexpire
2840</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2841<dt class="hdlist1">
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]2842gc.&lt;pattern&gt;.reflogexpire
2843</dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2844<dd>
2845<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2846 <em>git reflog expire</em> removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]2847 this time; defaults to 90 days. With "&lt;pattern&gt;" (e.g.
2848 "refs/stash") in the middle the setting applies only to
2849 the refs that match the &lt;pattern&gt;.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2850</p>
2851</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2852<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2853gc.reflogexpireunreachable
2854</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2855<dt class="hdlist1">
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]2856gc.&lt;ref&gt;.reflogexpireunreachable
2857</dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2858<dd>
2859<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2860 <em>git reflog expire</em> removes reflog entries older than
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2861 this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]2862 defaults to 30 days. With "&lt;pattern&gt;" (e.g. "refs/stash")
2863 in the middle, the setting applies only to the refs that
2864 match the &lt;pattern&gt;.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2865</p>
2866</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2867<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2868gc.rerereresolved
2869</dt>
2870<dd>
2871<p>
2872 Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2873 kept for this many days when <em>git rerere gc</em> is run.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2874 The default is 60 days. See <a href="git-rerere.html">git-rerere(1)</a>.
2875</p>
2876</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2877<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2878gc.rerereunresolved
2879</dt>
2880<dd>
2881<p>
2882 Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2883 kept for this many days when <em>git rerere gc</em> is run.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2884 The default is 15 days. See <a href="git-rerere.html">git-rerere(1)</a>.
2885</p>
2886</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2887<dt class="hdlist1">
Junio C Hamanoa3148f52009-01-14 08:49:57[diff] [blame]2888gitcvs.commitmsgannotation
2889</dt>
2890<dd>
2891<p>
2892 Append this string to each commit message. Set to empty string
2893 to disable this feature. Defaults to "via git-CVS emulator".
2894</p>
2895</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2896<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2897gitcvs.enabled
2898</dt>
2899<dd>
2900<p>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]2901 Whether the CVS server interface is enabled for this repository.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2902 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
2903</p>
2904</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2905<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2906gitcvs.logfile
2907</dt>
2908<dd>
2909<p>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]2910 Path to a log file where the CVS server interface well&#8230; logs
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2911 various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
2912</p>
2913</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2914<dt class="hdlist1">
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]2915gitcvs.usecrlfattr
2916</dt>
2917<dd>
2918<p>
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]2919 If true, the server will look up the end-of-line conversion
2920 attributes for files to determine the <em>-k</em> modes to use. If
2921 the attributes force git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]2922 the <em>-k</em> mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]2923 treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]2924 will be set with <em>-kb</em> mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]2925 the client might otherwise do. If the attributes do not allow
2926 the file type to be determined, then <em>gitcvs.allbinary</em> is
2927 used. See <a href="gitattributes.html">gitattributes(5)</a>.
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]2928</p>
2929</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2930<dt class="hdlist1">
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]2931gitcvs.allbinary
2932</dt>
2933<dd>
2934<p>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]2935 This is used if <em>gitcvs.usecrlfattr</em> does not resolve
2936 the correct <em>-kb</em> mode to use. If true, all
2937 unresolved files are sent to the client in
2938 mode <em>-kb</em>. This causes the client to treat them
2939 as binary files, which suppresses any newline munging it
2940 otherwise might do. Alternatively, if it is set to "guess",
2941 then the contents of the file are examined to decide if
2942 it is binary, similar to <em>core.autocrlf</em>.
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]2943</p>
2944</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2945<dt class="hdlist1">
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]2946gitcvs.dbname
2947</dt>
2948<dd>
2949<p>
2950 Database used by git-cvsserver to cache revision information
2951 derived from the git repository. The exact meaning depends on the
2952 used database driver, for SQLite (which is the default driver) this
2953 is a filename. Supports variable substitution (see
2954 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<tt>;</tt>).
2955 Default: <em>%Ggitcvs.%m.sqlite</em>
2956</p>
2957</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2958<dt class="hdlist1">
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]2959gitcvs.dbdriver
2960</dt>
2961<dd>
2962<p>
2963 Used Perl DBI driver. You can specify any available driver
2964 for this here, but it might not work. git-cvsserver is tested
2965 with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
2966 reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
2967 May not contain double colons (<tt>:</tt>). Default: <em>SQLite</em>.
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]2968 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
2969</p>
2970</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2971<dt class="hdlist1">
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]2972gitcvs.dbuser, gitcvs.dbpass
2973</dt>
2974<dd>
2975<p>
2976 Database user and password. Only useful if setting <em>gitcvs.dbdriver</em>,
2977 since SQLite has no concept of database users and/or passwords.
2978 <em>gitcvs.dbuser</em> supports variable substitution (see
2979 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
2980</p>
2981</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2982<dt class="hdlist1">
Junio C Hamanoa74efce2008-04-02 08:39:08[diff] [blame]2983gitcvs.dbTableNamePrefix
2984</dt>
2985<dd>
2986<p>
2987 Database table name prefix. Prepended to the names of any
2988 database tables used, allowing a single database to be used
2989 for several repositories. Supports variable substitution (see
2990 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). Any non-alphabetic
2991 characters will be replaced with underscores.
2992</p>
2993</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2994</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2995<div class="paragraph"><p>All gitcvs variables except for <em>gitcvs.usecrlfattr</em> and
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]2996<em>gitcvs.allbinary</em> can also be specified as
2997<em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]2998is one of "ext" and "pserver") to make them apply only for the given
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2999access method.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3000<div class="dlist"><dl>
3001<dt class="hdlist1">
Junio C Hamanoa03ac862011-04-02 04:32:29[diff] [blame]3002grep.lineNumber
3003</dt>
3004<dd>
3005<p>
3006 If set to true, enable <em>-n</em> option by default.
3007</p>
3008</dd>
3009<dt class="hdlist1">
3010grep.extendedRegexp
3011</dt>
3012<dd>
3013<p>
3014 If set to true, enable <em>--extended-regexp</em> option by default.
3015</p>
3016</dd>
3017<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3018gui.commitmsgwidth
3019</dt>
3020<dd>
3021<p>
3022 Defines how wide the commit message window is in the
3023 <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
3024</p>
3025</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3026<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3027gui.diffcontext
3028</dt>
3029<dd>
3030<p>
3031 Specifies how many context lines should be used in calls to diff
3032 made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
3033</p>
3034</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3035<dt class="hdlist1">
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]3036gui.encoding
3037</dt>
3038<dd>
3039<p>
3040 Specifies the default encoding to use for displaying of
3041 file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
3042 It can be overridden by setting the <em>encoding</em> attribute
3043 for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
3044 If this option is not set, the tools default to the
3045 locale encoding.
3046</p>
3047</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3048<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3049gui.matchtrackingbranch
3050</dt>
3051<dd>
3052<p>
3053 Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
3054 default to tracking remote branches with matching names or
3055 not. Default: "false".
3056</p>
3057</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3058<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3059gui.newbranchtemplate
3060</dt>
3061<dd>
3062<p>
3063 Is used as suggested name when creating new branches using the
3064 <a href="git-gui.html">git-gui(1)</a>.
3065</p>
3066</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3067<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3068gui.pruneduringfetch
3069</dt>
3070<dd>
3071<p>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]3072 "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3073 performing a fetch. The default value is "false".
3074</p>
3075</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3076<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3077gui.trustmtime
3078</dt>
3079<dd>
3080<p>
3081 Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
3082 timestamp or not. By default the timestamps are not trusted.
3083</p>
3084</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3085<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3086gui.spellingdictionary
3087</dt>
3088<dd>
3089<p>
3090 Specifies the dictionary used for spell checking commit messages in
3091 the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
3092 off.
3093</p>
3094</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3095<dt class="hdlist1">
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]3096gui.fastcopyblame
3097</dt>
3098<dd>
3099<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]3100 If true, <em>git gui blame</em> uses <tt>-C</tt> instead of <tt>-C -C</tt> for original
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]3101 location detection. It makes blame significantly faster on huge
3102 repositories at the expense of less thorough copy detection.
3103</p>
3104</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3105<dt class="hdlist1">
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]3106gui.copyblamethreshold
3107</dt>
3108<dd>
3109<p>
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]3110 Specifies the threshold to use in <em>git gui blame</em> original location
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]3111 detection, measured in alphanumeric characters. See the
3112 <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
3113</p>
3114</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3115<dt class="hdlist1">
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]3116gui.blamehistoryctx
3117</dt>
3118<dd>
3119<p>
3120 Specifies the radius of history context in days to show in
3121 <a href="gitk.html">gitk(1)</a> for the selected commit, when the <tt>Show History
3122 Context</tt> menu item is invoked from <em>git gui blame</em>. If this
3123 variable is set to zero, the whole history is shown.
3124</p>
3125</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3126<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3127guitool.&lt;name&gt;.cmd
3128</dt>
3129<dd>
3130<p>
3131 Specifies the shell command line to execute when the corresponding item
3132 of the <a href="git-gui.html">git-gui(1)</a> <tt>Tools</tt> menu is invoked. This option is
3133 mandatory for every tool. The command is executed from the root of
3134 the working directory, and in the environment it receives the name of
3135 the tool as <em>GIT_GUITOOL</em>, the name of the currently selected file as
3136 <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
3137 the head is detached, <em>CUR_BRANCH</em> is empty).
3138</p>
3139</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3140<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3141guitool.&lt;name&gt;.needsfile
3142</dt>
3143<dd>
3144<p>
3145 Run the tool only if a diff is selected in the GUI. It guarantees
3146 that <em>FILENAME</em> is not empty.
3147</p>
3148</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3149<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3150guitool.&lt;name&gt;.noconsole
3151</dt>
3152<dd>
3153<p>
3154 Run the command silently, without creating a window to display its
3155 output.
3156</p>
3157</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3158<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3159guitool.&lt;name&gt;.norescan
3160</dt>
3161<dd>
3162<p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3163 Don&#8217;t rescan the working directory for changes after the tool
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3164 finishes execution.
3165</p>
3166</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3167<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3168guitool.&lt;name&gt;.confirm
3169</dt>
3170<dd>
3171<p>
3172 Show a confirmation dialog before actually running the tool.
3173</p>
3174</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3175<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3176guitool.&lt;name&gt;.argprompt
3177</dt>
3178<dd>
3179<p>
3180 Request a string argument from the user, and pass it to the tool
3181 through the <em>ARGS</em> environment variable. Since requesting an
3182 argument implies confirmation, the <em>confirm</em> option has no effect
3183 if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
3184 the dialog uses a built-in generic prompt; otherwise the exact
3185 value of the variable is used.
3186</p>
3187</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3188<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3189guitool.&lt;name&gt;.revprompt
3190</dt>
3191<dd>
3192<p>
3193 Request a single valid revision from the user, and set the
3194 <em>REVISION</em> environment variable. In other aspects this option
3195 is similar to <em>argprompt</em>, and can be used together with it.
3196</p>
3197</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3198<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3199guitool.&lt;name&gt;.revunmerged
3200</dt>
3201<dd>
3202<p>
3203 Show only unmerged branches in the <em>revprompt</em> subdialog.
3204 This is useful for tools similar to merge or rebase, but not
3205 for things like checkout or reset.
3206</p>
3207</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3208<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3209guitool.&lt;name&gt;.title
3210</dt>
3211<dd>
3212<p>
3213 Specifies the title to use for the prompt dialog. The default
3214 is the tool name.
3215</p>
3216</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3217<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]3218guitool.&lt;name&gt;.prompt
3219</dt>
3220<dd>
3221<p>
3222 Specifies the general prompt string to display at the top of
3223 the dialog, before subsections for <em>argprompt</em> and <em>revprompt</em>.
3224 The default value includes the actual command.
3225</p>
3226</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3227<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]3228help.browser
3229</dt>
3230<dd>
3231<p>
3232 Specify the browser that will be used to display help in the
3233 <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
3234</p>
3235</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3236<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]3237help.format
3238</dt>
3239<dd>
3240<p>
3241 Override the default help format used by <a href="git-help.html">git-help(1)</a>.
3242 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
3243 the default. <em>web</em> and <em>html</em> are the same.
3244</p>
3245</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3246<dt class="hdlist1">
Junio C Hamanof24b8062008-09-09 01:34:39[diff] [blame]3247help.autocorrect
3248</dt>
3249<dd>
3250<p>
3251 Automatically correct and execute mistyped commands after
3252 waiting for the given number of deciseconds (0.1 sec). If more
3253 than one command can be deduced from the entered text, nothing
3254 will be executed. If the value of this option is negative,
3255 the corrected command will be executed immediately. If the
3256 value is 0 - the command will be just shown but not executed.
3257 This is the default.
3258</p>
3259</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3260<dt class="hdlist1">
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]3261http.proxy
3262</dt>
3263<dd>
3264<p>
3265 Override the HTTP proxy, normally configured using the <em>http_proxy</em>
3266 environment variable (see <a href="curl.html">curl(1)</a>). This can be overridden
3267 on a per-remote basis; see remote.&lt;name&gt;.proxy
3268</p>
3269</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3270<dt class="hdlist1">
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]3271http.cookiefile
3272</dt>
3273<dd>
3274<p>
3275 File containing previously stored cookie lines which should be used
3276 in the git http session, if they match the server. The file format
3277 of the file to read cookies from should be plain HTTP headers or
3278 the Netscape/Mozilla cookie file format (see <a href="curl.html">curl(1)</a>).
3279 NOTE that the file specified with http.cookiefile is only used as
3280 input. No cookies will be stored in the file.
3281</p>
3282</dd>
3283<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3284http.sslVerify
3285</dt>
3286<dd>
3287<p>
3288 Whether to verify the SSL certificate when fetching or pushing
3289 over HTTPS. Can be overridden by the <em>GIT_SSL_NO_VERIFY</em> environment
3290 variable.
3291</p>
3292</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3293<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3294http.sslCert
3295</dt>
3296<dd>
3297<p>
3298 File containing the SSL certificate when fetching or pushing
3299 over HTTPS. Can be overridden by the <em>GIT_SSL_CERT</em> environment
3300 variable.
3301</p>
3302</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3303<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3304http.sslKey
3305</dt>
3306<dd>
3307<p>
3308 File containing the SSL private key when fetching or pushing
3309 over HTTPS. Can be overridden by the <em>GIT_SSL_KEY</em> environment
3310 variable.
3311</p>
3312</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3313<dt class="hdlist1">
Junio C Hamano48bc1ce2009-07-09 16:49:19[diff] [blame]3314http.sslCertPasswordProtected
3315</dt>
3316<dd>
3317<p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3318 Enable git&#8217;s password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:19[diff] [blame]3319 OpenSSL will prompt the user, possibly many times, if the
3320 certificate or private key is encrypted. Can be overridden by the
3321 <em>GIT_SSL_CERT_PASSWORD_PROTECTED</em> environment variable.
3322</p>
3323</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3324<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3325http.sslCAInfo
3326</dt>
3327<dd>
3328<p>
3329 File containing the certificates to verify the peer with when
3330 fetching or pushing over HTTPS. Can be overridden by the
3331 <em>GIT_SSL_CAINFO</em> environment variable.
3332</p>
3333</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3334<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3335http.sslCAPath
3336</dt>
3337<dd>
3338<p>
3339 Path containing files with the CA certificates to verify the peer
3340 with when fetching or pushing over HTTPS. Can be overridden
3341 by the <em>GIT_SSL_CAPATH</em> environment variable.
3342</p>
3343</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3344<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3345http.maxRequests
3346</dt>
3347<dd>
3348<p>
3349 How many HTTP requests to launch in parallel. Can be overridden
3350 by the <em>GIT_HTTP_MAX_REQUESTS</em> environment variable. Default is 5.
3351</p>
3352</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3353<dt class="hdlist1">
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]3354http.minSessions
3355</dt>
3356<dd>
3357<p>
3358 The number of curl sessions (counted across slots) to be kept across
3359 requests. They will not be ended with curl_easy_cleanup() until
3360 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
3361 value will be capped at 1. Defaults to 1.
3362</p>
3363</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3364<dt class="hdlist1">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]3365http.postBuffer
3366</dt>
3367<dd>
3368<p>
3369 Maximum size in bytes of the buffer used by smart HTTP
3370 transports when POSTing data to the remote system.
3371 For requests larger than this buffer size, HTTP/1.1 and
3372 Transfer-Encoding: chunked is used to avoid creating a
3373 massive pack file locally. Default is 1 MiB, which is
3374 sufficient for most requests.
3375</p>
3376</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3377<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3378http.lowSpeedLimit, http.lowSpeedTime
3379</dt>
3380<dd>
3381<p>
3382 If the HTTP transfer speed is less than <em>http.lowSpeedLimit</em>
3383 for longer than <em>http.lowSpeedTime</em> seconds, the transfer is aborted.
3384 Can be overridden by the <em>GIT_HTTP_LOW_SPEED_LIMIT</em> and
3385 <em>GIT_HTTP_LOW_SPEED_TIME</em> environment variables.
3386</p>
3387</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3388<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3389http.noEPSV
3390</dt>
3391<dd>
3392<p>
3393 A boolean which disables using of EPSV ftp command by curl.
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3394 This can helpful with some "poor" ftp servers which don&#8217;t
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3395 support EPSV mode. Can be overridden by the <em>GIT_CURL_FTP_NO_EPSV</em>
3396 environment variable. Default is false (curl will use EPSV).
3397</p>
3398</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3399<dt class="hdlist1">
Junio C Hamano53ba6d02010-08-22 07:25:12[diff] [blame]3400http.useragent
3401</dt>
3402<dd>
3403<p>
3404 The HTTP USER_AGENT string presented to an HTTP server. The default
3405 value represents the version of the client git such as git/1.7.1.
3406 This option allows you to override this value to a more common value
3407 such as Mozilla/4.0. This may be necessary, for instance, if
3408 connecting through a firewall that restricts HTTP connections to a set
3409 of common USER_AGENT strings (but not including those like git/1.7.1).
3410 Can be overridden by the <em>GIT_HTTP_USER_AGENT</em> environment variable.
3411</p>
3412</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3413<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3414i18n.commitEncoding
3415</dt>
3416<dd>
3417<p>
3418 Character encoding the commit messages are stored in; git itself
3419 does not care per se, but this information is necessary e.g. when
3420 importing commits from emails or in the gitk graphical history
3421 browser (and possibly at other places in the future or in other
3422 porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
3423</p>
3424</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3425<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3426i18n.logOutputEncoding
3427</dt>
3428<dd>
3429<p>
3430 Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]3431 running <em>git log</em> and friends.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3432</p>
3433</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3434<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]3435imap
3436</dt>
3437<dd>
3438<p>
3439 The configuration variables in the <em>imap</em> section are described
3440 in <a href="git-imap-send.html">git-imap-send(1)</a>.
3441</p>
3442</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3443<dt class="hdlist1">
Junio C Hamanocaa712a2010-03-11 01:17:35[diff] [blame]3444init.templatedir
3445</dt>
3446<dd>
3447<p>
3448 Specify the directory from which templates will be copied.
3449 (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)
3450</p>
3451</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3452<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]3453instaweb.browser
3454</dt>
3455<dd>
3456<p>
3457 Specify the program that will be used to browse your working
3458 repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
3459</p>
3460</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3461<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]3462instaweb.httpd
3463</dt>
3464<dd>
3465<p>
3466 The HTTP daemon command-line to start gitweb on your working
3467 repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
3468</p>
3469</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3470<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]3471instaweb.local
3472</dt>
3473<dd>
3474<p>
3475 If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
3476 be bound to the local IP (127.0.0.1).
3477</p>
3478</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3479<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]3480instaweb.modulepath
3481</dt>
3482<dd>
3483<p>
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]3484 The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
3485 instead of /usr/lib/apache2/modules. Only used if httpd
3486 is Apache.
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]3487</p>
3488</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3489<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]3490instaweb.port
3491</dt>
3492<dd>
3493<p>
3494 The port number to bind the gitweb httpd to. See
3495 <a href="git-instaweb.html">git-instaweb(1)</a>.
3496</p>
3497</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3498<dt class="hdlist1">
Junio C Hamanoe5bf6c12009-02-07 21:43:10[diff] [blame]3499interactive.singlekey
3500</dt>
3501<dd>
3502<p>
Junio C Hamano27a128b2009-08-13 01:23:00[diff] [blame]3503 In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:10[diff] [blame]3504 input with a single key (i.e., without hitting enter).
Junio C Hamano9eb58352011-05-11 20:09:24[diff] [blame]3505 Currently this is used by the <tt>--patch</tt> mode of
Junio C Hamano3d050d62011-05-17 06:43:34[diff] [blame]3506 <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
3507 <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>. Note that this
3508 setting is silently ignored if portable keystroke input
3509 is not available.
Junio C Hamanoe5bf6c12009-02-07 21:43:10[diff] [blame]3510</p>
3511</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3512<dt class="hdlist1">
Junio C Hamanof93530e2011-05-25 23:59:59[diff] [blame]3513log.abbrevCommit
3514</dt>
3515<dd>
3516<p>
3517 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
3518 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <tt>--abbrev-commit</tt>. You may
3519 override this option with <tt>--no-abbrev-commit</tt>.
3520</p>
3521</dd>
3522<dt class="hdlist1">
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]3523log.date
3524</dt>
3525<dd>
3526<p>
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]3527 Set the default date-time mode for the <em>log</em> command.
3528 Setting a value for log.date is similar to using <em>git log</em>'s
3529 <tt>--date</tt> option. Possible values are <tt>relative</tt>, <tt>local</tt>,
3530 <tt>default</tt>, <tt>iso</tt>, <tt>rfc</tt>, and <tt>short</tt>; see <a href="git-log.html">git-log(1)</a>
3531 for details.
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]3532</p>
3533</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3534<dt class="hdlist1">
Junio C Hamanocb39aea2010-05-09 07:24:48[diff] [blame]3535log.decorate
3536</dt>
3537<dd>
3538<p>
3539 Print out the ref names of any commits that are shown by the log
3540 command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
3541 <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
3542 specified, the full ref name (including prefix) will be printed.
3543 This is the same as the log commands <em>--decorate</em> option.
3544</p>
3545</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3546<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3547log.showroot
3548</dt>
3549<dd>
3550<p>
3551 If true, the initial commit will be shown as a big creation event.
3552 This is equivalent to a diff against an empty tree.
3553 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
3554 normally hide the root commit will now show it. True by default.
3555</p>
3556</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3557<dt class="hdlist1">
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]3558mailmap.file
3559</dt>
3560<dd>
3561<p>
3562 The location of an augmenting mailmap file. The default
3563 mailmap, located in the root of the repository, is loaded
3564 first, then the mailmap file pointed to by this variable.
3565 The location of the mailmap file may be in a repository
3566 subdirectory, or somewhere outside of the repository itself.
3567 See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
3568</p>
3569</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3570<dt class="hdlist1">
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]3571man.viewer
3572</dt>
3573<dd>
3574<p>
3575 Specify the programs that may be used to display help in the
3576 <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
3577</p>
3578</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3579<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]3580man.&lt;tool&gt;.cmd
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3581</dt>
3582<dd>
3583<p>
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]3584 Specify the command to invoke the specified man viewer. The
3585 specified command is evaluated in shell with the man page
3586 passed as argument. (See <a href="git-help.html">git-help(1)</a>.)
3587</p>
3588</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3589<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]3590man.&lt;tool&gt;.path
3591</dt>
3592<dd>
3593<p>
3594 Override the path for the given tool that may be used to
3595 display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
3596</p>
3597</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3598<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]3599merge.conflictstyle
3600</dt>
3601<dd>
3602<p>
3603 Specify the style in which conflicted hunks are written out to
3604 working tree files upon merge. The default is "merge", which
Junio C Hamanoec87f522008-12-10 08:35:25[diff] [blame]3605 shows a <tt>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</tt> conflict marker, changes made by one side,
3606 a <tt>=======</tt> marker, changes made by the other side, and then
3607 a <tt>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</tt> marker. An alternate style, "diff3", adds a <tt>|||||||</tt>
3608 marker and the original text before the <tt>=======</tt> marker.
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3609</p>
3610</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3611<dt class="hdlist1">
Junio C Hamanoa03ac862011-04-02 04:32:29[diff] [blame]3612merge.defaultToUpstream
3613</dt>
3614<dd>
3615<p>
3616 If merge is called without any commit argument, merge the upstream
3617 branches configured for the current branch by using their last
3618 observed values stored in their remote tracking branches.
3619 The values of the <tt>branch.&lt;current branch&gt;.merge</tt> that name the
3620 branches at the remote named by <tt>branch.&lt;current branch&gt;.remote</tt>
3621 are consulted, and then they are mapped via <tt>remote.&lt;remote&gt;.fetch</tt>
3622 to their corresponding remote tracking branches, and the tips of
3623 these tracking branches are merged.
3624</p>
3625</dd>
3626<dt class="hdlist1">
Junio C Hamano3d050d62011-05-17 06:43:34[diff] [blame]3627merge.ff
3628</dt>
3629<dd>
3630<p>
3631 By default, git does not create an extra merge commit when merging
3632 a commit that is a descendant of the current commit. Instead, the
3633 tip of the current branch is fast-forwarded. When set to <tt>false</tt>,
3634 this variable tells git to create an extra merge commit in such
3635 a case (equivalent to giving the <tt>--no-ff</tt> option from the command
3636 line). When set to <tt>only</tt>, only such fast-forward merges are
3637 allowed (equivalent to giving the <tt>--ff-only</tt> option from the
3638 command line).
3639</p>
3640</dd>
3641<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]3642merge.log
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3643</dt>
3644<dd>
3645<p>
Junio C Hamano3b4609d2010-09-30 00:04:34[diff] [blame]3646 In addition to branch names, populate the log message with at
3647 most the specified number of one-line descriptions from the
3648 actual commits that are being merged. Defaults to false, and
Junio C Hamano7165bf72011-01-04 22:06:18[diff] [blame]3649 true is a synonym for 20.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3650</p>
3651</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3652<dt class="hdlist1">
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]3653merge.renameLimit
3654</dt>
3655<dd>
3656<p>
3657 The number of files to consider when performing rename detection
3658 during a merge; if not specified, defaults to the value of
3659 diff.renameLimit.
3660</p>
3661</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3662<dt class="hdlist1">
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]3663merge.renormalize
3664</dt>
3665<dd>
3666<p>
3667 Tell git that canonical representation of files in the
3668 repository has changed over time (e.g. earlier commits record
3669 text files with CRLF line endings, but recent ones use LF line
3670 endings). In such a repository, git can convert the data
3671 recorded in commits to a canonical form before performing a
3672 merge to reduce unnecessary conflicts. For more information,
3673 see section "Merging branches with differing checkin/checkout
3674 attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
3675</p>
3676</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3677<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]3678merge.stat
3679</dt>
3680<dd>
3681<p>
3682 Whether to print the diffstat between ORIG_HEAD and the merge result
3683 at the end of the merge. True by default.
3684</p>
3685</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3686<dt class="hdlist1">
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]3687merge.tool
3688</dt>
3689<dd>
3690<p>
3691 Controls which merge resolution program is used by
Junio C Hamanod2c978f2011-03-20 19:42:22[diff] [blame]3692 <a href="git-mergetool.html">git-mergetool(1)</a>. Valid built-in values are: "araxis",
3693 "bc3", "diffuse", "ecmerge", "emerge", "gvimdiff", "kdiff3", "meld",
3694 "opendiff", "p4merge", "tkdiff", "tortoisemerge", "vimdiff"
3695 and "xxdiff". Any other value is treated is custom merge tool
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]3696 and there must be a corresponding mergetool.&lt;tool&gt;.cmd option.
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]3697</p>
3698</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3699<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3700merge.verbosity
3701</dt>
3702<dd>
3703<p>
3704 Controls the amount of output shown by the recursive merge
3705 strategy. Level 0 outputs nothing except a final error
3706 message if conflicts were detected. Level 1 outputs only
3707 conflicts, 2 outputs conflicts and file changes. Level 5 and
3708 above outputs debugging information. The default is level 2.
Junio C Hamanoec87f522008-12-10 08:35:25[diff] [blame]3709 Can be overridden by the <em>GIT_MERGE_VERBOSITY</em> environment variable.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3710</p>
3711</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3712<dt class="hdlist1">
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]3713merge.&lt;driver&gt;.name
3714</dt>
3715<dd>
3716<p>
Junio C Hamanoec87f522008-12-10 08:35:25[diff] [blame]3717 Defines a human-readable name for a custom low-level
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]3718 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
3719</p>
3720</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3721<dt class="hdlist1">
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]3722merge.&lt;driver&gt;.driver
3723</dt>
3724<dd>
3725<p>
3726 Defines the command that implements a custom low-level
3727 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
3728</p>
3729</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3730<dt class="hdlist1">
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]3731merge.&lt;driver&gt;.recursive
3732</dt>
3733<dd>
3734<p>
3735 Names a low-level merge driver to be used when
3736 performing an internal merge between common ancestors.
3737 See <a href="gitattributes.html">gitattributes(5)</a> for details.
3738</p>
3739</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3740<dt class="hdlist1">
Junio C Hamano1fbbbc12007-12-18 07:01:27[diff] [blame]3741mergetool.&lt;tool&gt;.path
3742</dt>
3743<dd>
3744<p>
3745 Override the path for the given tool. This is useful in case
3746 your tool is not in the PATH.
3747</p>
3748</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3749<dt class="hdlist1">
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]3750mergetool.&lt;tool&gt;.cmd
3751</dt>
3752<dd>
3753<p>
3754 Specify the command to invoke the specified merge tool. The
3755 specified command is evaluated in shell with the following
3756 variables available: <em>BASE</em> is the name of a temporary file
3757 containing the common base of the files to be merged, if available;
3758 <em>LOCAL</em> is the name of a temporary file containing the contents of
3759 the file on the current branch; <em>REMOTE</em> is the name of a temporary
3760 file containing the contents of the file from the branch being
3761 merged; <em>MERGED</em> contains the name of the file to which the merge
3762 tool should write the results of a successful merge.
3763</p>
3764</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3765<dt class="hdlist1">
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]3766mergetool.&lt;tool&gt;.trustExitCode
3767</dt>
3768<dd>
3769<p>
3770 For a custom merge command, specify whether the exit code of
3771 the merge command can be used to determine whether the merge was
3772 successful. If this is not set to true then the merge target file
3773 timestamp is checked and the merge assumed to have been successful
3774 if the file has been updated, otherwise the user is prompted to
3775 indicate the success of the merge.
3776</p>
3777</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3778<dt class="hdlist1">
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]3779mergetool.keepBackup
3780</dt>
3781<dd>
3782<p>
3783 After performing a merge, the original file with conflict markers
3784 can be saved as a file with a <tt>.orig</tt> extension. If this variable
3785 is set to <tt>false</tt> then this file is not preserved. Defaults to
3786 <tt>true</tt> (i.e. keep the backup files).
3787</p>
3788</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3789<dt class="hdlist1">
Junio C Hamano10b7a342009-01-01 22:05:17[diff] [blame]3790mergetool.keepTemporaries
3791</dt>
3792<dd>
3793<p>
3794 When invoking a custom merge tool, git uses a set of temporary
3795 files to pass to the tool. If the tool returns an error and this
3796 variable is set to <tt>true</tt>, then these temporary files will be
3797 preserved, otherwise they will be removed after the tool has
3798 exited. Defaults to <tt>false</tt>.
3799</p>
3800</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3801<dt class="hdlist1">
Junio C Hamano10b7a342009-01-01 22:05:17[diff] [blame]3802mergetool.prompt
3803</dt>
3804<dd>
3805<p>
3806 Prompt before each invocation of the merge resolution program.
3807</p>
3808</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3809<dt class="hdlist1">
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]3810notes.displayRef
3811</dt>
3812<dd>
3813<p>
3814 The (fully qualified) refname from which to show notes when
3815 showing commit messages. The value of this variable can be set
3816 to a glob, in which case notes from all matching refs will be
3817 shown. You may also specify this configuration variable
3818 several times. A warning will be issued for refs that do not
3819 exist, but a glob that does not match any refs is silently
3820 ignored.
3821</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3822<div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_DISPLAY_REF</tt>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]3823environment variable, which must be a colon separated list of refs or
3824globs.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3825<div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]3826GIT_NOTES_REF) is also implicitly added to the list of refs to be
3827displayed.</p></div>
3828</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3829<dt class="hdlist1">
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]3830notes.rewrite.&lt;command&gt;
3831</dt>
3832<dd>
3833<p>
3834 When rewriting commits with &lt;command&gt; (currently <tt>amend</tt> or
3835 <tt>rebase</tt>) and this variable is set to <tt>true</tt>, git
3836 automatically copies your notes from the original to the
3837 rewritten commit. Defaults to <tt>true</tt>, but see
3838 "notes.rewriteRef" below.
3839</p>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]3840</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3841<dt class="hdlist1">
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]3842notes.rewriteMode
3843</dt>
3844<dd>
3845<p>
3846 When copying notes during a rewrite (see the
3847 "notes.rewrite.&lt;command&gt;" option), determines what to do if
3848 the target commit already has a note. Must be one of
3849 <tt>overwrite</tt>, <tt>concatenate</tt>, or <tt>ignore</tt>. Defaults to
3850 <tt>concatenate</tt>.
3851</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3852<div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_MODE</tt>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]3853environment variable.</p></div>
3854</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3855<dt class="hdlist1">
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]3856notes.rewriteRef
3857</dt>
3858<dd>
3859<p>
3860 When copying notes during a rewrite, specifies the (fully
3861 qualified) ref whose notes should be copied. The ref may be a
3862 glob, in which case notes in all matching refs will be copied.
3863 You may also specify this configuration several times.
3864</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3865<div class="paragraph"><p>Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame^]3866enable note rewriting. Set it to <tt>refs/notes/commits</tt> to enable
3867rewriting for the default commit notes.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3868<div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_REF</tt>
Junio C Hamano2b3ee5d2010-05-08 05:41:18[diff] [blame]3869environment variable, which must be a colon separated list of refs or
3870globs.</p></div>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]3871</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3872<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3873pack.window
3874</dt>
3875<dd>
3876<p>
3877 The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
3878 window size is given on the command line. Defaults to 10.
3879</p>
3880</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3881<dt class="hdlist1">
Junio C Hamano91d44c52007-05-09 07:16:07[diff] [blame]3882pack.depth
3883</dt>
3884<dd>
3885<p>
3886 The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
3887 maximum depth is given on the command line. Defaults to 50.
3888</p>
3889</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3890<dt class="hdlist1">
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]3891pack.windowMemory
3892</dt>
3893<dd>
3894<p>
3895 The window memory size limit used by <a href="git-pack-objects.html">git-pack-objects(1)</a>
3896 when no limit is given on the command line. The value can be
3897 suffixed with "k", "m", or "g". Defaults to 0, meaning no
3898 limit.
3899</p>
3900</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3901<dt class="hdlist1">
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]3902pack.compression
3903</dt>
3904<dd>
3905<p>
3906 An integer -1..9, indicating the compression level for objects
3907 in a pack file. -1 is the zlib default. 0 means no
3908 compression, and 1..9 are various speed/size tradeoffs, 9 being
3909 slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42[diff] [blame]3910 not set, defaults to -1, the zlib default, which is "a default
3911 compromise between speed and compression (currently equivalent
3912 to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]3913</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3914<div class="paragraph"><p>Note that changing the compression level will not automatically recompress
Junio C Hamano657fd8a2010-10-07 00:01:24[diff] [blame]3915all existing objects. You can force recompression by passing the -F option
3916to <a href="git-repack.html">git-repack(1)</a>.</p></div>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]3917</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3918<dt class="hdlist1">
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]3919pack.deltaCacheSize
3920</dt>
3921<dd>
3922<p>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]3923 The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:52[diff] [blame]3924 <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
3925 This cache is used to speed up the writing object phase by not
3926 having to recompute the final delta result once the best match
3927 for all objects is found. Repacking large repositories on machines
3928 which are tight with memory might be badly impacted by this though,
3929 especially if this cache pushes the system into swapping.
3930 A value of 0 means no limit. The smallest size of 1 byte may be
3931 used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]3932</p>
3933</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3934<dt class="hdlist1">
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]3935pack.deltaCacheLimit
3936</dt>
3937<dd>
3938<p>
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]3939 The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:52[diff] [blame]3940 <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
3941 writing object phase by not having to recompute the final delta
3942 result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]3943</p>
3944</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3945<dt class="hdlist1">
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]3946pack.threads
3947</dt>
3948<dd>
3949<p>
3950 Specifies the number of threads to spawn when searching for best
3951 delta matches. This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
3952 be compiled with pthreads otherwise this option is ignored with a
3953 warning. This is meant to reduce packing time on multiprocessor
3954 machines. The required amount of memory for the delta search window
3955 is however multiplied by the number of threads.
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3956 Specifying 0 will cause git to auto-detect the number of CPU&#8217;s
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]3957 and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]3958</p>
3959</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3960<dt class="hdlist1">
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]3961pack.indexVersion
3962</dt>
3963<dd>
3964<p>
3965 Specify the default pack index version. Valid values are 1 for
3966 legacy pack index used by Git versions prior to 1.5.2, and 2 for
3967 the new pack index with capabilities for packs larger than 4 GB
3968 as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]3969 packs. Version 2 is the default. Note that version 2 is enforced
3970 and this config option ignored whenever the corresponding pack is
3971 larger than 2 GB.
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]3972</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3973<div class="paragraph"><p>If you have an old git that does not understand the version 2 <tt>&#42;.idx</tt> file,
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]3974cloning or fetching over a non native protocol (e.g. "http" and "rsync")
3975that will copy both <tt>&#42;.pack</tt> file and corresponding <tt>&#42;.idx</tt> file from the
3976other side may give you a repository that cannot be accessed with your
3977older version of git. If the <tt>&#42;.pack</tt> file is smaller than 2 GB, however,
3978you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]3979the <tt>&#42;.idx</tt> file.</p></div>
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]3980</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3981<dt class="hdlist1">
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]3982pack.packSizeLimit
3983</dt>
3984<dd>
3985<p>
Junio C Hamano4d979582010-02-04 06:27:29[diff] [blame]3986 The maximum size of a pack. This setting only affects
3987 packing to a file when repacking, i.e. the git:// protocol
3988 is unaffected. It can be overridden by the <tt>--max-pack-size</tt>
3989 option of <a href="git-repack.html">git-repack(1)</a>. The minimum size allowed is
3990 limited to 1 MiB. The default is unlimited.
3991 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
3992 supported.
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]3993</p>
3994</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3995<dt class="hdlist1">
Junio C Hamano9e96a1a2008-08-16 10:23:18[diff] [blame]3996pager.&lt;cmd&gt;
3997</dt>
3998<dd>
3999<p>
Junio C Hamano788eeba2010-12-08 22:50:43[diff] [blame]4000 If the value is boolean, turns on or off pagination of the
4001 output of a particular git subcommand when writing to a tty.
4002 Otherwise, turns on pagination for the subcommand using the
4003 pager specified by the value of <tt>pager.&lt;cmd&gt;</tt>. If <tt>--paginate</tt>
4004 or <tt>--no-pager</tt> is specified on the command line, it takes
4005 precedence over this option. To disable pagination for all
4006 commands, set <tt>core.pager</tt> or <tt>GIT_PAGER</tt> to <tt>cat</tt>.
Junio C Hamano9e96a1a2008-08-16 10:23:18[diff] [blame]4007</p>
4008</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4009<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]4010pretty.&lt;name&gt;
4011</dt>
4012<dd>
4013<p>
4014 Alias for a --pretty= format string, as specified in
4015 <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
4016 as the built-in pretty formats could. For example,
4017 running <tt>git config pretty.changelog "format:&#42; %H %s"</tt>
4018 would cause the invocation <tt>git log --pretty=changelog</tt>
4019 to be equivalent to running <tt>git log "--pretty=format:&#42; %H %s"</tt>.
4020 Note that an alias with the same name as a built-in format
4021 will be silently ignored.
4022</p>
4023</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4024<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4025pull.octopus
4026</dt>
4027<dd>
4028<p>
4029 The default merge strategy to use when pulling multiple branches
4030 at once.
4031</p>
4032</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4033<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4034pull.twohead
4035</dt>
4036<dd>
4037<p>
4038 The default merge strategy to use when pulling a single branch.
4039</p>
4040</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4041<dt class="hdlist1">
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]4042push.default
4043</dt>
4044<dd>
4045<p>
4046 Defines the action git push should take if no refspec is given
4047 on the command line, no refspec is configured in the remote, and
4048 no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:19[diff] [blame]4049 line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]4050</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4051<div class="ulist"><ul>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]4052<li>
4053<p>
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]4054<tt>nothing</tt> - do not push anything.
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]4055</p>
4056</li>
4057<li>
4058<p>
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]4059<tt>matching</tt> - push all matching branches.
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]4060 All branches having the same name in both ends are considered to be
Junio C Hamano0706c802009-03-30 22:34:19[diff] [blame]4061 matching. This is the default.
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]4062</p>
4063</li>
4064<li>
4065<p>
Junio C Hamano63c2bc92011-02-28 06:41:28[diff] [blame]4066<tt>upstream</tt> - push the current branch to its upstream branch.
4067</p>
4068</li>
4069<li>
4070<p>
4071<tt>tracking</tt> - deprecated synonym for <tt>upstream</tt>.
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]4072</p>
4073</li>
4074<li>
4075<p>
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]4076<tt>current</tt> - push the current branch to a branch of the same name.
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]4077</p>
4078</li>
4079</ul></div>
4080</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4081<dt class="hdlist1">
Junio C Hamanoea6a7642009-03-11 23:56:19[diff] [blame]4082rebase.stat
4083</dt>
4084<dd>
4085<p>
4086 Whether to show a diffstat of what changed upstream since the last
4087 rebase. False by default.
4088</p>
4089</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4090<dt class="hdlist1">
Junio C Hamano075ae872010-09-01 18:43:07[diff] [blame]4091rebase.autosquash
4092</dt>
4093<dd>
4094<p>
4095 If set to true enable <em>--autosquash</em> option by default.
4096</p>
4097</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4098<dt class="hdlist1">
Junio C Hamano621e1232009-10-26 05:16:47[diff] [blame]4099receive.autogc
4100</dt>
4101<dd>
4102<p>
4103 By default, git-receive-pack will run "git-gc --auto" after
4104 receiving data from git-push and updating refs. You can stop
4105 it by setting this variable to false.
4106</p>
4107</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4108<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4109receive.fsckObjects
4110</dt>
4111<dd>
4112<p>
4113 If it is set to true, git-receive-pack will check all received
4114 objects. It will abort in the case of a malformed object or a
4115 broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame^]4116 Defaults to false. If not set, the value of <tt>transfer.fsckObjects</tt>
4117 is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4118</p>
4119</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4120<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4121receive.unpackLimit
4122</dt>
4123<dd>
4124<p>
4125 If the number of objects received in a push is below this
4126 limit then the objects will be unpacked into loose object
4127 files. However if the number of received objects equals or
4128 exceeds this limit then the received pack will be stored as
4129 a pack, after adding any missing delta bases. Storing the
4130 pack from a push can make the push operation complete faster,
4131 especially on slow filesystems. If not set, the value of
4132 <tt>transfer.unpackLimit</tt> is used instead.
4133</p>
4134</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4135<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4136receive.denyDeletes
4137</dt>
4138<dd>
4139<p>
4140 If set to true, git-receive-pack will deny a ref update that deletes
4141 the ref. Use this to prevent such a ref deletion via a push.
4142</p>
4143</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4144<dt class="hdlist1">
Junio C Hamanob4448a82010-07-26 09:02:32[diff] [blame]4145receive.denyDeleteCurrent
4146</dt>
4147<dd>
4148<p>
4149 If set to true, git-receive-pack will deny a ref update that
4150 deletes the currently checked out branch of a non-bare repository.
4151</p>
4152</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4153<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4154receive.denyCurrentBranch
4155</dt>
4156<dd>
4157<p>
Junio C Hamanoe97d5772010-05-19 08:13:58[diff] [blame]4158 If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4159 to the currently checked out branch of a non-bare repository.
4160 Such a push is potentially dangerous because it brings the HEAD
4161 out of sync with the index and working tree. If set to "warn",
4162 print a warning of such a push to stderr, but allow the push to
4163 proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:15[diff] [blame]4164 message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4165</p>
4166</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4167<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4168receive.denyNonFastForwards
4169</dt>
4170<dd>
4171<p>
4172 If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:54[diff] [blame]4173 not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4174 even if that push is forced. This configuration variable is
4175 set when initializing a shared repository.
4176</p>
4177</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4178<dt class="hdlist1">
Junio C Hamano621e1232009-10-26 05:16:47[diff] [blame]4179receive.updateserverinfo
4180</dt>
4181<dd>
4182<p>
4183 If set to true, git-receive-pack will run git-update-server-info
4184 after receiving data from git-push and updating refs.
4185</p>
4186</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4187<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4188remote.&lt;name&gt;.url
4189</dt>
4190<dd>
4191<p>
4192 The URL of a remote repository. See <a href="git-fetch.html">git-fetch(1)</a> or
4193 <a href="git-push.html">git-push(1)</a>.
4194</p>
4195</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4196<dt class="hdlist1">
Junio C Hamano0e88f3e2009-06-21 08:03:25[diff] [blame]4197remote.&lt;name&gt;.pushurl
4198</dt>
4199<dd>
4200<p>
4201 The push URL of a remote repository. See <a href="git-push.html">git-push(1)</a>.
4202</p>
4203</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4204<dt class="hdlist1">
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]4205remote.&lt;name&gt;.proxy
4206</dt>
4207<dd>
4208<p>
4209 For remotes that require curl (http, https and ftp), the URL to
4210 the proxy to use for that remote. Set to the empty string to
4211 disable proxying for that remote.
4212</p>
4213</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4214<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4215remote.&lt;name&gt;.fetch
4216</dt>
4217<dd>
4218<p>
4219 The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
4220 <a href="git-fetch.html">git-fetch(1)</a>.
4221</p>
4222</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4223<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4224remote.&lt;name&gt;.push
4225</dt>
4226<dd>
4227<p>
4228 The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
4229 <a href="git-push.html">git-push(1)</a>.
4230</p>
4231</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4232<dt class="hdlist1">
Junio C Hamano47d68a52008-05-06 06:35:40[diff] [blame]4233remote.&lt;name&gt;.mirror
4234</dt>
4235<dd>
4236<p>
4237 If true, pushing to this remote will automatically behave
4238 as if the <tt>--mirror</tt> option was given on the command line.
4239</p>
4240</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4241<dt class="hdlist1">
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]4242remote.&lt;name&gt;.skipDefaultUpdate
4243</dt>
4244<dd>
4245<p>
4246 If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]4247 using <a href="git-fetch.html">git-fetch(1)</a> or the <tt>update</tt> subcommand of
4248 <a href="git-remote.html">git-remote(1)</a>.
4249</p>
4250</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4251<dt class="hdlist1">
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]4252remote.&lt;name&gt;.skipFetchAll
4253</dt>
4254<dd>
4255<p>
4256 If true, this remote will be skipped by default when updating
4257 using <a href="git-fetch.html">git-fetch(1)</a> or the <tt>update</tt> subcommand of
4258 <a href="git-remote.html">git-remote(1)</a>.
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]4259</p>
4260</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4261<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4262remote.&lt;name&gt;.receivepack
4263</dt>
4264<dd>
4265<p>
4266 The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]4267 option --receive-pack of <a href="git-push.html">git-push(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4268</p>
4269</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4270<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4271remote.&lt;name&gt;.uploadpack
4272</dt>
4273<dd>
4274<p>
4275 The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]4276 option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4277</p>
4278</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4279<dt class="hdlist1">
Junio C Hamano17dde0e2007-02-26 09:50:21[diff] [blame]4280remote.&lt;name&gt;.tagopt
4281</dt>
4282<dd>
4283<p>
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]4284 Setting this value to --no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]4285 fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
4286 tag from remote &lt;name&gt;, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:07[diff] [blame]4287 branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
4288 override this setting. See options --tags and --no-tags of
4289 <a href="git-fetch.html">git-fetch(1)</a>.
Junio C Hamano17dde0e2007-02-26 09:50:21[diff] [blame]4290</p>
4291</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4292<dt class="hdlist1">
Junio C Hamano096dde22009-12-26 23:14:11[diff] [blame]4293remote.&lt;name&gt;.vcs
4294</dt>
4295<dd>
4296<p>
4297 Setting this to a value &lt;vcs&gt; will cause git to interact with
4298 the remote with the git-remote-&lt;vcs&gt; helper.
4299</p>
4300</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4301<dt class="hdlist1">
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]4302remotes.&lt;group&gt;
4303</dt>
4304<dd>
4305<p>
4306 The list of remotes which are fetched by "git remote update
4307 &lt;group&gt;". See <a href="git-remote.html">git-remote(1)</a>.
4308</p>
4309</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4310<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4311repack.usedeltabaseoffset
4312</dt>
4313<dd>
4314<p>
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]4315 By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
4316 delta-base offset. If you need to share your repository with
4317 git older than version 1.4.4, either directly or via a dumb
4318 protocol such as http, then you need to set this option to
4319 "false" and repack. Access from old git versions over the
4320 native protocol are unaffected by this option.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4321</p>
4322</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4323<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4324rerere.autoupdate
4325</dt>
4326<dd>
4327<p>
4328 When set to true, <tt>git-rerere</tt> updates the index with the
4329 resulting contents after it cleanly resolves conflicts using
4330 previously recorded resolution. Defaults to false.
4331</p>
4332</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4333<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4334rerere.enabled
4335</dt>
4336<dd>
4337<p>
4338 Activate recording of resolved conflicts, so that identical
4339 conflict hunks can be resolved automatically, should they
4340 be encountered again. <a href="git-rerere.html">git-rerere(1)</a> command is by
4341 default enabled if you create <tt>rr-cache</tt> directory under
4342 <tt>$GIT_DIR</tt>, but can be disabled by setting this option to false.
4343</p>
4344</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4345<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4346sendemail.identity
4347</dt>
4348<dd>
4349<p>
4350 A configuration identity. When given, causes values in the
4351 <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
4352 values in the <em>sendemail</em> section. The default identity is
4353 the value of <em>sendemail.identity</em>.
4354</p>
4355</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4356<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4357sendemail.smtpencryption
4358</dt>
4359<dd>
4360<p>
4361 See <a href="git-send-email.html">git-send-email(1)</a> for description. Note that this
4362 setting is not subject to the <em>identity</em> mechanism.
4363</p>
4364</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4365<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4366sendemail.smtpssl
4367</dt>
4368<dd>
4369<p>
4370 Deprecated alias for <em>sendemail.smtpencryption = ssl</em>.
4371</p>
4372</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4373<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4374sendemail.&lt;identity&gt;.*
4375</dt>
4376<dd>
4377<p>
4378 Identity-specific versions of the <em>sendemail.*</em> parameters
4379 found below, taking precedence over those when the this
4380 identity is selected, through command-line or
4381 <em>sendemail.identity</em>.
4382</p>
4383</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4384<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4385sendemail.aliasesfile
4386</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4387<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4388sendemail.aliasfiletype
4389</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4390<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4391sendemail.bcc
4392</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4393<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4394sendemail.cc
4395</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4396<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4397sendemail.cccmd
4398</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4399<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4400sendemail.chainreplyto
4401</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4402<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4403sendemail.confirm
4404</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4405<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4406sendemail.envelopesender
4407</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4408<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4409sendemail.from
4410</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4411<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4412sendemail.multiedit
4413</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4414<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4415sendemail.signedoffbycc
4416</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4417<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4418sendemail.smtppass
4419</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4420<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4421sendemail.suppresscc
4422</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4423<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4424sendemail.suppressfrom
4425</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4426<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4427sendemail.to
4428</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4429<dt class="hdlist1">
Junio C Hamanocb39aea2010-05-09 07:24:48[diff] [blame]4430sendemail.smtpdomain
4431</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4432<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4433sendemail.smtpserver
4434</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4435<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4436sendemail.smtpserverport
4437</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4438<dt class="hdlist1">
Junio C Hamano39c7a692010-10-27 06:08:54[diff] [blame]4439sendemail.smtpserveroption
4440</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4441<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4442sendemail.smtpuser
4443</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4444<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4445sendemail.thread
4446</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4447<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4448sendemail.validate
4449</dt>
4450<dd>
4451<p>
4452 See <a href="git-send-email.html">git-send-email(1)</a> for description.
4453</p>
4454</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4455<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]4456sendemail.signedoffcc
4457</dt>
4458<dd>
4459<p>
4460 Deprecated alias for <em>sendemail.signedoffbycc</em>.
4461</p>
4462</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4463<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4464showbranch.default
4465</dt>
4466<dd>
4467<p>
4468 The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
4469 See <a href="git-show-branch.html">git-show-branch(1)</a>.
4470</p>
4471</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4472<dt class="hdlist1">
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]4473status.relativePaths
4474</dt>
4475<dd>
4476<p>
4477 By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
4478 current directory. Setting this variable to <tt>false</tt> shows paths
4479 relative to the repository root (this was the default for git
4480 prior to v1.5.4).
4481</p>
4482</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4483<dt class="hdlist1">
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]4484status.showUntrackedFiles
4485</dt>
4486<dd>
4487<p>
4488 By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
4489 files which are not currently tracked by Git. Directories which
4490 contain only untracked files, are shown with the directory name
4491 only. Showing untracked files means that Git needs to lstat() all
4492 all the files in the whole repository, which might be slow on some
4493 systems. So, this variable controls how the commands displays
4494 the untracked files. Possible values are:
4495</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4496<div class="ulist"><ul>
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]4497<li>
4498<p>
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]4499<tt>no</tt> - Show no untracked files.
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]4500</p>
4501</li>
4502<li>
4503<p>
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]4504<tt>normal</tt> - Show untracked files and directories.
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]4505</p>
4506</li>
4507<li>
4508<p>
Junio C Hamano7f9fa862010-10-19 23:51:14[diff] [blame]4509<tt>all</tt> - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]4510</p>
4511</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]4512</ul></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4513<div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>.
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]4514This variable can be overridden with the -u|--untracked-files option
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]4515of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]4516</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4517<dt class="hdlist1">
Junio C Hamanob671fb52010-06-01 05:06:14[diff] [blame]4518status.submodulesummary
4519</dt>
4520<dd>
4521<p>
4522 Defaults to false.
4523 If this is set to a non zero number or true (identical to -1 or an
4524 unlimited number), the submodule summary will be enabled and a
4525 summary of commits for modified submodules will be shown (see
4526 --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>).
4527</p>
4528</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4529<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]4530submodule.&lt;name&gt;.path
4531</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4532<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]4533submodule.&lt;name&gt;.url
4534</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4535<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]4536submodule.&lt;name&gt;.update
4537</dt>
4538<dd>
4539<p>
4540 The path within this project, URL, and the updating strategy
4541 for a submodule. These variables are initially populated
4542 by <em>git submodule init</em>; edit them to override the
4543 URL and other values found in the <tt>.gitmodules</tt> file. See
4544 <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
4545</p>
4546</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4547<dt class="hdlist1">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]4548submodule.&lt;name&gt;.fetchRecurseSubmodules
4549</dt>
4550<dd>
4551<p>
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]4552 This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:18[diff] [blame]4553 submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]4554 command line option to "git fetch" and "git pull".
4555 This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
4556 file.
4557</p>
4558</dd>
4559<dt class="hdlist1">
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]4560submodule.&lt;name&gt;.ignore
4561</dt>
4562<dd>
4563<p>
4564 Defines under what circumstances "git status" and the diff family show
4565 a submodule as modified. When set to "all", it will never be considered
4566 modified, "dirty" will ignore all changes to the submodules work tree and
4567 takes only differences between the HEAD of the submodule and the commit
4568 recorded in the superproject into account. "untracked" will additionally
4569 let submodules with modified tracked files in their work tree show up.
4570 Using "none" (the default when this option is not set) also shows
4571 submodules that have untracked files in their work tree as changed.
4572 This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:18[diff] [blame]4573 both settings can be overridden on the command line by using the
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]4574 "--ignore-submodules" option.
4575</p>
4576</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4577<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4578tar.umask
4579</dt>
4580<dd>
4581<p>
Junio C Hamanobdebabb2007-08-23 00:25:09[diff] [blame]4582 This variable can be used to restrict the permission bits of
4583 tar archive entries. The default is 0002, which turns off the
4584 world write bit. The special value "user" indicates that the
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4585 archiving user&#8217;s umask will be used instead. See umask(2) and
Junio C Hamanobdebabb2007-08-23 00:25:09[diff] [blame]4586 <a href="git-archive.html">git-archive(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4587</p>
4588</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4589<dt class="hdlist1">
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame^]4590transfer.fsckObjects
4591</dt>
4592<dd>
4593<p>
4594 When <tt>fetch.fsckObjects</tt> or <tt>receive.fsckObjects</tt> are
4595 not set, the value of this variable is used instead.
4596 Defaults to false.
4597</p>
4598</dd>
4599<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]4600transfer.unpackLimit
4601</dt>
4602<dd>
4603<p>
4604 When <tt>fetch.unpackLimit</tt> or <tt>receive.unpackLimit</tt> are
4605 not set, the value of this variable is used instead.
4606 The default value is 100.
4607</p>
4608</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4609<dt class="hdlist1">
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]4610url.&lt;base&gt;.insteadOf
4611</dt>
4612<dd>
4613<p>
4614 Any URL that starts with this value will be rewritten to
4615 start, instead, with &lt;base&gt;. In cases where some site serves a
4616 large number of repositories, and serves them with multiple
4617 access methods, and some users need to use different access
4618 methods, this feature allows people to specify any of the
4619 equivalent URLs and have git automatically rewrite the URL to
4620 the best alternative for the particular user, even for a
4621 never-before-seen repository on the site. When more than one
4622 insteadOf strings match a given URL, the longest match is used.
4623</p>
4624</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4625<dt class="hdlist1">
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]4626url.&lt;base&gt;.pushInsteadOf
4627</dt>
4628<dd>
4629<p>
4630 Any URL that starts with this value will not be pushed to;
4631 instead, it will be rewritten to start with &lt;base&gt;, and the
4632 resulting URL will be pushed to. In cases where some site serves
4633 a large number of repositories, and serves them with multiple
4634 access methods, some of which do not allow push, this feature
4635 allows people to specify a pull-only URL and have git
4636 automatically use an appropriate URL to push, even for a
4637 never-before-seen repository on the site. When more than one
4638 pushInsteadOf strings match a given URL, the longest match is
4639 used. If a remote has an explicit pushurl, git will ignore this
4640 setting for that remote.
4641</p>
4642</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4643<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4644user.email
4645</dt>
4646<dd>
4647<p>
4648 Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:34[diff] [blame]4649 Can be overridden by the <em>GIT_AUTHOR_EMAIL</em>, <em>GIT_COMMITTER_EMAIL</em>, and
4650 <em>EMAIL</em> environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4651</p>
4652</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4653<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4654user.name
4655</dt>
4656<dd>
4657<p>
4658 Your full name to be recorded in any newly created commits.
4659 Can be overridden by the <em>GIT_AUTHOR_NAME</em> and <em>GIT_COMMITTER_NAME</em>
4660 environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
4661</p>
4662</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4663<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4664user.signingkey
4665</dt>
4666<dd>
4667<p>
4668 If <a href="git-tag.html">git-tag(1)</a> is not selecting the key you want it to
4669 automatically when creating a signed tag, you can override the
4670 default selection with this variable. This option is passed
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4671 unchanged to gpg&#8217;s --local-user parameter, so you may specify a key
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4672 using any method that gpg supports.
4673</p>
4674</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4675<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]4676web.browser
4677</dt>
4678<dd>
4679<p>
4680 Specify a web browser that may be used by some commands.
4681 Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
4682 may use it.
4683</p>
4684</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]4685</dl></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4686</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]4687<h2 id="_git">GIT</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4688<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4689<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4690</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]4691</div>
4692<div id="footnotes"><hr /></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4693<div id="footer">
4694<div id="footer-text">
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]4695Last updated 2011-09-21 23:01:14 PDT
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4696</div>
4697</div>
4698</body>
4699</html>