Google Git
Sign in
chromium / external / gitster / git-htmldocs / d88ba73d702fe5539887dbcc805006d92c3d1a1c / . / git-config.html
blob: 855d725c759028320e3cf7f626cf33aab8404628 [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>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]5<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6<meta name="generator" content="AsciiDoc 8.6.9" />
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">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]9/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]24}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]37
38em {
39 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]40 color: navy;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]41}
42
43strong {
44 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]45 color: #083194;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]46}
47
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]55h1, h2, h3 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]56 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]59 padding-top: 0.5em;
60}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]61h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]67h5 {
68 font-size: 1.0em;
69}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]70
71div.sectionbody {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]72 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]84ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]87ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]89
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]94 padding: 0;
95 margin: 0;
96}
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]97pre {
98 white-space: pre-wrap;
99}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]100
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]101#author {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]102 color: #527bbd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]103 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]104 font-size: 1.1em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#email {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]107}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]108#revnumber, #revdate, #revremark {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]109}
110
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]111#footer {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]117#footer-text {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]121#footer-badges {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]126#preamble {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]133 margin-top: 1.0em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]149 color: #527bbd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]180 padding: 0.5em;
181}
182
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]189}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]190
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]193 text-align: right;
194}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]195
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]219 border-left: 3px solid #dddddd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]220}
221
222div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]225}
226
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]227div.imageblock div.content { padding-left: 0; }
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]229a.image:visited { color: white; }
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]238 font-style: normal;
239 color: navy;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]240}
241dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]242 margin-top: 0.1em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]252 list-style-type: lower-alpha;
253}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]270
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]271tfoot {
272 font-weight: bold;
273}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]277
278div.hdlist {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]284}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]289 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]290 font-style: normal;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]291 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]292 color: navy;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]293}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]294td.hdlist2 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]295 vertical-align: top;
296}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]305
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]340}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]341
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]350#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]374
375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
427}
428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
432 font-weight: bold;
433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
449}
450
451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
480}
481
482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
501 text-align: right;
502}
503
504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
506}
507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
512}
513
514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]526body.manpage h2 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]527 border-style: none;
528}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]531}
532
533@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]534 body.manpage div#toc { display: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]535}
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]536
537
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]538</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]730asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]731/*]]>*/
732</script>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]733</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]734<body class="manpage">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]735<div id="header">
736<h1>
737git-config(1) Manual Page
738</h1>
739<h2>NAME</h2>
740<div class="sectionbody">
741<p>git-config -
742 Get and set repository or global options
743</p>
744</div>
745</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]746<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]747<div class="sect1">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]748<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]749<div class="sectionbody">
750<div class="verseblock">
Junio C Hamano76df4f72016-02-26 22:13:10[diff] [blame]751<pre class="content"><em>git config</em> [&lt;file-option&gt;] [type] [--show-origin] [-z|--null] name [value [value_regex]]
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]752<em>git config</em> [&lt;file-option&gt;] [type] --add name value
Junio C Hamano5217a272009-03-21 00:39:33[diff] [blame]753<em>git config</em> [&lt;file-option&gt;] [type] --replace-all name value [value_regex]
Junio C Hamano76df4f72016-02-26 22:13:10[diff] [blame]754<em>git config</em> [&lt;file-option&gt;] [type] [--show-origin] [-z|--null] --get name [value_regex]
755<em>git config</em> [&lt;file-option&gt;] [type] [--show-origin] [-z|--null] --get-all name [value_regex]
756<em>git config</em> [&lt;file-option&gt;] [type] [--show-origin] [-z|--null] [--name-only] --get-regexp name_regex [value_regex]
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]757<em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get-urlmatch name URL
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]758<em>git config</em> [&lt;file-option&gt;] --unset name [value_regex]
759<em>git config</em> [&lt;file-option&gt;] --unset-all name [value_regex]
760<em>git config</em> [&lt;file-option&gt;] --rename-section old_name new_name
761<em>git config</em> [&lt;file-option&gt;] --remove-section name
Junio C Hamano76df4f72016-02-26 22:13:10[diff] [blame]762<em>git config</em> [&lt;file-option&gt;] [--show-origin] [-z|--null] [--name-only] -l | --list
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]763<em>git config</em> [&lt;file-option&gt;] --get-color name [default]
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]764<em>git config</em> [&lt;file-option&gt;] --get-colorbool name [stdout-is-tty]
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]765<em>git config</em> [&lt;file-option&gt;] -e | --edit</pre>
766<div class="attribution">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]767</div></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]768</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]769</div>
770<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]771<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]772<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]773<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]774actually the section and the key separated by a dot, and the value will be
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]775escaped.</p></div>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]776<div class="paragraph"><p>Multiple lines can be added to an option by using the <code>--add</code> option.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]777If you want to update or unset an option which can occur on multiple
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]778lines, a POSIX regexp <code>value_regex</code> needs to be given. Only the
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]779existing values that match the regexp are updated or unset. If
780you want to handle the lines that do <strong>not</strong> match the regex, just
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]781prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>).</p></div>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]782<div class="paragraph"><p>The type specifier can be either <code>--int</code> or <code>--bool</code>, to make
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]783<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]784convert the value to the canonical form (simple decimal number for int,
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]785a "true" or "false" string for bool), or <code>--path</code>, which does some
786path expansion (see <code>--path</code> below). If no type specifier is passed, no
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]787checks or transformations are performed on the value.</p></div>
Junio C Hamanobcdb12e2012-05-10 18:45:15[diff] [blame]788<div class="paragraph"><p>When reading, the values are read from the system, global and
789repository local configuration files by default, and options
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]790<code>--system</code>, <code>--global</code>, <code>--local</code> and <code>--file &lt;filename&gt;</code> can be
Junio C Hamanobcdb12e2012-05-10 18:45:15[diff] [blame]791used to tell the command to read from only that location (see <a href="#FILES">[FILES]</a>).</p></div>
792<div class="paragraph"><p>When writing, the new value is written to the repository local
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]793configuration file by default, and options <code>--system</code>, <code>--global</code>,
794<code>--file &lt;filename&gt;</code> can be used to tell the command to write to
795that location (you can say <code>--local</code> but that is the default).</p></div>
Junio C Hamanof3353932012-09-04 23:16:51[diff] [blame]796<div class="paragraph"><p>This command will fail with non-zero status upon error. Some exit
797codes are:</p></div>
Junio C Hamano4ba4a782016-04-03 19:11:32[diff] [blame]798<div class="ulist"><ul>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]799<li>
800<p>
Junio C Hamanoccdabca2016-05-06 22:27:09[diff] [blame]801The section or key is invalid (ret=1),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]802</p>
803</li>
804<li>
805<p>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]806no section or name was provided (ret=2),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]807</p>
808</li>
809<li>
810<p>
Junio C Hamanoccdabca2016-05-06 22:27:09[diff] [blame]811the config file is invalid (ret=3),
812</p>
813</li>
814<li>
815<p>
816the config file cannot be written (ret=4),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]817</p>
818</li>
819<li>
820<p>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]821you try to unset an option which does not exist (ret=5),
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]822</p>
823</li>
824<li>
825<p>
Junio C Hamanof3353932012-09-04 23:16:51[diff] [blame]826you try to unset/set an option for which multiple lines match (ret=5), or
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]827</p>
828</li>
829<li>
830<p>
Junio C Hamanof3353932012-09-04 23:16:51[diff] [blame]831you try to use an invalid regexp (ret=6).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]832</p>
833</li>
Junio C Hamano4ba4a782016-04-03 19:11:32[diff] [blame]834</ul></div>
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]835<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]836</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]837</div>
838<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]839<h2 id="_options">OPTIONS</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]840<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]841<div class="dlist"><dl>
842<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]843--replace-all
844</dt>
845<dd>
846<p>
847 Default behavior is to replace at most one line. This replaces
848 all lines matching the key (and optionally the value_regex).
849</p>
850</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]851<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]852--add
853</dt>
854<dd>
855<p>
856 Adds a new line to the option without altering any existing
Junio C Hamano89bdb3b2009-05-10 06:48:14[diff] [blame]857 values. This is the same as providing <em>^$</em> as the value_regex
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]858 in <code>--replace-all</code>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]859</p>
860</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]861<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]862--get
863</dt>
864<dd>
865<p>
866 Get the value for a given key (optionally filtered by a regex
867 matching the value). Returns error code 1 if the key was not
Junio C Hamano68e17742013-07-04 00:44:26[diff] [blame]868 found and the last value if multiple key values were found.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]869</p>
870</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]871<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]872--get-all
873</dt>
874<dd>
875<p>
Junio C Hamano4ba4a782016-04-03 19:11:32[diff] [blame]876 Like get, but returns all values for a multi-valued key.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]877</p>
878</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]879<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]880--get-regexp
881</dt>
882<dd>
883<p>
Junio C Hamano81d540a2012-03-02 19:52:47[diff] [blame]884 Like --get-all, but interprets the name as a regular expression and
885 writes out the key names. Regular expression matching is currently
886 case-sensitive and done against a canonicalized version of the key
887 in which section and variable names are lowercased, but subsection
888 names are not.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]889</p>
890</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]891<dt class="hdlist1">
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]892--get-urlmatch name URL
893</dt>
894<dd>
895<p>
896 When given a two-part name section.key, the value for
897 section.&lt;url&gt;.key whose &lt;url&gt; part matches the best to the
898 given URL is returned (if no such key exists, the value for
899 section.key is used as a fallback). When given just the
900 section as name, do so for all the keys in the section and
Junio C Hamano4ba4a782016-04-03 19:11:32[diff] [blame]901 list them. Returns error code 1 if no value is found.
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]902</p>
903</dd>
904<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]905--global
906</dt>
907<dd>
908<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]909 For writing options: write to global <code>~/.gitconfig</code> file
910 rather than the repository <code>.git/config</code>, write to
911 <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the
912 <code>~/.gitconfig</code> file doesn&#8217;t.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]913</p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]914<div class="paragraph"><p>For reading options: read only from global <code>~/.gitconfig</code> and from
915<code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]916<div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]917</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]918<dt class="hdlist1">
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]919--system
920</dt>
921<dd>
922<p>
Junio C Hamano4b500fa2013-07-31 23:11:16[diff] [blame]923 For writing options: write to system-wide
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]924 <code>$(prefix)/etc/gitconfig</code> rather than the repository
925 <code>.git/config</code>.
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]926</p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]927<div class="paragraph"><p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]928rather than from all available files.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]929<div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]930</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]931<dt class="hdlist1">
Junio C Hamano8ab94942013-06-24 21:55:30[diff] [blame]932--local
933</dt>
934<dd>
935<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]936 For writing options: write to the repository <code>.git/config</code> file.
Junio C Hamano8ab94942013-06-24 21:55:30[diff] [blame]937 This is the default behavior.
938</p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]939<div class="paragraph"><p>For reading options: read only from the repository <code>.git/config</code> rather than
Junio C Hamano8ab94942013-06-24 21:55:30[diff] [blame]940from all available files.</p></div>
941<div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
942</dd>
943<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]944-f config-file
945</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]946<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]947--file config-file
Junio C Hamano0ddc94d2007-08-01 08:42:39[diff] [blame]948</dt>
949<dd>
950<p>
951 Use the given config file instead of the one specified by GIT_CONFIG.
952</p>
953</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]954<dt class="hdlist1">
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]955--blob blob
956</dt>
957<dd>
958<p>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]959 Similar to <code>--file</code> but use the given blob instead of a file. E.g.
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]960 you can use <em>master:.gitmodules</em> to read values from the file
961 <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS"
962 section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of
963 ways to spell blob names.
964</p>
965</dd>
966<dt class="hdlist1">
Junio C Hamanod15328a2007-03-09 09:06:40[diff] [blame]967--remove-section
968</dt>
969<dd>
970<p>
971 Remove the given section from the configuration file.
972</p>
973</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]974<dt class="hdlist1">
Junio C Hamanod15328a2007-03-09 09:06:40[diff] [blame]975--rename-section
976</dt>
977<dd>
978<p>
979 Rename the given section to a new name.
980</p>
981</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]982<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]983--unset
984</dt>
985<dd>
986<p>
987 Remove the line matching the key from config file.
988</p>
989</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]990<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]991--unset-all
992</dt>
993<dd>
994<p>
Junio C Hamano10557772007-03-15 07:12:30[diff] [blame]995 Remove all lines matching the key from config file.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]996</p>
997</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]998<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]999-l
1000</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1001<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1002--list
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1003</dt>
1004<dd>
1005<p>
Junio C Hamano3891e252015-08-31 23:06:13[diff] [blame]1006 List all variables set in config file, along with their values.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1007</p>
1008</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1009<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1010--bool
1011</dt>
1012<dd>
1013<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1014 <em>git config</em> will ensure that the output is "true" or "false"
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1015</p>
1016</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1017<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1018--int
1019</dt>
1020<dd>
1021<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1022 <em>git config</em> will ensure that the output is a simple
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1023 decimal number. An optional value suffix of <em>k</em>, <em>m</em>, or <em>g</em>
1024 in the config file will cause the value to be multiplied
1025 by 1024, 1048576, or 1073741824 prior to output.
1026</p>
1027</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1028<dt class="hdlist1">
Junio C Hamano792c5a92009-03-08 08:45:13[diff] [blame]1029--bool-or-int
1030</dt>
1031<dd>
1032<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1033 <em>git config</em> will ensure that the output matches the format of
Junio C Hamano792c5a92009-03-08 08:45:13[diff] [blame]1034 either --bool or --int, as described above.
1035</p>
1036</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1037<dt class="hdlist1">
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]1038--path
1039</dt>
1040<dd>
1041<p>
1042 <em>git-config</em> will expand leading <em>&#126;</em> to the value of
1043 <em>$HOME</em>, and <em>&#126;user</em> to the home directory for the
1044 specified user. This option has no effect when setting the
1045 value (but you can use <em>git config bla &#126;/</em> from the
1046 command line to let your shell do the expansion).
1047</p>
1048</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1049<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1050-z
1051</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1052<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1053--null
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]1054</dt>
1055<dd>
1056<p>
1057 For all options that output values and/or keys, always
Junio C Hamano1f511962008-01-30 08:28:52[diff] [blame]1058 end values with the null character (instead of a
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]1059 newline). Use newline instead as a delimiter between
1060 key and value. This allows for secure parsing of the
1061 output without getting confused e.g. by values that
1062 contain line breaks.
1063</p>
1064</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1065<dt class="hdlist1">
Junio C Hamano3891e252015-08-31 23:06:13[diff] [blame]1066--name-only
1067</dt>
1068<dd>
1069<p>
1070 Output only the names of config variables for <code>--list</code> or
1071 <code>--get-regexp</code>.
1072</p>
1073</dd>
1074<dt class="hdlist1">
Junio C Hamano76df4f72016-02-26 22:13:10[diff] [blame]1075--show-origin
1076</dt>
1077<dd>
1078<p>
1079 Augment the output of all queried config options with the
1080 origin type (file, standard input, blob, command line) and
1081 the actual origin (config file path, ref, or blob id if
1082 applicable).
1083</p>
1084</dd>
1085<dt class="hdlist1">
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]1086--get-colorbool name [stdout-is-tty]
1087</dt>
1088<dd>
1089<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1090 Find the color setting for <code>name</code> (e.g. <code>color.diff</code>) and output
1091 "true" or "false". <code>stdout-is-tty</code> should be either "true" or
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]1092 "false", and is taken into account when configuration says
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1093 "auto". If <code>stdout-is-tty</code> is missing, then checks the standard
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]1094 output of the command itself, and exits with status 0 if color
1095 is to be used, or exits with status 1 otherwise.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1096 When the color setting for <code>name</code> is undefined, the command uses
1097 <code>color.ui</code> as fallback.
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]1098</p>
1099</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1100<dt class="hdlist1">
Junio C Hamano89bdb3b2009-05-10 06:48:14[diff] [blame]1101--get-color name [default]
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1102</dt>
1103<dd>
1104<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1105 Find the color configured for <code>name</code> (e.g. <code>color.diff.new</code>) and
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1106 output it as the ANSI color escape sequence to the standard
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1107 output. The optional <code>default</code> parameter is used instead, if
1108 there is no color configured for <code>name</code>.
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1109</p>
1110</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1111<dt class="hdlist1">
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1112-e
1113</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1114<dt class="hdlist1">
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1115--edit
1116</dt>
1117<dd>
1118<p>
1119 Opens an editor to modify the specified config file; either
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1120 <code>--system</code>, <code>--global</code>, or repository (default).
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1121</p>
1122</dd>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]1123<dt class="hdlist1">
Junio C Hamano3d1b5a12013-05-17 23:34:02[diff] [blame]1124--[no-]includes
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]1125</dt>
1126<dd>
1127<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1128 Respect <code>include.*</code> directives in config files when looking up
Junio C Hamanob29ef022016-02-22 22:06:01[diff] [blame]1129 values. Defaults to <code>off</code> when a specific file is given (e.g.,
1130 using <code>--file</code>, <code>--global</code>, etc) and <code>on</code> when searching all
1131 config files.
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]1132</p>
1133</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1134</dl></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1135</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1136</div>
1137<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1138<h2 id="FILES">FILES</h2>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]1139<div class="sectionbody">
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1140<div class="paragraph"><p>If not set explicitly with <code>--file</code>, there are four files where
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1141<em>git config</em> will search for configuration options:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1142<div class="dlist"><dl>
1143<dt class="hdlist1">
Junio C Hamano8401f142013-07-12 22:47:46[diff] [blame]1144$(prefix)/etc/gitconfig
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]1145</dt>
1146<dd>
1147<p>
Junio C Hamano8401f142013-07-12 22:47:46[diff] [blame]1148 System-wide configuration file.
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]1149</p>
1150</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1151<dt class="hdlist1">
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]1152$XDG_CONFIG_HOME/git/config
1153</dt>
1154<dd>
1155<p>
1156 Second user-specific configuration file. If $XDG_CONFIG_HOME is not set
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1157 or empty, <code>$HOME/.config/git/config</code> will be used. Any single-valued
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]1158 variable set in this file will be overwritten by whatever is in
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1159 <code>~/.gitconfig</code>. It is a good idea not to create this file if
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]1160 you sometimes use older versions of Git, as support for this
1161 file was added fairly recently.
1162</p>
1163</dd>
1164<dt class="hdlist1">
Junio C Hamano8401f142013-07-12 22:47:46[diff] [blame]1165~/.gitconfig
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]1166</dt>
1167<dd>
1168<p>
Junio C Hamano8401f142013-07-12 22:47:46[diff] [blame]1169 User-specific configuration file. Also called "global"
1170 configuration file.
1171</p>
1172</dd>
1173<dt class="hdlist1">
1174$GIT_DIR/config
1175</dt>
1176<dd>
1177<p>
1178 Repository specific configuration file.
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]1179</p>
1180</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1181</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1182<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]1183files that are available. If the global or the system-wide configuration
1184file are not available they will be ignored. If the repository configuration
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1185file 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]1186error code. However, in neither case will an error message be issued.</p></div>
Junio C Hamano8401f142013-07-12 22:47:46[diff] [blame]1187<div class="paragraph"><p>The files are read in the order given above, with last value found taking
1188precedence over values read earlier. When multiple values are taken then all
1189values of a key from all files will be used.</p></div>
Junio C Hamanoe7808d72016-08-26 21:48:01[diff] [blame]1190<div class="paragraph"><p>You may override individual configuration parameters when running any git
1191command by using the <code>-c</code> option. See <a href="git.html">git(1)</a> for details.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1192<div class="paragraph"><p>All writing options will per default write to the repository specific
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1193configuration file. Note that this also affects options like <code>--replace-all</code>
1194and <code>--unset</code>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]1195<div class="paragraph"><p>You can override these rules either by command-line options or by environment
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1196variables. The <code>--global</code> and the <code>--system</code> options will limit the file used
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1197to the global or system-wide file respectively. The <code>GIT_CONFIG</code> environment
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1198variable has a similar effect, but you can specify any filename you want.</p></div>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]1199</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1200</div>
1201<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1202<h2 id="_environment">ENVIRONMENT</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1203<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1204<div class="dlist"><dl>
1205<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1206GIT_CONFIG
1207</dt>
1208<dd>
1209<p>
1210 Take the configuration from the given file instead of .git/config.
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]1211 Using the "--global" option forces this to ~/.gitconfig. Using the
1212 "--system" option forces this to $(prefix)/etc/gitconfig.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1213</p>
1214</dd>
Junio C Hamanoeec745b2013-01-07 08:08:20[diff] [blame]1215<dt class="hdlist1">
1216GIT_CONFIG_NOSYSTEM
1217</dt>
1218<dd>
1219<p>
1220 Whether to skip reading settings from the system-wide
1221 $(prefix)/etc/gitconfig file. See <a href="git.html">git(1)</a> for details.
1222</p>
1223</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1224</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1225<div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1226</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1227</div>
1228<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1229<h2 id="EXAMPLES">EXAMPLES</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1230<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1231<div class="paragraph"><p>Given a .git/config like this:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1232<div class="literalblock">
1233<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1234<pre><code>#
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1235# This is the config file, and
1236# a '#' or ';' character indicates
1237# a comment
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1238#</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1239</div></div>
1240<div class="literalblock">
1241<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1242<pre><code>; core variables
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1243[core]
1244 ; Don't trust file modes
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1245 filemode = false</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1246</div></div>
1247<div class="literalblock">
1248<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1249<pre><code>; Our diff algorithm
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1250[diff]
Junio C Hamano85c71572008-07-28 00:03:31[diff] [blame]1251 external = /usr/local/bin/diff-wrapper
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1252 renames = true</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1253</div></div>
1254<div class="literalblock">
1255<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1256<pre><code>; Proxy settings
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1257[core]
Junio C Hamano53850262012-08-29 23:03:49[diff] [blame]1258 gitproxy=proxy-command for kernel.org
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1259 gitproxy=default-proxy ; for all the rest</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1260</div></div>
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1261<div class="literalblock">
1262<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1263<pre><code>; HTTP
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1264[http]
1265 sslVerify
1266[http "https://weak.example.com"]
1267 sslVerify = false
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1268 cookieFile = /tmp/cookie.txt</code></pre>
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1269</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1270<div class="paragraph"><p>you can set the filemode to true with</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1271<div class="listingblock">
1272<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1273<pre><code>% git config core.filemode true</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1274</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1275<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]1276what URL they apply to. Here is how to change the entry for kernel.org
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1277to "ssh".</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1278<div class="listingblock">
1279<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1280<pre><code>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1281</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1282<div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
1283<div class="paragraph"><p>To delete the entry for renames, do</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1284<div class="listingblock">
1285<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1286<pre><code>% git config --unset diff.renames</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1287</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1288<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]1289you have to provide a regex matching the value of exactly one line.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1290<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]1291<div class="listingblock">
1292<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1293<pre><code>% git config --get core.filemode</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1294</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1295<div class="paragraph"><p>or</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1296<div class="listingblock">
1297<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1298<pre><code>% git config core.filemode</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1299</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1300<div class="paragraph"><p>or, to query a multivar:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1301<div class="listingblock">
1302<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1303<pre><code>% git config --get core.gitproxy "for kernel.org$"</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1304</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1305<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]1306<div class="listingblock">
1307<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1308<pre><code>% git config --get-all core.gitproxy</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1309</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1310<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]1311new one with</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1312<div class="listingblock">
1313<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1314<pre><code>% git config --replace-all core.gitproxy ssh</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1315</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1316<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]1317i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1318<div class="listingblock">
1319<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1320<pre><code>% git config core.gitproxy ssh '! for '</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1321</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1322<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]1323<div class="listingblock">
1324<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1325<pre><code>% git config section.key value '[!]'</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1326</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1327<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]1328<div class="listingblock">
1329<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1330<pre><code>% git config --add core.gitproxy '"proxy-command" for example.com'</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1331</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1332<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]1333script:</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1334<div class="listingblock">
1335<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1336<pre><code>#!/bin/sh
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1337WS=$(git config --get-color color.diff.whitespace "blue reverse")
1338RESET=$(git config --get-color "" "reset")
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1339echo "${WS}your whitespace color or blue reverse${RESET}"</code></pre>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1340</div></div>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1341<div class="paragraph"><p>For URLs in <code>https://weak.example.com</code>, <code>http.sslVerify</code> is set to
1342false, while it is set to <code>true</code> for all others:</p></div>
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1343<div class="listingblock">
1344<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1345<pre><code>% git config --bool --get-urlmatch http.sslverify https://good.example.com
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1346true
1347% git config --bool --get-urlmatch http.sslverify https://weak.example.com
1348false
1349% git config --get-urlmatch http https://weak.example.com
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1350http.cookieFile /tmp/cookie.txt
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1351http.sslverify false</code></pre>
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1352</div></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1353</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1354</div>
1355<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1356<h2 id="_configuration_file">CONFIGURATION FILE</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1357<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1358<div class="paragraph"><p>The Git configuration file contains a number of variables that affect
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1359the Git commands' behavior. The <code>.git/config</code> file in each repository
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1360is used to store the configuration for that repository, and
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1361<code>$HOME/.gitconfig</code> is used to store a per-user configuration as
1362fallback values for the <code>.git/config</code> file. The file <code>/etc/gitconfig</code>
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1363can be used to store a system-wide default configuration.</p></div>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1364<div class="paragraph"><p>The configuration variables are used by both the Git plumbing
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1365and the porcelains. The variables are divided into sections, wherein
1366the fully qualified variable name of the variable itself is the last
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1367dot-separated segment and the section name is everything before the last
Junio C Hamano81d540a2012-03-02 19:52:47[diff] [blame]1368dot. The variable names are case-insensitive, allow only alphanumeric
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1369characters and <code>-</code>, and must start with an alphabetic character. Some
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1370variables may appear multiple times; we say then that the variable is
1371multivalued.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1372<div class="sect2">
1373<h3 id="_syntax">Syntax</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1374<div class="paragraph"><p>The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1375ignored. The <em>#</em> and <em>;</em> characters begin comments to the end of line,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1376blank lines are ignored.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1377<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]1378the name of the section in square brackets and continues until the next
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1379section begins. Section names are case-insensitive. Only alphanumeric
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1380characters, <code>-</code> and <code>.</code> are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1381must belong to some section, which means that there must be a section
1382header before the first setting of a variable.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1383<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]1384put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]1385in the section header, like in the example below:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1386<div class="listingblock">
1387<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1388<pre><code> [section "subsection"]</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1389</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1390<div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1391newline (doublequote <code>"</code> and backslash can be included by escaping them
1392as <code>\"</code> and <code>\\</code>, respectively). Section headers cannot span multiple
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1393lines. Variables may belong directly to a section or to a given subsection.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1394You can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1395don&#8217;t need to.</p></div>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1396<div class="paragraph"><p>There is also a deprecated <code>[section.subsection]</code> syntax. With this
Junio C Hamano6231f822011-10-24 05:18:52[diff] [blame]1397syntax, the subsection name is converted to lower-case and is also
1398compared case sensitively. These subsection names follow the same
1399restrictions as section names.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1400<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]1401header) are recognized as setting variables, in the form
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1402<em>name = value</em> (or just <em>name</em>, which is a short-hand to say that
1403the variable is the boolean "true").
Junio C Hamano81d540a2012-03-02 19:52:47[diff] [blame]1404The variable names are case-insensitive, allow only alphanumeric characters
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1405and <code>-</code>, and must start with an alphabetic character.</p></div>
1406<div class="paragraph"><p>A line that defines a value can be continued to the next line by
1407ending it with a <code>\</code>; the backquote and the end-of-line are
1408stripped. Leading whitespaces after <em>name =</em>, the remainder of the
1409line after the first comment character <em>#</em> or <em>;</em>, and trailing
1410whitespaces of the line are discarded unless they are enclosed in
1411double quotes. Internal whitespaces within the value are retained
1412verbatim.</p></div>
1413<div class="paragraph"><p>Inside double quotes, double quote <code>"</code> and backslash <code>\</code> characters
1414must be escaped: use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p></div>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1415<div class="paragraph"><p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized:
1416<code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB)
1417and <code>\b</code> for backspace (BS). Other char escape sequences (including octal
Junio C Hamanod75148a2014-04-08 19:48:38[diff] [blame]1418escape sequences) are invalid.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1419</div>
1420<div class="sect2">
1421<h3 id="_includes">Includes</h3>
Junio C Hamano6b6144f2017-05-29 06:20:15[diff] [blame]1422<div class="paragraph"><p>The <code>include</code> and <code>includeIf</code> sections allow you to include config
1423directives from another source. These sections behave identically to
1424each other with the exception that <code>includeIf</code> sections may be ignored
1425if their condition does not evaluate to true; see "Conditional includes"
1426below.</p></div>
Junio C Hamanocb06ef92017-03-21 22:40:14[diff] [blame]1427<div class="paragraph"><p>You can include a config file from another by setting the special
Junio C Hamano6b6144f2017-05-29 06:20:15[diff] [blame]1428<code>include.path</code> (or <code>includeIf.*.path</code>) variable to the name of the file
1429to be included. The variable takes a pathname as its value, and is
1430subject to tilde expansion. These variables can be given multiple times.</p></div>
1431<div class="paragraph"><p>The contents of the included file are inserted immediately, as if they
1432had been found at the location of the include directive. If the value of the
1433variable is a relative path, the path is considered to
Junio C Hamanocb06ef92017-03-21 22:40:14[diff] [blame]1434be relative to the configuration file in which the include directive
1435was found. See below for examples.</p></div>
1436</div>
1437<div class="sect2">
1438<h3 id="_conditional_includes">Conditional includes</h3>
1439<div class="paragraph"><p>You can include a config file from another conditionally by setting a
1440<code>includeIf.&lt;condition&gt;.path</code> variable to the name of the file to be
Junio C Hamano6b6144f2017-05-29 06:20:15[diff] [blame]1441included.</p></div>
Junio C Hamanocb06ef92017-03-21 22:40:14[diff] [blame]1442<div class="paragraph"><p>The condition starts with a keyword followed by a colon and some data
1443whose format and meaning depends on the keyword. Supported keywords
1444are:</p></div>
1445<div class="dlist"><dl>
1446<dt class="hdlist1">
1447<code>gitdir</code>
1448</dt>
1449<dd>
1450<p>
1451 The data that follows the keyword <code>gitdir:</code> is used as a glob
1452 pattern. If the location of the .git directory matches the
1453 pattern, the include condition is met.
1454</p>
1455<div class="paragraph"><p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1456environment variable. If the repository is auto discovered via a .git
1457file (e.g. from submodules, or a linked worktree), the .git location
1458would be the final location where the .git directory is, not where the
1459.git file is.</p></div>
1460<div class="paragraph"><p>The pattern can contain standard globbing wildcards and two additional
1461ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1462refer to <a href="gitignore.html">gitignore(5)</a> for details. For convenience:</p></div>
1463<div class="ulist"><ul>
1464<li>
1465<p>
1466If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1467 content of the environment variable <code>HOME</code>.
1468</p>
1469</li>
1470<li>
1471<p>
1472If the pattern starts with <code>./</code>, it is replaced with the directory
1473 containing the current config file.
1474</p>
1475</li>
1476<li>
1477<p>
1478If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1479 will be automatically prepended. For example, the pattern <code>foo/bar</code>
1480 becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.
1481</p>
1482</li>
1483<li>
1484<p>
1485If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1486 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1487 matches "foo" and everything inside, recursively.
1488</p>
1489</li>
1490</ul></div>
1491</dd>
1492<dt class="hdlist1">
1493<code>gitdir/i</code>
1494</dt>
1495<dd>
1496<p>
1497 This is the same as <code>gitdir</code> except that matching is done
1498 case-insensitively (e.g. on case-insensitive file sytems)
1499</p>
1500</dd>
1501</dl></div>
1502<div class="paragraph"><p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p></div>
1503<div class="ulist"><ul>
1504<li>
1505<p>
1506Symlinks in <code>$GIT_DIR</code> are not resolved before matching.
1507</p>
1508</li>
1509<li>
1510<p>
Junio C Hamanod88ba732017-05-30 04:14:20[diff] [blame^]1511Both the symlink &amp; realpath versions of paths will be matched
1512 outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1513 /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1514 will match.
1515</p>
1516<div class="paragraph"><p>This was not the case in the initial release of this feature in
1517v2.13.0, which only matched the realpath version. Configuration that
1518wants to be compatible with the initial release of this feature needs
1519to either specify only the realpath version, or both versions.</p></div>
1520</li>
1521<li>
1522<p>
Junio C Hamanocb06ef92017-03-21 22:40:14[diff] [blame]1523Note that "../" is not special and will match literally, which is
1524 unlikely what you want.
1525</p>
1526</li>
1527</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1528</div>
1529<div class="sect2">
1530<h3 id="_example">Example</h3>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1531<div class="literalblock">
1532<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1533<pre><code># Core variables
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1534[core]
1535 ; Don't trust file modes
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1536 filemode = false</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1537</div></div>
1538<div class="literalblock">
1539<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1540<pre><code># Our diff algorithm
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1541[diff]
Junio C Hamano85c71572008-07-28 00:03:31[diff] [blame]1542 external = /usr/local/bin/diff-wrapper
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1543 renames = true</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1544</div></div>
1545<div class="literalblock">
1546<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1547<pre><code>[branch "devel"]
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1548 remote = origin
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1549 merge = refs/heads/devel</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1550</div></div>
1551<div class="literalblock">
1552<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1553<pre><code># Proxy settings
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1554[core]
Junio C Hamanoc71a8732007-08-04 00:27:26[diff] [blame]1555 gitProxy="ssh" for "kernel.org"
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1556 gitProxy=default-proxy ; for the rest</code></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1557</div></div>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]1558<div class="literalblock">
1559<div class="content">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1560<pre><code>[include]
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]1561 path = /path/to/foo.inc ; include by absolute path
Junio C Hamano6b6144f2017-05-29 06:20:15[diff] [blame]1562 path = foo.inc ; find "foo.inc" relative to the current file
1563 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory</code></pre>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]1564</div></div>
Junio C Hamanocb06ef92017-03-21 22:40:14[diff] [blame]1565<div class="literalblock">
1566<div class="content">
1567<pre><code>; include if $GIT_DIR is /path/to/foo/.git
1568[includeIf "gitdir:/path/to/foo/.git"]
1569 path = /path/to/foo.inc</code></pre>
1570</div></div>
1571<div class="literalblock">
1572<div class="content">
1573<pre><code>; include for all repositories inside /path/to/group
1574[includeIf "gitdir:/path/to/group/"]
1575 path = /path/to/foo.inc</code></pre>
1576</div></div>
1577<div class="literalblock">
1578<div class="content">
1579<pre><code>; include for all repositories inside $HOME/to/group
1580[includeIf "gitdir:~/to/group/"]
1581 path = /path/to/foo.inc</code></pre>
1582</div></div>
Junio C Hamano6b6144f2017-05-29 06:20:15[diff] [blame]1583<div class="literalblock">
1584<div class="content">
1585<pre><code>; relative paths are always relative to the including
1586; file (if the condition is true); their location is not
1587; affected by the condition
1588[includeIf "gitdir:/path/to/group/"]
1589 path = foo.inc</code></pre>
1590</div></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1591</div>
1592<div class="sect2">
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1593<h3 id="_values">Values</h3>
1594<div class="paragraph"><p>Values of many variables are treated as a simple string, but there
1595are variables that take values of specific types and there are rules
1596as to how to spell them.</p></div>
1597<div class="dlist"><dl>
1598<dt class="hdlist1">
1599boolean
1600</dt>
1601<dd>
1602<p>
1603 When a variable is said to take a boolean value, many
1604 synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1605 case-insensitive.
1606</p>
1607<div class="dlist"><dl>
1608<dt class="hdlist1">
1609true
1610</dt>
1611<dd>
1612<p>
1613Boolean true can be spelled as <code>yes</code>, <code>on</code>, <code>true</code>,
1614 or <code>1</code>. Also, a variable defined without <code>= &lt;value&gt;</code>
1615 is taken as true.
1616</p>
1617</dd>
1618<dt class="hdlist1">
1619false
1620</dt>
1621<dd>
1622<p>
1623Boolean false can be spelled as <code>no</code>, <code>off</code>,
1624 <code>false</code>, or <code>0</code>.
1625</p>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1626<div class="paragraph"><p>When converting value to the canonical form using <code>--bool</code> type
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1627specifier; <em>git config</em> will ensure that the output is "true" or
1628"false" (spelled in lowercase).</p></div>
1629</dd>
1630</dl></div>
1631</dd>
1632<dt class="hdlist1">
1633integer
1634</dt>
1635<dd>
1636<p>
1637 The value for many variables that specify various sizes can
1638 be suffixed with <code>k</code>, <code>M</code>,&#8230; to mean "scale the number by
1639 1024", "by 1024x1024", etc.
1640</p>
1641</dd>
1642<dt class="hdlist1">
1643color
1644</dt>
1645<dd>
1646<p>
Junio C Hamano48931e22016-07-11 20:08:47[diff] [blame]1647 The value for a variable that takes a color is a list of
1648 colors (at most two, one for foreground and one for background)
1649 and attributes (as many as you want), separated by spaces.
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1650</p>
Junio C Hamano48931e22016-07-11 20:08:47[diff] [blame]1651<div class="paragraph"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>, <code>yellow</code>,
1652<code>blue</code>, <code>magenta</code>, <code>cyan</code> and <code>white</code>. The first color given is the
1653foreground; the second is the background.</p></div>
1654<div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
1655256-color mode (but note that not all terminals may support this). If
1656your terminal supports it, you may also specify 24-bit RGB values as
1657hex, like <code>#ff0ab3</code>.</p></div>
1658<div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
1659<code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
1660The position of any attributes with respect to the colors
1661(before, after, or in between), doesn&#8217;t matter. Specific attributes may
1662be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
1663<code>no-ul</code>, etc).</p></div>
Junio C Hamanob86c8032017-02-02 21:50:19[diff] [blame]1664<div class="paragraph"><p>An empty color string produces no color effect at all. This can be used
1665to avoid coloring specific elements without disabling color entirely.</p></div>
Junio C Hamano48931e22016-07-11 20:08:47[diff] [blame]1666<div class="paragraph"><p>For git&#8217;s pre-defined color slots, the attributes are meant to be reset
1667at the beginning of each item in the colored output. So setting
1668<code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
1669plain <code>black</code>, even if the previous thing on the same output line (e.g.
1670opening parenthesis before the list of branch names in <code>log --decorate</code>
1671output) is set to be painted with <code>bold</code> or some other attribute.
1672However, custom log formats may do more complicated and layered
1673coloring, and the negated forms may be useful there.</p></div>
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1674</dd>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]1675<dt class="hdlist1">
1676pathname
1677</dt>
1678<dd>
1679<p>
1680 A variable that takes a pathname value can be given a
1681 string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual
1682 tilde expansion happens to such a string: <code>~/</code>
1683 is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
1684 specified user&#8217;s home directory.
1685</p>
1686</dd>
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]1687</dl></div>
1688</div>
1689<div class="sect2">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1690<h3 id="_variables">Variables</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1691<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]1692For command-specific variables, you will find a more detailed description
Junio C Hamano52b6ba32014-04-01 00:26:48[diff] [blame]1693in the appropriate manual page.</p></div>
1694<div class="paragraph"><p>Other git-related tools may and do use their own variables. When
1695inventing new variables for use in your own tool, make sure their
1696names do not conflict with those that are used by Git itself and
1697other popular tools, and describe them in your documentation.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1698<div class="dlist"><dl>
1699<dt class="hdlist1">
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1700advice.*
1701</dt>
1702<dd>
1703<p>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1704 These variables control various optional help messages designed to
1705 aid new users. All <em>advice.*</em> variables default to <em>true</em>, and you
1706 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]1707</p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1708<div class="openblock">
1709<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1710<div class="dlist"><dl>
1711<dt class="hdlist1">
Junio C Hamanoabad6da2013-01-06 09:06:32[diff] [blame]1712pushUpdateRejected
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1713</dt>
1714<dd>
1715<p>
Junio C Hamano0c1b64e2012-04-20 23:50:49[diff] [blame]1716 Set this variable to <em>false</em> if you want to disable
Junio C Hamano1d669b82014-03-11 21:36:00[diff] [blame]1717 <em>pushNonFFCurrent</em>,
Junio C Hamano3f2ed6f2013-02-04 19:24:09[diff] [blame]1718 <em>pushNonFFMatching</em>, <em>pushAlreadyExists</em>,
1719 <em>pushFetchFirst</em>, and <em>pushNeedsForce</em>
Junio C Hamanoabad6da2013-01-06 09:06:32[diff] [blame]1720 simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49[diff] [blame]1721</p>
1722</dd>
1723<dt class="hdlist1">
1724pushNonFFCurrent
1725</dt>
1726<dd>
1727<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1728 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]1729 non-fast-forward update to the current branch.
1730</p>
1731</dd>
1732<dt class="hdlist1">
Junio C Hamano0c1b64e2012-04-20 23:50:49[diff] [blame]1733pushNonFFMatching
1734</dt>
1735<dd>
1736<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1737 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]1738 <em>matching refs</em> explicitly (i.e. you used <em>:</em>, or
1739 specified a refspec that isn&#8217;t your current branch) and
1740 it resulted in a non-fast-forward error.
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1741</p>
1742</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1743<dt class="hdlist1">
Junio C Hamanoabad6da2013-01-06 09:06:32[diff] [blame]1744pushAlreadyExists
1745</dt>
1746<dd>
1747<p>
1748 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
1749 does not qualify for fast-forwarding (e.g., a tag.)
1750</p>
1751</dd>
1752<dt class="hdlist1">
Junio C Hamano3f2ed6f2013-02-04 19:24:09[diff] [blame]1753pushFetchFirst
1754</dt>
1755<dd>
1756<p>
1757 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
1758 tries to overwrite a remote ref that points at an
1759 object we do not have.
1760</p>
1761</dd>
1762<dt class="hdlist1">
1763pushNeedsForce
1764</dt>
1765<dd>
1766<p>
1767 Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
1768 tries to overwrite a remote ref that points at an
Junio C Hamanoe6f28d02013-09-17 21:34:00[diff] [blame]1769 object that is not a commit-ish, or make the remote
1770 ref point at an object that is not a commit-ish.
Junio C Hamano3f2ed6f2013-02-04 19:24:09[diff] [blame]1771</p>
1772</dd>
1773<dt class="hdlist1">
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1774statusHints
1775</dt>
1776<dd>
1777<p>
Junio C Hamano644936c2012-06-28 23:05:14[diff] [blame]1778 Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10[diff] [blame]1779 state in the output of <a href="git-status.html">git-status(1)</a>, in
Junio C Hamano644936c2012-06-28 23:05:14[diff] [blame]1780 the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10[diff] [blame]1781 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
1782 by <a href="git-checkout.html">git-checkout(1)</a> when switching branch.
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1783</p>
1784</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1785<dt class="hdlist1">
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]1786statusUoption
1787</dt>
1788<dd>
1789<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]1790 Advise to consider using the <code>-u</code> option to <a href="git-status.html">git-status(1)</a>
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]1791 when the command takes more than 2 seconds to enumerate untracked
1792 files.
1793</p>
1794</dd>
1795<dt class="hdlist1">
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1796commitBeforeMerge
1797</dt>
1798<dd>
1799<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1800 Advice shown when <a href="git-merge.html">git-merge(1)</a> refuses to
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]1801 merge to avoid overwriting local changes.
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1802</p>
1803</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1804<dt class="hdlist1">
Junio C Hamanoa9701f02010-01-21 00:42:16[diff] [blame]1805resolveConflict
1806</dt>
1807<dd>
1808<p>
Junio C Hamano5dab5a92013-02-25 18:51:24[diff] [blame]1809 Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16[diff] [blame]1810 prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16[diff] [blame]1811</p>
1812</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1813<dt class="hdlist1">
Junio C Hamanoa9701f02010-01-21 00:42:16[diff] [blame]1814implicitIdentity
1815</dt>
1816<dd>
1817<p>
1818 Advice on how to set your identity configuration when
1819 your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1820 domain name.
Junio C Hamanoa9701f02010-01-21 00:42:16[diff] [blame]1821</p>
1822</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1823<dt class="hdlist1">
Junio C Hamano74a198f2010-02-22 00:13:31[diff] [blame]1824detachedHead
1825</dt>
1826<dd>
1827<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1828 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]1829 move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1830 a local branch after the fact.
Junio C Hamano74a198f2010-02-22 00:13:31[diff] [blame]1831</p>
1832</dd>
Junio C Hamanobb300642012-07-22 21:09:14[diff] [blame]1833<dt class="hdlist1">
1834amWorkDir
1835</dt>
1836<dd>
1837<p>
1838 Advice that shows the location of the patch file when
1839 <a href="git-am.html">git-am(1)</a> fails to apply it.
1840</p>
1841</dd>
Junio C Hamano8ab94942013-06-24 21:55:30[diff] [blame]1842<dt class="hdlist1">
1843rmHints
1844</dt>
1845<dd>
1846<p>
1847 In case of failure in the output of <a href="git-rm.html">git-rm(1)</a>,
1848 show directions on how to proceed from the current state.
1849</p>
1850</dd>
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1851</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1852</div></div>
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]1853</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1854<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1855core.fileMode
1856</dt>
1857<dd>
1858<p>
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1859 Tells Git if the executable bit of files in the working tree
1860 is to be honored.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1861</p>
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1862<div class="paragraph"><p>Some filesystems lose the executable bit when a file that is
Junio C Hamano6b6144f2017-05-29 06:20:15[diff] [blame]1863marked as executable is checked out, or checks out a
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1864non-executable file with executable bit on.
1865<a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
1866to see if it handles the executable bit correctly
1867and this variable is automatically set as necessary.</p></div>
1868<div class="paragraph"><p>A repository, however, may be on a filesystem that handles
1869the filemode correctly, and this variable is set to <em>true</em>
1870when created, but later may be made accessible from another
1871environment that loses the filemode (e.g. exporting ext4 via
1872CIFS mount, visiting a Cygwin created repository with
1873Git for Windows or Eclipse).
1874In such a case it may be necessary to set this variable to <em>false</em>.
1875See <a href="git-update-index.html">git-update-index(1)</a>.</p></div>
1876<div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1877</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1878<dt class="hdlist1">
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]1879core.hideDotFiles
1880</dt>
1881<dd>
1882<p>
1883 (Windows-only) If true, mark newly-created directories and files whose
1884 name starts with a dot as hidden. If <em>dotGitOnly</em>, only the <code>.git/</code>
1885 directory is hidden, but no other files starting with a dot. The
1886 default mode is <em>dotGitOnly</em>.
1887</p>
1888</dd>
1889<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1890core.ignoreCase
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1891</dt>
1892<dd>
1893<p>
1894 If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1895 Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1896 like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1897 "makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1898 it is really the same file, and continue to remember it as
1899 "Makefile".
1900</p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1901<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 Hamano322c6242015-03-23 21:32:46[diff] [blame]1902will probe and set core.ignoreCase true if appropriate when the repository
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]1903is created.</p></div>
1904</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1905<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1906core.precomposeUnicode
Junio C Hamanob61a7772012-07-13 23:34:48[diff] [blame]1907</dt>
1908<dd>
1909<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1910 This option is only used by Mac OS implementation of Git.
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1911 When core.precomposeUnicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48[diff] [blame]1912 of filenames done by Mac OS. This is useful when sharing a repository
1913 between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1914 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
1915 When false, file names are handled fully transparent by Git,
1916 which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48[diff] [blame]1917</p>
1918</dd>
1919<dt class="hdlist1">
Junio C Hamano30758bd2014-12-18 20:44:14[diff] [blame]1920core.protectHFS
1921</dt>
1922<dd>
1923<p>
1924 If set to true, do not allow checkout of paths that would
1925 be considered equivalent to <code>.git</code> on an HFS+ filesystem.
1926 Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
1927</p>
1928</dd>
1929<dt class="hdlist1">
1930core.protectNTFS
1931</dt>
1932<dd>
1933<p>
1934 If set to true, do not allow checkout of paths that would
1935 cause problems with the NTFS filesystem, e.g. conflict with
1936 8.3 "short" names.
1937 Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
1938</p>
1939</dd>
1940<dt class="hdlist1">
Junio C Hamano90ccff32008-07-29 08:17:24[diff] [blame]1941core.trustctime
1942</dt>
1943<dd>
1944<p>
1945 If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]1946 working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24[diff] [blame]1947 is regularly modified by something outside Git (file system
1948 crawlers and some backup systems).
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1949 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]1950</p>
1951</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1952<dt class="hdlist1">
Junio C Hamano3d4a66d2017-03-17 21:07:26[diff] [blame]1953core.splitIndex
1954</dt>
1955<dd>
1956<p>
1957 If true, the split-index feature of the index will be used.
1958 See <a href="git-update-index.html">git-update-index(1)</a>. False by default.
1959</p>
1960</dd>
1961<dt class="hdlist1">
Junio C Hamano9099a7c2016-02-10 23:42:05[diff] [blame]1962core.untrackedCache
1963</dt>
1964<dd>
1965<p>
1966 Determines what to do about the untracked cache feature of the
1967 index. It will be kept, if this variable is unset or set to
1968 <code>keep</code>. It will automatically be added if set to <code>true</code>. And
1969 it will automatically be removed, if set to <code>false</code>. Before
1970 setting it to <code>true</code>, you should check that mtime is working
1971 properly on your system.
1972 See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default.
1973</p>
1974</dd>
1975<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1976core.checkStat
Junio C Hamano4cfed0c2013-01-30 17:58:54[diff] [blame]1977</dt>
1978<dd>
1979<p>
1980 Determines which stat fields to match between the index
1981 and work tree. The user can set this to <em>default</em> or
1982 <em>minimal</em>. Default (or explicitly <em>default</em>), is to check
1983 all fields, including the sub-second part of mtime and ctime.
1984</p>
1985</dd>
1986<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1987core.quotePath
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]1988</dt>
1989<dd>
1990<p>
Junio C Hamano0f6f3bf2017-03-13 07:01:53[diff] [blame]1991 Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
1992 quote "unusual" characters in the pathname by enclosing the
1993 pathname in double-quotes and escaping those characters with
1994 backslashes in the same way C escapes control characters (e.g.
1995 <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
1996 values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
1997 UTF-8). If this variable is set to false, bytes higher than
1998 0x80 are not considered "unusual" any more. Double-quotes,
1999 backslash and control characters are always escaped regardless
2000 of the setting of this variable. A simple space character is
2001 not considered "unusual". Many commands can output pathnames
2002 completely verbatim using the <code>-z</code> option. The default value
2003 is true.
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]2004</p>
2005</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2006<dt class="hdlist1">
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]2007core.eol
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]2008</dt>
2009<dd>
2010<p>
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]2011 Sets the line ending type to use in the working directory for
Junio C Hamanof2a3a752016-05-23 22:54:39[diff] [blame]2012 files that have the <code>text</code> property set when core.autocrlf is false.
2013 Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
2014 native line ending. The default value is <code>native</code>. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2015 <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]2016 conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]2017</p>
2018</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2019<dt class="hdlist1">
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]2020core.safecrlf
2021</dt>
2022<dd>
2023<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2024 If true, makes Git check if converting <code>CRLF</code> is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]2025 end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]2026 modifies a file in the work tree either directly or indirectly.
2027 For example, committing a file followed by checking out the
2028 same file should yield the original file in the work tree. If
2029 this is not the case for the current setting of
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2030 <code>core.autocrlf</code>, Git will reject the file. The variable can
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2031 be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]2032 irreversible conversion but continue the operation.
2033</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2034<div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2035When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]2036CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2037CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]2038files this is the right thing to do: it corrects line endings
2039such that we have only LF line endings in the repository.
2040But for binary files that are accidentally classified as text the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2041conversion can corrupt data.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2042<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]2043setting the conversion type explicitly in .gitattributes. Right
2044after committing you still have the original file in your work
2045tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2046Git that this file is binary and Git will handle the file
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2047appropriately.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2048<div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]2049mixed line endings and the undesired effect of corrupting binary
2050files cannot be distinguished. In both cases CRLFs are removed
2051in an irreversible way. For text files this is the right thing
2052to do because CRLFs are line endings, while for binary files
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2053converting CRLFs corrupts data.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2054<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]2055file identical to the original file for a different setting of
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2056<code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one. For
2057example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
2058and could later be checked out with <code>core.eol=crlf</code>, in which case the
2059resulting file would contain <code>CRLF</code>, although the original file
2060contained <code>LF</code>. However, in both work trees the line endings would be
2061consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed. A
2062file with mixed line endings would be reported by the <code>core.safecrlf</code>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2063mechanism.</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]2064</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2065<dt class="hdlist1">
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]2066core.autocrlf
2067</dt>
2068<dd>
2069<p>
Junio C Hamanoeed15af2016-07-25 22:49:42[diff] [blame]2070 Setting this variable to "true" is the same as setting
2071 the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
2072 Set to true if you want to have <code>CRLF</code> line endings in your
2073 working directory and the repository has LF line endings.
2074 This variable can be set to <em>input</em>,
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]2075 in which case no output conversion is performed.
2076</p>
2077</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2078<dt class="hdlist1">
Junio C Hamanoaa83a7d2007-03-05 02:37:29[diff] [blame]2079core.symlinks
2080</dt>
2081<dd>
2082<p>
2083 If false, symbolic links are checked out as small plain files that
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2084 contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
2085 <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]2086 file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]2087 symbolic links.
Junio C Hamanoaa83a7d2007-03-05 02:37:29[diff] [blame]2088</p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2089<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]2090will probe and set core.symlinks false if appropriate when the repository
2091is created.</p></div>
Junio C Hamanoaa83a7d2007-03-05 02:37:29[diff] [blame]2092</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2093<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2094core.gitProxy
2095</dt>
2096<dd>
2097<p>
2098 A "proxy command" to execute (as <em>command host port</em>) instead
2099 of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2100 using the Git protocol for fetching. If the variable value is
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2101 in the "COMMAND for DOMAIN" format, the command is applied only
2102 on hostnames ending with the specified domain string. This variable
2103 may be set multiple times and is matched in the given order;
2104 the first match wins.
2105</p>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]2106<div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2107(which always applies universally, without the special "for"
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2108handling).</p></div>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2109<div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]2110specify that no proxy be used for a given domain pattern.
2111This is useful for excluding servers inside a firewall from
2112proxy use, while defaulting to a common proxy for external domains.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2113</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2114<dt class="hdlist1">
Junio C Hamano1a1b8472016-07-19 21:37:13[diff] [blame]2115core.sshCommand
2116</dt>
2117<dd>
2118<p>
2119 If this variable is set, <code>git fetch</code> and <code>git push</code> will
2120 use the specified command instead of <code>ssh</code> when they need to
2121 connect to a remote system. The command is in the same form as
2122 the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
2123 when the environment variable is set.
2124</p>
2125</dd>
2126<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2127core.ignoreStat
2128</dt>
2129<dd>
2130<p>
Junio C Hamanoe8acc8e2015-01-14 22:01:34[diff] [blame]2131 If true, Git will avoid using lstat() calls to detect if files have
2132 changed by setting the "assume-unchanged" bit for those tracked files
2133 which it has updated identically in both the index and working tree.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2134</p>
Junio C Hamanoe8acc8e2015-01-14 22:01:34[diff] [blame]2135<div class="paragraph"><p>When files are modified outside of Git, the user will need to stage
2136the modified files explicitly (e.g. see <em>Examples</em> section in
2137<a href="git-update-index.html">git-update-index(1)</a>).
2138Git will not normally detect changes to those files.</p></div>
2139<div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as
2140CIFS/Microsoft Windows.</p></div>
2141<div class="paragraph"><p>False by default.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2142</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2143<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2144core.preferSymlinkRefs
2145</dt>
2146<dd>
2147<p>
2148 Instead of the default "symref" format for HEAD
2149 and other symbolic reference files, use symbolic links.
2150 This is sometimes needed to work with old scripts that
2151 expect HEAD to be a symbolic link.
2152</p>
2153</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2154<dt class="hdlist1">
Junio C Hamano1025e752007-02-23 07:21:26[diff] [blame]2155core.bare
2156</dt>
2157<dd>
2158<p>
2159 If true this repository is assumed to be <em>bare</em> and has no
2160 working directory associated with it. If this is the case a
2161 number of commands that require a working directory will be
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2162 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]2163</p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2164<div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
2165<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]2166repository that ends in "/.git" is assumed to be not bare (bare =
2167false), while all other repositories are assumed to be bare (bare
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2168= true).</p></div>
Junio C Hamano1025e752007-02-23 07:21:26[diff] [blame]2169</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2170<dt class="hdlist1">
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]2171core.worktree
2172</dt>
2173<dd>
2174<p>
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]2175 Set the path to the root of the working tree.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]2176 If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
Junio C Hamano4cc4a842015-05-11 22:41:02[diff] [blame]2177 is ignored and not used for determining the root of working tree.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]2178 This can be overridden by the <code>GIT_WORK_TREE</code> environment
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]2179 variable and the <code>--work-tree</code> command-line option.
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]2180 The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]2181 the .git directory, which is either specified by --git-dir
2182 or GIT_DIR, or automatically discovered.
2183 If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27[diff] [blame]2184 --work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]2185 the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52[diff] [blame]2186 of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]2187</p>
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]2188<div class="paragraph"><p>Note that this variable is honored even when set in a configuration
2189file in a ".git" subdirectory of a directory and its value differs
2190from the latter directory (e.g. "/path/to/.git/config" has
2191core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2192misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52[diff] [blame]2193still use "/different/path" as the root of the work tree and can cause
2194confusion unless you know what you are doing (e.g. you are creating a
2195read-only snapshot of the same index to a location different from the
2196repository&#8217;s usual working tree).</p></div>
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]2197</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2198<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2199core.logAllRefUpdates
2200</dt>
2201<dd>
2202<p>
Junio C Hamanocae86272007-08-21 02:20:49[diff] [blame]2203 Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]2204 "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]2205 SHA-1, the date/time and the reason of the update, but
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2206 only when the file exists. If this configuration
Junio C Hamanoa8e42612017-02-03 21:44:07[diff] [blame]2207 variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]2208 file is automatically created for branch heads (i.e. under
Junio C Hamanoa8e42612017-02-03 21:44:07[diff] [blame]2209 <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
2210 note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
2211 If it is set to <code>always</code>, then a missing reflog is automatically
2212 created for any ref under <code>refs/</code>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2213</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2214<div class="paragraph"><p>This information can be used to determine what commit
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2215was the tip of a branch "2 days ago".</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2216<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]2217a working directory associated with it, and false by
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2218default in a bare repository.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2219</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2220<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2221core.repositoryFormatVersion
2222</dt>
2223<dd>
2224<p>
2225 Internal variable identifying the repository format and layout
2226 version.
2227</p>
2228</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2229<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2230core.sharedRepository
2231</dt>
2232<dd>
2233<p>
2234 When <em>group</em> (or <em>true</em>), the repository is made shareable between
2235 several users in a group (making sure all the files and objects are
2236 group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
2237 repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2238 group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37[diff] [blame]2239 reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
2240 files in the repository will have this mode value. <em>0xxx</em> will override
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2241 user&#8217;s umask value (whereas the other options will only override
2242 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]2243 the repo read/write-able for the owner and group, but inaccessible to
2244 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]2245 repository that is group-readable but not group-writable.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2246 See <a href="git-init.html">git-init(1)</a>. False by default.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2247</p>
2248</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2249<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2250core.warnAmbiguousRefs
2251</dt>
2252<dd>
2253<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2254 If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29[diff] [blame]2255 and might match multiple refs in the repository. True by default.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2256</p>
2257</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2258<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2259core.compression
2260</dt>
2261<dd>
2262<p>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]2263 An integer -1..9, indicating a default compression level.
2264 -1 is the zlib default. 0 means no compression,
2265 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42[diff] [blame]2266 If set, this provides a default to other compression variables,
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]2267 such as <code>core.looseCompression</code> and <code>pack.compression</code>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2268</p>
2269</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2270<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2271core.looseCompression
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2272</dt>
2273<dd>
2274<p>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]2275 An integer -1..9, indicating the compression level for objects that
2276 are not in a pack file. -1 is the zlib default. 0 means no
2277 compression, and 1..9 are various speed/size tradeoffs, 9 being
2278 slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42[diff] [blame]2279 not set, defaults to 1 (best speed).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2280</p>
2281</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2282<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2283core.packedGitWindowSize
2284</dt>
2285<dd>
2286<p>
2287 Number of bytes of a pack file to map into memory in a
2288 single mapping operation. Larger window sizes may allow
2289 your system to process a smaller number of large pack files
2290 more quickly. Smaller window sizes will negatively affect
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2291 performance due to increased calls to the operating system&#8217;s
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2292 memory manager, but may improve performance when accessing
2293 a large number of large pack files.
2294</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2295<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]2296MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
2297be reasonable for all users/operating systems. You probably do
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2298not need to adjust this value.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2299<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]2300</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2301<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2302core.packedGitLimit
2303</dt>
2304<dd>
2305<p>
2306 Maximum number of bytes to map simultaneously into memory
2307 from pack files. If Git needs to access more than this many
2308 bytes at once to complete an operation it will unmap existing
2309 regions to reclaim virtual address space within the process.
2310</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2311<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]2312This should be reasonable for all users/operating systems, except on
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2313the largest projects. You probably do not need to adjust this value.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2314<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]2315</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2316<dt class="hdlist1">
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]2317core.deltaBaseCacheLimit
2318</dt>
2319<dd>
2320<p>
2321 Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]2322 that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]2323 entire decompressed base objects in a cache Git is able
2324 to avoid unpacking and decompressing frequently used base
2325 objects multiple times.
2326</p>
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]2327<div class="paragraph"><p>Default is 96 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]2328for all users/operating systems, except on the largest projects.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2329You probably do not need to adjust this value.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2330<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]2331</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2332<dt class="hdlist1">
Junio C Hamano5c246f22010-02-03 07:34:53[diff] [blame]2333core.bigFileThreshold
2334</dt>
2335<dd>
2336<p>
2337 Files larger than this size are stored deflated, without
2338 attempting delta compression. Storing large files without
2339 delta compression avoids excessive memory usage, at the
Junio C Hamano8e61f1f2014-09-11 21:53:45[diff] [blame]2340 slight expense of increased disk usage. Additionally files
2341 larger than this size are always treated as binary.
Junio C Hamano5c246f22010-02-03 07:34:53[diff] [blame]2342</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2343<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]2344for most projects as source code and other text files can still
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2345be delta compressed, but larger binary media files won&#8217;t be.</p></div>
2346<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]2347</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2348<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2349core.excludesFile
Junio C Hamano5e284b42007-05-22 07:23:37[diff] [blame]2350</dt>
2351<dd>
2352<p>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]2353 Specifies the pathname to the file that contains patterns to
2354 describe paths that are not meant to be tracked, in addition
2355 to <em>.gitignore</em> (per-directory) and <em>.git/info/exclude</em>.
2356 Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
2357 If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]2358 is used instead. See <a href="gitignore.html">gitignore(5)</a>.
Junio C Hamano5e284b42007-05-22 07:23:37[diff] [blame]2359</p>
2360</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2361<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2362core.askPass
Junio C Hamano3fd7b262010-09-08 22:44:20[diff] [blame]2363</dt>
2364<dd>
2365<p>
2366 Some commands (e.g. svn and http interfaces) that interactively
2367 ask for a password can be told to use an external program given
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]2368 via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
Junio C Hamano3fd7b262010-09-08 22:44:20[diff] [blame]2369 environment variable. If not set, fall back to the value of the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]2370 <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
Junio C Hamano3fd7b262010-09-08 22:44:20[diff] [blame]2371 prompt. The external program shall be given a suitable prompt as
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]2372 command-line argument and write the password on its STDOUT.
Junio C Hamano3fd7b262010-09-08 22:44:20[diff] [blame]2373</p>
2374</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2375<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2376core.attributesFile
Junio C Hamano3b4609d2010-09-30 00:04:34[diff] [blame]2377</dt>
2378<dd>
2379<p>
2380 In addition to <em>.gitattributes</em> (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2381 <em>.git/info/attributes</em>, Git looks into this file for attributes
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2382 (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2383 way as for <code>core.excludesFile</code>. Its default value is
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]2384 <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
2385 set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
Junio C Hamano3b4609d2010-09-30 00:04:34[diff] [blame]2386</p>
2387</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2388<dt class="hdlist1">
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]2389core.hooksPath
2390</dt>
2391<dd>
2392<p>
2393 By default Git will look for your hooks in the
2394 <em>$GIT_DIR/hooks</em> directory. Set this to different path,
2395 e.g. <em>/etc/git/hooks</em>, and Git will try to find your hooks in
2396 that directory, e.g. <em>/etc/git/hooks/pre-receive</em> instead of
2397 in <em>$GIT_DIR/hooks/pre-receive</em>.
2398</p>
2399<div class="paragraph"><p>The path can be either absolute or relative. A relative path is
2400taken as relative to the directory where the hooks are run (see
2401the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div>
2402<div class="paragraph"><p>This configuration variable is useful in cases where you&#8217;d like to
2403centrally configure your Git hooks instead of configuring them on a
2404per-repository basis, or as a more flexible and centralized
2405alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
2406default hooks.</p></div>
2407</dd>
2408<dt class="hdlist1">
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]2409core.editor
2410</dt>
2411<dd>
2412<p>
Junio C Hamano7ab74c42017-03-27 18:23:59[diff] [blame]2413 Commands such as <code>commit</code> and <code>tag</code> that let you edit
2414 messages by launching an editor use the value of this
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]2415 variable when it is set, and the environment variable
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2416 <code>GIT_EDITOR</code> is not set. See <a href="git-var.html">git-var(1)</a>.
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]2417</p>
2418</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2419<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2420core.commentChar
Junio C Hamano3f2ed6f2013-02-04 19:24:09[diff] [blame]2421</dt>
2422<dd>
2423<p>
Junio C Hamano7ab74c42017-03-27 18:23:59[diff] [blame]2424 Commands such as <code>commit</code> and <code>tag</code> that let you edit
Junio C Hamano3f2ed6f2013-02-04 19:24:09[diff] [blame]2425 messages consider a line that begins with this character
2426 commented, and removes them after the editor returns
2427 (default <em>#</em>).
2428</p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2429<div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]2430the beginning character of any line in existing commit messages.</p></div>
Junio C Hamano3f2ed6f2013-02-04 19:24:09[diff] [blame]2431</dd>
2432<dt class="hdlist1">
Junio C Hamano1dbca522015-05-22 20:48:55[diff] [blame]2433core.packedRefsTimeout
2434</dt>
2435<dd>
2436<p>
2437 The length of time, in milliseconds, to retry when trying to
2438 lock the <code>packed-refs</code> file. Value 0 means not to retry at
2439 all; -1 means to try indefinitely. Default is 1000 (i.e.,
2440 retry for 1 second).
2441</p>
2442</dd>
2443<dt class="hdlist1">
Junio C Hamano6231f822011-10-24 05:18:52[diff] [blame]2444sequence.editor
2445</dt>
2446<dd>
2447<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2448 Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52[diff] [blame]2449 The value is meant to be interpreted by the shell when it is used.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2450 It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
Junio C Hamano6231f822011-10-24 05:18:52[diff] [blame]2451 When not configured the default commit message editor is used instead.
2452</p>
2453</dd>
2454<dt class="hdlist1">
Junio C Hamano28d8ede2007-07-05 05:51:38[diff] [blame]2455core.pager
2456</dt>
2457<dd>
2458<p>
Junio C Hamano0e0e0d22013-09-12 23:25:03[diff] [blame]2459 Text viewer for use by Git commands (e.g., <em>less</em>). The value
2460 is meant to be interpreted by the shell. The order of preference
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2461 is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
2462 configuration, then <code>$PAGER</code>, and then the default chosen at
Junio C Hamano0e0e0d22013-09-12 23:25:03[diff] [blame]2463 compile time (usually <em>less</em>).
Junio C Hamano28d8ede2007-07-05 05:51:38[diff] [blame]2464</p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2465<div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
2466(if <code>LESS</code> environment variable is set, Git does not change it at
Junio C Hamano0e0e0d22013-09-12 23:25:03[diff] [blame]2467all). If you want to selectively override Git&#8217;s default setting
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2468for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>. This will
Junio C Hamano0e0e0d22013-09-12 23:25:03[diff] [blame]2469be passed to the shell by Git, which will translate the final
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2470command to <code>LESS=FRX less -S</code>. The environment does not set the
2471<code>S</code> option but the command line does, instructing less to truncate
2472long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
2473deactivate the <code>F</code> option specified by the environment from the
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]2474command-line, deactivating the "quit if one screen" behavior of
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2475<code>less</code>. One can specifically activate some flags for particular
2476commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
2477line truncation only for <code>git blame</code>.</p></div>
2478<div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
2479to <code>-c</code>. You can override this setting by exporting <code>LV</code> with
2480another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
Junio C Hamano28d8ede2007-07-05 05:51:38[diff] [blame]2481</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2482<dt class="hdlist1">
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]2483core.whitespace
2484</dt>
2485<dd>
2486<p>
2487 A comma separated list of common whitespace problems to
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2488 notice. <em>git diff</em> will use <code>color.diff.whitespace</code> to
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2489 highlight them, and <em>git apply --whitespace=error</em> will
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2490 consider them as errors. You can prefix <code>-</code> to disable
2491 any of them (e.g. <code>-trailing-space</code>):
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]2492</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2493<div class="ulist"><ul>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]2494<li>
2495<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2496<code>blank-at-eol</code> treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]2497 as an error (enabled by default).
2498</p>
2499</li>
2500<li>
2501<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2502<code>space-before-tab</code> treats a space character that appears immediately
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]2503 before a tab character in the initial indent part of the line as an
2504 error (enabled by default).
2505</p>
2506</li>
2507<li>
2508<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2509<code>indent-with-non-tab</code> treats a line that is indented with space
Junio C Hamano281fd392012-09-17 23:57:41[diff] [blame]2510 characters instead of the equivalent tabs as an error (not enabled by
2511 default).
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]2512</p>
2513</li>
Junio C Hamano601f3e52008-02-25 08:40:42[diff] [blame]2514<li>
2515<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2516<code>tab-in-indent</code> treats a tab character in the initial indent part of
Junio C Hamanocb39aea2010-05-09 07:24:48[diff] [blame]2517 the line as an error (not enabled by default).
2518</p>
2519</li>
2520<li>
2521<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2522<code>blank-at-eof</code> treats blank lines added at the end of file as an error
Junio C Hamanob71a22d2009-10-17 08:23:47[diff] [blame]2523 (enabled by default).
2524</p>
2525</li>
2526<li>
2527<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2528<code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
2529 <code>blank-at-eof</code>.
Junio C Hamanob71a22d2009-10-17 08:23:47[diff] [blame]2530</p>
2531</li>
2532<li>
2533<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2534<code>cr-at-eol</code> treats a carriage-return at the end of line as
2535 part of the line terminator, i.e. with it, <code>trailing-space</code>
Junio C Hamano601f3e52008-02-25 08:40:42[diff] [blame]2536 does not trigger if the character before such a carriage-return
2537 is not a whitespace (not enabled by default).
2538</p>
2539</li>
Junio C Hamanoeef01fe2010-12-13 08:31:58[diff] [blame]2540<li>
2541<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2542<code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
2543 is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
Junio C Hamanoeef01fe2010-12-13 08:31:58[diff] [blame]2544 errors. The default tab width is 8. Allowed values are 1 to 63.
2545</p>
2546</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2547</ul></div>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]2548</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2549<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2550core.fsyncObjectFiles
Junio C Hamano9eb57532008-06-26 06:33:46[diff] [blame]2551</dt>
2552<dd>
2553<p>
2554 This boolean will enable <em>fsync()</em> when writing object files.
2555</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2556<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]2557data writes properly, but can be useful for filesystems that do not use
2558journalling (traditional UNIX filesystems) or that only journal metadata
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2559and 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]2560</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2561<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2562core.preloadIndex
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]2563</dt>
2564<dd>
2565<p>
2566 Enable parallel index preload for operations like <em>git diff</em>
2567</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2568<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]2569on filesystems like NFS that have weak caching semantics and thus
Junio C Hamanoc8c398a2014-06-16 21:14:05[diff] [blame]2570relatively high IO latencies. When enabled, Git will do the
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]2571index comparison to the filesystem data in parallel, allowing
Junio C Hamanoc8c398a2014-06-16 21:14:05[diff] [blame]2572overlapping IO&#8217;s. Defaults to true.</p></div>
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]2573</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2574<dt class="hdlist1">
Junio C Hamanoa9499de2009-04-30 03:38:48[diff] [blame]2575core.createObject
Junio C Hamanoe91ea772009-04-26 01:41:41[diff] [blame]2576</dt>
2577<dd>
2578<p>
Junio C Hamanoa9499de2009-04-30 03:38:48[diff] [blame]2579 You can set this to <em>link</em>, in which case a hardlink followed by
2580 a delete of the source are used to make sure that object creation
2581 will not overwrite existing objects.
Junio C Hamanoe91ea772009-04-26 01:41:41[diff] [blame]2582</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2583<div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
Junio C Hamanoa9499de2009-04-30 03:38:48[diff] [blame]2584Set this config setting to <em>rename</em> there; However, This will remove the
2585check that makes sure that existing object files will not get overwritten.</p></div>
Junio C Hamanoe91ea772009-04-26 01:41:41[diff] [blame]2586</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2587<dt class="hdlist1">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]2588core.notesRef
2589</dt>
2590<dd>
2591<p>
2592 When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]2593 the given ref. The ref must be fully qualified. If the given
2594 ref does not exist, it is not an error but means that no
2595 notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]2596</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2597<div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]2598the <code>GIT_NOTES_REF</code> environment variable. See <a href="git-notes.html">git-notes(1)</a>.</p></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]2599</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2600<dt class="hdlist1">
Junio C Hamano3c8d6702010-01-13 23:09:03[diff] [blame]2601core.sparseCheckout
2602</dt>
2603<dd>
2604<p>
2605 Enable "sparse checkout" feature. See section "Sparse checkout" in
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2606 <a href="git-read-tree.html">git-read-tree(1)</a> for more information.
Junio C Hamano3c8d6702010-01-13 23:09:03[diff] [blame]2607</p>
2608</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2609<dt class="hdlist1">
Junio C Hamano6371b0e2011-03-23 23:36:21[diff] [blame]2610core.abbrev
2611</dt>
2612<dd>
2613<p>
Junio C Hamano56ace3d2017-01-10 23:43:41[diff] [blame]2614 Set the length object names are abbreviated to. If
2615 unspecified or set to "auto", an appropriate value is
2616 computed based on the approximate number of packed objects
2617 in your repository, which hopefully is enough for
2618 abbreviated object names to stay unique for some time.
Junio C Hamano6371b0e2011-03-23 23:36:21[diff] [blame]2619</p>
2620</dd>
2621<dt class="hdlist1">
Junio C Hamanobe087982015-02-22 21:29:39[diff] [blame]2622add.ignoreErrors
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]2623</dt>
Junio C Hamano60186642010-12-02 14:18:26[diff] [blame]2624<dt class="hdlist1">
Junio C Hamanobe087982015-02-22 21:29:39[diff] [blame]2625add.ignore-errors (deprecated)
Junio C Hamano60186642010-12-02 14:18:26[diff] [blame]2626</dt>
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]2627<dd>
2628<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2629 Tells <em>git add</em> to continue adding files when some files cannot be
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]2630 added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
Junio C Hamanobe087982015-02-22 21:29:39[diff] [blame]2631 option of <a href="git-add.html">git-add(1)</a>. <code>add.ignore-errors</code> is deprecated,
2632 as it does not follow the usual naming convention for configuration
2633 variables.
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]2634</p>
2635</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2636<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2637alias.*
2638</dt>
2639<dd>
2640<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2641 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]2642 after defining "alias.last = cat-file commit HEAD", the invocation
2643 "git last" is equivalent to "git cat-file commit HEAD". To avoid
2644 confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2645 hide existing Git commands are ignored. Arguments are split by
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2646 spaces, the usual shell quoting and escaping is supported.
Junio C Hamano2efd5e42014-11-10 22:38:52[diff] [blame]2647 A quote pair or a backslash can be used to quote them.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2648</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2649<div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point,
Junio C Hamano9cb74f22007-02-12 04:15:05[diff] [blame]2650it will be treated as a shell command. For example, defining
2651"alias.new = !gitk --all --not ORIG_HEAD", the invocation
2652"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19[diff] [blame]2653"gitk --all --not ORIG_HEAD". Note that shell commands will be
2654executed from the top-level directory of a repository, which may
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]2655not necessarily be the current directory.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]2656<code>GIT_PREFIX</code> is set as returned by running <em>git rev-parse --show-prefix</em>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2657from 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]2658</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2659<dt class="hdlist1">
Junio C Hamanocaa712a2010-03-11 01:17:35[diff] [blame]2660am.keepcr
2661</dt>
2662<dd>
2663<p>
2664 If true, git-am will call git-mailsplit for patches in mbox format
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]2665 with parameter <code>--keep-cr</code>. In this case git-mailsplit will
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2666 not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]2667 by giving <code>--no-keep-cr</code> from the command line.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2668 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]2669</p>
2670</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2671<dt class="hdlist1">
Junio C Hamano9c512872015-08-12 21:59:25[diff] [blame]2672am.threeWay
2673</dt>
2674<dd>
2675<p>
2676 By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2677 set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2678 the patch records the identity of blobs it is supposed to apply to and
2679 we have those blobs available locally (equivalent to giving the <code>--3way</code>
2680 option from the command line). Defaults to <code>false</code>.
2681 See <a href="git-am.html">git-am(1)</a>.
2682</p>
2683</dd>
2684<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2685apply.ignoreWhitespace
Junio C Hamanofe24db02009-08-22 05:10:47[diff] [blame]2686</dt>
2687<dd>
2688<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2689 When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]2690 whitespace, in the same way as the <code>--ignore-space-change</code>
Junio C Hamanofe24db02009-08-22 05:10:47[diff] [blame]2691 option.
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2692 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]2693 respect all whitespace differences.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2694 See <a href="git-apply.html">git-apply(1)</a>.
Junio C Hamanofe24db02009-08-22 05:10:47[diff] [blame]2695</p>
2696</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2697<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2698apply.whitespace
2699</dt>
2700<dd>
2701<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2702 Tells <em>git apply</em> how to handle whitespaces, in the same way
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]2703 as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2704</p>
2705</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2706<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2707branch.autoSetupMerge
Junio C Hamano7fd84172007-05-24 07:00:32[diff] [blame]2708</dt>
2709<dd>
2710<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2711 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]2712 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]2713 starting point branch. Note that even if this option is not set,
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2714 this behavior can be chosen per-branch using the <code>--track</code>
2715 and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
2716 automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
2717 starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201; automatic setup is done when the starting point is either a
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]2718 local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]2719 branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32[diff] [blame]2720</p>
2721</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2722<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2723branch.autoSetupRebase
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]2724</dt>
2725<dd>
2726<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2727 When a new branch is created with <em>git branch</em> or <em>git checkout</em>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]2728 that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]2729 up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2730 When <code>never</code>, rebase is never automatically set to true.
2731 When <code>local</code>, rebase is set to true for tracked branches of
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]2732 other local branches.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2733 When <code>remote</code>, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]2734 remote-tracking branches.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2735 When <code>always</code>, rebase will be set to true for all tracking
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]2736 branches.
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2737 See "branch.autoSetupMerge" for details on how to set up a
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]2738 branch to track another branch.
2739 This option defaults to never.
2740</p>
2741</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2742<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2743branch.&lt;name&gt;.remote
2744</dt>
2745<dd>
2746<p>
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]2747 When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
2748 which remote to fetch from/push to. The remote to push to
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2749 may be overridden with <code>remote.pushDefault</code> (for all branches).
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]2750 The remote to push to, for the current branch, may be further
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2751 overridden by <code>branch.&lt;name&gt;.pushRemote</code>. If no remote is
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]2752 configured, or if you are not on any branch, it defaults to
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2753 <code>origin</code> for fetching and <code>remote.pushDefault</code> for pushing.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2754 Additionally, <code>.</code> (a period) is the current local repository
2755 (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]2756</p>
2757</dd>
2758<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2759branch.&lt;name&gt;.pushRemote
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]2760</dt>
2761<dd>
2762<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2763 When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2764 pushing. It also overrides <code>remote.pushDefault</code> for pushing
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]2765 from branch &lt;name&gt;. When you pull from one place (e.g. your
2766 upstream) and push to another place (e.g. your own publishing
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2767 repository), you would want to set <code>remote.pushDefault</code> to
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]2768 specify the remote to push to for all branches, and use this
2769 option to override it for a specific branch.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2770</p>
2771</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2772<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2773branch.&lt;name&gt;.merge
2774</dt>
2775<dd>
2776<p>
Junio C Hamano0706c802009-03-30 22:34:19[diff] [blame]2777 Defines, together with branch.&lt;name&gt;.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02[diff] [blame]2778 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]2779 branch to merge and can also affect <em>git push</em> (see push.default).
2780 When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
Junio C Hamanoc2b47092007-10-25 06:50:31[diff] [blame]2781 refspec to be marked for merging in FETCH_HEAD. The value is
2782 handled like the remote part of a refspec, and must match a
2783 ref which is fetched from the remote given by
2784 "branch.&lt;name&gt;.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2785 The merge information is used by <em>git pull</em> (which at first calls
2786 <em>git fetch</em>) to lookup the default branch for merging. Without
2787 this option, <em>git pull</em> defaults to merge the first refspec fetched.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2788 Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]2789 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]2790 another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:38[diff] [blame]2791 branch.&lt;name&gt;.merge to the desired branch, and use the relative path
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2792 setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2793</p>
2794</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2795<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]2796branch.&lt;name&gt;.mergeOptions
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]2797</dt>
2798<dd>
2799<p>
2800 Sets default options for merging into branch &lt;name&gt;. The syntax and
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2801 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]2802 option values containing whitespace characters are currently not
2803 supported.
2804</p>
2805</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2806<dt class="hdlist1">
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]2807branch.&lt;name&gt;.rebase
2808</dt>
2809<dd>
2810<p>
2811 When true, rebase the branch &lt;name&gt; on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]2812 instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20[diff] [blame]2813 "git pull" is run. See "pull.rebase" for doing this in a non
2814 branch-specific manner.
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]2815</p>
Junio C Hamano7db630e2015-09-17 20:26:22[diff] [blame]2816<div class="paragraph"><p>When preserve, also pass <code>--preserve-merges</code> along to <em>git rebase</em>
Junio C Hamanocf4a1742013-09-11 22:57:50[diff] [blame]2817so that locally committed merge commits will not be flattened
Junio C Hamano7db630e2015-09-17 20:26:22[diff] [blame]2818by running <em>git pull</em>.</p></div>
Junio C Hamano289d7e82016-01-27 00:20:38[diff] [blame]2819<div class="paragraph"><p>When the value is <code>interactive</code>, the rebase is run in interactive mode.</p></div>
Junio C Hamano515ab1d2011-12-09 23:41:20[diff] [blame]2820<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]2821it 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]2822for details).</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]2823</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2824<dt class="hdlist1">
Junio C Hamano46247182013-01-09 20:50:28[diff] [blame]2825branch.&lt;name&gt;.description
2826</dt>
2827<dd>
2828<p>
2829 Branch description, can be edited with
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2830 <code>git branch --edit-description</code>. Branch description is
Junio C Hamano46247182013-01-09 20:50:28[diff] [blame]2831 automatically added in the format-patch cover letter or
2832 request-pull summary.
2833</p>
2834</dd>
2835<dt class="hdlist1">
Junio C Hamano8760ea62008-03-14 08:58:45[diff] [blame]2836browser.&lt;tool&gt;.cmd
2837</dt>
2838<dd>
2839<p>
2840 Specify the command to invoke the specified browser. The
2841 specified command is evaluated in shell with the URLs passed
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2842 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]2843</p>
2844</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2845<dt class="hdlist1">
Junio C Hamanoe35a6fc2008-01-29 09:46:27[diff] [blame]2846browser.&lt;tool&gt;.path
2847</dt>
2848<dd>
2849<p>
2850 Override the path for the given tool that may be used to
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]2851 browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2852 working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
Junio C Hamanoe35a6fc2008-01-29 09:46:27[diff] [blame]2853</p>
2854</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2855<dt class="hdlist1">
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]2856clean.requireForce
2857</dt>
2858<dd>
2859<p>
Junio C Hamanoe6f28d02013-09-17 21:34:00[diff] [blame]2860 A boolean to make git-clean do nothing unless given -f,
2861 -i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]2862</p>
2863</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2864<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2865color.branch
2866</dt>
2867<dd>
2868<p>
2869 A boolean to enable/disable color in the output of
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2870 <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
2871 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:27[diff] [blame]2872 only when the output is to a terminal. If unset, then the
2873 value of <code>color.ui</code> is used (<code>auto</code> by default).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2874</p>
2875</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2876<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2877color.branch.&lt;slot&gt;
2878</dt>
2879<dd>
2880<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2881 Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
2882 <code>current</code> (the current branch), <code>local</code> (a local branch),
2883 <code>remote</code> (a remote-tracking branch in refs/remotes/),
2884 <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2885 refs).
2886</p>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2887</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2888<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2889color.diff
2890</dt>
2891<dd>
2892<p>
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]2893 Whether to use ANSI escape sequences to add color to patches.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2894 If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]2895 <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2896 for all patches. If it is set to <code>true</code> or <code>auto</code>, those
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]2897 commands will only use color when output is to the terminal.
Junio C Hamanoad70bf02016-09-26 23:44:27[diff] [blame]2898 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
2899 default).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2900</p>
Junio C Hamanod75148a2014-04-08 19:48:38[diff] [blame]2901<div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]2902<em>git-diff-&#42;</em> plumbing commands. Can be overridden on the
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2903command line with the <code>--color[=&lt;when&gt;]</code> option.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2904</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2905<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2906color.diff.&lt;slot&gt;
2907</dt>
2908<dd>
2909<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2910 Use customized color for diff colorization. <code>&lt;slot&gt;</code> specifies
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2911 which part of the patch to use the specified color, and is one
Junio C Hamano8c5d5942015-06-11 19:37:48[diff] [blame]2912 of <code>context</code> (context text - <code>plain</code> is a historical synonym),
2913 <code>meta</code> (metainformation), <code>frag</code>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2914 (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
2915 <code>new</code> (added lines), <code>commit</code> (commit headers), or <code>whitespace</code>
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]2916 (highlighting whitespace errors).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2917</p>
2918</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2919<dt class="hdlist1">
Junio C Hamano7d449522010-07-01 00:08:51[diff] [blame]2920color.decorate.&lt;slot&gt;
2921</dt>
2922<dd>
2923<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2924 Use customized color for <em>git log --decorate</em> output. <code>&lt;slot&gt;</code> is one
2925 of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]2926 branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51[diff] [blame]2927</p>
2928</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2929<dt class="hdlist1">
Junio C Hamanod257cff2009-03-18 05:27:16[diff] [blame]2930color.grep
2931</dt>
2932<dd>
2933<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2934 When set to <code>always</code>, always highlight matches. When <code>false</code> (or
2935 <code>never</code>), never. When set to <code>true</code> or <code>auto</code>, use color only
Junio C Hamanoad70bf02016-09-26 23:44:27[diff] [blame]2936 when the output is written to the terminal. If unset, then the
2937 value of <code>color.ui</code> is used (<code>auto</code> by default).
Junio C Hamanod257cff2009-03-18 05:27:16[diff] [blame]2938</p>
2939</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2940<dt class="hdlist1">
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2941color.grep.&lt;slot&gt;
Junio C Hamanod257cff2009-03-18 05:27:16[diff] [blame]2942</dt>
2943<dd>
2944<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2945 Use customized color for grep colorization. <code>&lt;slot&gt;</code> specifies which
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2946 part of the line to use the specified color, and is one of
Junio C Hamanod257cff2009-03-18 05:27:16[diff] [blame]2947</p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]2948<div class="openblock">
2949<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2950<div class="dlist"><dl>
2951<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2952<code>context</code>
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2953</dt>
2954<dd>
2955<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2956 non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2957</p>
2958</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2959<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2960<code>filename</code>
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2961</dt>
2962<dd>
2963<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2964 filename prefix (when not using <code>-h</code>)
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2965</p>
2966</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2967<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2968<code>function</code>
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2969</dt>
2970<dd>
2971<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2972 function name lines (when using <code>-p</code>)
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2973</p>
2974</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2975<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2976<code>linenumber</code>
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2977</dt>
2978<dd>
2979<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2980 line number prefix (when using <code>-n</code>)
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2981</p>
2982</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]2983<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]2984<code>match</code>
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]2985</dt>
2986<dd>
2987<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]2988 matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
2989</p>
2990</dd>
2991<dt class="hdlist1">
2992<code>matchContext</code>
2993</dt>
2994<dd>
2995<p>
2996 matching text in context lines
2997</p>
2998</dd>
2999<dt class="hdlist1">
3000<code>matchSelected</code>
3001</dt>
3002<dd>
3003<p>
3004 matching text in selected lines
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]3005</p>
3006</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3007<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3008<code>selected</code>
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]3009</dt>
3010<dd>
3011<p>
3012 non-matching text in selected lines
3013</p>
3014</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3015<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3016<code>separator</code>
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]3017</dt>
3018<dd>
3019<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3020 separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
3021 and between hunks (<code>--</code>)
Junio C Hamano0299d922010-03-20 20:59:31[diff] [blame]3022</p>
3023</dd>
3024</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]3025</div></div>
Junio C Hamanod257cff2009-03-18 05:27:16[diff] [blame]3026</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3027<dt class="hdlist1">
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]3028color.interactive
3029</dt>
3030<dd>
3031<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3032 When set to <code>always</code>, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]3033 and displays (such as those used by "git-add --interactive" and
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3034 "git-clean --interactive"). When false (or <code>never</code>), never.
3035 When set to <code>true</code> or <code>auto</code>, use colors only when the output is
Junio C Hamanoad70bf02016-09-26 23:44:27[diff] [blame]3036 to the terminal. If unset, then the value of <code>color.ui</code> is
3037 used (<code>auto</code> by default).
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]3038</p>
3039</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3040<dt class="hdlist1">
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]3041color.interactive.&lt;slot&gt;
3042</dt>
3043<dd>
3044<p>
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]3045 Use customized color for <em>git add --interactive</em> and <em>git clean
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3046 --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
3047 or <code>error</code>, for four distinct types of normal output from
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]3048 interactive commands.
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]3049</p>
3050</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3051<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3052color.pager
3053</dt>
3054<dd>
3055<p>
3056 A boolean to enable/disable colored output when the pager is in
3057 use (default is true).
3058</p>
3059</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3060<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]3061color.showBranch
Junio C Hamano52ba2952009-05-18 17:43:02[diff] [blame]3062</dt>
3063<dd>
3064<p>
3065 A boolean to enable/disable color in the output of
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3066 <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
3067 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:27[diff] [blame]3068 only when the output is to a terminal. If unset, then the
3069 value of <code>color.ui</code> is used (<code>auto</code> by default).
Junio C Hamano52ba2952009-05-18 17:43:02[diff] [blame]3070</p>
3071</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3072<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3073color.status
3074</dt>
3075<dd>
3076<p>
3077 A boolean to enable/disable color in the output of
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3078 <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
3079 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:27[diff] [blame]3080 only when the output is to a terminal. If unset, then the
3081 value of <code>color.ui</code> is used (<code>auto</code> by default).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3082</p>
3083</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3084<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3085color.status.&lt;slot&gt;
3086</dt>
3087<dd>
3088<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3089 Use customized color for status colorization. <code>&lt;slot&gt;</code> is
3090 one of <code>header</code> (the header text of the status message),
3091 <code>added</code> or <code>updated</code> (files which are added but not committed),
3092 <code>changed</code> (files which are changed but not added in the index),
3093 <code>untracked</code> (files which are not tracked by Git),
Junio C Hamano5992a252015-03-17 23:39:30[diff] [blame]3094 <code>branch</code> (the current branch),
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3095 <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
Junio C Hamanod5176902017-05-16 04:30:56[diff] [blame]3096 to red),
3097 <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
3098 respectively, when branch and tracking information is displayed in the
3099 status short-format), or
Junio C Hamano5992a252015-03-17 23:39:30[diff] [blame]3100 <code>unmerged</code> (files which have unmerged changes).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3101</p>
3102</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3103<dt class="hdlist1">
Junio C Hamano83d46a22008-02-21 02:29:42[diff] [blame]3104color.ui
3105</dt>
3106<dd>
3107<p>
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]3108 This variable determines the default value for variables such
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3109 as <code>color.diff</code> and <code>color.grep</code> that control the use of color
Junio C Hamano5f2627d2011-05-06 20:23:48[diff] [blame]3110 per command family. Its scope will expand as more commands learn
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3111 configuration to set a default for the <code>--color</code> option. Set it
3112 to <code>false</code> or <code>never</code> if you prefer Git commands not to use
Junio C Hamanofa1d3492013-06-20 23:39:43[diff] [blame]3113 color unless enabled explicitly with some other configuration
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3114 or the <code>--color</code> option. Set it to <code>always</code> if you want all
Junio C Hamanofa1d3492013-06-20 23:39:43[diff] [blame]3115 output not intended for machine consumption to use color, to
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3116 <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
Junio C Hamanofa1d3492013-06-20 23:39:43[diff] [blame]3117 want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:42[diff] [blame]3118</p>
3119</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3120<dt class="hdlist1">
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3121column.ui
3122</dt>
3123<dd>
3124<p>
3125 Specify whether supported commands should output in columns.
3126 This variable consists of a list of tokens separated by spaces
3127 or commas:
3128</p>
Junio C Hamanoa1952302013-07-01 21:31:18[diff] [blame]3129<div class="paragraph"><p>These options control when the feature should be enabled
3130(defaults to <em>never</em>):</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]3131<div class="openblock">
3132<div class="content">
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3133<div class="dlist"><dl>
3134<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3135<code>always</code>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3136</dt>
3137<dd>
3138<p>
3139 always show in columns
3140</p>
3141</dd>
3142<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3143<code>never</code>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3144</dt>
3145<dd>
3146<p>
3147 never show in columns
3148</p>
3149</dd>
3150<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3151<code>auto</code>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3152</dt>
3153<dd>
3154<p>
3155 show in columns if the output is to the terminal
3156</p>
3157</dd>
Junio C Hamanoa1952302013-07-01 21:31:18[diff] [blame]3158</dl></div>
3159</div></div>
3160<div class="paragraph"><p>These options control layout (defaults to <em>column</em>). Setting any
3161of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
3162specified.</p></div>
3163<div class="openblock">
3164<div class="content">
3165<div class="dlist"><dl>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3166<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3167<code>column</code>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3168</dt>
3169<dd>
3170<p>
Junio C Hamanoa1952302013-07-01 21:31:18[diff] [blame]3171 fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3172</p>
3173</dd>
3174<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3175<code>row</code>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3176</dt>
3177<dd>
3178<p>
3179 fill rows before columns
3180</p>
3181</dd>
3182<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3183<code>plain</code>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3184</dt>
3185<dd>
3186<p>
3187 show in one column
3188</p>
3189</dd>
Junio C Hamanoa1952302013-07-01 21:31:18[diff] [blame]3190</dl></div>
3191</div></div>
3192<div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults
3193to <em>nodense</em>):</p></div>
3194<div class="openblock">
3195<div class="content">
3196<div class="dlist"><dl>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3197<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3198<code>dense</code>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3199</dt>
3200<dd>
3201<p>
3202 make unequal size columns to utilize more space
3203</p>
3204</dd>
3205<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3206<code>nodense</code>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3207</dt>
3208<dd>
3209<p>
3210 make equal size columns
3211</p>
3212</dd>
3213</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]3214</div></div>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3215</dd>
3216<dt class="hdlist1">
3217column.branch
3218</dt>
3219<dd>
3220<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3221 Specify whether to output branch listing in <code>git branch</code> in columns.
3222 See <code>column.ui</code> for details.
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3223</p>
3224</dd>
3225<dt class="hdlist1">
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]3226column.clean
3227</dt>
3228<dd>
3229<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3230 Specify the layout when list items in <code>git clean -i</code>, which always
3231 shows files and directories in columns. See <code>column.ui</code> for details.
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]3232</p>
3233</dd>
3234<dt class="hdlist1">
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3235column.status
3236</dt>
3237<dd>
3238<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3239 Specify whether to output untracked files in <code>git status</code> in columns.
3240 See <code>column.ui</code> for details.
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3241</p>
3242</dd>
3243<dt class="hdlist1">
3244column.tag
3245</dt>
3246<dd>
3247<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3248 Specify whether to output tag listing in <code>git tag</code> in columns.
3249 See <code>column.ui</code> for details.
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]3250</p>
3251</dd>
3252<dt class="hdlist1">
Junio C Hamanoce836cc2013-01-21 02:01:53[diff] [blame]3253commit.cleanup
3254</dt>
3255<dd>
3256<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3257 This setting overrides the default of the <code>--cleanup</code> option in
3258 <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
Junio C Hamanoce836cc2013-01-21 02:01:53[diff] [blame]3259 default can be useful when you always want to keep lines that begin
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3260 with comment character <code>#</code> in your log message, in which case you
3261 would do <code>git config commit.cleanup whitespace</code> (note that you will
3262 have to remove the help lines that begin with <code>#</code> in the commit log
Junio C Hamanoce836cc2013-01-21 02:01:53[diff] [blame]3263 template yourself, if you do this).
3264</p>
3265</dd>
3266<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]3267commit.gpgSign
Junio C Hamano5b3533d2014-02-27 23:07:15[diff] [blame]3268</dt>
3269<dd>
3270<p>
3271 A boolean to specify whether all commits should be GPG signed.
3272 Use of this option when doing operations such as rebase can
3273 result in a large number of commits being signed. It may be
3274 convenient to use an agent to avoid typing your GPG passphrase
3275 several times.
3276</p>
3277</dd>
3278<dt class="hdlist1">
Junio C Hamanod0d892c2010-01-24 20:06:29[diff] [blame]3279commit.status
3280</dt>
3281<dd>
3282<p>
Junio C Hamano6ce6b6c2010-01-18 01:25:50[diff] [blame]3283 A boolean to enable/disable inclusion of status information in the
3284 commit message template when using an editor to prepare the commit
Junio C Hamanod0d892c2010-01-24 20:06:29[diff] [blame]3285 message. Defaults to true.
3286</p>
3287</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3288<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]3289commit.template
3290</dt>
3291<dd>
3292<p>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]3293 Specify the pathname of a file to use as the template for
3294 new commit messages.
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]3295</p>
3296</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3297<dt class="hdlist1">
Junio C Hamanof2a3a752016-05-23 22:54:39[diff] [blame]3298commit.verbose
3299</dt>
3300<dd>
3301<p>
3302 A boolean or int to specify the level of verbose with <code>git commit</code>.
3303 See <a href="git-commit.html">git-commit(1)</a>.
3304</p>
3305</dd>
3306<dt class="hdlist1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]3307credential.helper
3308</dt>
3309<dd>
3310<p>
3311 Specify an external helper to be called when a username or
3312 password credential is needed; the helper may consult external
Junio C Hamano4ba4a782016-04-03 19:11:32[diff] [blame]3313 storage to avoid prompting the user for the credentials. Note
3314 that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
3315 for details.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]3316</p>
3317</dd>
3318<dt class="hdlist1">
3319credential.useHttpPath
3320</dt>
3321<dd>
3322<p>
3323 When acquiring credentials, consider the "path" component of an http
3324 or https URL to be important. Defaults to false. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3325 <a href="gitcredentials.html">gitcredentials(7)</a> for more information.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]3326</p>
3327</dd>
3328<dt class="hdlist1">
3329credential.username
3330</dt>
3331<dd>
3332<p>
3333 If no username is set for a network authentication, use this username
3334 by default. See credential.&lt;context&gt;.* below, and
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3335 <a href="gitcredentials.html">gitcredentials(7)</a>.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]3336</p>
3337</dd>
3338<dt class="hdlist1">
3339credential.&lt;url&gt;.*
3340</dt>
3341<dd>
3342<p>
3343 Any of the credential.* options above can be applied selectively to
3344 some credentials. For example "credential.https://example.com.username"
3345 would set the default username only for https connections to
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3346 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]3347 matched.
3348</p>
3349</dd>
3350<dt class="hdlist1">
Junio C Hamanoabb8a052015-12-04 22:43:11[diff] [blame]3351credentialCache.ignoreSIGHUP
3352</dt>
3353<dd>
3354<p>
3355 Tell git-credential-cache&#8212;daemon to ignore SIGHUP, instead of quitting.
3356</p>
3357</dd>
3358<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]3359diff.autoRefreshIndex
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]3360</dt>
3361<dd>
3362<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]3363 When using <em>git diff</em> to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]3364 files, do not consider stat-only change as changed.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3365 Instead, silently run <code>git update-index --refresh</code> to
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]3366 update the cached stat information for paths whose
3367 contents in the work tree match the contents in the
3368 index. This option defaults to true. Note that this
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]3369 affects only <em>git diff</em> Porcelain, and not lower level
3370 <em>diff</em> commands such as <em>git diff-files</em>.
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]3371</p>
3372</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3373<dt class="hdlist1">
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3374diff.dirstat
3375</dt>
3376<dd>
3377<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3378 A comma separated list of <code>--dirstat</code> parameters specifying the
3379 default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>`
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3380 and friends. The defaults can be overridden on the command line
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3381 (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
3382 (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3383 The following parameters are available:
3384</p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]3385<div class="openblock">
3386<div class="content">
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3387<div class="dlist"><dl>
3388<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3389<code>changes</code>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3390</dt>
3391<dd>
3392<p>
3393 Compute the dirstat numbers by counting the lines that have been
3394 removed from the source, or added to the destination. This ignores
3395 the amount of pure code movements within a file. In other words,
3396 rearranging lines in a file is not counted as much as other changes.
3397 This is the default behavior when no parameter is given.
3398</p>
3399</dd>
3400<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3401<code>lines</code>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3402</dt>
3403<dd>
3404<p>
3405 Compute the dirstat numbers by doing the regular line-based diff
3406 analysis, and summing the removed/added line counts. (For binary
3407 files, count 64-byte chunks instead, since binary files have no
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3408 natural concept of lines). This is a more expensive <code>--dirstat</code>
3409 behavior than the <code>changes</code> behavior, but it does count rearranged
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3410 lines within a file as much as other changes. The resulting output
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3411 is consistent with what you get from the other <code>--*stat</code> options.
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3412</p>
3413</dd>
3414<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3415<code>files</code>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3416</dt>
3417<dd>
3418<p>
3419 Compute the dirstat numbers by counting the number of files changed.
3420 Each changed file counts equally in the dirstat analysis. This is
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3421 the computationally cheapest <code>--dirstat</code> behavior, since it does
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3422 not have to look at the file contents at all.
3423</p>
3424</dd>
3425<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3426<code>cumulative</code>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3427</dt>
3428<dd>
3429<p>
3430 Count changes in a child directory for the parent directory as well.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3431 Note that when using <code>cumulative</code>, the sum of the percentages
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3432 reported may exceed 100%. The default (non-cumulative) behavior can
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3433 be specified with the <code>noncumulative</code> parameter.
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3434</p>
3435</dd>
3436<dt class="hdlist1">
3437&lt;limit&gt;
3438</dt>
3439<dd>
3440<p>
3441 An integer parameter specifies a cut-off percent (3% by default).
3442 Directories contributing less than this percentage of the changes
3443 are not shown in the output.
3444</p>
3445</dd>
3446</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]3447</div></div>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3448<div class="paragraph"><p>Example: The following will count changed files, while ignoring
3449directories with less than 10% of the total amount of changed files,
3450and accumulating child directory counts in the parent directories:
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3451<code>files,10,cumulative</code>.</p></div>
Junio C Hamano1c222c52011-05-13 19:55:32[diff] [blame]3452</dd>
3453<dt class="hdlist1">
Junio C Hamanoaea9e6b2012-03-07 00:17:11[diff] [blame]3454diff.statGraphWidth
3455</dt>
3456<dd>
3457<p>
3458 Limit the width of the graph part in --stat output. If set, applies
Junio C Hamano010705a2012-06-19 23:37:26[diff] [blame]3459 to all commands generating --stat output except format-patch.
Junio C Hamanoaea9e6b2012-03-07 00:17:11[diff] [blame]3460</p>
3461</dd>
3462<dt class="hdlist1">
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]3463diff.context
3464</dt>
3465<dd>
3466<p>
Junio C Hamano0766abc2012-12-08 00:08:56[diff] [blame]3467 Generate diffs with &lt;n&gt; lines of context instead of the default
3468 of 3. This value is overridden by the -U option.
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]3469</p>
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]3470</dd>
3471<dt class="hdlist1">
Junio C Hamanobcd98f42017-01-24 00:12:16[diff] [blame]3472diff.interHunkContext
3473</dt>
3474<dd>
3475<p>
3476 Show the context between diff hunks, up to the specified number
3477 of lines, thereby fusing the hunks that are close to each other.
3478 This value serves as the default for the <code>--inter-hunk-context</code>
3479 command line option.
3480</p>
3481</dd>
3482<dt class="hdlist1">
Junio C Hamano1fbbbc12007-12-18 07:01:27[diff] [blame]3483diff.external
3484</dt>
3485<dd>
3486<p>
3487 If this config variable is set, diff generation is not
3488 performed using the internal diff machinery, but using the
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3489 given command. Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
Junio C Hamano85c71572008-07-28 00:03:31[diff] [blame]3490 environment variable. The command is called with parameters
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3491 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]3492 you want to use an external diff program only on a subset of
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3493 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]3494</p>
3495</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3496<dt class="hdlist1">
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3497diff.ignoreSubmodules
3498</dt>
3499<dd>
3500<p>
3501 Sets the default value of --ignore-submodules. Note that this
3502 affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
3503 commands such as <em>git diff-files</em>. <em>git checkout</em> also honors
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]3504 this setting when reporting uncommitted changes. Setting it to
3505 <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]3506 and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]3507 overridden by using the --ignore-submodules command-line option.
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]3508 The <em>git submodule</em> commands are not affected by this setting.
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3509</p>
3510</dd>
3511<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]3512diff.mnemonicPrefix
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]3513</dt>
3514<dd>
3515<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]3516 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]3517 standard "a/" and "b/" depending on what is being compared. When
3518 this configuration is in effect, reverse diff output also swaps
3519 the order of the prefixes:
3520</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3521<div class="dlist"><dl>
3522<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3523<code>git diff</code>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]3524</dt>
3525<dd>
3526<p>
3527 compares the (i)ndex and the (w)ork tree;
3528</p>
3529</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3530<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3531<code>git diff HEAD</code>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]3532</dt>
3533<dd>
3534<p>
3535 compares a (c)ommit and the (w)ork tree;
3536</p>
3537</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3538<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3539<code>git diff --cached</code>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]3540</dt>
3541<dd>
3542<p>
3543 compares a (c)ommit and the (i)ndex;
3544</p>
3545</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3546<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3547<code>git diff HEAD:file1 file2</code>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]3548</dt>
3549<dd>
3550<p>
3551 compares an (o)bject and a (w)ork tree entity;
3552</p>
3553</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3554<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3555<code>git diff --no-index a b</code>
Junio C Hamano5e4d8de2008-09-19 06:27:02[diff] [blame]3556</dt>
3557<dd>
3558<p>
3559 compares two non-git things (1) and (2).
3560</p>
3561</dd>
3562</dl></div>
3563</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3564<dt class="hdlist1">
Junio C Hamano21c2d142010-09-10 18:09:27[diff] [blame]3565diff.noprefix
3566</dt>
3567<dd>
3568<p>
3569 If set, <em>git diff</em> does not show any source or destination prefix.
3570</p>
3571</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3572<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]3573diff.orderFile
Junio C Hamano21bc18b2014-01-10 20:33:07[diff] [blame]3574</dt>
3575<dd>
3576<p>
Junio C Hamanobcd98f42017-01-24 00:12:16[diff] [blame]3577 File indicating how to order files within a diff.
3578 See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
3579 If <code>diff.orderFile</code> is a relative pathname, it is treated as
3580 relative to the top of the working tree.
Junio C Hamano21bc18b2014-01-10 20:33:07[diff] [blame]3581</p>
3582</dd>
3583<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3584diff.renameLimit
3585</dt>
3586<dd>
3587<p>
3588 The number of files to consider when performing the copy/rename
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]3589 detection; equivalent to the <em>git diff</em> option <code>-l</code>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3590</p>
3591</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3592<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3593diff.renames
3594</dt>
3595<dd>
3596<p>
Junio C Hamano4ba4a782016-04-03 19:11:32[diff] [blame]3597 Whether and how Git detects renames. If set to "false",
3598 rename detection is disabled. If set to "true", basic rename
3599 detection is enabled. If set to "copies" or "copy", Git will
3600 detect copies, as well. Defaults to true. Note that this
3601 affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
3602 <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
3603 <a href="git-diff-files.html">git-diff-files(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3604</p>
3605</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3606<dt class="hdlist1">
Junio C Hamanobc4852e2009-01-21 10:51:14[diff] [blame]3607diff.suppressBlankEmpty
Junio C Hamanof1231492008-12-22 08:27:21[diff] [blame]3608</dt>
3609<dd>
3610<p>
3611 A boolean to inhibit the standard behavior of printing a space
3612 before each empty output line. Defaults to false.
3613</p>
3614</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3615<dt class="hdlist1">
Junio C Hamanob4e58b12012-11-26 03:13:06[diff] [blame]3616diff.submodule
3617</dt>
3618<dd>
3619<p>
3620 Specify the format in which differences in submodules are
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]3621 shown. The "short" format just shows the names of the commits
3622 at the beginning and end of the range. The "log" format lists
3623 the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
3624 does. The "diff" format shows an inline diff of the changed
3625 contents of the submodule. Defaults to "short".
Junio C Hamanob4e58b12012-11-26 03:13:06[diff] [blame]3626</p>
3627</dd>
3628<dt class="hdlist1">
3629diff.wordRegex
3630</dt>
3631<dd>
3632<p>
3633 A POSIX Extended Regular Expression used to determine what is a "word"
3634 when performing word-by-word difference calculations. Character
3635 sequences that match the regular expression are "words", all other
3636 characters are <strong>ignorable</strong> whitespace.
3637</p>
3638</dd>
3639<dt class="hdlist1">
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3640diff.&lt;driver&gt;.command
3641</dt>
3642<dd>
3643<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3644 The custom diff driver command. See <a href="gitattributes.html">gitattributes(5)</a>
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3645 for details.
3646</p>
3647</dd>
3648<dt class="hdlist1">
3649diff.&lt;driver&gt;.xfuncname
3650</dt>
3651<dd>
3652<p>
3653 The regular expression that the diff driver should use to
3654 recognize the hunk header. A built-in pattern may also be used.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3655 See <a href="gitattributes.html">gitattributes(5)</a> for details.
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3656</p>
3657</dd>
3658<dt class="hdlist1">
3659diff.&lt;driver&gt;.binary
3660</dt>
3661<dd>
3662<p>
3663 Set this option to true to make the diff driver treat files as
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3664 binary. See <a href="gitattributes.html">gitattributes(5)</a> for details.
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3665</p>
3666</dd>
3667<dt class="hdlist1">
3668diff.&lt;driver&gt;.textconv
3669</dt>
3670<dd>
3671<p>
3672 The command that the diff driver should call to generate the
3673 text-converted version of a file. The result of the
3674 conversion is used to generate a human-readable diff. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3675 <a href="gitattributes.html">gitattributes(5)</a> for details.
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3676</p>
3677</dd>
3678<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]3679diff.&lt;driver&gt;.wordRegex
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3680</dt>
3681<dd>
3682<p>
3683 The regular expression that the diff driver should use to
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3684 split words in a line. See <a href="gitattributes.html">gitattributes(5)</a> for
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3685 details.
3686</p>
3687</dd>
3688<dt class="hdlist1">
3689diff.&lt;driver&gt;.cachetextconv
3690</dt>
3691<dd>
3692<p>
3693 Set this option to true to make the diff driver cache the text
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]3694 conversion outputs. See <a href="gitattributes.html">gitattributes(5)</a> for details.
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]3695</p>
3696</dd>
3697<dt class="hdlist1">
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]3698diff.tool
3699</dt>
3700<dd>
3701<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]3702 Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3703 This variable overrides the value configured in <code>merge.tool</code>.
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]3704 The list below shows the valid built-in values.
3705 Any other value is treated as a custom diff tool and requires
3706 that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]3707</p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]3708<div class="ulist"><ul>
3709<li>
3710<p>
3711araxis
3712</p>
3713</li>
3714<li>
3715<p>
Junio C Hamano2a4bcbc2014-10-29 20:07:39[diff] [blame]3716bc
3717</p>
3718</li>
3719<li>
3720<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]3721bc3
3722</p>
3723</li>
3724<li>
3725<p>
3726codecompare
3727</p>
3728</li>
3729<li>
3730<p>
3731deltawalker
3732</p>
3733</li>
3734<li>
3735<p>
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]3736diffmerge
3737</p>
3738</li>
3739<li>
3740<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]3741diffuse
3742</p>
3743</li>
3744<li>
3745<p>
3746ecmerge
3747</p>
3748</li>
3749<li>
3750<p>
3751emerge
3752</p>
3753</li>
3754<li>
3755<p>
Junio C Hamano5996b672016-04-13 22:01:41[diff] [blame]3756examdiff
3757</p>
3758</li>
3759<li>
3760<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]3761gvimdiff
3762</p>
3763</li>
3764<li>
3765<p>
3766gvimdiff2
3767</p>
3768</li>
3769<li>
3770<p>
Junio C Hamanob051caf2014-06-03 22:15:13[diff] [blame]3771gvimdiff3
3772</p>
3773</li>
3774<li>
3775<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]3776kdiff3
3777</p>
3778</li>
3779<li>
3780<p>
3781kompare
3782</p>
3783</li>
3784<li>
3785<p>
3786meld
3787</p>
3788</li>
3789<li>
3790<p>
3791opendiff
3792</p>
3793</li>
3794<li>
3795<p>
3796p4merge
3797</p>
3798</li>
3799<li>
3800<p>
3801tkdiff
3802</p>
3803</li>
3804<li>
3805<p>
3806vimdiff
3807</p>
3808</li>
3809<li>
3810<p>
3811vimdiff2
3812</p>
3813</li>
3814<li>
3815<p>
Junio C Hamanob051caf2014-06-03 22:15:13[diff] [blame]3816vimdiff3
3817</p>
3818</li>
3819<li>
3820<p>
Junio C Hamano85f1fde2015-06-01 20:37:32[diff] [blame]3821winmerge
3822</p>
3823</li>
3824<li>
3825<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]3826xxdiff
3827</p>
3828</li>
3829</ul></div>
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]3830</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3831<dt class="hdlist1">
Junio C Hamanoad70bf02016-09-26 23:44:27[diff] [blame]3832diff.indentHeuristic
3833</dt>
Junio C Hamano5f888332016-06-13 19:28:31[diff] [blame]3834<dd>
3835<p>
Junio C Hamano56ace3d2017-01-10 23:43:41[diff] [blame]3836 Set this option to <code>true</code> to enable experimental heuristics
3837 that shift diff hunk boundaries to make patches easier to read.
Junio C Hamano5f888332016-06-13 19:28:31[diff] [blame]3838</p>
3839</dd>
3840<dt class="hdlist1">
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3841diff.algorithm
3842</dt>
3843<dd>
3844<p>
3845 Choose a diff algorithm. The variants are as follows:
3846</p>
3847<div class="openblock">
3848<div class="content">
3849<div class="dlist"><dl>
3850<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3851<code>default</code>, <code>myers</code>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3852</dt>
3853<dd>
3854<p>
3855 The basic greedy diff algorithm. Currently, this is the default.
3856</p>
3857</dd>
3858<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3859<code>minimal</code>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3860</dt>
3861<dd>
3862<p>
3863 Spend extra time to make sure the smallest possible diff is
3864 produced.
3865</p>
3866</dd>
3867<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3868<code>patience</code>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3869</dt>
3870<dd>
3871<p>
3872 Use "patience diff" algorithm when generating patches.
3873</p>
3874</dd>
3875<dt class="hdlist1">
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3876<code>histogram</code>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]3877</dt>
3878<dd>
3879<p>
3880 This algorithm extends the patience algorithm to "support
3881 low-occurrence common elements".
3882</p>
3883</dd>
3884</dl></div>
3885</div></div>
3886</dd>
3887<dt class="hdlist1">
Junio C Hamano4a401d52016-10-26 22:24:37[diff] [blame]3888diff.wsErrorHighlight
3889</dt>
3890<dd>
3891<p>
3892 A comma separated list of <code>old</code>, <code>new</code>, <code>context</code>, that
3893 specifies how whitespace errors on lines are highlighted
3894 with <code>color.diff.whitespace</code>. Can be overridden by the
3895 command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
3896</p>
3897</dd>
3898<dt class="hdlist1">
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]3899difftool.&lt;tool&gt;.path
3900</dt>
3901<dd>
3902<p>
3903 Override the path for the given tool. This is useful in case
3904 your tool is not in the PATH.
3905</p>
3906</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3907<dt class="hdlist1">
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]3908difftool.&lt;tool&gt;.cmd
3909</dt>
3910<dd>
3911<p>
3912 Specify the command to invoke the specified diff tool.
3913 The specified command is evaluated in shell with the following
3914 variables available: <em>LOCAL</em> is set to the name of the temporary
3915 file containing the contents of the diff pre-image and <em>REMOTE</em>
3916 is set to the name of the temporary file containing the contents
3917 of the diff post-image.
3918</p>
3919</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3920<dt class="hdlist1">
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]3921difftool.prompt
3922</dt>
3923<dd>
3924<p>
3925 Prompt before each invocation of the diff tool.
3926</p>
3927</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3928<dt class="hdlist1">
Junio C Hamanofedb1b42016-06-20 21:23:40[diff] [blame]3929fastimport.unpackLimit
3930</dt>
3931<dd>
3932<p>
3933 If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
3934 is below this limit, then the objects will be unpacked into
3935 loose object files. However if the number of imported objects
3936 equals or exceeds this limit then the pack will be stored as a
3937 pack. Storing the pack from a fast-import can make the import
3938 operation complete faster, especially on slow filesystems. If
3939 not set, the value of <code>transfer.unpackLimit</code> is used instead.
3940</p>
3941</dd>
3942<dt class="hdlist1">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]3943fetch.recurseSubmodules
3944</dt>
3945<dd>
3946<p>
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]3947 This option can be either set to a boolean value or to <em>on-demand</em>.
3948 Setting it to a boolean changes the behavior of fetch and pull to
3949 unconditionally recurse into submodules when set to true or to not
3950 recurse at all when set to false. When set to <em>on-demand</em> (the default
3951 value), fetch and pull will only recurse into a populated submodule
3952 when its superproject retrieves a commit that updates the submodule&#8217;s
3953 reference.
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]3954</p>
3955</dd>
3956<dt class="hdlist1">
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]3957fetch.fsckObjects
3958</dt>
3959<dd>
3960<p>
3961 If it is set to true, git-fetch-pack will check all fetched
3962 objects. It will abort in the case of a malformed object or a
3963 broken link. The result of an abort are only dangling objects.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3964 Defaults to false. If not set, the value of <code>transfer.fsckObjects</code>
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]3965 is used instead.
3966</p>
3967</dd>
3968<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3969fetch.unpackLimit
3970</dt>
3971<dd>
3972<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]3973 If the number of objects fetched over the Git native
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3974 transfer is below this
3975 limit, then the objects will be unpacked into loose object
3976 files. However if the number of received objects equals or
3977 exceeds this limit then the received pack will be stored as
3978 a pack, after adding any missing delta bases. Storing the
3979 pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]3980 especially on slow filesystems. If not set, the value of
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3981 <code>transfer.unpackLimit</code> is used instead.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]3982</p>
3983</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]3984<dt class="hdlist1">
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]3985fetch.prune
3986</dt>
3987<dd>
3988<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]3989 If true, fetch will automatically behave as if the <code>--prune</code>
3990 option was given on the command line. See also <code>remote.&lt;name&gt;.prune</code>.
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]3991</p>
3992</dd>
3993<dt class="hdlist1">
Junio C Hamano1a1b8472016-07-19 21:37:13[diff] [blame]3994fetch.output
3995</dt>
3996<dd>
3997<p>
3998 Control how ref update status is printed. Valid values are
3999 <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See section
4000 OUTPUT in <a href="git-fetch.html">git-fetch(1)</a> for detail.
4001</p>
4002</dd>
4003<dt class="hdlist1">
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]4004format.attach
4005</dt>
4006<dd>
4007<p>
4008 Enable multipart/mixed attachments as the default for
4009 <em>format-patch</em>. The value can also be a double quoted string
4010 which will enable attachments as the default and set the
4011 value as the boundary. See the --attach option in
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4012 <a href="git-format-patch.html">git-format-patch(1)</a>.
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]4013</p>
4014</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4015<dt class="hdlist1">
Junio C Hamanoaf182942016-08-10 20:46:26[diff] [blame]4016format.from
4017</dt>
4018<dd>
4019<p>
4020 Provides the default value for the <code>--from</code> option to format-patch.
4021 Accepts a boolean value, or a name and email address. If false,
4022 format-patch defaults to <code>--no-from</code>, using commit authors directly in
4023 the "From:" field of patch mails. If true, format-patch defaults to
4024 <code>--from</code>, using your committer identity in the "From:" field of patch
4025 mails and including a "From:" field in the body of the patch mail if
4026 different. If set to a non-boolean value, format-patch uses that
4027 value instead of your committer identity. Defaults to false.
4028</p>
4029</dd>
4030<dt class="hdlist1">
Junio C Hamano8c5802d2007-11-15 00:13:36[diff] [blame]4031format.numbered
4032</dt>
4033<dd>
4034<p>
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]4035 A boolean which can enable or disable sequence numbers in patch
4036 subjects. It defaults to "auto" which enables it only if there
4037 is more than one patch. It can be enabled or disabled for all
4038 messages by setting it to "true" or "false". See --numbered
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4039 option in <a href="git-format-patch.html">git-format-patch(1)</a>.
Junio C Hamano8c5802d2007-11-15 00:13:36[diff] [blame]4040</p>
4041</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4042<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4043format.headers
4044</dt>
4045<dd>
4046<p>
4047 Additional email headers to include in a patch to be submitted
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4048 by mail. See <a href="git-format-patch.html">git-format-patch(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4049</p>
4050</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4051<dt class="hdlist1">
Junio C Hamano70664a02010-07-13 22:48:05[diff] [blame]4052format.to
4053</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4054<dt class="hdlist1">
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]4055format.cc
4056</dt>
4057<dd>
4058<p>
Junio C Hamano70664a02010-07-13 22:48:05[diff] [blame]4059 Additional recipients to include in a patch to be submitted
4060 by mail. See the --to and --cc options in
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4061 <a href="git-format-patch.html">git-format-patch(1)</a>.
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]4062</p>
4063</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4064<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4065format.subjectPrefix
Junio C Hamanof4581102009-04-25 08:29:59[diff] [blame]4066</dt>
4067<dd>
4068<p>
4069 The default for format-patch is to output files with the <em>[PATCH]</em>
4070 subject prefix. Use this variable to change that prefix.
4071</p>
4072</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4073<dt class="hdlist1">
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]4074format.signature
4075</dt>
4076<dd>
4077<p>
4078 The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]4079 the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:55[diff] [blame]4080 Set this variable to the empty string ("") to suppress
4081 signature generation.
4082</p>
4083</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4084<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4085format.signatureFile
Junio C Hamanoc8c398a2014-06-16 21:14:05[diff] [blame]4086</dt>
4087<dd>
4088<p>
4089 Works just like format.signature except the contents of the
4090 file specified by this variable will be used as the signature.
4091</p>
4092</dd>
4093<dt class="hdlist1">
Junio C Hamanod4c8e112007-03-04 10:32:38[diff] [blame]4094format.suffix
4095</dt>
4096<dd>
4097<p>
4098 The default for format-patch is to output files with the suffix
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4099 <code>.patch</code>. Use this variable to change that suffix (make sure to
Junio C Hamanod4c8e112007-03-04 10:32:38[diff] [blame]4100 include the dot if you want it).
4101</p>
4102</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4103<dt class="hdlist1">
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]4104format.pretty
4105</dt>
4106<dd>
4107<p>
4108 The default pretty format for log/show/whatchanged command,
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4109 See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
4110 <a href="git-whatchanged.html">git-whatchanged(1)</a>.
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]4111</p>
4112</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4113<dt class="hdlist1">
Junio C Hamanoea6a7642009-03-11 23:56:19[diff] [blame]4114format.thread
4115</dt>
4116<dd>
4117<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]4118 The default threading style for <em>git format-patch</em>. Can be
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4119 a boolean value, or <code>shallow</code> or <code>deep</code>. <code>shallow</code> threading
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]4120 makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:19[diff] [blame]4121 where the head is chosen from the cover letter, the
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4122 <code>--in-reply-to</code>, and the first patch mail, in this order.
4123 <code>deep</code> threading makes every mail a reply to the previous one.
4124 A true boolean value is the same as <code>shallow</code>, and a false
Junio C Hamanoea6a7642009-03-11 23:56:19[diff] [blame]4125 value disables threading.
4126</p>
4127</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4128<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4129format.signOff
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]4130</dt>
4131<dd>
4132<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4133 A boolean value which lets you enable the <code>-s/--signoff</code> option of
Junio C Hamano804a9742013-04-28 23:10:31[diff] [blame]4134 format-patch by default. <strong>Note:</strong> Adding the Signed-off-by: line to a
4135 patch should be a conscious act and means that you certify you have
4136 the rights to submit this work under the same open source license.
4137 Please see the <em>SubmittingPatches</em> document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]4138</p>
4139</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4140<dt class="hdlist1">
Junio C Hamanoea3b7522013-04-18 19:37:53[diff] [blame]4141format.coverLetter
4142</dt>
4143<dd>
4144<p>
4145 A boolean that controls whether to generate a cover-letter when
4146 format-patch is invoked, but in addition can be set to "auto", to
4147 generate a cover-letter only when there&#8217;s more than one patch.
4148</p>
4149</dd>
4150<dt class="hdlist1">
Junio C Hamano289d7e82016-01-27 00:20:38[diff] [blame]4151format.outputDirectory
4152</dt>
4153<dd>
4154<p>
4155 Set a custom directory to store the resulting files instead of the
4156 current working directory.
4157</p>
4158</dd>
4159<dt class="hdlist1">
Junio C Hamanof2a3a752016-05-23 22:54:39[diff] [blame]4160format.useAutoBase
4161</dt>
4162<dd>
4163<p>
4164 A boolean value which lets you enable the <code>--base=auto</code> option of
4165 format-patch by default.
4166</p>
4167</dd>
4168<dt class="hdlist1">
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]4169filter.&lt;driver&gt;.clean
4170</dt>
4171<dd>
4172<p>
4173 The command which is used to convert the content of a worktree
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4174 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]4175 details.
4176</p>
4177</dd>
4178<dt class="hdlist1">
4179filter.&lt;driver&gt;.smudge
4180</dt>
4181<dd>
4182<p>
4183 The command which is used to convert the content of a blob
4184 object to a worktree file upon checkout. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4185 <a href="gitattributes.html">gitattributes(5)</a> for details.
Junio C Hamano209ebe82011-04-27 21:09:59[diff] [blame]4186</p>
4187</dd>
4188<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]4189fsck.&lt;msg-id&gt;
4190</dt>
4191<dd>
4192<p>
4193 Allows overriding the message type (error, warn or ignore) of a
4194 specific message ID such as <code>missingEmail</code>.
4195</p>
4196<div class="paragraph"><p>For convenience, fsck prefixes the error/warning with the message ID,
4197e.g. "missingEmail: invalid author/committer line - missing email" means
4198that setting <code>fsck.missingEmail = ignore</code> will hide that issue.</p></div>
4199<div class="paragraph"><p>This feature is intended to support working with legacy repositories
4200which cannot be repaired without disruptive changes.</p></div>
4201</dd>
4202<dt class="hdlist1">
4203fsck.skipList
4204</dt>
4205<dd>
4206<p>
4207 The path to a sorted list of object names (i.e. one SHA-1 per
4208 line) that are known to be broken in a non-fatal way and should
4209 be ignored. This feature is useful when an established project
4210 should be accepted despite early commits containing errors that
4211 can be safely ignored such as invalid committer email addresses.
4212 Note: corrupt objects cannot be skipped with this setting.
4213</p>
4214</dd>
4215<dt class="hdlist1">
Junio C Hamano624dd4c2014-04-03 21:56:30[diff] [blame]4216gc.aggressiveDepth
4217</dt>
4218<dd>
4219<p>
4220 The depth parameter used in the delta compression
4221 algorithm used by <em>git gc --aggressive</em>. This defaults
Junio C Hamano53800482016-09-21 23:26:43[diff] [blame]4222 to 50.
Junio C Hamano624dd4c2014-04-03 21:56:30[diff] [blame]4223</p>
4224</dd>
4225<dt class="hdlist1">
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]4226gc.aggressiveWindow
4227</dt>
4228<dd>
4229<p>
4230 The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]4231 algorithm used by <em>git gc --aggressive</em>. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:36[diff] [blame]4232 to 250.
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]4233</p>
4234</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4235<dt class="hdlist1">
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]4236gc.auto
4237</dt>
4238<dd>
4239<p>
4240 When there are approximately more than this many loose
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4241 objects in the repository, <code>git gc --auto</code> will pack them.
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]4242 Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]4243 light-weight garbage collection from time to time. The
4244 default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]4245</p>
4246</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4247<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4248gc.autoPackLimit
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]4249</dt>
4250<dd>
4251<p>
4252 When there are more than this many packs that are not
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4253 marked with <code>*.keep</code> file in the repository, <code>git gc
4254 --auto</code> consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37[diff] [blame]4255 default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]4256</p>
4257</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4258<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4259gc.autoDetach
Junio C Hamano08ef8c22014-03-10 14:53:44[diff] [blame]4260</dt>
4261<dd>
4262<p>
Junio C Hamanofb5ffde2014-11-04 22:38:56[diff] [blame]4263 Make <code>git gc --auto</code> return immediately and run in background
Junio C Hamano08ef8c22014-03-10 14:53:44[diff] [blame]4264 if the system supports it. Default is true.
4265</p>
4266</dd>
4267<dt class="hdlist1">
Junio C Hamanocbe0eb22017-02-27 23:37:49[diff] [blame]4268gc.logExpiry
4269</dt>
4270<dd>
4271<p>
4272 If the file gc.log exists, then <code>git gc --auto</code> won&#8217;t run
4273 unless that file is more than <em>gc.logExpiry</em> old. Default is
4274 "1.day". See <code>gc.pruneExpire</code> for more ways to specify its
4275 value.
4276</p>
4277</dd>
4278<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4279gc.packRefs
Junio C Hamano9d52e572007-02-13 23:48:20[diff] [blame]4280</dt>
4281<dd>
4282<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4283 Running <code>git pack-refs</code> in a repository renders it
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]4284 unclonable by Git versions prior to 1.5.1.2 over dumb
4285 transports such as HTTP. This variable determines whether
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4286 <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]4287 to enable it within all non-bare repos or it can be set to a
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4288 boolean value. The default is <code>true</code>.
Junio C Hamano9d52e572007-02-13 23:48:20[diff] [blame]4289</p>
4290</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4291<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4292gc.pruneExpire
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]4293</dt>
4294<dd>
4295<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]4296 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]4297 Override the grace period with this config variable. The value
Junio C Hamano9c512872015-08-12 21:59:25[diff] [blame]4298 "now" may be used to disable this grace period and always prune
4299 unreachable objects immediately, or "never" may be used to
Junio C Hamano56ace3d2017-01-10 23:43:41[diff] [blame]4300 suppress pruning. This feature helps prevent corruption when
4301 <em>git gc</em> runs concurrently with another process writing to the
4302 repository; see the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]4303</p>
4304</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4305<dt class="hdlist1">
Junio C Hamano9c512872015-08-12 21:59:25[diff] [blame]4306gc.worktreePruneExpire
Junio C Hamano4cc4a842015-05-11 22:41:02[diff] [blame]4307</dt>
4308<dd>
4309<p>
Junio C Hamano9c512872015-08-12 21:59:25[diff] [blame]4310 When <em>git gc</em> is run, it calls
4311 <em>git worktree prune --expire 3.months.ago</em>.
4312 This config variable can be used to set a different grace
4313 period. The value "now" may be used to disable the grace
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]4314 period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
Junio C Hamano9c512872015-08-12 21:59:25[diff] [blame]4315 may be used to suppress pruning.
Junio C Hamano4cc4a842015-05-11 22:41:02[diff] [blame]4316</p>
4317</dd>
4318<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4319gc.reflogExpire
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4320</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4321<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4322gc.&lt;pattern&gt;.reflogExpire
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]4323</dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4324<dd>
4325<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]4326 <em>git reflog expire</em> removes reflog entries older than
Junio C Hamano9c512872015-08-12 21:59:25[diff] [blame]4327 this time; defaults to 90 days. The value "now" expires all
4328 entries immediately, and "never" suppresses expiration
4329 altogether. With "&lt;pattern&gt;" (e.g.
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]4330 "refs/stash") in the middle the setting applies only to
4331 the refs that match the &lt;pattern&gt;.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4332</p>
4333</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4334<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4335gc.reflogExpireUnreachable
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4336</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4337<dt class="hdlist1">
Junio C Hamanoa1746be2015-08-26 23:07:07[diff] [blame]4338gc.&lt;pattern&gt;.reflogExpireUnreachable
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]4339</dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4340<dd>
4341<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]4342 <em>git reflog expire</em> removes reflog entries older than
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4343 this time and are not reachable from the current tip;
Junio C Hamano9c512872015-08-12 21:59:25[diff] [blame]4344 defaults to 30 days. The value "now" expires all entries
4345 immediately, and "never" suppresses expiration altogether.
4346 With "&lt;pattern&gt;" (e.g. "refs/stash")
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]4347 in the middle, the setting applies only to the refs that
4348 match the &lt;pattern&gt;.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4349</p>
4350</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4351<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4352gc.rerereResolved
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4353</dt>
4354<dd>
4355<p>
4356 Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]4357 kept for this many days when <em>git rerere gc</em> is run.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4358 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]4359</p>
4360</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4361<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4362gc.rerereUnresolved
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4363</dt>
4364<dd>
4365<p>
4366 Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]4367 kept for this many days when <em>git rerere gc</em> is run.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4368 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]4369</p>
4370</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4371<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4372gitcvs.commitMsgAnnotation
Junio C Hamanoa3148f52009-01-14 08:49:57[diff] [blame]4373</dt>
4374<dd>
4375<p>
4376 Append this string to each commit message. Set to empty string
4377 to disable this feature. Defaults to "via git-CVS emulator".
4378</p>
4379</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4380<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4381gitcvs.enabled
4382</dt>
4383<dd>
4384<p>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]4385 Whether the CVS server interface is enabled for this repository.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4386 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4387</p>
4388</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4389<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4390gitcvs.logFile
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4391</dt>
4392<dd>
4393<p>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]4394 Path to a log file where the CVS server interface well&#8230; logs
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4395 various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]4396</p>
4397</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4398<dt class="hdlist1">
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]4399gitcvs.usecrlfattr
4400</dt>
4401<dd>
4402<p>
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]4403 If true, the server will look up the end-of-line conversion
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]4404 attributes for files to determine the <code>-k</code> modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]4405 the attributes force Git to treat a file as text,
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]4406 the <code>-k</code> mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]4407 treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]4408 will be set with <em>-kb</em> mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:55[diff] [blame]4409 the client might otherwise do. If the attributes do not allow
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4410 the file type to be determined, then <code>gitcvs.allBinary</code> is
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4411 used. See <a href="gitattributes.html">gitattributes(5)</a>.
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]4412</p>
4413</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4414<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4415gitcvs.allBinary
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]4416</dt>
4417<dd>
4418<p>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4419 This is used if <code>gitcvs.usecrlfattr</code> does not resolve
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]4420 the correct <em>-kb</em> mode to use. If true, all
4421 unresolved files are sent to the client in
4422 mode <em>-kb</em>. This causes the client to treat them
4423 as binary files, which suppresses any newline munging it
4424 otherwise might do. Alternatively, if it is set to "guess",
4425 then the contents of the file are examined to decide if
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4426 it is binary, similar to <code>core.autocrlf</code>.
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]4427</p>
4428</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4429<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4430gitcvs.dbName
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]4431</dt>
4432<dd>
4433<p>
4434 Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]4435 derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]4436 used database driver, for SQLite (which is the default driver) this
4437 is a filename. Supports variable substitution (see
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4438 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]4439 Default: <em>%Ggitcvs.%m.sqlite</em>
4440</p>
4441</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4442<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4443gitcvs.dbDriver
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]4444</dt>
4445<dd>
4446<p>
4447 Used Perl DBI driver. You can specify any available driver
4448 for this here, but it might not work. git-cvsserver is tested
4449 with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
4450 reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4451 May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4452 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]4453</p>
4454</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4455<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4456gitcvs.dbUser, gitcvs.dbPass
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]4457</dt>
4458<dd>
4459<p>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4460 Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]4461 since SQLite has no concept of database users and/or passwords.
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4462 <em>gitcvs.dbUser</em> supports variable substitution (see
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4463 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]4464</p>
4465</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4466<dt class="hdlist1">
Junio C Hamanoa74efce2008-04-02 08:39:08[diff] [blame]4467gitcvs.dbTableNamePrefix
4468</dt>
4469<dd>
4470<p>
4471 Database table name prefix. Prepended to the names of any
4472 database tables used, allowing a single database to be used
4473 for several repositories. Supports variable substitution (see
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4474 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). Any non-alphabetic
Junio C Hamanoa74efce2008-04-02 08:39:08[diff] [blame]4475 characters will be replaced with underscores.
4476</p>
4477</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]4478</dl></div>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4479<div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
4480<code>gitcvs.allBinary</code> can also be specified as
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]4481<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]4482is one of "ext" and "pserver") to make them apply only for the given
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]4483access method.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4484<div class="dlist"><dl>
4485<dt class="hdlist1">
Junio C Hamano11821ed2011-10-19 18:42:09[diff] [blame]4486gitweb.category
4487</dt>
4488<dt class="hdlist1">
4489gitweb.description
4490</dt>
4491<dt class="hdlist1">
4492gitweb.owner
4493</dt>
4494<dt class="hdlist1">
4495gitweb.url
4496</dt>
4497<dd>
4498<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4499 See <a href="gitweb.html">gitweb(1)</a> for description.
Junio C Hamano11821ed2011-10-19 18:42:09[diff] [blame]4500</p>
4501</dd>
4502<dt class="hdlist1">
4503gitweb.avatar
4504</dt>
4505<dt class="hdlist1">
4506gitweb.blame
4507</dt>
4508<dt class="hdlist1">
4509gitweb.grep
4510</dt>
4511<dt class="hdlist1">
4512gitweb.highlight
4513</dt>
4514<dt class="hdlist1">
4515gitweb.patches
4516</dt>
4517<dt class="hdlist1">
4518gitweb.pickaxe
4519</dt>
4520<dt class="hdlist1">
4521gitweb.remote_heads
4522</dt>
4523<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4524gitweb.showSizes
Junio C Hamano11821ed2011-10-19 18:42:09[diff] [blame]4525</dt>
4526<dt class="hdlist1">
4527gitweb.snapshot
4528</dt>
4529<dd>
4530<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4531 See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.
Junio C Hamano11821ed2011-10-19 18:42:09[diff] [blame]4532</p>
4533</dd>
4534<dt class="hdlist1">
Junio C Hamanoa03ac862011-04-02 04:32:29[diff] [blame]4535grep.lineNumber
4536</dt>
4537<dd>
4538<p>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]4539 If set to true, enable <code>-n</code> option by default.
Junio C Hamanoa03ac862011-04-02 04:32:29[diff] [blame]4540</p>
4541</dd>
4542<dt class="hdlist1">
Junio C Hamanoa00504d2012-08-27 21:11:23[diff] [blame]4543grep.patternType
4544</dt>
4545<dd>
4546<p>
4547 Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]4548 <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
4549 <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
Junio C Hamanoa00504d2012-08-27 21:11:23[diff] [blame]4550 value <em>default</em> will return to the default matching behavior.
4551</p>
4552</dd>
4553<dt class="hdlist1">
Junio C Hamanoa03ac862011-04-02 04:32:29[diff] [blame]4554grep.extendedRegexp
4555</dt>
4556<dd>
4557<p>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]4558 If set to true, enable <code>--extended-regexp</code> option by default. This
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4559 option is ignored when the <code>grep.patternType</code> option is set to a value
Junio C Hamanoa00504d2012-08-27 21:11:23[diff] [blame]4560 other than <em>default</em>.
Junio C Hamanoa03ac862011-04-02 04:32:29[diff] [blame]4561</p>
4562</dd>
4563<dt class="hdlist1">
Junio C Hamanoa7da1ba2016-01-13 00:19:45[diff] [blame]4564grep.threads
4565</dt>
4566<dd>
4567<p>
4568 Number of grep worker threads to use.
4569 See <code>grep.threads</code> in <a href="git-grep.html">git-grep(1)</a> for more information.
4570</p>
4571</dd>
4572<dt class="hdlist1">
Junio C Hamano4e6ba272016-01-20 23:23:19[diff] [blame]4573grep.fallbackToNoIndex
4574</dt>
4575<dd>
4576<p>
4577 If set to true, fall back to git grep --no-index if git grep
4578 is executed outside of a git repository. Defaults to false.
4579</p>
4580</dd>
4581<dt class="hdlist1">
Junio C Hamano4fd24422012-01-06 21:52:43[diff] [blame]4582gpg.program
4583</dt>
4584<dd>
4585<p>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]4586 Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
Junio C Hamano4fd24422012-01-06 21:52:43[diff] [blame]4587 making or verifying a PGP signature. The program must support the
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]4588 same command-line interface as GPG, namely, to verify a detached
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]4589 signature, "<code>gpg --verify $file - &lt;$signature</code>" is run, and the
Junio C Hamano4fd24422012-01-06 21:52:43[diff] [blame]4590 program is expected to signal a good signature by exiting with
Junio C Hamanofb5ffde2014-11-04 22:38:56[diff] [blame]4591 code 0, and to generate an ASCII-armored detached signature, the
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]4592 standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
Junio C Hamano4fd24422012-01-06 21:52:43[diff] [blame]4593 signed, and the program is expected to send the result to its
4594 standard output.
4595</p>
4596</dd>
4597<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4598gui.commitMsgWidth
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]4599</dt>
4600<dd>
4601<p>
4602 Defines how wide the commit message window is in the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4603 <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]4604</p>
4605</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4606<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4607gui.diffContext
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]4608</dt>
4609<dd>
4610<p>
4611 Specifies how many context lines should be used in calls to diff
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4612 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]4613</p>
4614</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4615<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4616gui.displayUntracked
Junio C Hamano796c55f2014-05-02 21:45:15[diff] [blame]4617</dt>
4618<dd>
4619<p>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]4620 Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
Junio C Hamano796c55f2014-05-02 21:45:15[diff] [blame]4621 in the file list. The default is "true".
4622</p>
4623</dd>
4624<dt class="hdlist1">
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]4625gui.encoding
4626</dt>
4627<dd>
4628<p>
4629 Specifies the default encoding to use for displaying of
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4630 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]4631 It can be overridden by setting the <em>encoding</em> attribute
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4632 for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]4633 If this option is not set, the tools default to the
4634 locale encoding.
4635</p>
4636</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4637<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4638gui.matchTrackingBranch
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]4639</dt>
4640<dd>
4641<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4642 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]4643 default to tracking remote branches with matching names or
4644 not. Default: "false".
4645</p>
4646</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4647<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4648gui.newBranchTemplate
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]4649</dt>
4650<dd>
4651<p>
4652 Is used as suggested name when creating new branches using the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4653 <a href="git-gui.html">git-gui(1)</a>.
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]4654</p>
4655</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4656<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4657gui.pruneDuringFetch
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]4658</dt>
4659<dd>
4660<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4661 "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]4662 performing a fetch. The default value is "false".
4663</p>
4664</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4665<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]4666gui.trustmtime
4667</dt>
4668<dd>
4669<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4670 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]4671 timestamp or not. By default the timestamps are not trusted.
4672</p>
4673</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4674<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4675gui.spellingDictionary
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]4676</dt>
4677<dd>
4678<p>
4679 Specifies the dictionary used for spell checking commit messages in
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4680 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]4681 off.
4682</p>
4683</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4684<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4685gui.fastCopyBlame
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]4686</dt>
4687<dd>
4688<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4689 If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]4690 location detection. It makes blame significantly faster on huge
4691 repositories at the expense of less thorough copy detection.
4692</p>
4693</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4694<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4695gui.copyBlameThreshold
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]4696</dt>
4697<dd>
4698<p>
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]4699 Specifies the threshold to use in <em>git gui blame</em> original location
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]4700 detection, measured in alphanumeric characters. See the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4701 <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]4702</p>
4703</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4704<dt class="hdlist1">
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]4705gui.blamehistoryctx
4706</dt>
4707<dd>
4708<p>
4709 Specifies the radius of history context in days to show in
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4710 <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
4711 Context</code> menu item is invoked from <em>git gui blame</em>. If this
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]4712 variable is set to zero, the whole history is shown.
4713</p>
4714</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4715<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4716guitool.&lt;name&gt;.cmd
4717</dt>
4718<dd>
4719<p>
4720 Specifies the shell command line to execute when the corresponding item
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]4721 of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4722 mandatory for every tool. The command is executed from the root of
4723 the working directory, and in the environment it receives the name of
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4724 the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4725 <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
4726 the head is detached, <em>CUR_BRANCH</em> is empty).
4727</p>
4728</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4729<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4730guitool.&lt;name&gt;.needsFile
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4731</dt>
4732<dd>
4733<p>
4734 Run the tool only if a diff is selected in the GUI. It guarantees
4735 that <em>FILENAME</em> is not empty.
4736</p>
4737</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4738<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4739guitool.&lt;name&gt;.noConsole
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4740</dt>
4741<dd>
4742<p>
4743 Run the command silently, without creating a window to display its
4744 output.
4745</p>
4746</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4747<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4748guitool.&lt;name&gt;.noRescan
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4749</dt>
4750<dd>
4751<p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4752 Don&#8217;t rescan the working directory for changes after the tool
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4753 finishes execution.
4754</p>
4755</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4756<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4757guitool.&lt;name&gt;.confirm
4758</dt>
4759<dd>
4760<p>
4761 Show a confirmation dialog before actually running the tool.
4762</p>
4763</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4764<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4765guitool.&lt;name&gt;.argPrompt
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4766</dt>
4767<dd>
4768<p>
4769 Request a string argument from the user, and pass it to the tool
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4770 through the <code>ARGS</code> environment variable. Since requesting an
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4771 argument implies confirmation, the <em>confirm</em> option has no effect
4772 if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
4773 the dialog uses a built-in generic prompt; otherwise the exact
4774 value of the variable is used.
4775</p>
4776</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4777<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4778guitool.&lt;name&gt;.revPrompt
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4779</dt>
4780<dd>
4781<p>
4782 Request a single valid revision from the user, and set the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4783 <code>REVISION</code> environment variable. In other aspects this option
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4784 is similar to <em>argPrompt</em>, and can be used together with it.
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4785</p>
4786</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4787<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4788guitool.&lt;name&gt;.revUnmerged
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4789</dt>
4790<dd>
4791<p>
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4792 Show only unmerged branches in the <em>revPrompt</em> subdialog.
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4793 This is useful for tools similar to merge or rebase, but not
4794 for things like checkout or reset.
4795</p>
4796</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4797<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4798guitool.&lt;name&gt;.title
4799</dt>
4800<dd>
4801<p>
4802 Specifies the title to use for the prompt dialog. The default
4803 is the tool name.
4804</p>
4805</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4806<dt class="hdlist1">
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4807guitool.&lt;name&gt;.prompt
4808</dt>
4809<dd>
4810<p>
4811 Specifies the general prompt string to display at the top of
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4812 the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
Junio C Hamano92d312a2008-12-15 07:22:20[diff] [blame]4813 The default value includes the actual command.
4814</p>
4815</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4816<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]4817help.browser
4818</dt>
4819<dd>
4820<p>
4821 Specify the browser that will be used to display help in the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4822 <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]4823</p>
4824</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4825<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]4826help.format
4827</dt>
4828<dd>
4829<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]4830 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]4831 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
4832 the default. <em>web</em> and <em>html</em> are the same.
4833</p>
4834</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4835<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4836help.autoCorrect
Junio C Hamanof24b8062008-09-09 01:34:39[diff] [blame]4837</dt>
4838<dd>
4839<p>
4840 Automatically correct and execute mistyped commands after
4841 waiting for the given number of deciseconds (0.1 sec). If more
4842 than one command can be deduced from the entered text, nothing
4843 will be executed. If the value of this option is negative,
4844 the corrected command will be executed immediately. If the
4845 value is 0 - the command will be just shown but not executed.
4846 This is the default.
4847</p>
4848</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4849<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4850help.htmlPath
Junio C Hamano5dd5fae2013-01-18 21:06:49[diff] [blame]4851</dt>
4852<dd>
4853<p>
4854 Specify the path where the HTML documentation resides. File system paths
4855 and URLs are supported. HTML pages will be prefixed with this path when
4856 help is displayed in the <em>web</em> format. This defaults to the documentation
4857 path of your Git installation.
4858</p>
4859</dd>
4860<dt class="hdlist1">
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]4861http.proxy
4862</dt>
4863<dd>
4864<p>
Junio C Hamano3dd93922012-03-05 07:49:11[diff] [blame]4865 Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
Junio C Hamanoffe10ca2016-02-04 00:44:23[diff] [blame]4866 <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
4867 addition to the syntax understood by curl, it is possible to specify a
4868 proxy string with a user name but no password, in which case git will
4869 attempt to acquire one in the same way it does for other credentials. See
4870 <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
4871 <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
4872 on a per-remote basis; see remote.&lt;name&gt;.proxy
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]4873</p>
4874</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]4875<dt class="hdlist1">
Junio C Hamanoffe10ca2016-02-04 00:44:23[diff] [blame]4876http.proxyAuthMethod
4877</dt>
4878<dd>
4879<p>
4880 Set the method with which to authenticate against the HTTP proxy. This
4881 only takes effect if the configured proxy string contains a user name part
4882 (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
4883 overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]4884 Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
Junio C Hamanoffe10ca2016-02-04 00:44:23[diff] [blame]4885 variable. Possible values are:
4886</p>
4887<div class="openblock">
4888<div class="content">
4889<div class="ulist"><ul>
4890<li>
4891<p>
4892<code>anyauth</code> - Automatically pick a suitable authentication method. It is
4893 assumed that the proxy answers an unauthenticated request with a 407
4894 status code and one or more Proxy-authenticate headers with supported
4895 authentication methods. This is the default.
4896</p>
4897</li>
4898<li>
4899<p>
4900<code>basic</code> - HTTP Basic authentication
4901</p>
4902</li>
4903<li>
4904<p>
4905<code>digest</code> - HTTP Digest authentication; this prevents the password from being
4906 transmitted to the proxy in clear text
4907</p>
4908</li>
4909<li>
4910<p>
4911<code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
4912 of <code>curl(1)</code>)
4913</p>
4914</li>
4915<li>
4916<p>
4917<code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
4918</p>
4919</li>
4920</ul></div>
4921</div></div>
4922</dd>
4923<dt class="hdlist1">
Junio C Hamano3fcdd072016-02-24 23:41:08[diff] [blame]4924http.emptyAuth
4925</dt>
4926<dd>
4927<p>
4928 Attempt authentication without seeking a username or password. This
4929 can be used to attempt GSS-Negotiate authentication without specifying
4930 a username in the URL, as libcurl normally requires a username for
4931 authentication.
4932</p>
4933</dd>
4934<dt class="hdlist1">
Junio C Hamano34afdb22016-10-06 22:16:39[diff] [blame]4935http.delegation
4936</dt>
4937<dd>
4938<p>
4939 Control GSSAPI credential delegation. The delegation is disabled
4940 by default in libcurl since version 7.21.7. Set parameter to tell
4941 the server what it is allowed to delegate when it comes to user
4942 credentials. Used with GSS/kerberos. Possible values are:
4943</p>
4944<div class="openblock">
4945<div class="content">
4946<div class="ulist"><ul>
4947<li>
4948<p>
4949<code>none</code> - Don&#8217;t allow any delegation.
4950</p>
4951</li>
4952<li>
4953<p>
4954<code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
4955 Kerberos service ticket, which is a matter of realm policy.
4956</p>
4957</li>
4958<li>
4959<p>
4960<code>always</code> - Unconditionally allow the server to delegate.
4961</p>
4962</li>
4963</ul></div>
4964</div></div>
4965</dd>
4966<dt class="hdlist1">
Junio C Hamanoccdabca2016-05-06 22:27:09[diff] [blame]4967http.extraHeader
4968</dt>
4969<dd>
4970<p>
4971 Pass an additional HTTP header when communicating with a server. If
4972 more than one such entry exists, all of them are added as extra
4973 headers. To allow overriding the settings inherited from the system
4974 config, an empty value will reset the extra headers to the empty list.
4975</p>
4976</dd>
4977<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4978http.cookieFile
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]4979</dt>
4980<dd>
4981<p>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]4982 The pathname of a file containing previously stored cookie lines,
4983 which should be used
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]4984 in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]4985 of the file to read cookies from should be plain HTTP headers or
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]4986 the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
4987 NOTE that the file specified with http.cookieFile is used only as
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]4988 input unless http.saveCookies is set.
4989</p>
4990</dd>
4991<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4992http.saveCookies
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]4993</dt>
4994<dd>
4995<p>
4996 If set, store cookies received during requests to the file specified by
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]4997 http.cookieFile. Has no effect if http.cookieFile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]4998</p>
4999</dd>
5000<dt class="hdlist1">
Junio C Hamanoa1746be2015-08-26 23:07:07[diff] [blame]5001http.sslVersion
5002</dt>
5003<dd>
5004<p>
5005 The SSL version to use when negotiating an SSL connection, if you
5006 want to force the default. The available and default version
5007 depend on whether libcurl was built against NSS or OpenSSL and the
5008 particular configuration of the crypto library in use. Internally
5009 this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
5010 documentation for more details on the format of this option and
5011 for the ssl version supported. Actually the possible values of
5012 this option are:
5013</p>
5014<div class="ulist"><ul>
5015<li>
5016<p>
5017sslv2
5018</p>
5019</li>
5020<li>
5021<p>
5022sslv3
5023</p>
5024</li>
5025<li>
5026<p>
5027tlsv1
5028</p>
5029</li>
5030<li>
5031<p>
5032tlsv1.0
5033</p>
5034</li>
5035<li>
5036<p>
5037tlsv1.1
5038</p>
5039</li>
5040<li>
5041<p>
5042tlsv1.2
5043</p>
5044</li>
5045</ul></div>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5046<div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
Junio C Hamanoa1746be2015-08-26 23:07:07[diff] [blame]5047To force git to use libcurl&#8217;s default ssl version and ignore any
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5048explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
Junio C Hamanoa1746be2015-08-26 23:07:07[diff] [blame]5049empty string.</p></div>
5050</dd>
5051<dt class="hdlist1">
Junio C Hamano1dbca522015-05-22 20:48:55[diff] [blame]5052http.sslCipherList
5053</dt>
5054<dd>
5055<p>
5056 A list of SSL ciphers to use when negotiating an SSL connection.
5057 The available ciphers depend on whether libcurl was built against
5058 NSS or OpenSSL and the particular configuration of the crypto
5059 library in use. Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
5060 option; see the libcurl documentation for more details on the format
5061 of this list.
5062</p>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5063<div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
Junio C Hamano1dbca522015-05-22 20:48:55[diff] [blame]5064To force git to use libcurl&#8217;s default cipher list and ignore any
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5065explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
Junio C Hamano1dbca522015-05-22 20:48:55[diff] [blame]5066empty string.</p></div>
5067</dd>
5068<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5069http.sslVerify
5070</dt>
5071<dd>
5072<p>
5073 Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5074 over HTTPS. Can be overridden by the <code>GIT_SSL_NO_VERIFY</code> environment
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5075 variable.
5076</p>
5077</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5078<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5079http.sslCert
5080</dt>
5081<dd>
5082<p>
5083 File containing the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5084 over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5085 variable.
5086</p>
5087</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5088<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5089http.sslKey
5090</dt>
5091<dd>
5092<p>
5093 File containing the SSL private key when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5094 over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5095 variable.
5096</p>
5097</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5098<dt class="hdlist1">
Junio C Hamano48bc1ce2009-07-09 16:49:19[diff] [blame]5099http.sslCertPasswordProtected
5100</dt>
5101<dd>
5102<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5103 Enable Git&#8217;s password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:19[diff] [blame]5104 OpenSSL will prompt the user, possibly many times, if the
5105 certificate or private key is encrypted. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5106 <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
Junio C Hamano48bc1ce2009-07-09 16:49:19[diff] [blame]5107</p>
5108</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5109<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5110http.sslCAInfo
5111</dt>
5112<dd>
5113<p>
5114 File containing the certificates to verify the peer with when
5115 fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5116 <code>GIT_SSL_CAINFO</code> environment variable.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5117</p>
5118</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5119<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5120http.sslCAPath
5121</dt>
5122<dd>
5123<p>
5124 Path containing files with the CA certificates to verify the peer
5125 with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5126 by the <code>GIT_SSL_CAPATH</code> environment variable.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5127</p>
5128</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5129<dt class="hdlist1">
Junio C Hamano3fcdd072016-02-24 23:41:08[diff] [blame]5130http.pinnedpubkey
5131</dt>
5132<dd>
5133<p>
5134 Public key of the https service. It may either be the filename of
5135 a PEM or DER encoded public key file or a string starting with
5136 <em>sha256//</em> followed by the base64 encoded sha256 hash of the
5137 public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
5138 exit with an error if this option is set but not supported by
5139 cURL.
5140</p>
5141</dd>
5142<dt class="hdlist1">
Junio C Hamano76927822013-04-19 21:26:57[diff] [blame]5143http.sslTry
5144</dt>
5145<dd>
5146<p>
5147 Attempt to use AUTH SSL/TLS and encrypted data transfers
5148 when connecting via regular FTP protocol. This might be needed
5149 if the FTP server requires it for security reasons or you wish
5150 to connect securely whenever remote FTP server supports it.
5151 Default is false since it might trigger certificate verification
5152 errors on misconfigured servers.
5153</p>
5154</dd>
5155<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5156http.maxRequests
5157</dt>
5158<dd>
5159<p>
5160 How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5161 by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5162</p>
5163</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5164<dt class="hdlist1">
Junio C Hamanob141a922010-01-10 19:55:14[diff] [blame]5165http.minSessions
5166</dt>
5167<dd>
5168<p>
5169 The number of curl sessions (counted across slots) to be kept across
5170 requests. They will not be ended with curl_easy_cleanup() until
5171 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
5172 value will be capped at 1. Defaults to 1.
5173</p>
5174</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5175<dt class="hdlist1">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]5176http.postBuffer
5177</dt>
5178<dd>
5179<p>
5180 Maximum size in bytes of the buffer used by smart HTTP
5181 transports when POSTing data to the remote system.
5182 For requests larger than this buffer size, HTTP/1.1 and
5183 Transfer-Encoding: chunked is used to avoid creating a
5184 massive pack file locally. Default is 1 MiB, which is
5185 sufficient for most requests.
5186</p>
5187</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5188<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5189http.lowSpeedLimit, http.lowSpeedTime
5190</dt>
5191<dd>
5192<p>
5193 If the HTTP transfer speed is less than <em>http.lowSpeedLimit</em>
5194 for longer than <em>http.lowSpeedTime</em> seconds, the transfer is aborted.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5195 Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
5196 <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5197</p>
5198</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5199<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5200http.noEPSV
5201</dt>
5202<dd>
5203<p>
5204 A boolean which disables using of EPSV ftp command by curl.
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5205 This can helpful with some "poor" ftp servers which don&#8217;t
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5206 support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5207 environment variable. Default is false (curl will use EPSV).
5208</p>
5209</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5210<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]5211http.userAgent
Junio C Hamano53ba6d02010-08-22 07:25:12[diff] [blame]5212</dt>
5213<dd>
5214<p>
5215 The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5216 value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:12[diff] [blame]5217 This option allows you to override this value to a more common value
5218 such as Mozilla/4.0. This may be necessary, for instance, if
5219 connecting through a firewall that restricts HTTP connections to a set
5220 of common USER_AGENT strings (but not including those like git/1.7.1).
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5221 Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
Junio C Hamano53ba6d02010-08-22 07:25:12[diff] [blame]5222</p>
5223</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5224<dt class="hdlist1">
Junio C Hamano52b1cfb2016-12-20 00:18:36[diff] [blame]5225http.followRedirects
5226</dt>
5227<dd>
5228<p>
5229 Whether git should follow HTTP redirects. If set to <code>true</code>, git
5230 will transparently follow any redirect issued by a server it
5231 encounters. If set to <code>false</code>, git will treat all redirects as
5232 errors. If set to <code>initial</code>, git will follow redirects only for
5233 the initial request to a remote, but not for subsequent
5234 follow-up HTTP requests. Since git uses the redirected URL as
5235 the base for the follow-up requests, this is generally
5236 sufficient. The default is <code>initial</code>.
5237</p>
5238</dd>
5239<dt class="hdlist1">
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5240http.&lt;url&gt;.*
5241</dt>
5242<dd>
5243<p>
Junio C Hamanofb5ffde2014-11-04 22:38:56[diff] [blame]5244 Any of the http.* options above can be applied selectively to some URLs.
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5245 For a config key to match a URL, each element of the config key is
5246 compared to that of the URL, in the following order:
5247</p>
5248<div class="openblock">
5249<div class="content">
5250<div class="olist arabic"><ol class="arabic">
5251<li>
5252<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5253Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5254 must match exactly between the config key and the URL.
5255</p>
5256</li>
5257<li>
5258<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5259Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
Junio C Hamanocbe0eb22017-02-27 23:37:49[diff] [blame]5260 This field must match between the config key and the URL. It is
5261 possible to specify a <code>*</code> as part of the host name to match all subdomains
5262 at this level. <code>https://*.example.com/</code> for example would match
5263 <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5264</p>
5265</li>
5266<li>
5267<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5268Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5269 This field must match exactly between the config key and the URL.
5270 Omitted port numbers are automatically converted to the correct
5271 default for the scheme before matching.
5272</p>
5273</li>
5274<li>
5275<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5276Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5277 path field of the config key must match the path field of the URL
5278 either exactly or as a prefix of slash-delimited path elements. This means
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5279 a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>. A prefix can only
5280 match on a slash (<code>/</code>) boundary. Longer matches take precedence (so a config
5281 key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
5282 key with just path <code>foo/</code>).
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5283</p>
5284</li>
5285<li>
5286<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5287User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5288 the config key has a user name it must match the user name in the
5289 URL exactly. If the config key does not have a user name, that
5290 config key will match a URL with any user name (including none),
5291 but at a lower precedence than a config key with a user name.
5292</p>
5293</li>
5294</ol></div>
5295</div></div>
5296<div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches
5297a config key&#8217;s path is preferred to one that matches its user name. For example,
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5298if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
5299<code>https://example.com/foo</code> will be preferred over a config key match of
5300<code>https://user@example.com</code>.</p></div>
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5301<div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part,
5302if embedded in the URL, is always ignored for matching purposes) so that
Junio C Hamanofb5ffde2014-11-04 22:38:56[diff] [blame]5303equivalent URLs that are simply spelled differently will match properly.
5304Environment variable settings always override any matches. The URLs that are
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]5305matched against are those given directly to Git commands. This means any URLs
5306visited as a result of a redirection do not participate in matching.</p></div>
5307</dd>
5308<dt class="hdlist1">
Junio C Hamanocbe0eb22017-02-27 23:37:49[diff] [blame]5309ssh.variant
5310</dt>
5311<dd>
5312<p>
5313 Depending on the value of the environment variables <code>GIT_SSH</code> or
5314 <code>GIT_SSH_COMMAND</code>, or the config setting <code>core.sshCommand</code>, Git
5315 auto-detects whether to adjust its command-line parameters for use
5316 with plink or tortoiseplink, as opposed to the default (OpenSSH).
5317</p>
5318<div class="paragraph"><p>The config variable <code>ssh.variant</code> can be set to override this auto-detection;
5319valid values are <code>ssh</code>, <code>plink</code>, <code>putty</code> or <code>tortoiseplink</code>. Any other value
5320will be treated as normal ssh. This setting can be overridden via the
5321environment variable <code>GIT_SSH_VARIANT</code>.</p></div>
5322</dd>
5323<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5324i18n.commitEncoding
5325</dt>
5326<dd>
5327<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5328 Character encoding the commit messages are stored in; Git itself
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5329 does not care per se, but this information is necessary e.g. when
5330 importing commits from emails or in the gitk graphical history
5331 browser (and possibly at other places in the future or in other
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5332 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]5333</p>
5334</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5335<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5336i18n.logOutputEncoding
5337</dt>
5338<dd>
5339<p>
5340 Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]5341 running <em>git log</em> and friends.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5342</p>
5343</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5344<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]5345imap
5346</dt>
5347<dd>
5348<p>
5349 The configuration variables in the <em>imap</em> section are described
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5350 in <a href="git-imap-send.html">git-imap-send(1)</a>.
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]5351</p>
5352</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5353<dt class="hdlist1">
Junio C Hamano81703b22014-03-14 22:00:27[diff] [blame]5354index.version
5355</dt>
5356<dd>
5357<p>
5358 Specify the version with which new index files should be
5359 initialized. This does not affect existing repositories.
5360</p>
5361</dd>
5362<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]5363init.templateDir
Junio C Hamanocaa712a2010-03-11 01:17:35[diff] [blame]5364</dt>
5365<dd>
5366<p>
5367 Specify the directory from which templates will be copied.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5368 (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]5369</p>
5370</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5371<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]5372instaweb.browser
5373</dt>
5374<dd>
5375<p>
5376 Specify the program that will be used to browse your working
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5377 repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]5378</p>
5379</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5380<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]5381instaweb.httpd
5382</dt>
5383<dd>
5384<p>
5385 The HTTP daemon command-line to start gitweb on your working
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5386 repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]5387</p>
5388</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5389<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]5390instaweb.local
5391</dt>
5392<dd>
5393<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5394 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]5395 be bound to the local IP (127.0.0.1).
5396</p>
5397</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5398<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]5399instaweb.modulePath
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]5400</dt>
5401<dd>
5402<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5403 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]5404 instead of /usr/lib/apache2/modules. Only used if httpd
5405 is Apache.
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]5406</p>
5407</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5408<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]5409instaweb.port
5410</dt>
5411<dd>
5412<p>
5413 The port number to bind the gitweb httpd to. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5414 <a href="git-instaweb.html">git-instaweb(1)</a>.
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]5415</p>
5416</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5417<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]5418interactive.singleKey
Junio C Hamanoe5bf6c12009-02-07 21:43:10[diff] [blame]5419</dt>
5420<dd>
5421<p>
Junio C Hamano27a128b2009-08-13 01:23:00[diff] [blame]5422 In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:10[diff] [blame]5423 input with a single key (i.e., without hitting enter).
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5424 Currently this is used by the <code>--patch</code> mode of
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5425 <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>,
5426 <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]5427 setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:27[diff] [blame]5428 is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:10[diff] [blame]5429</p>
5430</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5431<dt class="hdlist1">
Junio C Hamano4ba4a782016-04-03 19:11:32[diff] [blame]5432interactive.diffFilter
5433</dt>
5434<dd>
5435<p>
5436 When an interactive command (such as <code>git add --patch</code>) shows
5437 a colorized diff, git will pipe the diff through the shell
5438 command defined by this configuration variable. The command may
5439 mark up the diff further for human consumption, provided that it
5440 retains a one-to-one correspondence with the lines in the
5441 original diff. Defaults to disabled (no filtering).
5442</p>
5443</dd>
5444<dt class="hdlist1">
Junio C Hamanof93530e2011-05-25 23:59:59[diff] [blame]5445log.abbrevCommit
5446</dt>
5447<dd>
5448<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5449 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5450 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
5451 override this option with <code>--no-abbrev-commit</code>.
Junio C Hamanof93530e2011-05-25 23:59:59[diff] [blame]5452</p>
5453</dd>
5454<dt class="hdlist1">
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]5455log.date
5456</dt>
5457<dd>
5458<p>
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]5459 Set the default date-time mode for the <em>log</em> command.
5460 Setting a value for log.date is similar to using <em>git log</em>'s
Junio C Hamano1eb56092015-10-05 20:39:53[diff] [blame]5461 <code>--date</code> option. See <a href="git-log.html">git-log(1)</a> for details.
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]5462</p>
5463</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5464<dt class="hdlist1">
Junio C Hamanocb39aea2010-05-09 07:24:48[diff] [blame]5465log.decorate
5466</dt>
5467<dd>
5468<p>
5469 Print out the ref names of any commits that are shown by the log
5470 command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
5471 <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
5472 specified, the full ref name (including prefix) will be printed.
Junio C Hamano37cf4082016-05-30 01:22:14[diff] [blame]5473 If <em>auto</em> is specified, then if the output is going to a terminal,
5474 the ref names are shown as if <em>short</em> were given, otherwise no ref
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]5475 names are shown. This is the same as the <code>--decorate</code> option
Junio C Hamano37cf4082016-05-30 01:22:14[diff] [blame]5476 of the <code>git log</code>.
Junio C Hamanocb39aea2010-05-09 07:24:48[diff] [blame]5477</p>
5478</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5479<dt class="hdlist1">
Junio C Hamanob0a1e832015-10-15 23:08:31[diff] [blame]5480log.follow
5481</dt>
5482<dd>
5483<p>
5484 If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
5485 a single &lt;path&gt; is given. This has the same limitations as <code>--follow</code>,
5486 i.e. it cannot be used to follow multiple files and does not work well
5487 on non-linear history.
5488</p>
5489</dd>
5490<dt class="hdlist1">
Junio C Hamanob86c8032017-02-02 21:50:19[diff] [blame]5491log.graphColors
5492</dt>
5493<dd>
5494<p>
5495 A list of colors, separated by commas, that can be used to draw
5496 history lines in <code>git log --graph</code>.
5497</p>
5498</dd>
5499<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]5500log.showRoot
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5501</dt>
5502<dd>
5503<p>
5504 If true, the initial commit will be shown as a big creation event.
5505 This is equivalent to a diff against an empty tree.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5506 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]5507 normally hide the root commit will now show it. True by default.
5508</p>
5509</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5510<dt class="hdlist1">
Junio C Hamano6b6144f2017-05-29 06:20:15[diff] [blame]5511log.showSignature
5512</dt>
5513<dd>
5514<p>
5515 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
5516 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.
5517</p>
5518</dd>
5519<dt class="hdlist1">
Junio C Hamanoce836cc2013-01-21 02:01:53[diff] [blame]5520log.mailmap
5521</dt>
5522<dd>
5523<p>
5524 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5525 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>.
Junio C Hamanoce836cc2013-01-21 02:01:53[diff] [blame]5526</p>
5527</dd>
5528<dt class="hdlist1">
Junio C Hamano7f1bc9d2015-03-05 22:38:26[diff] [blame]5529mailinfo.scissors
5530</dt>
5531<dd>
5532<p>
5533 If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
5534 <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
5535 was provided on the command-line. When active, this features
5536 removes everything from the message body before a scissors
5537 line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").
5538</p>
5539</dd>
5540<dt class="hdlist1">
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]5541mailmap.file
5542</dt>
5543<dd>
5544<p>
5545 The location of an augmenting mailmap file. The default
5546 mailmap, located in the root of the repository, is loaded
5547 first, then the mailmap file pointed to by this variable.
5548 The location of the mailmap file may be in a repository
5549 subdirectory, or somewhere outside of the repository itself.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5550 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]5551</p>
5552</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5553<dt class="hdlist1">
Junio C Hamanoabad6da2013-01-06 09:06:32[diff] [blame]5554mailmap.blob
5555</dt>
5556<dd>
5557<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5558 Like <code>mailmap.file</code>, but consider the value as a reference to a
5559 blob in the repository. If both <code>mailmap.file</code> and
5560 <code>mailmap.blob</code> are given, both are parsed, with entries from
5561 <code>mailmap.file</code> taking precedence. In a bare repository, this
5562 defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
Junio C Hamanoabad6da2013-01-06 09:06:32[diff] [blame]5563 defaults to empty.
5564</p>
5565</dd>
5566<dt class="hdlist1">
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]5567man.viewer
5568</dt>
5569<dd>
5570<p>
5571 Specify the programs that may be used to display help in the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5572 <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]5573</p>
5574</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5575<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]5576man.&lt;tool&gt;.cmd
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]5577</dt>
5578<dd>
5579<p>
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]5580 Specify the command to invoke the specified man viewer. The
5581 specified command is evaluated in shell with the man page
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5582 passed as argument. (See <a href="git-help.html">git-help(1)</a>.)
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]5583</p>
5584</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5585<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]5586man.&lt;tool&gt;.path
5587</dt>
5588<dd>
5589<p>
5590 Override the path for the given tool that may be used to
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5591 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]5592</p>
5593</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5594<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]5595merge.conflictStyle
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]5596</dt>
5597<dd>
5598<p>
5599 Specify the style in which conflicted hunks are written out to
5600 working tree files upon merge. The default is "merge", which
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5601 shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
5602 a <code>=======</code> marker, changes made by the other side, and then
5603 a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker. An alternate style, "diff3", adds a <code>|||||||</code>
5604 marker and the original text before the <code>=======</code> marker.
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]5605</p>
5606</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5607<dt class="hdlist1">
Junio C Hamanoa03ac862011-04-02 04:32:29[diff] [blame]5608merge.defaultToUpstream
5609</dt>
5610<dd>
5611<p>
5612 If merge is called without any commit argument, merge the upstream
5613 branches configured for the current branch by using their last
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]5614 observed values stored in their remote-tracking branches.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5615 The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
5616 branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
5617 are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]5618 to their corresponding remote-tracking branches, and the tips of
Junio C Hamanoa03ac862011-04-02 04:32:29[diff] [blame]5619 these tracking branches are merged.
5620</p>
5621</dd>
5622<dt class="hdlist1">
Junio C Hamano3d050d62011-05-17 06:43:34[diff] [blame]5623merge.ff
5624</dt>
5625<dd>
5626<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5627 By default, Git does not create an extra merge commit when merging
Junio C Hamano3d050d62011-05-17 06:43:34[diff] [blame]5628 a commit that is a descendant of the current commit. Instead, the
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5629 tip of the current branch is fast-forwarded. When set to <code>false</code>,
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5630 this variable tells Git to create an extra merge commit in such
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5631 a case (equivalent to giving the <code>--no-ff</code> option from the command
5632 line). When set to <code>only</code>, only such fast-forward merges are
5633 allowed (equivalent to giving the <code>--ff-only</code> option from the
Junio C Hamano3d050d62011-05-17 06:43:34[diff] [blame]5634 command line).
5635</p>
5636</dd>
5637<dt class="hdlist1">
Junio C Hamanoce447ab2015-06-16 22:08:01[diff] [blame]5638merge.branchdesc
5639</dt>
5640<dd>
5641<p>
5642 In addition to branch names, populate the log message with
5643 the branch description text associated with them. Defaults
5644 to false.
5645</p>
5646</dd>
5647<dt class="hdlist1">
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]5648merge.log
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5649</dt>
5650<dd>
5651<p>
Junio C Hamano3b4609d2010-09-30 00:04:34[diff] [blame]5652 In addition to branch names, populate the log message with at
5653 most the specified number of one-line descriptions from the
5654 actual commits that are being merged. Defaults to false, and
Junio C Hamano7165bf72011-01-04 22:06:18[diff] [blame]5655 true is a synonym for 20.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5656</p>
5657</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5658<dt class="hdlist1">
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]5659merge.renameLimit
5660</dt>
5661<dd>
5662<p>
5663 The number of files to consider when performing rename detection
5664 during a merge; if not specified, defaults to the value of
5665 diff.renameLimit.
5666</p>
5667</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5668<dt class="hdlist1">
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]5669merge.renormalize
5670</dt>
5671<dd>
5672<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5673 Tell Git that canonical representation of files in the
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]5674 repository has changed over time (e.g. earlier commits record
5675 text files with CRLF line endings, but recent ones use LF line
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5676 endings). In such a repository, Git can convert the data
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]5677 recorded in commits to a canonical form before performing a
5678 merge to reduce unnecessary conflicts. For more information,
5679 see section "Merging branches with differing checkin/checkout
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5680 attributes" in <a href="gitattributes.html">gitattributes(5)</a>.
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]5681</p>
5682</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5683<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]5684merge.stat
5685</dt>
5686<dd>
5687<p>
5688 Whether to print the diffstat between ORIG_HEAD and the merge result
5689 at the end of the merge. True by default.
5690</p>
5691</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5692<dt class="hdlist1">
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]5693merge.tool
5694</dt>
5695<dd>
5696<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]5697 Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
5698 The list below shows the valid built-in values.
5699 Any other value is treated as a custom merge tool and requires
5700 that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]5701</p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]5702<div class="ulist"><ul>
5703<li>
5704<p>
5705araxis
5706</p>
5707</li>
5708<li>
5709<p>
Junio C Hamano2a4bcbc2014-10-29 20:07:39[diff] [blame]5710bc
5711</p>
5712</li>
5713<li>
5714<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]5715bc3
5716</p>
5717</li>
5718<li>
5719<p>
5720codecompare
5721</p>
5722</li>
5723<li>
5724<p>
5725deltawalker
5726</p>
5727</li>
5728<li>
5729<p>
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]5730diffmerge
5731</p>
5732</li>
5733<li>
5734<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]5735diffuse
5736</p>
5737</li>
5738<li>
5739<p>
5740ecmerge
5741</p>
5742</li>
5743<li>
5744<p>
5745emerge
5746</p>
5747</li>
5748<li>
5749<p>
Junio C Hamano5996b672016-04-13 22:01:41[diff] [blame]5750examdiff
5751</p>
5752</li>
5753<li>
5754<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]5755gvimdiff
5756</p>
5757</li>
5758<li>
5759<p>
5760gvimdiff2
5761</p>
5762</li>
5763<li>
5764<p>
Junio C Hamanob051caf2014-06-03 22:15:13[diff] [blame]5765gvimdiff3
5766</p>
5767</li>
5768<li>
5769<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]5770kdiff3
5771</p>
5772</li>
5773<li>
5774<p>
5775meld
5776</p>
5777</li>
5778<li>
5779<p>
5780opendiff
5781</p>
5782</li>
5783<li>
5784<p>
5785p4merge
5786</p>
5787</li>
5788<li>
5789<p>
5790tkdiff
5791</p>
5792</li>
5793<li>
5794<p>
5795tortoisemerge
5796</p>
5797</li>
5798<li>
5799<p>
5800vimdiff
5801</p>
5802</li>
5803<li>
5804<p>
5805vimdiff2
5806</p>
5807</li>
5808<li>
5809<p>
Junio C Hamanob051caf2014-06-03 22:15:13[diff] [blame]5810vimdiff3
5811</p>
5812</li>
5813<li>
5814<p>
Junio C Hamano85f1fde2015-06-01 20:37:32[diff] [blame]5815winmerge
5816</p>
5817</li>
5818<li>
5819<p>
Junio C Hamanob5e079f2013-02-08 00:02:52[diff] [blame]5820xxdiff
5821</p>
5822</li>
5823</ul></div>
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]5824</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5825<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5826merge.verbosity
5827</dt>
5828<dd>
5829<p>
5830 Controls the amount of output shown by the recursive merge
5831 strategy. Level 0 outputs nothing except a final error
5832 message if conflicts were detected. Level 1 outputs only
5833 conflicts, 2 outputs conflicts and file changes. Level 5 and
5834 above outputs debugging information. The default is level 2.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]5835 Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]5836</p>
5837</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5838<dt class="hdlist1">
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]5839merge.&lt;driver&gt;.name
5840</dt>
5841<dd>
5842<p>
Junio C Hamanoec87f522008-12-10 08:35:25[diff] [blame]5843 Defines a human-readable name for a custom low-level
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5844 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]5845</p>
5846</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5847<dt class="hdlist1">
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]5848merge.&lt;driver&gt;.driver
5849</dt>
5850<dd>
5851<p>
5852 Defines the command that implements a custom low-level
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5853 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]5854</p>
5855</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5856<dt class="hdlist1">
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]5857merge.&lt;driver&gt;.recursive
5858</dt>
5859<dd>
5860<p>
5861 Names a low-level merge driver to be used when
5862 performing an internal merge between common ancestors.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]5863 See <a href="gitattributes.html">gitattributes(5)</a> for details.
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]5864</p>
5865</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5866<dt class="hdlist1">
Junio C Hamano1fbbbc12007-12-18 07:01:27[diff] [blame]5867mergetool.&lt;tool&gt;.path
5868</dt>
5869<dd>
5870<p>
5871 Override the path for the given tool. This is useful in case
5872 your tool is not in the PATH.
5873</p>
5874</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5875<dt class="hdlist1">
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]5876mergetool.&lt;tool&gt;.cmd
5877</dt>
5878<dd>
5879<p>
5880 Specify the command to invoke the specified merge tool. The
5881 specified command is evaluated in shell with the following
5882 variables available: <em>BASE</em> is the name of a temporary file
5883 containing the common base of the files to be merged, if available;
5884 <em>LOCAL</em> is the name of a temporary file containing the contents of
5885 the file on the current branch; <em>REMOTE</em> is the name of a temporary
5886 file containing the contents of the file from the branch being
5887 merged; <em>MERGED</em> contains the name of the file to which the merge
5888 tool should write the results of a successful merge.
5889</p>
5890</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5891<dt class="hdlist1">
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]5892mergetool.&lt;tool&gt;.trustExitCode
5893</dt>
5894<dd>
5895<p>
5896 For a custom merge command, specify whether the exit code of
5897 the merge command can be used to determine whether the merge was
5898 successful. If this is not set to true then the merge target file
5899 timestamp is checked and the merge assumed to have been successful
5900 if the file has been updated, otherwise the user is prompted to
5901 indicate the success of the merge.
5902</p>
5903</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5904<dt class="hdlist1">
Junio C Hamanoe478e402014-10-21 22:14:45[diff] [blame]5905mergetool.meld.hasOutput
5906</dt>
5907<dd>
5908<p>
5909 Older versions of <code>meld</code> do not support the <code>--output</code> option.
5910 Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
5911 by inspecting the output of <code>meld --help</code>. Configuring
5912 <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
5913 use the configured value instead. Setting <code>mergetool.meld.hasOutput</code>
5914 to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
5915 and <code>false</code> avoids using <code>--output</code>.
5916</p>
5917</dd>
5918<dt class="hdlist1">
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]5919mergetool.keepBackup
5920</dt>
5921<dd>
5922<p>
5923 After performing a merge, the original file with conflict markers
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5924 can be saved as a file with a <code>.orig</code> extension. If this variable
5925 is set to <code>false</code> then this file is not preserved. Defaults to
5926 <code>true</code> (i.e. keep the backup files).
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]5927</p>
5928</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5929<dt class="hdlist1">
Junio C Hamano10b7a342009-01-01 22:05:17[diff] [blame]5930mergetool.keepTemporaries
5931</dt>
5932<dd>
5933<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]5934 When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:17[diff] [blame]5935 files to pass to the tool. If the tool returns an error and this
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5936 variable is set to <code>true</code>, then these temporary files will be
Junio C Hamano10b7a342009-01-01 22:05:17[diff] [blame]5937 preserved, otherwise they will be removed after the tool has
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5938 exited. Defaults to <code>false</code>.
Junio C Hamano10b7a342009-01-01 22:05:17[diff] [blame]5939</p>
5940</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5941<dt class="hdlist1">
Junio C Hamanoe478e402014-10-21 22:14:45[diff] [blame]5942mergetool.writeToTemp
5943</dt>
5944<dd>
5945<p>
5946 Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
5947 conflicting files in the worktree by default. Git will attempt
5948 to use a temporary directory for these files when set <code>true</code>.
5949 Defaults to <code>false</code>.
5950</p>
5951</dd>
5952<dt class="hdlist1">
Junio C Hamano10b7a342009-01-01 22:05:17[diff] [blame]5953mergetool.prompt
5954</dt>
5955<dd>
5956<p>
5957 Prompt before each invocation of the merge resolution program.
5958</p>
5959</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5960<dt class="hdlist1">
Junio C Hamano3891e252015-08-31 23:06:13[diff] [blame]5961notes.mergeStrategy
5962</dt>
5963<dd>
5964<p>
5965 Which merge strategy to choose by default when resolving notes
5966 conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
5967 <code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See "NOTES MERGE STRATEGIES"
5968 section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
5969</p>
5970</dd>
5971<dt class="hdlist1">
5972notes.&lt;name&gt;.mergeStrategy
5973</dt>
5974<dd>
5975<p>
5976 Which merge strategy to choose when doing a notes merge into
5977 refs/notes/&lt;name&gt;. This overrides the more general
5978 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
5979 <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.
5980</p>
5981</dd>
5982<dt class="hdlist1">
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]5983notes.displayRef
5984</dt>
5985<dd>
5986<p>
5987 The (fully qualified) refname from which to show notes when
5988 showing commit messages. The value of this variable can be set
5989 to a glob, in which case notes from all matching refs will be
5990 shown. You may also specify this configuration variable
5991 several times. A warning will be issued for refs that do not
5992 exist, but a glob that does not match any refs is silently
5993 ignored.
5994</p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]5995<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]5996environment variable, which must be a colon separated list of refs or
5997globs.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]5998<div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]5999GIT_NOTES_REF) is also implicitly added to the list of refs to be
6000displayed.</p></div>
6001</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6002<dt class="hdlist1">
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]6003notes.rewrite.&lt;command&gt;
6004</dt>
6005<dd>
6006<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6007 When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
6008 <code>rebase</code>) and this variable is set to <code>true</code>, Git
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]6009 automatically copies your notes from the original to the
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6010 rewritten commit. Defaults to <code>true</code>, but see
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]6011 "notes.rewriteRef" below.
6012</p>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]6013</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6014<dt class="hdlist1">
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]6015notes.rewriteMode
6016</dt>
6017<dd>
6018<p>
6019 When copying notes during a rewrite (see the
6020 "notes.rewrite.&lt;command&gt;" option), determines what to do if
6021 the target commit already has a note. Must be one of
Junio C Hamano3891e252015-08-31 23:06:13[diff] [blame]6022 <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
6023 Defaults to <code>concatenate</code>.
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]6024</p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6025<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]6026environment variable.</p></div>
6027</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6028<dt class="hdlist1">
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]6029notes.rewriteRef
6030</dt>
6031<dd>
6032<p>
6033 When copying notes during a rewrite, specifies the (fully
6034 qualified) ref whose notes should be copied. The ref may be a
6035 glob, in which case notes in all matching refs will be copied.
6036 You may also specify this configuration several times.
6037</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6038<div class="paragraph"><p>Does not have a default value; you must configure this variable to
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6039enable note rewriting. Set it to <code>refs/notes/commits</code> to enable
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]6040rewriting for the default commit notes.</p></div>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6041<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
Junio C Hamano2b3ee5d2010-05-08 05:41:18[diff] [blame]6042environment variable, which must be a colon separated list of refs or
6043globs.</p></div>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]6044</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6045<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6046pack.window
6047</dt>
6048<dd>
6049<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6050 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]6051 window size is given on the command line. Defaults to 10.
6052</p>
6053</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6054<dt class="hdlist1">
Junio C Hamano91d44c52007-05-09 07:16:07[diff] [blame]6055pack.depth
6056</dt>
6057<dd>
6058<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6059 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]6060 maximum depth is given on the command line. Defaults to 50.
6061</p>
6062</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6063<dt class="hdlist1">
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]6064pack.windowMemory
6065</dt>
6066<dd>
6067<p>
Junio C Hamano2a4bcbc2014-10-29 20:07:39[diff] [blame]6068 The maximum size of memory that is consumed by each thread
6069 in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
6070 no limit is given on the command line. The value can be
6071 suffixed with "k", "m", or "g". When left unconfigured (or
6072 set explicitly to 0), there will be no limit.
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]6073</p>
6074</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6075<dt class="hdlist1">
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]6076pack.compression
6077</dt>
6078<dd>
6079<p>
6080 An integer -1..9, indicating the compression level for objects
6081 in a pack file. -1 is the zlib default. 0 means no
6082 compression, and 1..9 are various speed/size tradeoffs, 9 being
6083 slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42[diff] [blame]6084 not set, defaults to -1, the zlib default, which is "a default
6085 compromise between speed and compression (currently equivalent
6086 to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]6087</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6088<div class="paragraph"><p>Note that changing the compression level will not automatically recompress
Junio C Hamano657fd8a2010-10-07 00:01:24[diff] [blame]6089all existing objects. You can force recompression by passing the -F option
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6090to <a href="git-repack.html">git-repack(1)</a>.</p></div>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]6091</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6092<dt class="hdlist1">
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]6093pack.deltaCacheSize
6094</dt>
6095<dd>
6096<p>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]6097 The maximum memory in bytes used for caching deltas in
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6098 <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]6099 This cache is used to speed up the writing object phase by not
6100 having to recompute the final delta result once the best match
6101 for all objects is found. Repacking large repositories on machines
6102 which are tight with memory might be badly impacted by this though,
6103 especially if this cache pushes the system into swapping.
6104 A value of 0 means no limit. The smallest size of 1 byte may be
6105 used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]6106</p>
6107</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6108<dt class="hdlist1">
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]6109pack.deltaCacheLimit
6110</dt>
6111<dd>
6112<p>
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]6113 The maximum size of a delta, that is cached in
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6114 <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]6115 writing object phase by not having to recompute the final delta
6116 result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]6117</p>
6118</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6119<dt class="hdlist1">
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]6120pack.threads
6121</dt>
6122<dd>
6123<p>
6124 Specifies the number of threads to spawn when searching for best
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6125 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]6126 be compiled with pthreads otherwise this option is ignored with a
6127 warning. This is meant to reduce packing time on multiprocessor
6128 machines. The required amount of memory for the delta search window
6129 is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]6130 Specifying 0 will cause Git to auto-detect the number of CPU&#8217;s
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]6131 and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]6132</p>
6133</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6134<dt class="hdlist1">
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]6135pack.indexVersion
6136</dt>
6137<dd>
6138<p>
6139 Specify the default pack index version. Valid values are 1 for
6140 legacy pack index used by Git versions prior to 1.5.2, and 2 for
6141 the new pack index with capabilities for packs larger than 4 GB
6142 as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]6143 packs. Version 2 is the default. Note that version 2 is enforced
6144 and this config option ignored whenever the corresponding pack is
6145 larger than 2 GB.
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]6146</p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6147<div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
Junio C Hamanof85ef632016-02-17 22:31:06[diff] [blame]6148cloning or fetching over a non native protocol (e.g. "http")
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6149that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]6150other side may give you a repository that cannot be accessed with your
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6151older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6152you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6153the <code>*.idx</code> file.</p></div>
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]6154</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6155<dt class="hdlist1">
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]6156pack.packSizeLimit
6157</dt>
6158<dd>
6159<p>
Junio C Hamano4d979582010-02-04 06:27:29[diff] [blame]6160 The maximum size of a pack. This setting only affects
6161 packing to a file when repacking, i.e. the git:// protocol
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6162 is unaffected. It can be overridden by the <code>--max-pack-size</code>
Junio C Hamano74fd0fc2016-05-10 21:23:56[diff] [blame]6163 option of <a href="git-repack.html">git-repack(1)</a>. Reaching this limit results
6164 in the creation of multiple packfiles; which in turn prevents
6165 bitmaps from being created.
6166 The minimum size allowed is limited to 1 MiB.
6167 The default is unlimited.
Junio C Hamano4d979582010-02-04 06:27:29[diff] [blame]6168 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
6169 supported.
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]6170</p>
6171</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6172<dt class="hdlist1">
Junio C Hamano5b3533d2014-02-27 23:07:15[diff] [blame]6173pack.useBitmaps
6174</dt>
6175<dd>
6176<p>
6177 When true, git will use pack bitmaps (if available) when packing
6178 to stdout (e.g., during the server side of a fetch). Defaults to
6179 true. You should not generally need to turn this off unless
6180 you are debugging pack bitmaps.
6181</p>
6182</dd>
6183<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6184pack.writeBitmaps (deprecated)
Junio C Hamano5b3533d2014-02-27 23:07:15[diff] [blame]6185</dt>
6186<dd>
6187<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6188 This is a deprecated synonym for <code>repack.writeBitmaps</code>.
Junio C Hamano5b3533d2014-02-27 23:07:15[diff] [blame]6189</p>
6190</dd>
6191<dt class="hdlist1">
6192pack.writeBitmapHashCache
6193</dt>
6194<dd>
6195<p>
6196 When true, git will include a "hash cache" section in the bitmap
6197 index (if one is written). This cache can be used to feed git&#8217;s
6198 delta heuristics, potentially leading to better deltas between
6199 bitmapped and non-bitmapped objects (e.g., when serving a fetch
6200 between an older, bitmapped pack and objects that have been
6201 pushed since the last gc). The downside is that it consumes 4
6202 bytes per object of disk space, and that JGit&#8217;s bitmap
6203 implementation does not understand it, causing it to complain if
6204 Git and JGit are used on the same repository. Defaults to false.
6205</p>
6206</dd>
6207<dt class="hdlist1">
Junio C Hamano9e96a1a2008-08-16 10:23:18[diff] [blame]6208pager.&lt;cmd&gt;
6209</dt>
6210<dd>
6211<p>
Junio C Hamano788eeba2010-12-08 22:50:43[diff] [blame]6212 If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]6213 output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:43[diff] [blame]6214 Otherwise, turns on pagination for the subcommand using the
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6215 pager specified by the value of <code>pager.&lt;cmd&gt;</code>. If <code>--paginate</code>
6216 or <code>--no-pager</code> is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:43[diff] [blame]6217 precedence over this option. To disable pagination for all
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6218 commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
Junio C Hamano9e96a1a2008-08-16 10:23:18[diff] [blame]6219</p>
6220</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6221<dt class="hdlist1">
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]6222pretty.&lt;name&gt;
6223</dt>
6224<dd>
6225<p>
6226 Alias for a --pretty= format string, as specified in
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6227 <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]6228 as the built-in pretty formats could. For example,
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6229 running <code>git config pretty.changelog "format:* %H %s"</code>
6230 would cause the invocation <code>git log --pretty=changelog</code>
6231 to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]6232 Note that an alias with the same name as a built-in format
6233 will be silently ignored.
6234</p>
6235</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6236<dt class="hdlist1">
Junio C Hamano9e35abf2016-12-27 22:37:27[diff] [blame]6237protocol.allow
6238</dt>
6239<dd>
6240<p>
6241 If set, provide a user defined default policy for all protocols which
6242 don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>). By default,
6243 if unset, known-safe protocols (http, https, git, ssh, file) have a
6244 default policy of <code>always</code>, known-dangerous protocols (ext) have a
6245 default policy of <code>never</code>, and all other protocols have a default
6246 policy of <code>user</code>. Supported policies:
6247</p>
6248<div class="openblock">
6249<div class="content">
6250<div class="ulist"><ul>
6251<li>
6252<p>
6253<code>always</code> - protocol is always able to be used.
6254</p>
6255</li>
6256<li>
6257<p>
6258<code>never</code> - protocol is never able to be used.
6259</p>
6260</li>
6261<li>
6262<p>
6263<code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
6264 either unset or has a value of 1. This policy should be used when you want a
6265 protocol to be directly usable by the user but don&#8217;t want it used by commands which
6266 execute clone/fetch/push commands without user input, e.g. recursive
6267 submodule initialization.
6268</p>
6269</li>
6270</ul></div>
6271</div></div>
6272</dd>
6273<dt class="hdlist1">
6274protocol.&lt;name&gt;.allow
6275</dt>
6276<dd>
6277<p>
6278 Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
6279 commands. See <code>protocol.allow</code> above for the available policies.
6280</p>
6281<div class="paragraph"><p>The protocol names currently used by git are:</p></div>
6282<div class="openblock">
6283<div class="content">
6284<div class="ulist"><ul>
6285<li>
6286<p>
6287<code>file</code>: any local file-based path (including <code>file://</code> URLs,
6288 or local paths)
6289</p>
6290</li>
6291<li>
6292<p>
6293<code>git</code>: the anonymous git protocol over a direct TCP
6294 connection (or proxy, if configured)
6295</p>
6296</li>
6297<li>
6298<p>
6299<code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
6300 <code>ssh://</code>, etc).
6301</p>
6302</li>
6303<li>
6304<p>
6305<code>http</code>: git over http, both "smart http" and "dumb http".
6306 Note that this does <em>not</em> include <code>https</code>; if you want to configure
6307 both, you must do so individually.
6308</p>
6309</li>
6310<li>
6311<p>
6312any external helpers are named by their protocol (e.g., use
6313 <code>hg</code> to allow the <code>git-remote-hg</code> helper)
6314</p>
6315</li>
6316</ul></div>
6317</div></div>
6318</dd>
6319<dt class="hdlist1">
Junio C Hamano5b3533d2014-02-27 23:07:15[diff] [blame]6320pull.ff
6321</dt>
6322<dd>
6323<p>
6324 By default, Git does not create an extra merge commit when merging
6325 a commit that is a descendant of the current commit. Instead, the
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6326 tip of the current branch is fast-forwarded. When set to <code>false</code>,
Junio C Hamano5b3533d2014-02-27 23:07:15[diff] [blame]6327 this variable tells Git to create an extra merge commit in such
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6328 a case (equivalent to giving the <code>--no-ff</code> option from the command
6329 line). When set to <code>only</code>, only such fast-forward merges are
6330 allowed (equivalent to giving the <code>--ff-only</code> option from the
Junio C Hamanoc4e2a202015-05-26 21:38:47[diff] [blame]6331 command line). This setting overrides <code>merge.ff</code> when pulling.
Junio C Hamano5b3533d2014-02-27 23:07:15[diff] [blame]6332</p>
6333</dd>
6334<dt class="hdlist1">
Junio C Hamano515ab1d2011-12-09 23:41:20[diff] [blame]6335pull.rebase
6336</dt>
6337<dd>
6338<p>
6339 When true, rebase branches on top of the fetched branch, instead
6340 of merging the default branch from the default remote when "git
6341 pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
6342 per-branch basis.
6343</p>
Junio C Hamano7db630e2015-09-17 20:26:22[diff] [blame]6344<div class="paragraph"><p>When preserve, also pass <code>--preserve-merges</code> along to <em>git rebase</em>
Junio C Hamanocf4a1742013-09-11 22:57:50[diff] [blame]6345so that locally committed merge commits will not be flattened
Junio C Hamano7db630e2015-09-17 20:26:22[diff] [blame]6346by running <em>git pull</em>.</p></div>
Junio C Hamano289d7e82016-01-27 00:20:38[diff] [blame]6347<div class="paragraph"><p>When the value is <code>interactive</code>, the rebase is run in interactive mode.</p></div>
Junio C Hamano515ab1d2011-12-09 23:41:20[diff] [blame]6348<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]6349it 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]6350for details).</p></div>
6351</dd>
6352<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6353pull.octopus
6354</dt>
6355<dd>
6356<p>
6357 The default merge strategy to use when pulling multiple branches
6358 at once.
6359</p>
6360</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6361<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6362pull.twohead
6363</dt>
6364<dd>
6365<p>
6366 The default merge strategy to use when pulling a single branch.
6367</p>
6368</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6369<dt class="hdlist1">
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6370push.default
6371</dt>
6372<dd>
6373<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6374 Defines the action <code>git push</code> should take if no refspec is
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6375 explicitly given. Different values are well-suited for
6376 specific workflows; for instance, in a purely central workflow
6377 (i.e. the fetch source is equal to the push destination),
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6378 <code>upstream</code> is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6379</p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]6380<div class="openblock">
6381<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6382<div class="ulist"><ul>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6383<li>
6384<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6385<code>nothing</code> - do not push anything (error out) unless a refspec is
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6386 explicitly given. This is primarily meant for people who want to
6387 avoid mistakes by always being explicit.
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6388</p>
6389</li>
6390<li>
6391<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6392<code>current</code> - push the current branch to update a branch with the same
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6393 name on the receiving end. Works in both central and non-central
6394 workflows.
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6395</p>
6396</li>
6397<li>
6398<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6399<code>upstream</code> - push the current branch back to the branch whose
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6400 changes are usually integrated into the current branch (which is
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6401 called <code>@{upstream}</code>). This mode only makes sense if you are
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6402 pushing to the same repository you would normally pull from
6403 (i.e. central workflow).
Junio C Hamano63c2bc92011-02-28 06:41:28[diff] [blame]6404</p>
6405</li>
6406<li>
6407<p>
Junio C Hamanocb06ef92017-03-21 22:40:14[diff] [blame]6408<code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
6409</p>
6410</li>
6411<li>
6412<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6413<code>simple</code> - in centralized workflow, work like <code>upstream</code> with an
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6414 added safety to refuse to push if the upstream branch&#8217;s name is
6415 different from the local one.
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6416</p>
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6417<div class="paragraph"><p>When pushing to a remote that is different from the remote you normally
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6418pull from, work as <code>current</code>. This is the safest option and is suited
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6419for beginners.</p></div>
Junio C Hamano1d669b82014-03-11 21:36:00[diff] [blame]6420<div class="paragraph"><p>This mode has become the default in Git 2.0.</p></div>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6421</li>
6422<li>
6423<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6424<code>matching</code> - push all branches having the same name on both ends.
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6425 This makes the repository you are pushing to remember the set of
6426 branches that will be pushed out (e.g. if you always push <em>maint</em>
6427 and <em>master</em> there and no other branches, the repository you push
6428 to will have these two branches, and your local <em>maint</em> and
6429 <em>master</em> will be pushed there).
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6430</p>
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]6431<div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the
6432branches you would push out are ready to be pushed out before
6433running <em>git push</em>, as the whole point of this mode is to allow you
6434to push all of the branches in one go. If you usually finish work
6435on only one branch and push out the result, while other branches are
6436unfinished, this mode is not for you. Also this mode is not
6437suitable for pushing into a shared central repository, as other
6438people may add new branches there, or update the tip of existing
6439branches outside your control.</p></div>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6440<div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
Junio C Hamano1d669b82014-03-11 21:36:00[diff] [blame]6441new default).</p></div>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6442</li>
6443</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]6444</div></div>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]6445</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6446<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6447push.followTags
6448</dt>
6449<dd>
6450<p>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]6451 If set to true enable <code>--follow-tags</code> option by default. You
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6452 may override this configuration at time of push by specifying
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]6453 <code>--no-follow-tags</code>.
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6454</p>
6455</dd>
6456<dt class="hdlist1">
Junio C Hamano3891e252015-08-31 23:06:13[diff] [blame]6457push.gpgSign
6458</dt>
6459<dd>
6460<p>
6461 May be set to a boolean value, or the string <em>if-asked</em>. A true
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]6462 value causes all pushes to be GPG signed, as if <code>--signed</code> is
Junio C Hamano3891e252015-08-31 23:06:13[diff] [blame]6463 passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
6464 pushes to be signed if the server supports it, as if
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]6465 <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
Junio C Hamano3891e252015-08-31 23:06:13[diff] [blame]6466 override a value from a lower-priority config file. An explicit
6467 command-line flag always overrides this config option.
6468</p>
6469</dd>
6470<dt class="hdlist1">
Junio C Hamano409a33a2015-12-22 23:45:23[diff] [blame]6471push.recurseSubmodules
6472</dt>
6473<dd>
6474<p>
6475 Make sure all submodule commits used by the revisions to be pushed
6476 are available on a remote-tracking branch. If the value is <em>check</em>
6477 then Git will verify that all submodule commits that changed in the
6478 revisions to be pushed are available on at least one remote of the
6479 submodule. If any commits are missing, the push will be aborted and
6480 exit with non-zero status. If the value is <em>on-demand</em> then all
6481 submodules that changed in the revisions to be pushed will be
6482 pushed. If on-demand was not able to push all necessary revisions
6483 it will also be aborted and exit with non-zero status. If the value
6484 is <em>no</em> then default behavior of ignoring submodules when pushing
6485 is retained. You may override this configuration at time of push by
6486 specifying <em>--recurse-submodules=check|on-demand|no</em>.
6487</p>
6488</dd>
6489<dt class="hdlist1">
Junio C Hamanoea6a7642009-03-11 23:56:19[diff] [blame]6490rebase.stat
6491</dt>
6492<dd>
6493<p>
6494 Whether to show a diffstat of what changed upstream since the last
6495 rebase. False by default.
6496</p>
6497</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6498<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6499rebase.autoSquash
Junio C Hamano075ae872010-09-01 18:43:07[diff] [blame]6500</dt>
6501<dd>
6502<p>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]6503 If set to true enable <code>--autosquash</code> option by default.
Junio C Hamano075ae872010-09-01 18:43:07[diff] [blame]6504</p>
6505</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6506<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6507rebase.autoStash
Junio C Hamanof1f5a7b2013-06-11 22:23:52[diff] [blame]6508</dt>
6509<dd>
6510<p>
6511 When set to true, automatically create a temporary stash
6512 before the operation begins, and apply it after the operation
6513 ends. This means that you can run rebase on a dirty worktree.
6514 However, use with care: the final stash application after a
6515 successful rebase might result in non-trivial conflicts.
6516 Defaults to false.
6517</p>
6518</dd>
6519<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]6520rebase.missingCommitsCheck
6521</dt>
6522<dd>
6523<p>
6524 If set to "warn", git rebase -i will print a warning if some
6525 commits are removed (e.g. a line was deleted), however the
6526 rebase will still proceed. If set to "error", it will print
6527 the previous warning and stop the rebase, <em>git rebase
6528 --edit-todo</em> can then be used to correct the error. If set to
6529 "ignore", no checking is done.
6530 To drop a commit without warning or error, use the <code>drop</code>
6531 command in the todo-list.
6532 Defaults to "ignore".
6533</p>
6534</dd>
Junio C Hamanof2f28b12016-10-31 21:41:58[diff] [blame]6535<dt class="hdlist1">
6536rebase.instructionFormat
6537</dt>
6538<dd>
6539<p>
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]6540 A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for
6541 the instruction list during an interactive rebase. The format will automatically
Junio C Hamanof2f28b12016-10-31 21:41:58[diff] [blame]6542 have the long commit hash prepended to the format.
6543</p>
6544</dd>
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]6545<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6546receive.advertiseAtomic
Junio C Hamano6bb32e62015-02-17 22:11:26[diff] [blame]6547</dt>
6548<dd>
6549<p>
6550 By default, git-receive-pack will advertise the atomic push
Junio C Hamanoe48a1132016-08-03 22:40:21[diff] [blame]6551 capability to its clients. If you don&#8217;t want to advertise this
6552 capability, set this variable to false.
6553</p>
6554</dd>
6555<dt class="hdlist1">
6556receive.advertisePushOptions
6557</dt>
6558<dd>
6559<p>
Junio C Hamanod3ab1ad2017-05-23 06:52:18[diff] [blame]6560 When set to true, git-receive-pack will advertise the push options
6561 capability to its clients. False by default.
Junio C Hamano6bb32e62015-02-17 22:11:26[diff] [blame]6562</p>
6563</dd>
6564<dt class="hdlist1">
Junio C Hamano621e1232009-10-26 05:16:47[diff] [blame]6565receive.autogc
6566</dt>
6567<dd>
6568<p>
6569 By default, git-receive-pack will run "git-gc --auto" after
6570 receiving data from git-push and updating refs. You can stop
6571 it by setting this variable to false.
6572</p>
6573</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6574<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6575receive.certNonceSeed
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6576</dt>
6577<dd>
6578<p>
6579 By setting this variable to a string, <code>git receive-pack</code>
6580 will accept a <code>git push --signed</code> and verifies it by using
6581 a "nonce" protected by HMAC using this string as a secret
6582 key.
6583</p>
6584</dd>
6585<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6586receive.certNonceSlop
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6587</dt>
6588<dd>
6589<p>
6590 When a <code>git push --signed</code> sent a push certificate with a
6591 "nonce" that was issued by a receive-pack serving the same
6592 repository within this many seconds, export the "nonce"
6593 found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
6594 hooks (instead of what the receive-pack asked the sending
6595 side to include). This may allow writing checks in
6596 <code>pre-receive</code> and <code>post-receive</code> a bit easier. Instead of
6597 checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
6598 that records by how many seconds the nonce is stale to
6599 decide if they want to accept the certificate, they only
6600 can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
6601</p>
6602</dd>
6603<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6604receive.fsckObjects
6605</dt>
6606<dd>
6607<p>
6608 If it is set to true, git-receive-pack will check all received
6609 objects. It will abort in the case of a malformed object or a
6610 broken link. The result of an abort are only dangling objects.
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6611 Defaults to false. If not set, the value of <code>transfer.fsckObjects</code>
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]6612 is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6613</p>
6614</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6615<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]6616receive.fsck.&lt;msg-id&gt;
6617</dt>
6618<dd>
6619<p>
6620 When <code>receive.fsckObjects</code> is set to true, errors can be switched
6621 to warnings and vice versa by configuring the <code>receive.fsck.&lt;msg-id&gt;</code>
6622 setting where the <code>&lt;msg-id&gt;</code> is the fsck message ID and the value
6623 is one of <code>error</code>, <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes
6624 the error/warning with the message ID, e.g. "missingEmail: invalid
6625 author/committer line - missing email" means that setting
6626 <code>receive.fsck.missingEmail = ignore</code> will hide that issue.
6627</p>
6628<div class="paragraph"><p>This feature is intended to support working with legacy repositories
6629which would not pass pushing when <code>receive.fsckObjects = true</code>, allowing
6630the host to accept repositories with certain known issues but still catch
6631other issues.</p></div>
6632</dd>
6633<dt class="hdlist1">
6634receive.fsck.skipList
6635</dt>
6636<dd>
6637<p>
6638 The path to a sorted list of object names (i.e. one SHA-1 per
6639 line) that are known to be broken in a non-fatal way and should
6640 be ignored. This feature is useful when an established project
6641 should be accepted despite early commits containing errors that
6642 can be safely ignored such as invalid committer email addresses.
6643 Note: corrupt objects cannot be skipped with this setting.
6644</p>
6645</dd>
6646<dt class="hdlist1">
Junio C Hamanoe48a1132016-08-03 22:40:21[diff] [blame]6647receive.keepAlive
6648</dt>
6649<dd>
6650<p>
6651 After receiving the pack from the client, <code>receive-pack</code> may
6652 produce no output (if <code>--quiet</code> was specified) while processing
6653 the pack, causing some networks to drop the TCP connection.
6654 With this option set, if <code>receive-pack</code> does not transmit
6655 any data in this phase for <code>receive.keepAlive</code> seconds, it will
6656 send a short keepalive packet. The default is 5 seconds; set
6657 to 0 to disable keepalives entirely.
6658</p>
6659</dd>
6660<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6661receive.unpackLimit
6662</dt>
6663<dd>
6664<p>
6665 If the number of objects received in a push is below this
6666 limit then the objects will be unpacked into loose object
6667 files. However if the number of received objects equals or
6668 exceeds this limit then the received pack will be stored as
6669 a pack, after adding any missing delta bases. Storing the
6670 pack from a push can make the push operation complete faster,
6671 especially on slow filesystems. If not set, the value of
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6672 <code>transfer.unpackLimit</code> is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6673</p>
6674</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6675<dt class="hdlist1">
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]6676receive.maxInputSize
6677</dt>
6678<dd>
6679<p>
6680 If the size of the incoming pack stream is larger than this
6681 limit, then git-receive-pack will error out, instead of
6682 accepting the pack file. If not set or set to 0, then the size
6683 is unlimited.
6684</p>
6685</dd>
6686<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6687receive.denyDeletes
6688</dt>
6689<dd>
6690<p>
6691 If set to true, git-receive-pack will deny a ref update that deletes
6692 the ref. Use this to prevent such a ref deletion via a push.
6693</p>
6694</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6695<dt class="hdlist1">
Junio C Hamanob4448a82010-07-26 09:02:32[diff] [blame]6696receive.denyDeleteCurrent
6697</dt>
6698<dd>
6699<p>
6700 If set to true, git-receive-pack will deny a ref update that
6701 deletes the currently checked out branch of a non-bare repository.
6702</p>
6703</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6704<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6705receive.denyCurrentBranch
6706</dt>
6707<dd>
6708<p>
Junio C Hamanoe97d5772010-05-19 08:13:58[diff] [blame]6709 If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6710 to the currently checked out branch of a non-bare repository.
6711 Such a push is potentially dangerous because it brings the HEAD
6712 out of sync with the index and working tree. If set to "warn",
6713 print a warning of such a push to stderr, but allow the push to
6714 proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:15[diff] [blame]6715 message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6716</p>
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]6717<div class="paragraph"><p>Another option is "updateInstead" which will update the working
Junio C Hamano6bb32e62015-02-17 22:11:26[diff] [blame]6718tree if pushing into the current branch. This option is
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]6719intended for synchronizing working directories when one side is not easily
6720accessible via interactive ssh (e.g. a live web site, hence the requirement
6721that the working directory be clean). This mode also comes in handy when
6722developing inside a VM to test and fix code on different Operating Systems.</p></div>
Junio C Hamano6bb32e62015-02-17 22:11:26[diff] [blame]6723<div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or
6724the index have any difference from the HEAD, but the <code>push-to-checkout</code>
6725hook can be used to customize this. See <a href="githooks.html">githooks(5)</a>.</p></div>
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6726</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6727<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6728receive.denyNonFastForwards
6729</dt>
6730<dd>
6731<p>
6732 If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:54[diff] [blame]6733 not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6734 even if that push is forced. This configuration variable is
6735 set when initializing a shared repository.
6736</p>
6737</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6738<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6739receive.hideRefs
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]6740</dt>
6741<dd>
6742<p>
Junio C Hamanob6aa12e2015-08-19 22:40:17[diff] [blame]6743 This variable is the same as <code>transfer.hideRefs</code>, but applies
6744 only to <code>receive-pack</code> (and so affects pushes, but not fetches).
6745 An attempt to update or delete a hidden ref by <code>git push</code> is
6746 rejected.
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]6747</p>
6748</dd>
6749<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6750receive.updateServerInfo
Junio C Hamano621e1232009-10-26 05:16:47[diff] [blame]6751</dt>
6752<dd>
6753<p>
6754 If set to true, git-receive-pack will run git-update-server-info
6755 after receiving data from git-push and updating refs.
6756</p>
6757</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6758<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6759receive.shallowUpdate
Junio C Hamano61525f92014-01-17 22:46:49[diff] [blame]6760</dt>
6761<dd>
6762<p>
6763 If set to true, .git/shallow can be updated when new refs
6764 require new shallow roots. Otherwise those refs are rejected.
6765</p>
6766</dd>
6767<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6768remote.pushDefault
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]6769</dt>
6770<dd>
6771<p>
6772 The remote to push to by default. Overrides
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6773 <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6774 <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]6775</p>
6776</dd>
6777<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6778remote.&lt;name&gt;.url
6779</dt>
6780<dd>
6781<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6782 The URL of a remote repository. See <a href="git-fetch.html">git-fetch(1)</a> or
6783 <a href="git-push.html">git-push(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6784</p>
6785</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6786<dt class="hdlist1">
Junio C Hamano0e88f3e2009-06-21 08:03:25[diff] [blame]6787remote.&lt;name&gt;.pushurl
6788</dt>
6789<dd>
6790<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6791 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]6792</p>
6793</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6794<dt class="hdlist1">
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]6795remote.&lt;name&gt;.proxy
6796</dt>
6797<dd>
6798<p>
6799 For remotes that require curl (http, https and ftp), the URL to
6800 the proxy to use for that remote. Set to the empty string to
6801 disable proxying for that remote.
6802</p>
6803</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6804<dt class="hdlist1">
Junio C Hamanoffe10ca2016-02-04 00:44:23[diff] [blame]6805remote.&lt;name&gt;.proxyAuthMethod
6806</dt>
6807<dd>
6808<p>
6809 For remotes that require curl (http, https and ftp), the method to use for
6810 authenticating against the proxy in use (probably set in
6811 <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.
6812</p>
6813</dd>
6814<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6815remote.&lt;name&gt;.fetch
6816</dt>
6817<dd>
6818<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6819 The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
6820 <a href="git-fetch.html">git-fetch(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6821</p>
6822</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6823<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6824remote.&lt;name&gt;.push
6825</dt>
6826<dd>
6827<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6828 The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
6829 <a href="git-push.html">git-push(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6830</p>
6831</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6832<dt class="hdlist1">
Junio C Hamano47d68a52008-05-06 06:35:40[diff] [blame]6833remote.&lt;name&gt;.mirror
6834</dt>
6835<dd>
6836<p>
6837 If true, pushing to this remote will automatically behave
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6838 as if the <code>--mirror</code> option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:40[diff] [blame]6839</p>
6840</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6841<dt class="hdlist1">
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]6842remote.&lt;name&gt;.skipDefaultUpdate
6843</dt>
6844<dd>
6845<p>
6846 If true, this remote will be skipped by default when updating
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6847 using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6848 <a href="git-remote.html">git-remote(1)</a>.
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]6849</p>
6850</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6851<dt class="hdlist1">
Junio C Hamano9df0c662009-11-23 11:09:27[diff] [blame]6852remote.&lt;name&gt;.skipFetchAll
6853</dt>
6854<dd>
6855<p>
6856 If true, this remote will be skipped by default when updating
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6857 using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6858 <a href="git-remote.html">git-remote(1)</a>.
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]6859</p>
6860</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6861<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6862remote.&lt;name&gt;.receivepack
6863</dt>
6864<dd>
6865<p>
6866 The default program to execute on the remote side when pushing. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6867 option --receive-pack of <a href="git-push.html">git-push(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6868</p>
6869</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6870<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6871remote.&lt;name&gt;.uploadpack
6872</dt>
6873<dd>
6874<p>
6875 The default program to execute on the remote side when fetching. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6876 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]6877</p>
6878</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6879<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6880remote.&lt;name&gt;.tagOpt
Junio C Hamano17dde0e2007-02-26 09:50:21[diff] [blame]6881</dt>
6882<dd>
6883<p>
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]6884 Setting this value to --no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]6885 fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
6886 tag from remote &lt;name&gt;, even if they are not reachable from remote
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6887 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]6888 override this setting. See options --tags and --no-tags of
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6889 <a href="git-fetch.html">git-fetch(1)</a>.
Junio C Hamano17dde0e2007-02-26 09:50:21[diff] [blame]6890</p>
6891</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6892<dt class="hdlist1">
Junio C Hamano096dde22009-12-26 23:14:11[diff] [blame]6893remote.&lt;name&gt;.vcs
6894</dt>
6895<dd>
6896<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]6897 Setting this to a value &lt;vcs&gt; will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:11[diff] [blame]6898 the remote with the git-remote-&lt;vcs&gt; helper.
6899</p>
6900</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6901<dt class="hdlist1">
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]6902remote.&lt;name&gt;.prune
6903</dt>
6904<dd>
6905<p>
6906 When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:42[diff] [blame]6907 remove any remote-tracking references that no longer exist on the
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6908 remote (as if the <code>--prune</code> option was given on the command line).
6909 Overrides <code>fetch.prune</code> settings, if any.
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]6910</p>
6911</dd>
6912<dt class="hdlist1">
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]6913remotes.&lt;group&gt;
6914</dt>
6915<dd>
6916<p>
6917 The list of remotes which are fetched by "git remote update
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6918 &lt;group&gt;". See <a href="git-remote.html">git-remote(1)</a>.
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]6919</p>
6920</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6921<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6922repack.useDeltaBaseOffset
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6923</dt>
6924<dd>
6925<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6926 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]6927 delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]6928 Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]6929 protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]6930 "false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]6931 native protocol are unaffected by this option.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]6932</p>
6933</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6934<dt class="hdlist1">
Junio C Hamano3b0cdc22014-03-18 22:06:16[diff] [blame]6935repack.packKeptObjects
6936</dt>
6937<dd>
6938<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6939 If set to true, makes <code>git repack</code> act as if
6940 <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
6941 details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
6942 index is being written (either via <code>--write-bitmap-index</code> or
6943 <code>repack.writeBitmaps</code>).
Junio C Hamano38d02532014-06-26 21:48:50[diff] [blame]6944</p>
6945</dd>
6946<dt class="hdlist1">
6947repack.writeBitmaps
6948</dt>
6949<dd>
6950<p>
6951 When true, git will write a bitmap index when packing all
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6952 objects to disk (e.g., when <code>git repack -a</code> is run). This
Junio C Hamano38d02532014-06-26 21:48:50[diff] [blame]6953 index can speed up the "counting objects" phase of subsequent
6954 packs created for clones and fetches, at the cost of some disk
Junio C Hamano74fd0fc2016-05-10 21:23:56[diff] [blame]6955 space and extra time spent on the initial repack. This has
6956 no effect if multiple packfiles are created.
6957 Defaults to false.
Junio C Hamano3b0cdc22014-03-18 22:06:16[diff] [blame]6958</p>
6959</dd>
6960<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6961rerere.autoUpdate
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6962</dt>
6963<dd>
6964<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6965 When set to true, <code>git-rerere</code> updates the index with the
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6966 resulting contents after it cleanly resolves conflicts using
6967 previously recorded resolution. Defaults to false.
6968</p>
6969</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6970<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6971rerere.enabled
6972</dt>
6973<dd>
6974<p>
6975 Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:43[diff] [blame]6976 conflict hunks can be resolved automatically, should they be
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6977 encountered again. By default, <a href="git-rerere.html">git-rerere(1)</a> is
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]6978 enabled if there is an <code>rr-cache</code> directory under the
6979 <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
Junio C Hamano864ba892012-01-13 17:42:05[diff] [blame]6980 repository.
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]6981</p>
6982</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6983<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]6984sendemail.identity
6985</dt>
6986<dd>
6987<p>
6988 A configuration identity. When given, causes values in the
6989 <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
6990 values in the <em>sendemail</em> section. The default identity is
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]6991 the value of <code>sendemail.identity</code>.
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]6992</p>
6993</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6994<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]6995sendemail.smtpEncryption
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]6996</dt>
6997<dd>
6998<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]6999 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]7000 setting is not subject to the <em>identity</em> mechanism.
7001</p>
7002</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7003<dt class="hdlist1">
Junio C Hamanobe087982015-02-22 21:29:39[diff] [blame]7004sendemail.smtpssl (deprecated)
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7005</dt>
7006<dd>
7007<p>
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7008 Deprecated alias for <em>sendemail.smtpEncryption = ssl</em>.
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7009</p>
7010</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7011<dt class="hdlist1">
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]7012sendemail.smtpsslcertpath
7013</dt>
7014<dd>
7015<p>
7016 Path to ca-certificates (either a directory or a single file).
7017 Set it to an empty string to disable certificate verification.
7018</p>
7019</dd>
7020<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7021sendemail.&lt;identity&gt;.*
7022</dt>
7023<dd>
7024<p>
7025 Identity-specific versions of the <em>sendemail.*</em> parameters
7026 found below, taking precedence over those when the this
7027 identity is selected, through command-line or
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]7028 <code>sendemail.identity</code>.
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7029</p>
7030</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7031<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7032sendemail.aliasesFile
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7033</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7034<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7035sendemail.aliasFileType
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7036</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7037<dt class="hdlist1">
Junio C Hamanoea3b7522013-04-18 19:37:53[diff] [blame]7038sendemail.annotate
7039</dt>
7040<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7041sendemail.bcc
7042</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7043<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7044sendemail.cc
7045</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7046<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7047sendemail.ccCmd
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7048</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7049<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7050sendemail.chainReplyTo
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7051</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7052<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7053sendemail.confirm
7054</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7055<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7056sendemail.envelopeSender
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7057</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7058<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7059sendemail.from
7060</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7061<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7062sendemail.multiEdit
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7063</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7064<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7065sendemail.signedoffbycc
7066</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7067<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7068sendemail.smtpPass
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7069</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7070<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7071sendemail.suppresscc
7072</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7073<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7074sendemail.suppressFrom
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7075</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7076<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7077sendemail.to
7078</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7079<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7080sendemail.smtpDomain
Junio C Hamanocb39aea2010-05-09 07:24:48[diff] [blame]7081</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7082<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7083sendemail.smtpServer
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7084</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7085<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7086sendemail.smtpServerPort
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7087</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7088<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7089sendemail.smtpServerOption
Junio C Hamano39c7a692010-10-27 06:08:54[diff] [blame]7090</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7091<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7092sendemail.smtpUser
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7093</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7094<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7095sendemail.thread
7096</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7097<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7098sendemail.transferEncoding
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]7099</dt>
7100<dt class="hdlist1">
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7101sendemail.validate
7102</dt>
Junio C Hamanoc9394b22015-01-07 22:45:48[diff] [blame]7103<dt class="hdlist1">
7104sendemail.xmailer
7105</dt>
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7106<dd>
7107<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7108 See <a href="git-send-email.html">git-send-email(1)</a> for description.
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7109</p>
7110</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7111<dt class="hdlist1">
Junio C Hamanobe087982015-02-22 21:29:39[diff] [blame]7112sendemail.signedoffcc (deprecated)
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7113</dt>
7114<dd>
7115<p>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]7116 Deprecated alias for <code>sendemail.signedoffbycc</code>.
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]7117</p>
7118</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7119<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7120showbranch.default
7121</dt>
7122<dd>
7123<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7124 The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
7125 See <a href="git-show-branch.html">git-show-branch(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7126</p>
7127</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7128<dt class="hdlist1">
Junio C Hamano3d4a66d2017-03-17 21:07:26[diff] [blame]7129splitIndex.maxPercentChange
7130</dt>
7131<dd>
7132<p>
7133 When the split index feature is used, this specifies the
7134 percent of entries the split index can contain compared to the
7135 total number of entries in both the split index and the shared
7136 index before a new shared index is written.
7137 The value should be between 0 and 100. If the value is 0 then
7138 a new shared index is always written, if it is 100 a new
7139 shared index is never written.
7140 By default the value is 20, so a new shared index is written
7141 if the number of entries in the split index would be greater
7142 than 20 percent of the total number of entries.
7143 See <a href="git-update-index.html">git-update-index(1)</a>.
7144</p>
7145</dd>
7146<dt class="hdlist1">
7147splitIndex.sharedIndexExpire
7148</dt>
7149<dd>
7150<p>
7151 When the split index feature is used, shared index files that
7152 were not modified since the time this variable specifies will
7153 be removed when a new shared index file is created. The value
7154 "now" expires all entries immediately, and "never" suppresses
7155 expiration altogether.
7156 The default value is "2.weeks.ago".
7157 Note that a shared index file is considered modified (for the
7158 purpose of expiration) each time a new split-index file is
7159 either created based on it or read from it.
7160 See <a href="git-update-index.html">git-update-index(1)</a>.
7161</p>
7162</dd>
7163<dt class="hdlist1">
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]7164status.relativePaths
7165</dt>
7166<dd>
7167<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7168 By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7169 current directory. Setting this variable to <code>false</code> shows paths
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]7170 relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]7171 prior to v1.5.4).
7172</p>
7173</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7174<dt class="hdlist1">
Junio C Hamano58655592013-07-11 20:52:33[diff] [blame]7175status.short
7176</dt>
7177<dd>
7178<p>
7179 Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
7180 The option --no-short takes precedence over this variable.
7181</p>
7182</dd>
7183<dt class="hdlist1">
7184status.branch
7185</dt>
7186<dd>
7187<p>
7188 Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
7189 The option --no-branch takes precedence over this variable.
7190</p>
7191</dd>
7192<dt class="hdlist1">
Junio C Hamano79f4c7c2013-09-20 21:03:37[diff] [blame]7193status.displayCommentPrefix
7194</dt>
7195<dd>
7196<p>
7197 If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
7198 prefix before each output line (starting with
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7199 <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
Junio C Hamano79f4c7c2013-09-20 21:03:37[diff] [blame]7200 behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
7201 Defaults to false.
7202</p>
7203</dd>
7204<dt class="hdlist1">
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]7205status.showUntrackedFiles
7206</dt>
7207<dd>
7208<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7209 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]7210 files which are not currently tracked by Git. Directories which
7211 contain only untracked files, are shown with the directory name
7212 only. Showing untracked files means that Git needs to lstat() all
Junio C Hamano2efd5e42014-11-10 22:38:52[diff] [blame]7213 the files in the whole repository, which might be slow on some
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]7214 systems. So, this variable controls how the commands displays
7215 the untracked files. Possible values are:
7216</p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]7217<div class="openblock">
7218<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7219<div class="ulist"><ul>
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]7220<li>
7221<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7222<code>no</code> - Show no untracked files.
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]7223</p>
7224</li>
7225<li>
7226<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7227<code>normal</code> - Show untracked files and directories.
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]7228</p>
7229</li>
7230<li>
7231<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7232<code>all</code> - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]7233</p>
7234</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]7235</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]7236</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7237<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]7238This variable can be overridden with the -u|--untracked-files option
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7239of <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]7240</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7241<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7242status.submoduleSummary
Junio C Hamanob671fb52010-06-01 05:06:14[diff] [blame]7243</dt>
7244<dd>
7245<p>
7246 Defaults to false.
7247 If this is set to a non zero number or true (identical to -1 or an
7248 unlimited number), the submodule summary will be enabled and a
7249 summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]7250 --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
7251 that the summary output command will be suppressed for all
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7252 submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
7253 for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
Junio C Hamanoc8c398a2014-06-16 21:14:05[diff] [blame]7254 exception to that rule is that status and commit will show staged
7255 submodule changes. To
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]7256 also view the summary for ignored submodules you can either use
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]7257 the --ignore-submodules=dirty command-line option or the <em>git
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]7258 submodule summary</em> command, which shows a similar output but does
7259 not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:14[diff] [blame]7260</p>
7261</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7262<dt class="hdlist1">
Junio C Hamano1eb56092015-10-05 20:39:53[diff] [blame]7263stash.showPatch
7264</dt>
7265<dd>
7266<p>
7267 If this is set to true, the <code>git stash show</code> command without an
7268 option will show the stash in patch form. Defaults to false.
7269 See description of <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
7270</p>
7271</dd>
7272<dt class="hdlist1">
7273stash.showStat
7274</dt>
7275<dd>
7276<p>
7277 If this is set to true, the <code>git stash show</code> command without an
7278 option will show diffstat of the stash. Defaults to true.
7279 See description of <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.
7280</p>
7281</dd>
7282<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]7283submodule.&lt;name&gt;.url
7284</dt>
Junio C Hamano6bf68cf2015-03-06 23:46:29[diff] [blame]7285<dd>
7286<p>
Junio C Hamanoc0859f72016-10-17 22:22:57[diff] [blame]7287 The URL for a submodule. This variable is copied from the .gitmodules
7288 file to the git config via <em>git submodule init</em>. The user can change
7289 the configured URL before obtaining the submodule via <em>git submodule
Junio C Hamanodc8d0c32017-03-30 23:00:21[diff] [blame]7290 update</em>. If neither submodule.&lt;name&gt;.active or submodule.active are
7291 set, the presence of this variable is used as a fallback to indicate
7292 whether the submodule is of interest to git commands.
Junio C Hamanoc0859f72016-10-17 22:22:57[diff] [blame]7293 See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
Junio C Hamano6bf68cf2015-03-06 23:46:29[diff] [blame]7294</p>
7295</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7296<dt class="hdlist1">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]7297submodule.&lt;name&gt;.update
7298</dt>
7299<dd>
7300<p>
Junio C Hamano6bf68cf2015-03-06 23:46:29[diff] [blame]7301 The default update procedure for a submodule. This variable
7302 is populated by <code>git submodule init</code> from the
7303 <a href="gitmodules.html">gitmodules(5)</a> file. See description of <em>update</em>
7304 command in <a href="git-submodule.html">git-submodule(1)</a>.
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]7305</p>
7306</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7307<dt class="hdlist1">
Junio C Hamanoabad6da2013-01-06 09:06:32[diff] [blame]7308submodule.&lt;name&gt;.branch
7309</dt>
7310<dd>
7311<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7312 The remote branch name for a submodule, used by <code>git submodule
7313 update --remote</code>. Set this option to override the value found in
7314 the <code>.gitmodules</code> file. See <a href="git-submodule.html">git-submodule(1)</a> and
Junio C Hamanoabad6da2013-01-06 09:06:32[diff] [blame]7315 <a href="gitmodules.html">gitmodules(5)</a> for details.
7316</p>
7317</dd>
7318<dt class="hdlist1">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]7319submodule.&lt;name&gt;.fetchRecurseSubmodules
7320</dt>
7321<dd>
7322<p>
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]7323 This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:18[diff] [blame]7324 submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]7325 command-line option to "git fetch" and "git pull".
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7326 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]7327 file.
7328</p>
7329</dd>
7330<dt class="hdlist1">
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]7331submodule.&lt;name&gt;.ignore
7332</dt>
7333<dd>
7334<p>
7335 Defines under what circumstances "git status" and the diff family show
7336 a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:05[diff] [blame]7337 modified (but it will nonetheless show up in the output of status and
7338 commit when it has been staged), "dirty" will ignore all changes
7339 to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]7340 takes only differences between the HEAD of the submodule and the commit
7341 recorded in the superproject into account. "untracked" will additionally
7342 let submodules with modified tracked files in their work tree show up.
7343 Using "none" (the default when this option is not set) also shows
7344 submodules that have untracked files in their work tree as changed.
7345 This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:18[diff] [blame]7346 both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]7347 "--ignore-submodules" option. The <em>git submodule</em> commands are not
7348 affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]7349</p>
7350</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7351<dt class="hdlist1">
Junio C Hamanodc8d0c32017-03-30 23:00:21[diff] [blame]7352submodule.&lt;name&gt;.active
7353</dt>
7354<dd>
7355<p>
7356 Boolean value indicating if the submodule is of interest to git
7357 commands. This config option takes precedence over the
7358 submodule.active config option.
7359</p>
7360</dd>
7361<dt class="hdlist1">
7362submodule.active
7363</dt>
7364<dd>
7365<p>
7366 A repeated field which contains a pathspec used to match against a
7367 submodule&#8217;s path to determine if the submodule is of interest to git
7368 commands.
7369</p>
7370</dd>
7371<dt class="hdlist1">
Junio C Hamanobec5da42016-04-06 22:58:21[diff] [blame]7372submodule.fetchJobs
7373</dt>
7374<dd>
7375<p>
7376 Specifies how many submodules are fetched/cloned at the same time.
7377 A positive integer allows up to that number of submodules fetched
7378 in parallel. A value of 0 will give some reasonable default.
7379 If unset, it defaults to 1.
7380</p>
7381</dd>
7382<dt class="hdlist1">
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]7383submodule.alternateLocation
7384</dt>
7385<dd>
7386<p>
7387 Specifies how the submodules obtain alternates when submodules are
7388 cloned. Possible values are <code>no</code>, <code>superproject</code>.
7389 By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
7390 value is set to <code>superproject</code> the submodule to be cloned computes
7391 its alternates location relative to the superprojects alternate.
7392</p>
7393</dd>
Junio C Hamanoce01de82017-02-16 22:59:12[diff] [blame]7394<dt class="hdlist1">
7395submodule.alternateErrorStrategy
7396</dt>
7397<dd>
7398<p>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]7399 Specifies how to treat errors with the alternates for a submodule
7400 as computed via <code>submodule.alternateLocation</code>. Possible values are
Junio C Hamanoce01de82017-02-16 22:59:12[diff] [blame]7401 <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>.
7402</p>
7403</dd>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]7404<dt class="hdlist1">
Junio C Hamanobec5da42016-04-06 22:58:21[diff] [blame]7405tag.forceSignAnnotated
7406</dt>
7407<dd>
7408<p>
7409 A boolean to specify whether annotated tags created should be GPG signed.
7410 If <code>--annotate</code> is specified on the command line, it takes
7411 precedence over this option.
7412</p>
7413</dd>
7414<dt class="hdlist1">
Junio C Hamano7b43d412014-07-23 23:09:44[diff] [blame]7415tag.sort
7416</dt>
7417<dd>
7418<p>
7419 This variable controls the sort ordering of tags when displayed by
7420 <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
7421 value of this variable will be used as the default.
7422</p>
7423</dd>
7424<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7425tar.umask
7426</dt>
7427<dd>
7428<p>
Junio C Hamanobdebabb2007-08-23 00:25:09[diff] [blame]7429 This variable can be used to restrict the permission bits of
7430 tar archive entries. The default is 0002, which turns off the
7431 world write bit. The special value "user" indicates that the
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7432 archiving user&#8217;s umask will be used instead. See umask(2) and
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7433 <a href="git-archive.html">git-archive(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7434</p>
7435</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7436<dt class="hdlist1">
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]7437transfer.fsckObjects
7438</dt>
7439<dd>
7440<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7441 When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]7442 not set, the value of this variable is used instead.
7443 Defaults to false.
7444</p>
7445</dd>
7446<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7447transfer.hideRefs
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]7448</dt>
7449<dd>
7450<p>
Junio C Hamanob6aa12e2015-08-19 22:40:17[diff] [blame]7451 String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
7452 refs to omit from their initial advertisements. Use more than
7453 one definition to specify multiple prefix strings. A ref that is
7454 under the hierarchies listed in the value of this variable is
7455 excluded, and is hidden when responding to <code>git push</code> or <code>git
7456 fetch</code>. See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
7457 program-specific versions of this config.
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]7458</p>
Junio C Hamanob6aa12e2015-08-19 22:40:17[diff] [blame]7459<div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry,
7460explicitly exposing it, even if an earlier entry marked it as hidden.
7461If you have multiple hideRefs values, later entries override earlier ones
7462(and entries in more-specific config files override less-specific ones).</p></div>
Junio C Hamano713eded2015-12-03 00:24:02[diff] [blame]7463<div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
7464reference before it is matched against <code>transfer.hiderefs</code> patterns.
7465For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
7466the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
7467is omitted from the advertisements but <code>refs/heads/master</code> and
7468<code>refs/namespaces/bar/refs/heads/master</code> are still advertised as so-called
7469"have" lines. In order to match refs before stripping, add a <code>^</code> in front of
7470the ref name. If you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div>
Junio C Hamano56ace3d2017-01-10 23:43:41[diff] [blame]7471<div class="paragraph"><p>Even if you hide refs, a client may still be able to steal the target
7472objects via the techniques described in the "SECURITY" section of the
7473<a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
7474separate repository.</p></div>
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]7475</dd>
7476<dt class="hdlist1">
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]7477transfer.unpackLimit
7478</dt>
7479<dd>
7480<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7481 When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
Junio C Hamano4653c6f2008-11-26 22:50:20[diff] [blame]7482 not set, the value of this variable is used instead.
7483 The default value is 100.
7484</p>
7485</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7486<dt class="hdlist1">
Junio C Hamano81703b22014-03-14 22:00:27[diff] [blame]7487uploadarchive.allowUnreachable
7488</dt>
7489<dd>
7490<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7491 If true, allow clients to use <code>git archive --remote</code> to request
Junio C Hamano81703b22014-03-14 22:00:27[diff] [blame]7492 any tree, whether reachable from the ref tips or not. See the
Junio C Hamano56ace3d2017-01-10 23:43:41[diff] [blame]7493 discussion in the "SECURITY" section of
Junio C Hamano81703b22014-03-14 22:00:27[diff] [blame]7494 <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7495 <code>false</code>.
Junio C Hamano81703b22014-03-14 22:00:27[diff] [blame]7496</p>
7497</dd>
7498<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7499uploadpack.hideRefs
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]7500</dt>
7501<dd>
7502<p>
Junio C Hamanob6aa12e2015-08-19 22:40:17[diff] [blame]7503 This variable is the same as <code>transfer.hideRefs</code>, but applies
7504 only to <code>upload-pack</code> (and so affects only fetches, not pushes).
7505 An attempt to fetch a hidden ref by <code>git fetch</code> will fail. See
7506 also <code>uploadpack.allowTipSHA1InWant</code>.
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]7507</p>
7508</dd>
7509<dt class="hdlist1">
Junio C Hamano85f1fde2015-06-01 20:37:32[diff] [blame]7510uploadpack.allowTipSHA1InWant
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]7511</dt>
7512<dd>
7513<p>
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7514 When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]7515 to accept a fetch request that asks for an object at the tip
7516 of a hidden ref (by default, such a request is rejected).
Junio C Hamano56ace3d2017-01-10 23:43:41[diff] [blame]7517 See also <code>uploadpack.hideRefs</code>. Even if this is false, a client
7518 may be able to steal objects via the techniques described in the
7519 "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
7520 best to keep private data in a separate repository.
Junio C Hamano80ad00d2013-02-18 00:19:03[diff] [blame]7521</p>
7522</dd>
7523<dt class="hdlist1">
Junio C Hamano85f1fde2015-06-01 20:37:32[diff] [blame]7524uploadpack.allowReachableSHA1InWant
7525</dt>
7526<dd>
7527<p>
7528 Allow <code>upload-pack</code> to accept a fetch request that asks for an
7529 object that is reachable from any ref tip. However, note that
7530 calculating object reachability is computationally expensive.
Junio C Hamano56ace3d2017-01-10 23:43:41[diff] [blame]7531 Defaults to <code>false</code>. Even if this is false, a client may be able
7532 to steal objects via the techniques described in the "SECURITY"
7533 section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
7534 keep private data in a separate repository.
7535</p>
7536</dd>
7537<dt class="hdlist1">
7538uploadpack.allowAnySHA1InWant
7539</dt>
7540<dd>
7541<p>
7542 Allow <code>upload-pack</code> to accept a fetch request that asks for any
7543 object at all.
Junio C Hamano85f1fde2015-06-01 20:37:32[diff] [blame]7544 Defaults to <code>false</code>.
7545</p>
7546</dd>
7547<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7548uploadpack.keepAlive
Junio C Hamano79f4c7c2013-09-20 21:03:37[diff] [blame]7549</dt>
7550<dd>
7551<p>
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7552 When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
7553 quiet period while <code>pack-objects</code> prepares the pack. Normally
7554 it would output progress information, but if <code>--quiet</code> was used
7555 for the fetch, <code>pack-objects</code> will output nothing at all until
Junio C Hamano79f4c7c2013-09-20 21:03:37[diff] [blame]7556 the pack data begins. Some clients and networks may consider
7557 the server to be hung and give up. Setting this option instructs
Junio C Hamano9236fea2014-10-14 22:28:09[diff] [blame]7558 <code>upload-pack</code> to send an empty keepalive packet every
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7559 <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
Junio C Hamano79f4c7c2013-09-20 21:03:37[diff] [blame]7560 disables keepalive packets entirely. The default is 5 seconds.
7561</p>
7562</dd>
7563<dt class="hdlist1">
Junio C Hamanoc6c919b2016-07-06 21:34:15[diff] [blame]7564uploadpack.packObjectsHook
7565</dt>
7566<dd>
7567<p>
7568 If this option is set, when <code>upload-pack</code> would run
7569 <code>git pack-objects</code> to create a packfile for a client, it will
7570 run this shell command instead. The <code>pack-objects</code> command and
7571 arguments it <em>would</em> have run (including the <code>git pack-objects</code>
7572 at the beginning) are appended to the shell command. The stdin
7573 and stdout of the hook are treated as if <code>pack-objects</code> itself
7574 was run. I.e., <code>upload-pack</code> will feed input intended for
7575 <code>pack-objects</code> to the hook, and expects a completed packfile on
7576 stdout.
7577</p>
7578<div class="paragraph"><p>Note that this configuration variable is ignored if it is seen in the
7579repository-level config (this is a safety measure against fetching from
7580untrusted repositories).</p></div>
7581</dd>
7582<dt class="hdlist1">
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]7583url.&lt;base&gt;.insteadOf
7584</dt>
7585<dd>
7586<p>
7587 Any URL that starts with this value will be rewritten to
7588 start, instead, with &lt;base&gt;. In cases where some site serves a
7589 large number of repositories, and serves them with multiple
7590 access methods, and some users need to use different access
7591 methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]7592 equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]7593 the best alternative for the particular user, even for a
7594 never-before-seen repository on the site. When more than one
7595 insteadOf strings match a given URL, the longest match is used.
7596</p>
7597</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7598<dt class="hdlist1">
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]7599url.&lt;base&gt;.pushInsteadOf
7600</dt>
7601<dd>
7602<p>
7603 Any URL that starts with this value will not be pushed to;
7604 instead, it will be rewritten to start with &lt;base&gt;, and the
7605 resulting URL will be pushed to. In cases where some site serves
7606 a large number of repositories, and serves them with multiple
7607 access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]7608 allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]7609 automatically use an appropriate URL to push, even for a
7610 never-before-seen repository on the site. When more than one
7611 pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]7612 used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]7613 setting for that remote.
7614</p>
7615</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7616<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7617user.email
7618</dt>
7619<dd>
7620<p>
7621 Your email address to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]7622 Can be overridden by the <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_EMAIL</code>, and
7623 <code>EMAIL</code> environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7624</p>
7625</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7626<dt class="hdlist1">
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7627user.name
7628</dt>
7629<dd>
7630<p>
7631 Your full name to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]7632 Can be overridden by the <code>GIT_AUTHOR_NAME</code> and <code>GIT_COMMITTER_NAME</code>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7633 environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7634</p>
7635</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7636<dt class="hdlist1">
Junio C Hamanof85ef632016-02-17 22:31:06[diff] [blame]7637user.useConfigOnly
7638</dt>
7639<dd>
7640<p>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]7641 Instruct Git to avoid trying to guess defaults for <code>user.email</code>
7642 and <code>user.name</code>, and instead retrieve the values only from the
Junio C Hamanof85ef632016-02-17 22:31:06[diff] [blame]7643 configuration. For example, if you have multiple email addresses
7644 and would like to use a different one for each repository, then
7645 with this configuration option set to <code>true</code> in the global config
7646 along with a name, Git will prompt you to set up an email before
7647 making new commits in a newly cloned repository.
7648 Defaults to <code>false</code>.
7649</p>
7650</dd>
7651<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]7652user.signingKey
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7653</dt>
7654<dd>
7655<p>
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]7656 If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
7657 key you want it to automatically when creating a signed tag or
7658 commit, you can override the default selection with this variable.
7659 This option is passed unchanged to gpg&#8217;s --local-user parameter,
7660 so you may specify a key using any method that gpg supports.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7661</p>
7662</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7663<dt class="hdlist1">
Junio C Hamanobcd98f42017-01-24 00:12:16[diff] [blame]7664versionsort.prereleaseSuffix (deprecated)
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]7665</dt>
7666<dd>
7667<p>
Junio C Hamanobcd98f42017-01-24 00:12:16[diff] [blame]7668 Deprecated alias for <code>versionsort.suffix</code>. Ignored if
7669 <code>versionsort.suffix</code> is set.
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]7670</p>
Junio C Hamanobcd98f42017-01-24 00:12:16[diff] [blame]7671</dd>
7672<dt class="hdlist1">
7673versionsort.suffix
7674</dt>
7675<dd>
7676<p>
7677 Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
7678 with the same base version but different suffixes are still sorted
7679 lexicographically, resulting e.g. in prerelease tags appearing
7680 after the main release (e.g. "1.0-rc1" after "1.0"). This
7681 variable can be specified to determine the sorting order of tags
7682 with different suffixes.
7683</p>
7684<div class="paragraph"><p>By specifying a single suffix in this variable, any tagname containing
7685that suffix will appear before the corresponding main release. E.g. if
7686the variable is set to "-rc", then all "1.0-rcX" tags will appear before
7687"1.0". If specified multiple times, once per suffix, then the order of
7688suffixes in the configuration will determine the sorting order of tagnames
7689with those suffixes. E.g. if "-pre" appears before "-rc" in the
7690configuration, then all "1.0-preX" tags will be listed before any
7691"1.0-rcX" tags. The placement of the main release tag relative to tags
7692with various suffixes can be determined by specifying the empty suffix
7693among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
7694"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
7695are listed first, followed by "v4.8", then "v4.8-ckX" and finally
7696"v4.8-bfsX".</p></div>
7697<div class="paragraph"><p>If more than one suffixes match the same tagname, then that tagname will
7698be sorted according to the suffix which starts at the earliest position in
7699the tagname. If more than one different matching suffixes start at
7700that earliest position, then that tagname will be sorted according to the
7701longest of those suffixes.
7702The sorting order between different suffixes is undefined if they are
7703in multiple config files.</p></div>
Junio C Hamano07622622015-03-20 21:47:26[diff] [blame]7704</dd>
7705<dt class="hdlist1">
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]7706web.browser
7707</dt>
7708<dd>
7709<p>
7710 Specify a web browser that may be used by some commands.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7711 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]7712 may use it.
7713</p>
7714</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]7715</dl></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7716</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]7717</div>
7718</div>
7719<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]7720<h2 id="_git">GIT</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7721<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]7722<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]7723</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]7724</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]7725</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]7726<div id="footnotes"><hr /></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7727<div id="footer">
7728<div id="footer-text">
Junio C Hamano919d24f2017-05-09 14:51:22[diff] [blame]7729Last updated 2016-08-27 06:45:20 JST
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7730</div>
7731</div>
7732</body>
7733</html>