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