Google Git
Sign in
chromium / external / gitster / git-htmldocs / 17bd22710392bb8cd5d7cb26eb6d2eff19feca96 / . / git-config.html
blob: 8966da9db240c65e1eec8a128cf7e034202d4998 [file] [log] [blame]
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47h1, h2, h3 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]83 font-size: 1.1em;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]164
165div.attribution {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]214div.olist2 ol {
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]306</style>
307<title>git-config(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-config(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-config -
317 Get and set repository or global options
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
323<div class="verseblock">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]324<div class="content"><em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] name [value [value_regex]]
325<em>git config</em> [&lt;file-option&gt;] [type] --add name value
326<em>git config</em> [&lt;file-option&gt;] [type] --replace-all name [value [value_regex]]
327<em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get name [value_regex]
328<em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get-all name [value_regex]
329<em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get-regexp name_regex [value_regex]
330<em>git config</em> [&lt;file-option&gt;] --unset name [value_regex]
331<em>git config</em> [&lt;file-option&gt;] --unset-all name [value_regex]
332<em>git config</em> [&lt;file-option&gt;] --rename-section old_name new_name
333<em>git config</em> [&lt;file-option&gt;] --remove-section name
334<em>git config</em> [&lt;file-option&gt;] [-z|--null] -l | --list
335<em>git config</em> [&lt;file-option&gt;] --get-color name [default]
336<em>git config</em> [&lt;file-option&gt;] --get-colorbool name [stdout-is-tty]</div></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]337</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]338<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]339<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]340<div class="para"><p>You can query/set/replace/unset options with this command. The name is
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]341actually the section and the key separated by a dot, and the value will be
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]342escaped.</p></div>
343<div class="para"><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]344If you want to update or unset an option which can occur on multiple
345lines, a POSIX regexp <tt>value_regex</tt> needs to be given. Only the
346existing values that match the regexp are updated or unset. If
347you want to handle the lines that do <strong>not</strong> match the regex, just
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]348prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>).</p></div>
349<div class="para"><p>The type specifier can be either <em>--int</em> or <em>--bool</em>, which will make
350<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]351convert the value to the canonical form (simple decimal number for int,
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]352a "true" or "false" string for bool). If no type specifier is passed,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]353no checks or transformations are performed on the value.</p></div>
354<div class="para"><p>The file-option can be one of <em>--system</em>, <em>--global</em> or <em>--file</em>
Junio C Hamano0ddc94d2007-08-01 08:42:39[diff] [blame]355which specify where the values will be read from or written to.
356The default is to assume the config file of the current repository,
357.git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]358(see <a href="#FILES">[FILES]</a>).</p></div>
359<div class="para"><p>This command will fail if:</p></div>
360<div class="olist"><ol>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]361<li>
362<p>
Junio C Hamano0ddc94d2007-08-01 08:42:39[diff] [blame]363The config file is invalid,
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]364</p>
365</li>
366<li>
367<p>
Junio C Hamano0ddc94d2007-08-01 08:42:39[diff] [blame]368Can not write to the config file,
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]369</p>
370</li>
371<li>
372<p>
373no section was provided,
374</p>
375</li>
376<li>
377<p>
378the section or key is invalid,
379</p>
380</li>
381<li>
382<p>
383you try to unset an option which does not exist,
384</p>
385</li>
386<li>
387<p>
388you try to unset/set an option for which multiple lines match, or
389</p>
390</li>
391<li>
392<p>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]393you use <em>--global</em> option without $HOME being properly set.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]394</p>
395</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]396</ol></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]397</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]398<h2 id="_options">OPTIONS</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]399<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]400<div class="vlist"><dl>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]401<dt>
402--replace-all
403</dt>
404<dd>
405<p>
406 Default behavior is to replace at most one line. This replaces
407 all lines matching the key (and optionally the value_regex).
408</p>
409</dd>
410<dt>
411--add
412</dt>
413<dd>
414<p>
415 Adds a new line to the option without altering any existing
416 values. This is the same as providing <em>^$</em> as the value_regex.
417</p>
418</dd>
419<dt>
420--get
421</dt>
422<dd>
423<p>
424 Get the value for a given key (optionally filtered by a regex
425 matching the value). Returns error code 1 if the key was not
426 found and error code 2 if multiple key values were found.
427</p>
428</dd>
429<dt>
430--get-all
431</dt>
432<dd>
433<p>
434 Like get, but does not fail if the number of values for the key
435 is not exactly one.
436</p>
437</dd>
438<dt>
439--get-regexp
440</dt>
441<dd>
442<p>
443 Like --get-all, but interprets the name as a regular expression.
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]444 Also outputs the key names.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]445</p>
446</dd>
447<dt>
448--global
449</dt>
450<dd>
451<p>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]452 For writing options: write to global ~/.gitconfig file rather than
453 the repository .git/config.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]454</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]455<div class="para"><p>For reading options: read only from global ~/.gitconfig rather than
456from all available files.</p></div>
457<div class="para"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]458</dd>
459<dt>
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]460--system
461</dt>
462<dd>
463<p>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]464 For writing options: write to system-wide $(prefix)/etc/gitconfig
465 rather than the repository .git/config.
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]466</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]467<div class="para"><p>For reading options: read only from system-wide $(prefix)/etc/gitconfig
468rather than from all available files.</p></div>
469<div class="para"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]470</dd>
471<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]472-f config-file
473</dt>
474<dt>
475--file config-file
Junio C Hamano0ddc94d2007-08-01 08:42:39[diff] [blame]476</dt>
477<dd>
478<p>
479 Use the given config file instead of the one specified by GIT_CONFIG.
480</p>
481</dd>
482<dt>
Junio C Hamanod15328a2007-03-09 09:06:40[diff] [blame]483--remove-section
484</dt>
485<dd>
486<p>
487 Remove the given section from the configuration file.
488</p>
489</dd>
490<dt>
491--rename-section
492</dt>
493<dd>
494<p>
495 Rename the given section to a new name.
496</p>
497</dd>
498<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]499--unset
500</dt>
501<dd>
502<p>
503 Remove the line matching the key from config file.
504</p>
505</dd>
506<dt>
507--unset-all
508</dt>
509<dd>
510<p>
Junio C Hamano10557772007-03-15 07:12:30[diff] [blame]511 Remove all lines matching the key from config file.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]512</p>
513</dd>
514<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]515-l
516</dt>
517<dt>
518--list
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]519</dt>
520<dd>
521<p>
522 List all variables set in config file.
523</p>
524</dd>
525<dt>
526--bool
527</dt>
528<dd>
529<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]530 <em>git-config</em> will ensure that the output is "true" or "false"
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]531</p>
532</dd>
533<dt>
534--int
535</dt>
536<dd>
537<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]538 <em>git-config</em> will ensure that the output is a simple
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]539 decimal number. An optional value suffix of <em>k</em>, <em>m</em>, or <em>g</em>
540 in the config file will cause the value to be multiplied
541 by 1024, 1048576, or 1073741824 prior to output.
542</p>
543</dd>
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]544<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]545-z
546</dt>
547<dt>
548--null
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]549</dt>
550<dd>
551<p>
552 For all options that output values and/or keys, always
Junio C Hamano1f511962008-01-30 08:28:52[diff] [blame]553 end values with the null character (instead of a
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]554 newline). Use newline instead as a delimiter between
555 key and value. This allows for secure parsing of the
556 output without getting confused e.g. by values that
557 contain line breaks.
558</p>
559</dd>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]560<dt>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]561--get-colorbool name [stdout-is-tty]
562</dt>
563<dd>
564<p>
565 Find the color setting for <tt>name</tt> (e.g. <tt>color.diff</tt>) and output
566 "true" or "false". <tt>stdout-is-tty</tt> should be either "true" or
567 "false", and is taken into account when configuration says
568 "auto". If <tt>stdout-is-tty</tt> is missing, then checks the standard
569 output of the command itself, and exits with status 0 if color
570 is to be used, or exits with status 1 otherwise.
Junio C Hamanoe3ddb5b2008-04-21 00:48:07[diff] [blame]571 When the color setting for <tt>name</tt> is undefined, the command uses
572 <tt>color.ui</tt> as fallback.
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]573</p>
574</dd>
575<dt>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]576--get-color name default
577</dt>
578<dd>
579<p>
580 Find the color configured for <tt>name</tt> (e.g. <tt>color.diff.new</tt>) and
581 output it as the ANSI color escape sequence to the standard
582 output. The optional <tt>default</tt> parameter is used instead, if
583 there is no color configured for <tt>name</tt>.
584</p>
585</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]586</dl></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]587</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]588<h2 id="FILES">FILES</h2>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]589<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]590<div class="para"><p>If not set explicitly with <em>--file</em>, there are three files where
591<em>git-config</em> will search for configuration options:</p></div>
592<div class="vlist"><dl>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]593<dt>
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]594$GIT_DIR/config
595</dt>
596<dd>
597<p>
598 Repository specific configuration file. (The filename is
599 of course relative to the repository root, not the working
600 directory.)
601</p>
602</dd>
603<dt>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]604~/.gitconfig
605</dt>
606<dd>
607<p>
608 User-specific configuration file. Also called "global"
609 configuration file.
610</p>
611</dd>
612<dt>
613$(prefix)/etc/gitconfig
614</dt>
615<dd>
616<p>
617 System-wide configuration file.
618</p>
619</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]620</dl></div>
621<div class="para"><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]622files that are available. If the global or the system-wide configuration
623file are not available they will be ignored. If the repository configuration
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]624file is not available or readable, <em>git-config</em> will exit with a non-zero
625error code. However, in neither case will an error message be issued.</p></div>
626<div class="para"><p>All writing options will per default write to the repository specific
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]627configuration file. Note that this also affects options like <em>--replace-all</em>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]628and <em>--unset</em>. <strong><em>git-config</em> will only ever change one file at a time</strong>.</p></div>
629<div class="para"><p>You can override these rules either by command line options or by environment
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]630variables. The <em>--global</em> and the <em>--system</em> options will limit the file used
631to the global or system-wide file respectively. The GIT_CONFIG environment
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]632variable has a similar effect, but you can specify any filename you want.</p></div>
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]633</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]634<h2 id="_environment">ENVIRONMENT</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]635<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]636<div class="vlist"><dl>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]637<dt>
638GIT_CONFIG
639</dt>
640<dd>
641<p>
642 Take the configuration from the given file instead of .git/config.
Junio C Hamano6fddfe52007-05-31 07:38:19[diff] [blame]643 Using the "--global" option forces this to ~/.gitconfig. Using the
644 "--system" option forces this to $(prefix)/etc/gitconfig.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]645</p>
646</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]647</dl></div>
648<div class="para"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]649</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]650<h2 id="EXAMPLES">EXAMPLES</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]651<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]652<div class="para"><p>Given a .git/config like this:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]653<div class="literalblock">
654<div class="content">
655<pre><tt>#
656# This is the config file, and
657# a '#' or ';' character indicates
658# a comment
659#</tt></pre>
660</div></div>
661<div class="literalblock">
662<div class="content">
663<pre><tt>; core variables
664[core]
665 ; Don't trust file modes
666 filemode = false</tt></pre>
667</div></div>
668<div class="literalblock">
669<div class="content">
670<pre><tt>; Our diff algorithm
671[diff]
Junio C Hamano85c71572008-07-28 00:03:31[diff] [blame]672 external = /usr/local/bin/diff-wrapper
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]673 renames = true</tt></pre>
674</div></div>
675<div class="literalblock">
676<div class="content">
677<pre><tt>; Proxy settings
678[core]
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]679 gitproxy="proxy-command" for kernel.org
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]680 gitproxy=default-proxy ; for all the rest</tt></pre>
681</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]682<div class="para"><p>you can set the filemode to true with</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]683<div class="listingblock">
684<div class="content">
685<pre><tt>% git config core.filemode true</tt></pre>
686</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]687<div class="para"><p>The hypothetical proxy command entries actually have a postfix to discern
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]688what URL they apply to. Here is how to change the entry for kernel.org
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]689to "ssh".</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]690<div class="listingblock">
691<div class="content">
692<pre><tt>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</tt></pre>
693</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]694<div class="para"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
695<div class="para"><p>To delete the entry for renames, do</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]696<div class="listingblock">
697<div class="content">
698<pre><tt>% git config --unset diff.renames</tt></pre>
699</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]700<div class="para"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
701you have to provide a regex matching the value of exactly one line.</p></div>
702<div class="para"><p>To query the value for a given key, do</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]703<div class="listingblock">
704<div class="content">
705<pre><tt>% git config --get core.filemode</tt></pre>
706</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]707<div class="para"><p>or</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]708<div class="listingblock">
709<div class="content">
710<pre><tt>% git config core.filemode</tt></pre>
711</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]712<div class="para"><p>or, to query a multivar:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]713<div class="listingblock">
714<div class="content">
715<pre><tt>% git config --get core.gitproxy "for kernel.org$"</tt></pre>
716</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]717<div class="para"><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]718<div class="listingblock">
719<div class="content">
720<pre><tt>% git config --get-all core.gitproxy</tt></pre>
721</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]722<div class="para"><p>If you like to live dangerous, you can replace <strong>all</strong> core.gitproxy by a
723new one with</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]724<div class="listingblock">
725<div class="content">
726<pre><tt>% git config --replace-all core.gitproxy ssh</tt></pre>
727</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]728<div class="para"><p>However, if you really only want to replace the line for the default proxy,
729i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]730<div class="listingblock">
731<div class="content">
732<pre><tt>% git config core.gitproxy ssh '! for '</tt></pre>
733</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]734<div class="para"><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]735<div class="listingblock">
736<div class="content">
737<pre><tt>% git config section.key value '[!]'</tt></pre>
738</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]739<div class="para"><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]740<div class="listingblock">
741<div class="content">
Junio C Hamanoc71a8732007-08-04 00:27:26[diff] [blame]742<pre><tt>% git config core.gitproxy '"proxy-command" for example.com'</tt></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]743</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]744<div class="para"><p>An example to use customized color from the configuration in your
745script:</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]746<div class="listingblock">
747<div class="content">
748<pre><tt>#!/bin/sh
749WS=$(git config --get-color color.diff.whitespace "blue reverse")
750RESET=$(git config --get-color "" "reset")
751echo "${WS}your whitespace color or blue reverse${RESET}"</tt></pre>
752</div></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]753</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]754<h2 id="_configuration_file">CONFIGURATION FILE</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]755<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]756<div class="para"><p>The git configuration file contains a number of variables that affect
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]757the git command's behavior. <tt>.git/config</tt> file for each repository
758is used to store the information for that repository, and
759<tt>$HOME/.gitconfig</tt> is used to store per user information to give
Junio C Hamano79556902007-02-24 11:15:54[diff] [blame]760fallback values for <tt>.git/config</tt> file. The file <tt>/etc/gitconfig</tt>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]761can be used to store system-wide defaults.</p></div>
762<div class="para"><p>They can be used by both the git plumbing
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]763and the porcelains. The variables are divided into sections, where
764in the fully qualified variable name the variable itself is the last
765dot-separated segment and the section name is everything before the last
766dot. The variable names are case-insensitive and only alphanumeric
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]767characters are allowed. Some variables may appear multiple times.</p></div>
768<h3 id="_syntax">Syntax</h3><div style="clear:left"></div>
769<div class="para"><p>The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]770ignored. The <em>#</em> and <em>;</em> characters begin comments to the end of line,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]771blank lines are ignored.</p></div>
772<div class="para"><p>The file consists of sections and variables. A section begins with
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]773the name of the section in square brackets and continues until the next
774section begins. Section names are not case sensitive. Only alphanumeric
775characters, <em><tt>-</tt></em> and <em><tt>.</tt></em> are allowed in section names. Each variable
776must belong to some section, which means that there must be section
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]777header before first setting of a variable.</p></div>
778<div class="para"><p>Sections can be further divided into subsections. To begin a subsection
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]779put its name in double quotes, separated by space from the section name,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]780in the section header, like in example below:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]781<div class="listingblock">
782<div class="content">
783<pre><tt> [section "subsection"]
784</tt></pre>
785</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]786<div class="para"><p>Subsection names can contain any characters except newline (doublequote
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]787<em><tt>"</tt></em> and backslash have to be escaped as <em><tt>\"</tt></em> and <em><tt>\\</tt></em>,
Junio C Hamanoee1e4282007-02-04 08:32:04[diff] [blame]788respectively) and are case sensitive. Section header cannot span multiple
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]789lines. Variables may belong directly to a section or to a given subsection.
790You can have <tt>[section]</tt> if you have <tt>[section "subsection"]</tt>, but you
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]791don't need to.</p></div>
792<div class="para"><p>There is also (case insensitive) alternative <tt>[section.subsection]</tt> syntax.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]793In this syntax subsection names follow the same restrictions as for section
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]794name.</p></div>
795<div class="para"><p>All the other lines are recognized as setting variables, in the form
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]796<em>name = value</em>. If there is no equal sign on the line, the entire line
797is taken as <em>name</em> and the variable is recognized as boolean "true".
798The variable names are case-insensitive and only alphanumeric
799characters and <em><tt>-</tt></em> are allowed. There can be more than one value
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]800for a given variable; we say then that variable is multivalued.</p></div>
801<div class="para"><p>Leading and trailing whitespace in a variable value is discarded.
802Internal whitespace within a variable value is retained verbatim.</p></div>
803<div class="para"><p>The values following the equals sign in variable assign are all either
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]804a string, an integer, or a boolean. Boolean values may be given as yes/no,
8050/1 or true/false. Case is not significant in boolean values, when
806converting value to the canonical form using <em>--bool</em> type specifier;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]807<em>git-config</em> will ensure that the output is "true" or "false".</p></div>
808<div class="para"><p>String values may be entirely or partially enclosed in double quotes.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]809You need to enclose variable value in double quotes if you want to
810preserve leading or trailing whitespace, or if variable value contains
811beginning of comment characters (if it contains <em>#</em> or <em>;</em>).
812Double quote <em><tt>"</tt></em> and backslash <em><tt>\</tt></em> characters in variable value must
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]813be escaped: use <em><tt>\"</tt></em> for <em><tt>"</tt></em> and <em><tt>\\</tt></em> for <em><tt>\</tt></em>.</p></div>
814<div class="para"><p>The following escape sequences (beside <em><tt>\"</tt></em> and <em><tt>\\</tt></em>) are recognized:
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]815<em><tt>\n</tt></em> for newline character (NL), <em><tt>\t</tt></em> for horizontal tabulation (HT, TAB)
816and <em><tt>\b</tt></em> for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]817char sequences are valid.</p></div>
818<div class="para"><p>Variable value ending in a <em><tt>\</tt></em> is continued on the next line in the
819customary UNIX fashion.</p></div>
820<div class="para"><p>Some variables may require special value format.</p></div>
821<h3 id="_example">Example</h3><div style="clear:left"></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]822<div class="literalblock">
823<div class="content">
824<pre><tt># Core variables
825[core]
826 ; Don't trust file modes
827 filemode = false</tt></pre>
828</div></div>
829<div class="literalblock">
830<div class="content">
831<pre><tt># Our diff algorithm
832[diff]
Junio C Hamano85c71572008-07-28 00:03:31[diff] [blame]833 external = /usr/local/bin/diff-wrapper
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]834 renames = true</tt></pre>
835</div></div>
836<div class="literalblock">
837<div class="content">
838<pre><tt>[branch "devel"]
839 remote = origin
840 merge = refs/heads/devel</tt></pre>
841</div></div>
842<div class="literalblock">
843<div class="content">
844<pre><tt># Proxy settings
845[core]
Junio C Hamanoc71a8732007-08-04 00:27:26[diff] [blame]846 gitProxy="ssh" for "kernel.org"
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]847 gitProxy=default-proxy ; for the rest</tt></pre>
848</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]849<h3 id="_variables">Variables</h3><div style="clear:left"></div>
850<div class="para"><p>Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]851For command-specific variables, you will find a more detailed description
852in the appropriate manual page. You will find a description of non-core
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]853porcelain configuration variables in the respective porcelain documentation.</p></div>
854<div class="vlist"><dl>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]855<dt>
856core.fileMode
857</dt>
858<dd>
859<p>
860 If false, the executable bit differences between the index and
861 the working copy are ignored; useful on broken filesystems like FAT.
862 See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
863</p>
864</dd>
865<dt>
Junio C Hamano90ccff32008-07-29 08:17:24[diff] [blame]866core.trustctime
867</dt>
868<dd>
869<p>
870 If false, the ctime differences between the index and the
871 working copy are ignored; useful when the inode change time
872 is regularly modified by something outside Git (file system
873 crawlers and some backup systems).
874 See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
875</p>
876</dd>
877<dt>
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]878core.quotepath
879</dt>
880<dd>
881<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]882 The commands that output paths (e.g. <em>ls-files</em>,
883 <em>diff</em>), when not given the <tt>-z</tt> option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]884 "unusual" characters in the pathname by enclosing the
885 pathname in a double-quote pair and with backslashes the
886 same way strings in C source code are quoted. If this
887 variable is set to false, the bytes higher than 0x80 are
888 not quoted but output as verbatim. Note that double
889 quote, backslash and control characters are always
890 quoted without <tt>-z</tt> regardless of the setting of this
891 variable.
892</p>
893</dd>
894<dt>
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]895core.autocrlf
896</dt>
897<dd>
898<p>
899 If true, makes git convert <tt>CRLF</tt> at the end of lines in text files to
900 <tt>LF</tt> when reading from the filesystem, and convert in reverse when
901 writing to the filesystem. The variable can be set to
902 <em>input</em>, in which case the conversion happens only while
903 reading from the filesystem but files are written out with
904 <tt>LF</tt> at the end of lines. Currently, which paths to consider
905 "text" (i.e. be subjected to the autocrlf mechanism) is
906 decided purely based on the contents.
907</p>
908</dd>
909<dt>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]910core.safecrlf
911</dt>
912<dd>
913<p>
914 If true, makes git check if converting <tt>CRLF</tt> as controlled by
915 <tt>core.autocrlf</tt> is reversible. Git will verify if a command
916 modifies a file in the work tree either directly or indirectly.
917 For example, committing a file followed by checking out the
918 same file should yield the original file in the work tree. If
919 this is not the case for the current setting of
920 <tt>core.autocrlf</tt>, git will reject the file. The variable can
921 be set to "warn", in which case git will only warn about an
922 irreversible conversion but continue the operation.
923</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]924<div class="para"><p>CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]925autocrlf=true will convert CRLF to LF during commit and LF to
926CRLF during checkout. A file that contains a mixture of LF and
927CRLF before the commit cannot be recreated by git. For text
928files this is the right thing to do: it corrects line endings
929such that we have only LF line endings in the repository.
930But for binary files that are accidentally classified as text the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]931conversion can corrupt data.</p></div>
932<div class="para"><p>If you recognize such corruption early you can easily fix it by
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]933setting the conversion type explicitly in .gitattributes. Right
934after committing you still have the original file in your work
935tree and this file is not yet corrupted. You can explicitly tell
936git that this file is binary and git will handle the file
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]937appropriately.</p></div>
938<div class="para"><p>Unfortunately, the desired effect of cleaning up text files with
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]939mixed line endings and the undesired effect of corrupting binary
940files cannot be distinguished. In both cases CRLFs are removed
941in an irreversible way. For text files this is the right thing
942to do because CRLFs are line endings, while for binary files
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]943converting CRLFs corrupts data.</p></div>
944<div class="para"><p>Note, this safety check does not mean that a checkout will generate a
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]945file identical to the original file for a different setting of
946<tt>core.autocrlf</tt>, but only for the current one. For example, a text
947file with <tt>LF</tt> would be accepted with <tt>core.autocrlf=input</tt> and could
948later be checked out with <tt>core.autocrlf=true</tt>, in which case the
949resulting file would contain <tt>CRLF</tt>, although the original file
950contained <tt>LF</tt>. However, in both work trees the line endings would be
951consistent, that is either all <tt>LF</tt> or all <tt>CRLF</tt>, but never mixed. A
952file with mixed line endings would be reported by the <tt>core.safecrlf</tt>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]953mechanism.</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]954</dd>
955<dt>
Junio C Hamanoaa83a7d2007-03-05 02:37:29[diff] [blame]956core.symlinks
957</dt>
958<dd>
959<p>
960 If false, symbolic links are checked out as small plain files that
961 contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
962 <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
963 file. Useful on filesystems like FAT that do not support
964 symbolic links. True by default.
965</p>
966</dd>
967<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]968core.gitProxy
969</dt>
970<dd>
971<p>
972 A "proxy command" to execute (as <em>command host port</em>) instead
973 of establishing direct connection to the remote server when
974 using the git protocol for fetching. If the variable value is
975 in the "COMMAND for DOMAIN" format, the command is applied only
976 on hostnames ending with the specified domain string. This variable
977 may be set multiple times and is matched in the given order;
978 the first match wins.
979</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]980<div class="para"><p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]981(which always applies universally, without the special "for"
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]982handling).</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]983</dd>
984<dt>
985core.ignoreStat
986</dt>
987<dd>
988<p>
Junio C Hamano054ea082008-06-01 08:26:34[diff] [blame]989 If true, commands which modify both the working tree and the index
990 will mark the updated paths with the "assume unchanged" bit in the
991 index. These marked files are then assumed to stay unchanged in the
992 working copy, until you mark them otherwise manually - Git will not
993 detect the file changes by lstat() calls. This is useful on systems
994 where those are very slow, such as Microsoft Windows.
995 See <a href="git-update-index.html">git-update-index(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]996 False by default.
997</p>
998</dd>
999<dt>
1000core.preferSymlinkRefs
1001</dt>
1002<dd>
1003<p>
1004 Instead of the default "symref" format for HEAD
1005 and other symbolic reference files, use symbolic links.
1006 This is sometimes needed to work with old scripts that
1007 expect HEAD to be a symbolic link.
1008</p>
1009</dd>
1010<dt>
Junio C Hamano1025e752007-02-23 07:21:26[diff] [blame]1011core.bare
1012</dt>
1013<dd>
1014<p>
1015 If true this repository is assumed to be <em>bare</em> and has no
1016 working directory associated with it. If this is the case a
1017 number of commands that require a working directory will be
1018 disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
1019</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1020<div class="para"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
Junio C Hamano1025e752007-02-23 07:21:26[diff] [blame]1021<a href="git-init.html">git-init(1)</a> when the repository was created. By default a
1022repository that ends in "/.git" is assumed to be not bare (bare =
1023false), while all other repositories are assumed to be bare (bare
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1024= true).</p></div>
Junio C Hamano1025e752007-02-23 07:21:26[diff] [blame]1025</dd>
1026<dt>
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]1027core.worktree
1028</dt>
1029<dd>
1030<p>
1031 Set the path to the working tree. The value will not be
1032 used in combination with repositories found automatically in
1033 a .git directory (i.e. $GIT_DIR is not set).
Junio C Hamano764a6672007-10-23 01:23:31[diff] [blame]1034 This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27[diff] [blame]1035 variable and the <em>--work-tree</em> command line option. It can be
1036 a absolute path or relative path to the directory specified by
1037 --git-dir or GIT_DIR.
1038 Note: If --git-dir or GIT_DIR are specified but none of
1039 --work-tree, GIT_WORK_TREE and core.worktree is specified,
1040 the current working directory is regarded as the top directory
1041 of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]1042</p>
1043</dd>
1044<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1045core.logAllRefUpdates
1046</dt>
1047<dd>
1048<p>
Junio C Hamanocae86272007-08-21 02:20:49[diff] [blame]1049 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]1050 "$GIT_DIR/logs/&lt;ref&gt;", by appending the new and old
1051 SHA1, the date/time and the reason of the update, but
1052 only when the file exists. If this configuration
1053 variable is set to true, missing "$GIT_DIR/logs/&lt;ref&gt;"
1054 file is automatically created for branch heads.
1055</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1056<div class="para"><p>This information can be used to determine what commit
1057was the tip of a branch "2 days ago".</p></div>
1058<div class="para"><p>This value is true by default in a repository that has
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1059a working directory associated with it, and false by
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1060default in a bare repository.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1061</dd>
1062<dt>
1063core.repositoryFormatVersion
1064</dt>
1065<dd>
1066<p>
1067 Internal variable identifying the repository format and layout
1068 version.
1069</p>
1070</dd>
1071<dt>
1072core.sharedRepository
1073</dt>
1074<dd>
1075<p>
1076 When <em>group</em> (or <em>true</em>), the repository is made shareable between
1077 several users in a group (making sure all the files and objects are
1078 group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
1079 repository will be readable by all users, additionally to being
1080 group-shareable. When <em>umask</em> (or <em>false</em>), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37[diff] [blame]1081 reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
1082 files in the repository will have this mode value. <em>0xxx</em> will override
1083 user's umask value, and thus, users with a safe umask (0077) can use
1084 this option. Examples: <em>0660</em> is equivalent to <em>group</em>. <em>0640</em> is a
1085 repository that is group-readable but not group-writable.
1086 See <a href="git-init.html">git-init(1)</a>. False by default.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1087</p>
1088</dd>
1089<dt>
1090core.warnAmbiguousRefs
1091</dt>
1092<dd>
1093<p>
1094 If true, git will warn you if the ref name you passed it is ambiguous
1095 and might match multiple refs in the .git/refs/ tree. True by default.
1096</p>
1097</dd>
1098<dt>
1099core.compression
1100</dt>
1101<dd>
1102<p>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1103 An integer -1..9, indicating a default compression level.
1104 -1 is the zlib default. 0 means no compression,
1105 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42[diff] [blame]1106 If set, this provides a default to other compression variables,
1107 such as <em>core.loosecompression</em> and <em>pack.compression</em>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1108</p>
1109</dd>
1110<dt>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1111core.loosecompression
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1112</dt>
1113<dd>
1114<p>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1115 An integer -1..9, indicating the compression level for objects that
1116 are not in a pack file. -1 is the zlib default. 0 means no
1117 compression, and 1..9 are various speed/size tradeoffs, 9 being
1118 slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42[diff] [blame]1119 not set, defaults to 1 (best speed).
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1120</p>
1121</dd>
1122<dt>
1123core.packedGitWindowSize
1124</dt>
1125<dd>
1126<p>
1127 Number of bytes of a pack file to map into memory in a
1128 single mapping operation. Larger window sizes may allow
1129 your system to process a smaller number of large pack files
1130 more quickly. Smaller window sizes will negatively affect
1131 performance due to increased calls to the operating system's
1132 memory manager, but may improve performance when accessing
1133 a large number of large pack files.
1134</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1135<div class="para"><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]1136MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
1137be reasonable for all users/operating systems. You probably do
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1138not need to adjust this value.</p></div>
1139<div class="para"><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]1140</dd>
1141<dt>
1142core.packedGitLimit
1143</dt>
1144<dd>
1145<p>
1146 Maximum number of bytes to map simultaneously into memory
1147 from pack files. If Git needs to access more than this many
1148 bytes at once to complete an operation it will unmap existing
1149 regions to reclaim virtual address space within the process.
1150</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1151<div class="para"><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]1152This should be reasonable for all users/operating systems, except on
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1153the largest projects. You probably do not need to adjust this value.</p></div>
1154<div class="para"><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]1155</dd>
1156<dt>
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]1157core.deltaBaseCacheLimit
1158</dt>
1159<dd>
1160<p>
1161 Maximum number of bytes to reserve for caching base objects
1162 that multiple deltafied objects reference. By storing the
1163 entire decompressed base objects in a cache Git is able
1164 to avoid unpacking and decompressing frequently used base
1165 objects multiple times.
1166</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1167<div class="para"><p>Default is 16 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]1168for all users/operating systems, except on the largest projects.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1169You probably do not need to adjust this value.</p></div>
1170<div class="para"><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]1171</dd>
1172<dt>
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]1173core.excludesfile
Junio C Hamano5e284b42007-05-22 07:23:37[diff] [blame]1174</dt>
1175<dd>
1176<p>
1177 In addition to <em>.gitignore</em> (per-directory) and
1178 <em>.git/info/exclude</em>, git looks into this file for patterns
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]1179 of files which are not meant to be tracked. See
1180 <a href="gitignore.html">gitignore(5)</a>.
Junio C Hamano5e284b42007-05-22 07:23:37[diff] [blame]1181</p>
1182</dd>
1183<dt>
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]1184core.editor
1185</dt>
1186<dd>
1187<p>
1188 Commands such as <tt>commit</tt> and <tt>tag</tt> that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]1189 messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]1190 variable when it is set, and the environment variable
1191 <tt>GIT_EDITOR</tt> is not set. The order of preference is
Junio C Hamanode9879a2007-07-22 09:33:42[diff] [blame]1192 <tt>GIT_EDITOR</tt> environment, <tt>core.editor</tt>, <tt>VISUAL</tt> and
1193 <tt>EDITOR</tt> environment variables and then finally <tt>vi</tt>.
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]1194</p>
1195</dd>
1196<dt>
Junio C Hamano28d8ede2007-07-05 05:51:38[diff] [blame]1197core.pager
1198</dt>
1199<dd>
1200<p>
Junio C Hamano0551f6a2008-08-25 00:33:33[diff] [blame]1201 The command that git will use to paginate output. Can
1202 be overridden with the <tt>GIT_PAGER</tt> environment
1203 variable. Note that git sets the <tt>LESS</tt> environment
1204 variable to <tt>FRSX</tt> if it is unset when it runs the
1205 pager. One can change these settings by setting the
1206 <tt>LESS</tt> variable to some other value or by giving the
1207 <tt>core.pager</tt> option a value such as "<tt>less -+FRSX</tt>".
Junio C Hamano28d8ede2007-07-05 05:51:38[diff] [blame]1208</p>
1209</dd>
1210<dt>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1211core.whitespace
1212</dt>
1213<dd>
1214<p>
1215 A comma separated list of common whitespace problems to
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1216 notice. <em>git-diff</em> will use <tt>color.diff.whitespace</tt> to
1217 highlight them, and <em>git-apply --whitespace=error</em> will
Junio C Hamano3db8b412008-07-26 06:45:59[diff] [blame]1218 consider them as errors. You can prefix <tt>-</tt> to disable
1219 any of them (e.g. <tt>-trailing-space</tt>):
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1220</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1221<div class="ilist"><ul>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1222<li>
1223<p>
1224<tt>trailing-space</tt> treats trailing whitespaces at the end of the line
1225 as an error (enabled by default).
1226</p>
1227</li>
1228<li>
1229<p>
1230<tt>space-before-tab</tt> treats a space character that appears immediately
1231 before a tab character in the initial indent part of the line as an
1232 error (enabled by default).
1233</p>
1234</li>
1235<li>
1236<p>
1237<tt>indent-with-non-tab</tt> treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42[diff] [blame]1238 space characters as an error (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1239</p>
1240</li>
Junio C Hamano601f3e52008-02-25 08:40:42[diff] [blame]1241<li>
1242<p>
1243<tt>cr-at-eol</tt> treats a carriage-return at the end of line as
1244 part of the line terminator, i.e. with it, <tt>trailing-space</tt>
1245 does not trigger if the character before such a carriage-return
1246 is not a whitespace (not enabled by default).
1247</p>
1248</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1249</ul></div>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1250</dd>
1251<dt>
Junio C Hamano9eb57532008-06-26 06:33:46[diff] [blame]1252core.fsyncobjectfiles
1253</dt>
1254<dd>
1255<p>
1256 This boolean will enable <em>fsync()</em> when writing object files.
1257</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1258<div class="para"><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]1259data writes properly, but can be useful for filesystems that do not use
1260journalling (traditional UNIX filesystems) or that only journal metadata
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1261and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").</p></div>
Junio C Hamano9eb57532008-06-26 06:33:46[diff] [blame]1262</dd>
1263<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1264alias.*
1265</dt>
1266<dd>
1267<p>
1268 Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
1269 after defining "alias.last = cat-file commit HEAD", the invocation
1270 "git last" is equivalent to "git cat-file commit HEAD". To avoid
1271 confusion and troubles with script usage, aliases that
1272 hide existing git commands are ignored. Arguments are split by
1273 spaces, the usual shell quoting and escaping is supported.
1274 quote pair and a backslash can be used to quote them.
1275</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1276<div class="para"><p>If the alias expansion is prefixed with an exclamation point,
Junio C Hamano9cb74f22007-02-12 04:15:05[diff] [blame]1277it will be treated as a shell command. For example, defining
1278"alias.new = !gitk --all --not ORIG_HEAD", the invocation
1279"git new" is equivalent to running the shell command
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1280"gitk --all --not ORIG_HEAD".</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1281</dd>
1282<dt>
1283apply.whitespace
1284</dt>
1285<dd>
1286<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1287 Tells <em>git-apply</em> how to handle whitespaces, in the same way
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1288 as the <em>--whitespace</em> option. See <a href="git-apply.html">git-apply(1)</a>.
1289</p>
1290</dd>
1291<dt>
Junio C Hamano7fd84172007-05-24 07:00:32[diff] [blame]1292branch.autosetupmerge
1293</dt>
1294<dd>
1295<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1296 Tells <em>git-branch</em> and <em>git-checkout</em> to setup new branches
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]1297 so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
1298 starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32[diff] [blame]1299 this behavior can be chosen per-branch using the <tt>--track</tt>
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]1300 and <tt>--no-track</tt> options. The valid settings are: <tt>false</tt> &#8212; no
1301 automatic setup is done; <tt>true</tt> &#8212; automatic setup is done when the
1302 starting point is a remote branch; <tt>always</tt> &#8212; automatic setup is
1303 done when the starting point is either a local branch or remote
1304 branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32[diff] [blame]1305</p>
1306</dd>
1307<dt>
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]1308branch.autosetuprebase
1309</dt>
1310<dd>
1311<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1312 When a new branch is created with <em>git-branch</em> or <em>git-checkout</em>
Junio C Hamano869bb802008-05-12 00:29:47[diff] [blame]1313 that tracks another branch, this variable tells git to set
1314 up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
1315 When <tt>never</tt>, rebase is never automatically set to true.
1316 When <tt>local</tt>, rebase is set to true for tracked branches of
1317 other local branches.
1318 When <tt>remote</tt>, rebase is set to true for tracked branches of
1319 remote branches.
1320 When <tt>always</tt>, rebase will be set to true for all tracking
1321 branches.
1322 See "branch.autosetupmerge" for details on how to set up a
1323 branch to track another branch.
1324 This option defaults to never.
1325</p>
1326</dd>
1327<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1328branch.&lt;name&gt;.remote
1329</dt>
1330<dd>
1331<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1332 When in branch &lt;name&gt;, it tells <em>git-fetch</em> which remote to fetch.
1333 If this option is not given, <em>git-fetch</em> defaults to remote "origin".
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1334</p>
1335</dd>
1336<dt>
1337branch.&lt;name&gt;.merge
1338</dt>
1339<dd>
1340<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1341 When in branch &lt;name&gt;, it tells <em>git-fetch</em> the default
Junio C Hamanoc2b47092007-10-25 06:50:31[diff] [blame]1342 refspec to be marked for merging in FETCH_HEAD. The value is
1343 handled like the remote part of a refspec, and must match a
1344 ref which is fetched from the remote given by
1345 "branch.&lt;name&gt;.remote".
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1346 The merge information is used by <em>git-pull</em> (which at first calls
1347 <em>git-fetch</em>) to lookup the default branch for merging. Without
1348 this option, <em>git-pull</em> defaults to merge the first refspec fetched.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1349 Specify multiple values to get an octopus merge.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1350 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]1351 another branch in the local repository, you can point
1352 branch.&lt;name&gt;.merge to the desired branch, and use the special setting
1353 <tt>.</tt> (a period) for branch.&lt;name&gt;.remote.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1354</p>
1355</dd>
1356<dt>
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]1357branch.&lt;name&gt;.mergeoptions
1358</dt>
1359<dd>
1360<p>
1361 Sets default options for merging into branch &lt;name&gt;. The syntax and
1362 supported options are equal to that of <a href="git-merge.html">git-merge(1)</a>, but
1363 option values containing whitespace characters are currently not
1364 supported.
1365</p>
1366</dd>
1367<dt>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1368branch.&lt;name&gt;.rebase
1369</dt>
1370<dd>
1371<p>
1372 When true, rebase the branch &lt;name&gt; on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]1373 instead of merging the default branch from the default remote when
1374 "git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1375 <strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
1376 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
1377 for details).
1378</p>
1379</dd>
1380<dt>
Junio C Hamano8760ea62008-03-14 08:58:45[diff] [blame]1381browser.&lt;tool&gt;.cmd
1382</dt>
1383<dd>
1384<p>
1385 Specify the command to invoke the specified browser. The
1386 specified command is evaluated in shell with the URLs passed
1387 as arguments. (See <a href="git-web--browse.html">git-web--browse(1)</a>.)
1388</p>
1389</dd>
1390<dt>
Junio C Hamanoe35a6fc2008-01-29 09:46:27[diff] [blame]1391browser.&lt;tool&gt;.path
1392</dt>
1393<dd>
1394<p>
1395 Override the path for the given tool that may be used to
1396 browse HTML help (see <em>-w</em> option in <a href="git-help.html">git-help(1)</a>) or a
1397 working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
1398</p>
1399</dd>
1400<dt>
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]1401clean.requireForce
1402</dt>
1403<dd>
1404<p>
Junio C Hamano422cfec2007-11-08 08:07:45[diff] [blame]1405 A boolean to make git-clean do nothing unless given -f
1406 or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34[diff] [blame]1407</p>
1408</dd>
1409<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1410color.branch
1411</dt>
1412<dd>
1413<p>
1414 A boolean to enable/disable color in the output of
Junio C Hamano0fc8cd92007-12-06 03:26:21[diff] [blame]1415 <a href="git-branch.html">git-branch(1)</a>. May be set to <tt>always</tt>,
1416 <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]1417 only when the output is to a terminal. Defaults to false.
1418</p>
1419</dd>
1420<dt>
1421color.branch.&lt;slot&gt;
1422</dt>
1423<dd>
1424<p>
1425 Use customized color for branch coloration. <tt>&lt;slot&gt;</tt> is one of
1426 <tt>current</tt> (the current branch), <tt>local</tt> (a local branch),
1427 <tt>remote</tt> (a tracking branch in refs/remotes/), <tt>plain</tt> (other
1428 refs).
1429</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1430<div class="para"><p>The value for these configuration variables is a list of colors (at most
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1431two) and attributes (at most one), separated by spaces. The colors
1432accepted are <tt>normal</tt>, <tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>,
1433<tt>magenta</tt>, <tt>cyan</tt> and <tt>white</tt>; the attributes are <tt>bold</tt>, <tt>dim</tt>, <tt>ul</tt>,
1434<tt>blink</tt> and <tt>reverse</tt>. The first color given is the foreground; the
1435second is the background. The position of the attribute, if any,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1436doesn't matter.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1437</dd>
1438<dt>
1439color.diff
1440</dt>
1441<dd>
1442<p>
Junio C Hamano0fc8cd92007-12-06 03:26:21[diff] [blame]1443 When set to <tt>always</tt>, always use colors in patch.
1444 When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use
1445 colors only when the output is to the terminal. Defaults to false.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1446</p>
1447</dd>
1448<dt>
1449color.diff.&lt;slot&gt;
1450</dt>
1451<dd>
1452<p>
1453 Use customized color for diff colorization. <tt>&lt;slot&gt;</tt> specifies
1454 which part of the patch to use the specified color, and is one
1455 of <tt>plain</tt> (context text), <tt>meta</tt> (metainformation), <tt>frag</tt>
1456 (hunk header), <tt>old</tt> (removed lines), <tt>new</tt> (added lines),
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1457 <tt>commit</tt> (commit headers), or <tt>whitespace</tt> (highlighting
1458 whitespace errors). The values of these variables may be specified as
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1459 in color.branch.&lt;slot&gt;.
1460</p>
1461</dd>
1462<dt>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]1463color.interactive
1464</dt>
1465<dd>
1466<p>
Junio C Hamano35738e82008-01-07 07:55:46[diff] [blame]1467 When set to <tt>always</tt>, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1468 and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]1469 When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use
1470 colors only when the output is to the terminal. Defaults to false.
1471</p>
1472</dd>
1473<dt>
1474color.interactive.&lt;slot&gt;
1475</dt>
1476<dd>
1477<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1478 Use customized color for <em>git-add --interactive</em>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]1479 output. <tt>&lt;slot&gt;</tt> may be <tt>prompt</tt>, <tt>header</tt>, or <tt>help</tt>, for
1480 three distinct types of normal output from interactive
1481 programs. The values of these variables may be specified as
1482 in color.branch.&lt;slot&gt;.
1483</p>
1484</dd>
1485<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1486color.pager
1487</dt>
1488<dd>
1489<p>
1490 A boolean to enable/disable colored output when the pager is in
1491 use (default is true).
1492</p>
1493</dd>
1494<dt>
1495color.status
1496</dt>
1497<dd>
1498<p>
1499 A boolean to enable/disable color in the output of
Junio C Hamano0fc8cd92007-12-06 03:26:21[diff] [blame]1500 <a href="git-status.html">git-status(1)</a>. May be set to <tt>always</tt>,
1501 <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]1502 only when the output is to a terminal. Defaults to false.
1503</p>
1504</dd>
1505<dt>
1506color.status.&lt;slot&gt;
1507</dt>
1508<dd>
1509<p>
1510 Use customized color for status colorization. <tt>&lt;slot&gt;</tt> is
1511 one of <tt>header</tt> (the header text of the status message),
1512 <tt>added</tt> or <tt>updated</tt> (files which are added but not committed),
1513 <tt>changed</tt> (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]1514 <tt>untracked</tt> (files which are not tracked by git), or
1515 <tt>nobranch</tt> (the color the <em>no branch</em> warning is shown in, defaulting
1516 to red). The values of these variables may be specified as in
1517 color.branch.&lt;slot&gt;.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1518</p>
1519</dd>
1520<dt>
Junio C Hamanob968dbb2007-07-27 07:26:40[diff] [blame]1521commit.template
1522</dt>
1523<dd>
1524<p>
1525 Specify a file to use as the template for new commit messages.
1526</p>
1527</dd>
1528<dt>
Junio C Hamano83d46a22008-02-21 02:29:42[diff] [blame]1529color.ui
1530</dt>
1531<dd>
1532<p>
1533 When set to <tt>always</tt>, always use colors in all git commands which
1534 are capable of colored output. When false (or <tt>never</tt>), never. When
1535 set to <tt>true</tt> or <tt>auto</tt>, use colors only when the output is to the
1536 terminal. When more specific variables of color.* are set, they always
1537 take precedence over this setting. Defaults to false.
1538</p>
1539</dd>
1540<dt>
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]1541diff.autorefreshindex
1542</dt>
1543<dd>
1544<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1545 When using <em>git-diff</em> to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]1546 files, do not consider stat-only change as changed.
1547 Instead, silently run <tt>git update-index --refresh</tt> to
1548 update the cached stat information for paths whose
1549 contents in the work tree match the contents in the
1550 index. This option defaults to true. Note that this
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1551 affects only <em>git-diff</em> Porcelain, and not lower level
1552 <em>diff</em> commands, such as <em>git-diff-files</em>.
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]1553</p>
1554</dd>
1555<dt>
Junio C Hamano5cf43ca2008-08-20 09:14:14[diff] [blame]1556diff.suppress-blank-empty
1557</dt>
1558<dd>
1559<p>
1560 A boolean to inhibit the standard behavior of printing a space
1561 before each empty output line. Defaults to false.
1562</p>
1563</dd>
1564<dt>
Junio C Hamano1fbbbc12007-12-18 07:01:27[diff] [blame]1565diff.external
1566</dt>
1567<dd>
1568<p>
1569 If this config variable is set, diff generation is not
1570 performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:31[diff] [blame]1571 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
1572 environment variable. The command is called with parameters
1573 as described under "git Diffs" in <a href="git.html">git(1)</a>. Note: if
1574 you want to use an external diff program only on a subset of
1575 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]1576</p>
1577</dd>
1578<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1579diff.renameLimit
1580</dt>
1581<dd>
1582<p>
1583 The number of files to consider when performing the copy/rename
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1584 detection; equivalent to the <em>git-diff</em> option <em>-l</em>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1585</p>
1586</dd>
1587<dt>
1588diff.renames
1589</dt>
1590<dd>
1591<p>
1592 Tells git to detect renames. If set to any boolean value, it
1593 will enable basic rename detection. If set to "copies" or
1594 "copy", it will detect copies, as well.
1595</p>
1596</dd>
1597<dt>
1598fetch.unpackLimit
1599</dt>
1600<dd>
1601<p>
1602 If the number of objects fetched over the git native
1603 transfer is below this
1604 limit, then the objects will be unpacked into loose object
1605 files. However if the number of received objects equals or
1606 exceeds this limit then the received pack will be stored as
1607 a pack, after adding any missing delta bases. Storing the
1608 pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]1609 especially on slow filesystems. If not set, the value of
1610 <tt>transfer.unpackLimit</tt> is used instead.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1611</p>
1612</dd>
1613<dt>
Junio C Hamano8c5802d2007-11-15 00:13:36[diff] [blame]1614format.numbered
1615</dt>
1616<dd>
1617<p>
1618 A boolean which can enable sequence numbers in patch subjects.
Junio C Hamanofe986052007-12-19 07:33:38[diff] [blame]1619 Setting this option to "auto" will enable it only if there is
Junio C Hamano8c5802d2007-11-15 00:13:36[diff] [blame]1620 more than one patch. See --numbered option in
1621 <a href="git-format-patch.html">git-format-patch(1)</a>.
1622</p>
1623</dd>
1624<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1625format.headers
1626</dt>
1627<dd>
1628<p>
1629 Additional email headers to include in a patch to be submitted
1630 by mail. See <a href="git-format-patch.html">git-format-patch(1)</a>.
1631</p>
1632</dd>
1633<dt>
Junio C Hamanod4c8e112007-03-04 10:32:38[diff] [blame]1634format.suffix
1635</dt>
1636<dd>
1637<p>
1638 The default for format-patch is to output files with the suffix
1639 <tt>.patch</tt>. Use this variable to change that suffix (make sure to
1640 include the dot if you want it).
1641</p>
1642</dd>
1643<dt>
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]1644format.pretty
1645</dt>
1646<dd>
1647<p>
1648 The default pretty format for log/show/whatchanged command,
1649 See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
1650 <a href="git-whatchanged.html">git-whatchanged(1)</a>.
1651</p>
1652</dd>
1653<dt>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1654gc.aggressiveWindow
1655</dt>
1656<dd>
1657<p>
1658 The window size parameter used in the delta compression
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1659 algorithm used by <em>git-gc --aggressive</em>. This defaults
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1660 to 10.
1661</p>
1662</dd>
1663<dt>
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]1664gc.auto
1665</dt>
1666<dd>
1667<p>
1668 When there are approximately more than this many loose
1669 objects in the repository, <tt>git gc --auto</tt> will pack them.
1670 Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]1671 light-weight garbage collection from time to time. The
1672 default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]1673</p>
1674</dd>
1675<dt>
1676gc.autopacklimit
1677</dt>
1678<dd>
1679<p>
1680 When there are more than this many packs that are not
1681 marked with <tt>*.keep</tt> file in the repository, <tt>git gc
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]1682 --auto</tt> consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37[diff] [blame]1683 default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53[diff] [blame]1684</p>
1685</dd>
1686<dt>
Junio C Hamano9d52e572007-02-13 23:48:20[diff] [blame]1687gc.packrefs
1688</dt>
1689<dd>
1690<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1691 <em>git-gc</em> does not run <tt>git pack-refs</tt> in a bare repository by
Junio C Hamano9d52e572007-02-13 23:48:20[diff] [blame]1692 default so that older dumb-transport clients can still fetch
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1693 from the repository. Setting this to <tt>true</tt> lets <em>git-gc</em>
1694 to run <tt>git pack-refs</tt>. Setting this to <tt>false</tt> tells
1695 <em>git-gc</em> never to run <tt>git pack-refs</tt>. The default setting is
Junio C Hamano9d52e572007-02-13 23:48:20[diff] [blame]1696 <tt>notbare</tt>. Enable it only when you know you do not have to
1697 support such clients. The default setting will change to <tt>true</tt>
1698 at some stage, and setting this to <tt>false</tt> will continue to
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1699 prevent <tt>git pack-refs</tt> from being run from <em>git-gc</em>.
Junio C Hamano9d52e572007-02-13 23:48:20[diff] [blame]1700</p>
1701</dd>
1702<dt>
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]1703gc.pruneexpire
1704</dt>
1705<dd>
1706<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1707 When <em>git-gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>.
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]1708 Override the grace period with this config variable.
1709</p>
1710</dd>
1711<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1712gc.reflogexpire
1713</dt>
1714<dd>
1715<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1716 <em>git-reflog expire</em> removes reflog entries older than
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1717 this time; defaults to 90 days.
1718</p>
1719</dd>
1720<dt>
1721gc.reflogexpireunreachable
1722</dt>
1723<dd>
1724<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1725 <em>git-reflog expire</em> removes reflog entries older than
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1726 this time and are not reachable from the current tip;
1727 defaults to 30 days.
1728</p>
1729</dd>
1730<dt>
1731gc.rerereresolved
1732</dt>
1733<dd>
1734<p>
1735 Records of conflicted merge you resolved earlier are
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1736 kept for this many days when <em>git-rerere gc</em> is run.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1737 The default is 60 days. See <a href="git-rerere.html">git-rerere(1)</a>.
1738</p>
1739</dd>
1740<dt>
1741gc.rerereunresolved
1742</dt>
1743<dd>
1744<p>
1745 Records of conflicted merge you have not resolved are
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1746 kept for this many days when <em>git-rerere gc</em> is run.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1747 The default is 15 days. See <a href="git-rerere.html">git-rerere(1)</a>.
1748</p>
1749</dd>
1750<dt>
Junio C Hamano15048272008-07-07 22:10:48[diff] [blame]1751rerere.autoupdate
1752</dt>
1753<dd>
1754<p>
1755 When set to true, <tt>git-rerere</tt> updates the index with the
1756 resulting contents after it cleanly resolves conflicts using
1757 previously recorded resolution. Defaults to false.
1758</p>
1759</dd>
1760<dt>
Junio C Hamano7a4a2832007-07-07 21:53:22[diff] [blame]1761rerere.enabled
1762</dt>
1763<dd>
1764<p>
1765 Activate recording of resolved conflicts, so that identical
1766 conflict hunks can be resolved automatically, should they
Junio C Hamanoe0facb92007-12-05 10:59:48[diff] [blame]1767 be encountered again. <a href="git-rerere.html">git-rerere(1)</a> command is by
Junio C Hamano0e47b232008-01-15 08:31:10[diff] [blame]1768 default enabled if you create <tt>rr-cache</tt> directory under
1769 <tt>$GIT_DIR</tt>, but can be disabled by setting this option to false.
Junio C Hamano7a4a2832007-07-07 21:53:22[diff] [blame]1770</p>
1771</dd>
1772<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1773gitcvs.enabled
1774</dt>
1775<dd>
1776<p>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]1777 Whether the CVS server interface is enabled for this repository.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1778 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
1779</p>
1780</dd>
1781<dt>
1782gitcvs.logfile
1783</dt>
1784<dd>
1785<p>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]1786 Path to a log file where the CVS server interface well&#8230; logs
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1787 various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
1788</p>
1789</dd>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame^]1790<dt>
1791gitcvs.usecrlfattr
1792</dt>
1793<dd>
1794<p>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1795 If true, the server will look up the <tt>crlf</tt> attribute for
1796 files to determine the <em>-k</em> modes to use. If <tt>crlf</tt> is set,
1797 the <em>-k</em> mode will be left blank, so cvs clients will
1798 treat it as text. If <tt>crlf</tt> is explicitly unset, the file
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]1799 will be set with <em>-kb</em> mode, which suppresses any newline munging
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1800 the client might otherwise do. If <tt>crlf</tt> is not specified,
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame^]1801 then <em>gitcvs.allbinary</em> is used. See <a href="gitattributes.html">gitattributes(5)</a>.
1802</p>
1803</dd>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1804<dt>
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]1805gitcvs.allbinary
1806</dt>
1807<dd>
1808<p>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1809 This is used if <em>gitcvs.usecrlfattr</em> does not resolve
1810 the correct <em>-kb</em> mode to use. If true, all
1811 unresolved files are sent to the client in
1812 mode <em>-kb</em>. This causes the client to treat them
1813 as binary files, which suppresses any newline munging it
1814 otherwise might do. Alternatively, if it is set to "guess",
1815 then the contents of the file are examined to decide if
1816 it is binary, similar to <em>core.autocrlf</em>.
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]1817</p>
1818</dd>
1819<dt>
1820gitcvs.dbname
1821</dt>
1822<dd>
1823<p>
1824 Database used by git-cvsserver to cache revision information
1825 derived from the git repository. The exact meaning depends on the
1826 used database driver, for SQLite (which is the default driver) this
1827 is a filename. Supports variable substitution (see
1828 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<tt>;</tt>).
1829 Default: <em>%Ggitcvs.%m.sqlite</em>
1830</p>
1831</dd>
1832<dt>
1833gitcvs.dbdriver
1834</dt>
1835<dd>
1836<p>
1837 Used Perl DBI driver. You can specify any available driver
1838 for this here, but it might not work. git-cvsserver is tested
1839 with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
1840 reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
1841 May not contain double colons (<tt>:</tt>). Default: <em>SQLite</em>.
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]1842 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
1843</p>
1844</dd>
1845<dt>
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]1846gitcvs.dbuser, gitcvs.dbpass
1847</dt>
1848<dd>
1849<p>
1850 Database user and password. Only useful if setting <em>gitcvs.dbdriver</em>,
1851 since SQLite has no concept of database users and/or passwords.
1852 <em>gitcvs.dbuser</em> supports variable substitution (see
1853 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
1854</p>
1855</dd>
Junio C Hamanoa74efce2008-04-02 08:39:08[diff] [blame]1856<dt>
1857gitcvs.dbTableNamePrefix
1858</dt>
1859<dd>
1860<p>
1861 Database table name prefix. Prepended to the names of any
1862 database tables used, allowing a single database to be used
1863 for several repositories. Supports variable substitution (see
1864 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). Any non-alphabetic
1865 characters will be replaced with underscores.
1866</p>
1867</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1868</dl></div>
1869<div class="para"><p>All gitcvs variables except for <em>gitcvs.usecrlfattr</em> and
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1870<em>gitcvs.allbinary</em> can also be specified as
1871<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]1872is one of "ext" and "pserver") to make them apply only for the given
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1873access method.</p></div>
1874<div class="vlist"><dl>
Junio C Hamanoa2ad99e2007-04-18 09:57:04[diff] [blame]1875<dt>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]1876gui.commitmsgwidth
1877</dt>
1878<dd>
1879<p>
1880 Defines how wide the commit message window is in the
1881 <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
1882</p>
1883</dd>
1884<dt>
1885gui.diffcontext
1886</dt>
1887<dd>
1888<p>
1889 Specifies how many context lines should be used in calls to diff
1890 made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
1891</p>
1892</dd>
1893<dt>
1894gui.matchtrackingbranch
1895</dt>
1896<dd>
1897<p>
1898 Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
1899 default to tracking remote branches with matching names or
1900 not. Default: "false".
1901</p>
1902</dd>
1903<dt>
1904gui.newbranchtemplate
1905</dt>
1906<dd>
1907<p>
1908 Is used as suggested name when creating new branches using the
1909 <a href="git-gui.html">git-gui(1)</a>.
1910</p>
1911</dd>
1912<dt>
1913gui.pruneduringfetch
1914</dt>
1915<dd>
1916<p>
1917 "true" if <a href="git-gui.html">git-gui(1)</a> should prune tracking branches when
1918 performing a fetch. The default value is "false".
1919</p>
1920</dd>
1921<dt>
1922gui.trustmtime
1923</dt>
1924<dd>
1925<p>
1926 Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
1927 timestamp or not. By default the timestamps are not trusted.
1928</p>
1929</dd>
1930<dt>
1931gui.spellingdictionary
1932</dt>
1933<dd>
1934<p>
1935 Specifies the dictionary used for spell checking commit messages in
1936 the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
1937 off.
1938</p>
1939</dd>
1940<dt>
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]1941help.browser
1942</dt>
1943<dd>
1944<p>
1945 Specify the browser that will be used to display help in the
1946 <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
1947</p>
1948</dd>
1949<dt>
1950help.format
1951</dt>
1952<dd>
1953<p>
1954 Override the default help format used by <a href="git-help.html">git-help(1)</a>.
1955 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
1956 the default. <em>web</em> and <em>html</em> are the same.
1957</p>
1958</dd>
1959<dt>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]1960http.proxy
1961</dt>
1962<dd>
1963<p>
1964 Override the HTTP proxy, normally configured using the <em>http_proxy</em>
1965 environment variable (see <a href="curl.html">curl(1)</a>). This can be overridden
1966 on a per-remote basis; see remote.&lt;name&gt;.proxy
1967</p>
1968</dd>
1969<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]1970http.sslVerify
1971</dt>
1972<dd>
1973<p>
1974 Whether to verify the SSL certificate when fetching or pushing
1975 over HTTPS. Can be overridden by the <em>GIT_SSL_NO_VERIFY</em> environment
1976 variable.
1977</p>
1978</dd>
1979<dt>
1980http.sslCert
1981</dt>
1982<dd>
1983<p>
1984 File containing the SSL certificate when fetching or pushing
1985 over HTTPS. Can be overridden by the <em>GIT_SSL_CERT</em> environment
1986 variable.
1987</p>
1988</dd>
1989<dt>
1990http.sslKey
1991</dt>
1992<dd>
1993<p>
1994 File containing the SSL private key when fetching or pushing
1995 over HTTPS. Can be overridden by the <em>GIT_SSL_KEY</em> environment
1996 variable.
1997</p>
1998</dd>
1999<dt>
2000http.sslCAInfo
2001</dt>
2002<dd>
2003<p>
2004 File containing the certificates to verify the peer with when
2005 fetching or pushing over HTTPS. Can be overridden by the
2006 <em>GIT_SSL_CAINFO</em> environment variable.
2007</p>
2008</dd>
2009<dt>
2010http.sslCAPath
2011</dt>
2012<dd>
2013<p>
2014 Path containing files with the CA certificates to verify the peer
2015 with when fetching or pushing over HTTPS. Can be overridden
2016 by the <em>GIT_SSL_CAPATH</em> environment variable.
2017</p>
2018</dd>
2019<dt>
2020http.maxRequests
2021</dt>
2022<dd>
2023<p>
2024 How many HTTP requests to launch in parallel. Can be overridden
2025 by the <em>GIT_HTTP_MAX_REQUESTS</em> environment variable. Default is 5.
2026</p>
2027</dd>
2028<dt>
2029http.lowSpeedLimit, http.lowSpeedTime
2030</dt>
2031<dd>
2032<p>
2033 If the HTTP transfer speed is less than <em>http.lowSpeedLimit</em>
2034 for longer than <em>http.lowSpeedTime</em> seconds, the transfer is aborted.
2035 Can be overridden by the <em>GIT_HTTP_LOW_SPEED_LIMIT</em> and
2036 <em>GIT_HTTP_LOW_SPEED_TIME</em> environment variables.
2037</p>
2038</dd>
2039<dt>
2040http.noEPSV
2041</dt>
2042<dd>
2043<p>
2044 A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:04[diff] [blame]2045 This can helpful with some "poor" ftp servers which don't
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2046 support EPSV mode. Can be overridden by the <em>GIT_CURL_FTP_NO_EPSV</em>
2047 environment variable. Default is false (curl will use EPSV).
2048</p>
2049</dd>
2050<dt>
2051i18n.commitEncoding
2052</dt>
2053<dd>
2054<p>
2055 Character encoding the commit messages are stored in; git itself
2056 does not care per se, but this information is necessary e.g. when
2057 importing commits from emails or in the gitk graphical history
2058 browser (and possibly at other places in the future or in other
2059 porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
2060</p>
2061</dd>
2062<dt>
2063i18n.logOutputEncoding
2064</dt>
2065<dd>
2066<p>
2067 Character encoding the commit messages are converted to when
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2068 running <em>git-log</em> and friends.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2069</p>
2070</dd>
2071<dt>
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]2072instaweb.browser
2073</dt>
2074<dd>
2075<p>
2076 Specify the program that will be used to browse your working
2077 repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
2078</p>
2079</dd>
2080<dt>
2081instaweb.httpd
2082</dt>
2083<dd>
2084<p>
2085 The HTTP daemon command-line to start gitweb on your working
2086 repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
2087</p>
2088</dd>
2089<dt>
2090instaweb.local
2091</dt>
2092<dd>
2093<p>
2094 If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
2095 be bound to the local IP (127.0.0.1).
2096</p>
2097</dd>
2098<dt>
2099instaweb.modulepath
2100</dt>
2101<dd>
2102<p>
2103 The module path for an apache httpd used by <a href="git-instaweb.html">git-instaweb(1)</a>.
2104</p>
2105</dd>
2106<dt>
2107instaweb.port
2108</dt>
2109<dd>
2110<p>
2111 The port number to bind the gitweb httpd to. See
2112 <a href="git-instaweb.html">git-instaweb(1)</a>.
2113</p>
2114</dd>
2115<dt>
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]2116log.date
2117</dt>
2118<dd>
2119<p>
2120 Set default date-time mode for the log command. Setting log.date
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2121 value is similar to using <em>git-log</em>'s --date option. The value is one of the
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]2122 following alternatives: {relative,local,default,iso,rfc,short}.
2123 See <a href="git-log.html">git-log(1)</a>.
2124</p>
2125</dd>
2126<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2127log.showroot
2128</dt>
2129<dd>
2130<p>
2131 If true, the initial commit will be shown as a big creation event.
2132 This is equivalent to a diff against an empty tree.
2133 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
2134 normally hide the root commit will now show it. True by default.
2135</p>
2136</dd>
2137<dt>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]2138man.viewer
2139</dt>
2140<dd>
2141<p>
2142 Specify the programs that may be used to display help in the
2143 <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
2144</p>
2145</dd>
2146<dt>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]2147merge.stat
2148</dt>
2149<dd>
2150<p>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]2151 Whether to print the diffstat between ORIG_HEAD and merge result
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]2152 at the end of the merge. True by default.
2153</p>
2154</dd>
2155<dt>
2156merge.log
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2157</dt>
2158<dd>
2159<p>
2160 Whether to include summaries of merged commits in newly created
2161 merge commit messages. False by default.
2162</p>
2163</dd>
2164<dt>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]2165merge.renameLimit
2166</dt>
2167<dd>
2168<p>
2169 The number of files to consider when performing rename detection
2170 during a merge; if not specified, defaults to the value of
2171 diff.renameLimit.
2172</p>
2173</dd>
2174<dt>
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]2175merge.tool
2176</dt>
2177<dd>
2178<p>
2179 Controls which merge resolution program is used by
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]2180 <a href="git-mergetool.html">git-mergetool(1)</a>. Valid built-in values are: "kdiff3",
2181 "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and
2182 "opendiff". Any other value is treated is custom merge tool
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]2183 and there must be a corresponding mergetool.&lt;tool&gt;.cmd option.
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]2184</p>
2185</dd>
2186<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2187merge.verbosity
2188</dt>
2189<dd>
2190<p>
2191 Controls the amount of output shown by the recursive merge
2192 strategy. Level 0 outputs nothing except a final error
2193 message if conflicts were detected. Level 1 outputs only
2194 conflicts, 2 outputs conflicts and file changes. Level 5 and
2195 above outputs debugging information. The default is level 2.
Junio C Hamano764a6672007-10-23 01:23:31[diff] [blame]2196 Can be overridden by <em>GIT_MERGE_VERBOSITY</em> environment variable.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2197</p>
2198</dd>
2199<dt>
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]2200merge.&lt;driver&gt;.name
2201</dt>
2202<dd>
2203<p>
2204 Defines a human readable name for a custom low-level
2205 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
2206</p>
2207</dd>
2208<dt>
2209merge.&lt;driver&gt;.driver
2210</dt>
2211<dd>
2212<p>
2213 Defines the command that implements a custom low-level
2214 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
2215</p>
2216</dd>
2217<dt>
2218merge.&lt;driver&gt;.recursive
2219</dt>
2220<dd>
2221<p>
2222 Names a low-level merge driver to be used when
2223 performing an internal merge between common ancestors.
2224 See <a href="gitattributes.html">gitattributes(5)</a> for details.
2225</p>
2226</dd>
2227<dt>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]2228man.&lt;tool&gt;.cmd
2229</dt>
2230<dd>
2231<p>
2232 Specify the command to invoke the specified man viewer. The
2233 specified command is evaluated in shell with the man page
2234 passed as argument. (See <a href="git-help.html">git-help(1)</a>.)
2235</p>
2236</dd>
2237<dt>
2238man.&lt;tool&gt;.path
2239</dt>
2240<dd>
2241<p>
2242 Override the path for the given tool that may be used to
2243 display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
2244</p>
2245</dd>
2246<dt>
Junio C Hamano1fbbbc12007-12-18 07:01:27[diff] [blame]2247mergetool.&lt;tool&gt;.path
2248</dt>
2249<dd>
2250<p>
2251 Override the path for the given tool. This is useful in case
2252 your tool is not in the PATH.
2253</p>
2254</dd>
2255<dt>
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]2256mergetool.&lt;tool&gt;.cmd
2257</dt>
2258<dd>
2259<p>
2260 Specify the command to invoke the specified merge tool. The
2261 specified command is evaluated in shell with the following
2262 variables available: <em>BASE</em> is the name of a temporary file
2263 containing the common base of the files to be merged, if available;
2264 <em>LOCAL</em> is the name of a temporary file containing the contents of
2265 the file on the current branch; <em>REMOTE</em> is the name of a temporary
2266 file containing the contents of the file from the branch being
2267 merged; <em>MERGED</em> contains the name of the file to which the merge
2268 tool should write the results of a successful merge.
2269</p>
2270</dd>
2271<dt>
2272mergetool.&lt;tool&gt;.trustExitCode
2273</dt>
2274<dd>
2275<p>
2276 For a custom merge command, specify whether the exit code of
2277 the merge command can be used to determine whether the merge was
2278 successful. If this is not set to true then the merge target file
2279 timestamp is checked and the merge assumed to have been successful
2280 if the file has been updated, otherwise the user is prompted to
2281 indicate the success of the merge.
2282</p>
2283</dd>
2284<dt>
2285mergetool.keepBackup
2286</dt>
2287<dd>
2288<p>
2289 After performing a merge, the original file with conflict markers
2290 can be saved as a file with a <tt>.orig</tt> extension. If this variable
2291 is set to <tt>false</tt> then this file is not preserved. Defaults to
2292 <tt>true</tt> (i.e. keep the backup files).
2293</p>
2294</dd>
2295<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2296pack.window
2297</dt>
2298<dd>
2299<p>
2300 The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
2301 window size is given on the command line. Defaults to 10.
2302</p>
2303</dd>
2304<dt>
Junio C Hamano91d44c52007-05-09 07:16:07[diff] [blame]2305pack.depth
2306</dt>
2307<dd>
2308<p>
2309 The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
2310 maximum depth is given on the command line. Defaults to 50.
2311</p>
2312</dd>
2313<dt>
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]2314pack.windowMemory
2315</dt>
2316<dd>
2317<p>
2318 The window memory size limit used by <a href="git-pack-objects.html">git-pack-objects(1)</a>
2319 when no limit is given on the command line. The value can be
2320 suffixed with "k", "m", or "g". Defaults to 0, meaning no
2321 limit.
2322</p>
2323</dd>
2324<dt>
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]2325pack.compression
2326</dt>
2327<dd>
2328<p>
2329 An integer -1..9, indicating the compression level for objects
2330 in a pack file. -1 is the zlib default. 0 means no
2331 compression, and 1..9 are various speed/size tradeoffs, 9 being
2332 slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42[diff] [blame]2333 not set, defaults to -1, the zlib default, which is "a default
2334 compromise between speed and compression (currently equivalent
2335 to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]2336</p>
2337</dd>
2338<dt>
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]2339pack.deltaCacheSize
2340</dt>
2341<dd>
2342<p>
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]2343 The maximum memory in bytes used for caching deltas in
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]2344 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
2345 A value of 0 means no limit. Defaults to 0.
2346</p>
2347</dd>
2348<dt>
2349pack.deltaCacheLimit
2350</dt>
2351<dd>
2352<p>
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]2353 The maximum size of a delta, that is cached in
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]2354 <a href="git-pack-objects.html">git-pack-objects(1)</a>. Defaults to 1000.
2355</p>
2356</dd>
2357<dt>
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]2358pack.threads
2359</dt>
2360<dd>
2361<p>
2362 Specifies the number of threads to spawn when searching for best
2363 delta matches. This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
2364 be compiled with pthreads otherwise this option is ignored with a
2365 warning. This is meant to reduce packing time on multiprocessor
2366 machines. The required amount of memory for the delta search window
2367 is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]2368 Specifying 0 will cause git to auto-detect the number of CPU's
2369 and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]2370</p>
2371</dd>
2372<dt>
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]2373pack.indexVersion
2374</dt>
2375<dd>
2376<p>
2377 Specify the default pack index version. Valid values are 1 for
2378 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2379 the new pack index with capabilities for packs larger than 4 GB
2380 as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]2381 packs. Version 2 is the default. Note that version 2 is enforced
2382 and this config option ignored whenever the corresponding pack is
2383 larger than 2 GB.
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]2384</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2385<div class="para"><p>If you have an old git that does not understand the version 2 <tt>&#42;.idx</tt> file,
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]2386cloning or fetching over a non native protocol (e.g. "http" and "rsync")
2387that will copy both <tt>&#42;.pack</tt> file and corresponding <tt>&#42;.idx</tt> file from the
2388other side may give you a repository that cannot be accessed with your
2389older version of git. If the <tt>&#42;.pack</tt> file is smaller than 2 GB, however,
2390you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2391the <tt>&#42;.idx</tt> file.</p></div>
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]2392</dd>
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]2393<dt>
2394pack.packSizeLimit
2395</dt>
2396<dd>
2397<p>
Junio C Hamano49dccaf2008-02-10 10:48:01[diff] [blame]2398 The default maximum size of a pack. This setting only affects
2399 packing to a file, i.e. the git:// protocol is unaffected. It
2400 can be overridden by the <tt>--max-pack-size</tt> option of
Junio C Hamano09a926d2008-03-13 07:55:29[diff] [blame]2401 <a href="git-repack.html">git-repack(1)</a>.
2402</p>
2403</dd>
Junio C Hamanod814b6d2007-11-04 11:13:49[diff] [blame]2404<dt>
Junio C Hamano9e96a1a2008-08-16 10:23:18[diff] [blame]2405pager.&lt;cmd&gt;
2406</dt>
2407<dd>
2408<p>
Junio C Hamano0551f6a2008-08-25 00:33:33[diff] [blame]2409 Allows turning on or off pagination of the output of a
2410 particular git subcommand when writing to a tty. If
2411 <tt>--paginate</tt> or <tt>--no-pager</tt> is specified on the command line,
2412 it takes precedence over this option. To disable pagination for
2413 all commands, set <tt>core.pager</tt> or <em>GIT_PAGER</em> to "<tt>cat</tt>".
Junio C Hamano9e96a1a2008-08-16 10:23:18[diff] [blame]2414</p>
2415</dd>
2416<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2417pull.octopus
2418</dt>
2419<dd>
2420<p>
2421 The default merge strategy to use when pulling multiple branches
2422 at once.
2423</p>
2424</dd>
2425<dt>
2426pull.twohead
2427</dt>
2428<dd>
2429<p>
2430 The default merge strategy to use when pulling a single branch.
2431</p>
2432</dd>
2433<dt>
2434remote.&lt;name&gt;.url
2435</dt>
2436<dd>
2437<p>
2438 The URL of a remote repository. See <a href="git-fetch.html">git-fetch(1)</a> or
2439 <a href="git-push.html">git-push(1)</a>.
2440</p>
2441</dd>
2442<dt>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]2443remote.&lt;name&gt;.proxy
2444</dt>
2445<dd>
2446<p>
2447 For remotes that require curl (http, https and ftp), the URL to
2448 the proxy to use for that remote. Set to the empty string to
2449 disable proxying for that remote.
2450</p>
2451</dd>
2452<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2453remote.&lt;name&gt;.fetch
2454</dt>
2455<dd>
2456<p>
2457 The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
2458 <a href="git-fetch.html">git-fetch(1)</a>.
2459</p>
2460</dd>
2461<dt>
2462remote.&lt;name&gt;.push
2463</dt>
2464<dd>
2465<p>
2466 The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
2467 <a href="git-push.html">git-push(1)</a>.
2468</p>
2469</dd>
2470<dt>
Junio C Hamano47d68a52008-05-06 06:35:40[diff] [blame]2471remote.&lt;name&gt;.mirror
2472</dt>
2473<dd>
2474<p>
2475 If true, pushing to this remote will automatically behave
2476 as if the <tt>--mirror</tt> option was given on the command line.
2477</p>
2478</dd>
2479<dt>
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]2480remote.&lt;name&gt;.skipDefaultUpdate
2481</dt>
2482<dd>
2483<p>
2484 If true, this remote will be skipped by default when updating
Junio C Hamano618bdde2008-01-02 10:51:08[diff] [blame]2485 using the update subcommand of <a href="git-remote.html">git-remote(1)</a>.
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]2486</p>
2487</dd>
2488<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2489remote.&lt;name&gt;.receivepack
2490</dt>
2491<dd>
2492<p>
2493 The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]2494 option --receive-pack of <a href="git-push.html">git-push(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2495</p>
2496</dd>
2497<dt>
2498remote.&lt;name&gt;.uploadpack
2499</dt>
2500<dd>
2501<p>
2502 The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]2503 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]2504</p>
2505</dd>
2506<dt>
Junio C Hamano17dde0e2007-02-26 09:50:21[diff] [blame]2507remote.&lt;name&gt;.tagopt
2508</dt>
2509<dd>
2510<p>
Junio C Hamano86bcccc2008-03-08 09:33:55[diff] [blame]2511 Setting this value to --no-tags disables automatic tag following when
2512 fetching from remote &lt;name&gt;
Junio C Hamano17dde0e2007-02-26 09:50:21[diff] [blame]2513</p>
2514</dd>
2515<dt>
Junio C Hamano118d2772007-02-21 20:24:10[diff] [blame]2516remotes.&lt;group&gt;
2517</dt>
2518<dd>
2519<p>
2520 The list of remotes which are fetched by "git remote update
2521 &lt;group&gt;". See <a href="git-remote.html">git-remote(1)</a>.
2522</p>
2523</dd>
2524<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2525repack.usedeltabaseoffset
2526</dt>
2527<dd>
2528<p>
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]2529 By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
2530 delta-base offset. If you need to share your repository with
2531 git older than version 1.4.4, either directly or via a dumb
2532 protocol such as http, then you need to set this option to
2533 "false" and repack. Access from old git versions over the
2534 native protocol are unaffected by this option.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2535</p>
2536</dd>
2537<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2538showbranch.default
2539</dt>
2540<dd>
2541<p>
2542 The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
2543 See <a href="git-show-branch.html">git-show-branch(1)</a>.
2544</p>
2545</dd>
2546<dt>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]2547status.relativePaths
2548</dt>
2549<dd>
2550<p>
2551 By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
2552 current directory. Setting this variable to <tt>false</tt> shows paths
2553 relative to the repository root (this was the default for git
2554 prior to v1.5.4).
2555</p>
2556</dd>
2557<dt>
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]2558status.showUntrackedFiles
2559</dt>
2560<dd>
2561<p>
2562 By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
2563 files which are not currently tracked by Git. Directories which
2564 contain only untracked files, are shown with the directory name
2565 only. Showing untracked files means that Git needs to lstat() all
2566 all the files in the whole repository, which might be slow on some
2567 systems. So, this variable controls how the commands displays
2568 the untracked files. Possible values are:
2569</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2570<div class="ilist"><ul>
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]2571<li>
2572<p>
2573<em>no</em> - Show no untracked files
2574</p>
2575</li>
2576<li>
2577<p>
2578<em>normal</em> - Shows untracked files and directories
2579</p>
2580</li>
2581<li>
2582<p>
2583<em>all</em> - Shows also individual files in untracked directories.
2584</p>
2585</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2586</ul></div>
2587<div class="para"><p>If this variable is not specified, it defaults to <em>normal</em>.
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]2588This variable can be overridden with the -u|--untracked-files option
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2589of <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]2590</dd>
2591<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2592tar.umask
2593</dt>
2594<dd>
2595<p>
Junio C Hamanobdebabb2007-08-23 00:25:09[diff] [blame]2596 This variable can be used to restrict the permission bits of
2597 tar archive entries. The default is 0002, which turns off the
2598 world write bit. The special value "user" indicates that the
2599 archiving user's umask will be used instead. See umask(2) and
2600 <a href="git-archive.html">git-archive(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2601</p>
2602</dd>
2603<dt>
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]2604url.&lt;base&gt;.insteadOf
2605</dt>
2606<dd>
2607<p>
2608 Any URL that starts with this value will be rewritten to
2609 start, instead, with &lt;base&gt;. In cases where some site serves a
2610 large number of repositories, and serves them with multiple
2611 access methods, and some users need to use different access
2612 methods, this feature allows people to specify any of the
2613 equivalent URLs and have git automatically rewrite the URL to
2614 the best alternative for the particular user, even for a
2615 never-before-seen repository on the site. When more than one
2616 insteadOf strings match a given URL, the longest match is used.
2617</p>
2618</dd>
2619<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2620user.email
2621</dt>
2622<dd>
2623<p>
2624 Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:34[diff] [blame]2625 Can be overridden by the <em>GIT_AUTHOR_EMAIL</em>, <em>GIT_COMMITTER_EMAIL</em>, and
2626 <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]2627</p>
2628</dd>
2629<dt>
2630user.name
2631</dt>
2632<dd>
2633<p>
2634 Your full name to be recorded in any newly created commits.
2635 Can be overridden by the <em>GIT_AUTHOR_NAME</em> and <em>GIT_COMMITTER_NAME</em>
2636 environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
2637</p>
2638</dd>
2639<dt>
2640user.signingkey
2641</dt>
2642<dd>
2643<p>
2644 If <a href="git-tag.html">git-tag(1)</a> is not selecting the key you want it to
2645 automatically when creating a signed tag, you can override the
2646 default selection with this variable. This option is passed
2647 unchanged to gpg's --local-user parameter, so you may specify a key
2648 using any method that gpg supports.
2649</p>
2650</dd>
2651<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2652imap
2653</dt>
2654<dd>
2655<p>
2656 The configuration variables in the <em>imap</em> section are described
2657 in <a href="git-imap-send.html">git-imap-send(1)</a>.
2658</p>
2659</dd>
2660<dt>
Junio C Hamanob78d2592008-04-09 09:39:08[diff] [blame]2661receive.fsckObjects
2662</dt>
2663<dd>
2664<p>
2665 If it is set to true, git-receive-pack will check all received
2666 objects. It will abort in the case of a malformed object or a
2667 broken link. The result of an abort are only dangling objects.
2668 Defaults to false.
2669</p>
2670</dd>
2671<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2672receive.unpackLimit
2673</dt>
2674<dd>
2675<p>
2676 If the number of objects received in a push is below this
2677 limit then the objects will be unpacked into loose object
2678 files. However if the number of received objects equals or
2679 exceeds this limit then the received pack will be stored as
2680 a pack, after adding any missing delta bases. Storing the
2681 pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]2682 especially on slow filesystems. If not set, the value of
2683 <tt>transfer.unpackLimit</tt> is used instead.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2684</p>
2685</dd>
2686<dt>
2687receive.denyNonFastForwards
2688</dt>
2689<dd>
2690<p>
2691 If set to true, git-receive-pack will deny a ref update which is
2692 not a fast forward. Use this to prevent such an update via a push,
2693 even if that push is forced. This configuration variable is
2694 set when initializing a shared repository.
2695</p>
2696</dd>
2697<dt>
2698transfer.unpackLimit
2699</dt>
2700<dd>
2701<p>
2702 When <tt>fetch.unpackLimit</tt> or <tt>receive.unpackLimit</tt> are
2703 not set, the value of this variable is used instead.
Junio C Hamanoe77b0152008-01-12 06:44:17[diff] [blame]2704 The default value is 100.
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2705</p>
2706</dd>
Junio C Hamano4e272312008-01-08 09:13:21[diff] [blame]2707<dt>
2708web.browser
2709</dt>
2710<dd>
2711<p>
2712 Specify a web browser that may be used by some commands.
2713 Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
2714 may use it.
2715</p>
2716</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2717</dl></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2718</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2719<h2 id="_author">Author</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2720<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2721<div class="para"><p>Written by Johannes Schindelin &lt;Johannes.Schindelin@gmx.de&gt;</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2722</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2723<h2 id="_documentation">Documentation</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2724<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2725<div class="para"><p>Documentation by Johannes Schindelin, Petr Baudis and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2726</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2727<h2 id="_git">GIT</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2728<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2729<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2730</div>
2731<div id="footer">
2732<div id="footer-text">
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame^]2733Last updated 2008-09-01 06:10:53 UTC
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]2734</div>
2735</div>
2736</body>
2737</html>