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