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