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