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