blob: 332a37c637c99b45472e75cdc68f2f014528080f [file] [log] [blame]
Junio C Hamano7ad22dc2007-01-29 02:55:481<!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:316<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano7ad22dc2007-01-29 02:55:487<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:3119a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano7ad22dc2007-01-29 02:55:4826
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:3147h1, h2, h3 {
Junio C Hamano7ad22dc2007-01-29 02:55:4848 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano7ad22dc2007-01-29 02:55:4851 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:3153h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano7ad22dc2007-01-29 02:55:4859
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:3183 font-size: 1.1em;
Junio C Hamano7ad22dc2007-01-29 02:55:4884}
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:31152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano7ad22dc2007-01-29 02:55:48155div.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:31164
165div.attribution {
Junio C Hamano7ad22dc2007-01-29 02:55:48166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano7ad22dc2007-01-29 02:55:48171
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:31214div.olist2 ol {
Junio C Hamano7ad22dc2007-01-29 02:55:48215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31219 border: 3px solid #527bbd;
Junio C Hamano7ad22dc2007-01-29 02:55:48220}
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:31233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano7ad22dc2007-01-29 02:55:48236td.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:31248
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:48275/* 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:31303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano7ad22dc2007-01-29 02:55:48306</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:38324<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:48337</div>
Junio C Hamanoba4b9282008-07-06 05:20:31338<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48339<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31340<div class="para"><p>You can query/set/replace/unset options with this command. The name is
Junio C Hamano7ad22dc2007-01-29 02:55:48341actually the section and the key separated by a dot, and the value will be
Junio C Hamanoba4b9282008-07-06 05:20:31342escaped.</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:48344If 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:31348prepend 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:48351convert the value to the canonical form (simple decimal number for int,
Junio C Hamanod526ba92007-07-02 00:17:42352a "true" or "false" string for bool). If no type specifier is passed,
Junio C Hamanoba4b9282008-07-06 05:20:31353no 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:39355which 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:31358(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:48361<li>
362<p>
Junio C Hamano0ddc94d2007-08-01 08:42:39363The config file is invalid,
Junio C Hamano7ad22dc2007-01-29 02:55:48364</p>
365</li>
366<li>
367<p>
Junio C Hamano0ddc94d2007-08-01 08:42:39368Can not write to the config file,
Junio C Hamano7ad22dc2007-01-29 02:55:48369</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:19393you use <em>--global</em> option without $HOME being properly set.
Junio C Hamano7ad22dc2007-01-29 02:55:48394</p>
395</li>
Junio C Hamanoba4b9282008-07-06 05:20:31396</ol></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48397</div>
Junio C Hamanoba4b9282008-07-06 05:20:31398<h2 id="_options">OPTIONS</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48399<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31400<div class="vlist"><dl>
Junio C Hamano7ad22dc2007-01-29 02:55:48401<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:52444 Also outputs the key names.
Junio C Hamano7ad22dc2007-01-29 02:55:48445</p>
446</dd>
447<dt>
448--global
449</dt>
450<dd>
451<p>
Junio C Hamano6fddfe52007-05-31 07:38:19452 For writing options: write to global ~/.gitconfig file rather than
453 the repository .git/config.
Junio C Hamano7ad22dc2007-01-29 02:55:48454</p>
Junio C Hamanoba4b9282008-07-06 05:20:31455<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:48458</dd>
459<dt>
Junio C Hamano81c711d2007-04-20 07:20:14460--system
461</dt>
462<dd>
463<p>
Junio C Hamano6fddfe52007-05-31 07:38:19464 For writing options: write to system-wide $(prefix)/etc/gitconfig
465 rather than the repository .git/config.
Junio C Hamano81c711d2007-04-20 07:20:14466</p>
Junio C Hamanoba4b9282008-07-06 05:20:31467<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:14470</dd>
471<dt>
Junio C Hamanoeb415992008-06-08 22:49:47472-f config-file
473</dt>
474<dt>
475--file config-file
Junio C Hamano0ddc94d2007-08-01 08:42:39476</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:40483--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:48499--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:30511 Remove all lines matching the key from config file.
Junio C Hamano7ad22dc2007-01-29 02:55:48512</p>
513</dd>
514<dt>
Junio C Hamanoeb415992008-06-08 22:49:47515-l
516</dt>
517<dt>
518--list
Junio C Hamano7ad22dc2007-01-29 02:55:48519</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:31530 <em>git-config</em> will ensure that the output is "true" or "false"
Junio C Hamano7ad22dc2007-01-29 02:55:48531</p>
532</dd>
533<dt>
534--int
535</dt>
536<dd>
537<p>
Junio C Hamanoba4b9282008-07-06 05:20:31538 <em>git-config</em> will ensure that the output is a simple
Junio C Hamano7ad22dc2007-01-29 02:55:48539 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:52544<dt>
Junio C Hamanoeb415992008-06-08 22:49:47545-z
546</dt>
547<dt>
548--null
Junio C Hamanoddc5ad42007-06-27 07:14:52549</dt>
550<dd>
551<p>
552 For all options that output values and/or keys, always
Junio C Hamano1f511962008-01-30 08:28:52553 end values with the null character (instead of a
Junio C Hamanoddc5ad42007-06-27 07:14:52554 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:55560<dt>
Junio C Hamano00b8b632007-12-07 09:50:49561--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:07571 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:49573</p>
574</dd>
575<dt>
Junio C Hamano0c999702007-12-03 09:57:55576--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:31586</dl></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48587</div>
Junio C Hamanoba4b9282008-07-06 05:20:31588<h2 id="FILES">FILES</h2>
Junio C Hamano6fddfe52007-05-31 07:38:19589<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31590<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:19593<dt>
Junio C Hamano58155b42007-09-15 07:46:14594$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:19604~/.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:31620</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:19622files 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:31624file 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:19627configuration file. Note that this also affects options like <em>--replace-all</em>
Junio C Hamanoba4b9282008-07-06 05:20:31628and <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:19630variables. 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:31632variable has a similar effect, but you can specify any filename you want.</p></div>
Junio C Hamano6fddfe52007-05-31 07:38:19633</div>
Junio C Hamanoba4b9282008-07-06 05:20:31634<h2 id="_environment">ENVIRONMENT</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48635<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31636<div class="vlist"><dl>
Junio C Hamano7ad22dc2007-01-29 02:55:48637<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:19643 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:48645</p>
646</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31647</dl></div>
648<div class="para"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48649</div>
Junio C Hamanoba4b9282008-07-06 05:20:31650<h2 id="EXAMPLES">EXAMPLES</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48651<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31652<div class="para"><p>Given a .git/config like this:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48653<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:31672 external = /usr/local/bin/diff-wrapper
Junio C Hamano7ad22dc2007-01-29 02:55:48673 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:48679 gitproxy="proxy-command" for kernel.org
Junio C Hamano7ad22dc2007-01-29 02:55:48680 gitproxy=default-proxy ; for all the rest</tt></pre>
681</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31682<div class="para"><p>you can set the filemode to true with</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48683<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:31687<div class="para"><p>The hypothetical proxy command entries actually have a postfix to discern
Junio C Hamano7ad22dc2007-01-29 02:55:48688what URL they apply to. Here is how to change the entry for kernel.org
Junio C Hamanoba4b9282008-07-06 05:20:31689to "ssh".</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48690<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:31694<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:48696<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:31700<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:48703<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:31707<div class="para"><p>or</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48708<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:31712<div class="para"><p>or, to query a multivar:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48713<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:31717<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:48718<div class="listingblock">
719<div class="content">
720<pre><tt>% git config --get-all core.gitproxy</tt></pre>
721</div></div>
Junio C Hamanoffb4b682008-12-13 07:35:22722<div class="para"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
Junio C Hamanoba4b9282008-07-06 05:20:31723new one with</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48724<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:31728<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:48730<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:31734<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:48735<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:31739<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:48740<div class="listingblock">
741<div class="content">
Junio C Hamanoc71a8732007-08-04 00:27:26742<pre><tt>% git config core.gitproxy '"proxy-command" for example.com'</tt></pre>
Junio C Hamano7ad22dc2007-01-29 02:55:48743</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31744<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:55746<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:48753</div>
Junio C Hamanoba4b9282008-07-06 05:20:31754<h2 id="_configuration_file">CONFIGURATION FILE</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:48755<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31756<div class="para"><p>The git configuration file contains a number of variables that affect
Junio C Hamano7ad22dc2007-01-29 02:55:48757the 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:54760fallback values for <tt>.git/config</tt> file. The file <tt>/etc/gitconfig</tt>
Junio C Hamanoba4b9282008-07-06 05:20:31761can 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:48763and 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:31767characters 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:48770ignored. The <em>#</em> and <em>;</em> characters begin comments to the end of line,
Junio C Hamanoba4b9282008-07-06 05:20:31771blank 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:48773the 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:31777header 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:48779put its name in double quotes, separated by space from the section name,
Junio C Hamanoba4b9282008-07-06 05:20:31780in the section header, like in example below:</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48781<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:31786<div class="para"><p>Subsection names can contain any characters except newline (doublequote
Junio C Hamano7ad22dc2007-01-29 02:55:48787<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:04788respectively) and are case sensitive. Section header cannot span multiple
Junio C Hamano7ad22dc2007-01-29 02:55:48789lines. 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:31791don'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:48793In this syntax subsection names follow the same restrictions as for section
Junio C Hamanoba4b9282008-07-06 05:20:31794name.</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:48796<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:31800for 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:48804a 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:31807<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:48809You 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:31813be 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:48815<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:31817char 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:48822<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:31833 external = /usr/local/bin/diff-wrapper
Junio C Hamano7ad22dc2007-01-29 02:55:48834 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:26846 gitProxy="ssh" for "kernel.org"
Junio C Hamano7ad22dc2007-01-29 02:55:48847 gitProxy=default-proxy ; for the rest</tt></pre>
848</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31849<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:48851For 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:31853porcelain configuration variables in the respective porcelain documentation.</p></div>
854<div class="vlist"><dl>
Junio C Hamano7ad22dc2007-01-29 02:55:48855<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 Hamanoa476efa2008-10-10 15:31:42866core.ignoreCygwinFSTricks
867</dt>
868<dd>
869<p>
870 This option is only used by Cygwin implementation of Git. If false,
871 the Cygwin stat() and lstat() functions are used. This may be useful
872 if your repository consists of a few separate directories joined in
873 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
874 whenever it is possible and falls back to Cygwin functions only to
875 handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33876 normal Cygwin l/stat() functions. True by default, unless core.filemode
877 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
878 POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42879</p>
880</dd>
881<dt>
Junio C Hamano90ccff32008-07-29 08:17:24882core.trustctime
883</dt>
884<dd>
885<p>
886 If false, the ctime differences between the index and the
887 working copy are ignored; useful when the inode change time
888 is regularly modified by something outside Git (file system
889 crawlers and some backup systems).
890 See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
891</p>
892</dd>
893<dt>
Junio C Hamanod526ba92007-07-02 00:17:42894core.quotepath
895</dt>
896<dd>
897<p>
Junio C Hamanoba4b9282008-07-06 05:20:31898 The commands that output paths (e.g. <em>ls-files</em>,
899 <em>diff</em>), when not given the <tt>-z</tt> option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42900 "unusual" characters in the pathname by enclosing the
901 pathname in a double-quote pair and with backslashes the
902 same way strings in C source code are quoted. If this
903 variable is set to false, the bytes higher than 0x80 are
904 not quoted but output as verbatim. Note that double
905 quote, backslash and control characters are always
906 quoted without <tt>-z</tt> regardless of the setting of this
907 variable.
908</p>
909</dd>
910<dt>
Junio C Hamanod9e0e5d2007-04-14 16:22:04911core.autocrlf
912</dt>
913<dd>
914<p>
915 If true, makes git convert <tt>CRLF</tt> at the end of lines in text files to
916 <tt>LF</tt> when reading from the filesystem, and convert in reverse when
917 writing to the filesystem. The variable can be set to
918 <em>input</em>, in which case the conversion happens only while
919 reading from the filesystem but files are written out with
920 <tt>LF</tt> at the end of lines. Currently, which paths to consider
921 "text" (i.e. be subjected to the autocrlf mechanism) is
922 decided purely based on the contents.
923</p>
924</dd>
925<dt>
Junio C Hamano26e590a2008-02-17 03:53:51926core.safecrlf
927</dt>
928<dd>
929<p>
930 If true, makes git check if converting <tt>CRLF</tt> as controlled by
931 <tt>core.autocrlf</tt> is reversible. Git will verify if a command
932 modifies a file in the work tree either directly or indirectly.
933 For example, committing a file followed by checking out the
934 same file should yield the original file in the work tree. If
935 this is not the case for the current setting of
936 <tt>core.autocrlf</tt>, git will reject the file. The variable can
937 be set to "warn", in which case git will only warn about an
938 irreversible conversion but continue the operation.
939</p>
Junio C Hamanoba4b9282008-07-06 05:20:31940<div class="para"><p>CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano26e590a2008-02-17 03:53:51941autocrlf=true will convert CRLF to LF during commit and LF to
942CRLF during checkout. A file that contains a mixture of LF and
943CRLF before the commit cannot be recreated by git. For text
944files this is the right thing to do: it corrects line endings
945such that we have only LF line endings in the repository.
946But for binary files that are accidentally classified as text the
Junio C Hamanoba4b9282008-07-06 05:20:31947conversion can corrupt data.</p></div>
948<div class="para"><p>If you recognize such corruption early you can easily fix it by
Junio C Hamano26e590a2008-02-17 03:53:51949setting the conversion type explicitly in .gitattributes. Right
950after committing you still have the original file in your work
951tree and this file is not yet corrupted. You can explicitly tell
952git that this file is binary and git will handle the file
Junio C Hamanoba4b9282008-07-06 05:20:31953appropriately.</p></div>
954<div class="para"><p>Unfortunately, the desired effect of cleaning up text files with
Junio C Hamano26e590a2008-02-17 03:53:51955mixed line endings and the undesired effect of corrupting binary
956files cannot be distinguished. In both cases CRLFs are removed
957in an irreversible way. For text files this is the right thing
958to do because CRLFs are line endings, while for binary files
Junio C Hamanoba4b9282008-07-06 05:20:31959converting CRLFs corrupts data.</p></div>
960<div class="para"><p>Note, this safety check does not mean that a checkout will generate a
Junio C Hamano26e590a2008-02-17 03:53:51961file identical to the original file for a different setting of
962<tt>core.autocrlf</tt>, but only for the current one. For example, a text
963file with <tt>LF</tt> would be accepted with <tt>core.autocrlf=input</tt> and could
964later be checked out with <tt>core.autocrlf=true</tt>, in which case the
965resulting file would contain <tt>CRLF</tt>, although the original file
966contained <tt>LF</tt>. However, in both work trees the line endings would be
967consistent, that is either all <tt>LF</tt> or all <tt>CRLF</tt>, but never mixed. A
968file with mixed line endings would be reported by the <tt>core.safecrlf</tt>
Junio C Hamanoba4b9282008-07-06 05:20:31969mechanism.</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51970</dd>
971<dt>
Junio C Hamanoaa83a7d2007-03-05 02:37:29972core.symlinks
973</dt>
974<dd>
975<p>
976 If false, symbolic links are checked out as small plain files that
977 contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
978 <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
979 file. Useful on filesystems like FAT that do not support
980 symbolic links. True by default.
981</p>
982</dd>
983<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48984core.gitProxy
985</dt>
986<dd>
987<p>
988 A "proxy command" to execute (as <em>command host port</em>) instead
989 of establishing direct connection to the remote server when
990 using the git protocol for fetching. If the variable value is
991 in the "COMMAND for DOMAIN" format, the command is applied only
992 on hostnames ending with the specified domain string. This variable
993 may be set multiple times and is matched in the given order;
994 the first match wins.
995</p>
Junio C Hamanoba4b9282008-07-06 05:20:31996<div class="para"><p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable
Junio C Hamano7ad22dc2007-01-29 02:55:48997(which always applies universally, without the special "for"
Junio C Hamanoba4b9282008-07-06 05:20:31998handling).</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:48999</dd>
1000<dt>
1001core.ignoreStat
1002</dt>
1003<dd>
1004<p>
Junio C Hamano054ea082008-06-01 08:26:341005 If true, commands which modify both the working tree and the index
1006 will mark the updated paths with the "assume unchanged" bit in the
1007 index. These marked files are then assumed to stay unchanged in the
1008 working copy, until you mark them otherwise manually - Git will not
1009 detect the file changes by lstat() calls. This is useful on systems
1010 where those are very slow, such as Microsoft Windows.
1011 See <a href="git-update-index.html">git-update-index(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:481012 False by default.
1013</p>
1014</dd>
1015<dt>
1016core.preferSymlinkRefs
1017</dt>
1018<dd>
1019<p>
1020 Instead of the default "symref" format for HEAD
1021 and other symbolic reference files, use symbolic links.
1022 This is sometimes needed to work with old scripts that
1023 expect HEAD to be a symbolic link.
1024</p>
1025</dd>
1026<dt>
Junio C Hamano1025e752007-02-23 07:21:261027core.bare
1028</dt>
1029<dd>
1030<p>
1031 If true this repository is assumed to be <em>bare</em> and has no
1032 working directory associated with it. If this is the case a
1033 number of commands that require a working directory will be
1034 disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
1035</p>
Junio C Hamanoba4b9282008-07-06 05:20:311036<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:261037<a href="git-init.html">git-init(1)</a> when the repository was created. By default a
1038repository that ends in "/.git" is assumed to be not bare (bare =
1039false), while all other repositories are assumed to be bare (bare
Junio C Hamanoba4b9282008-07-06 05:20:311040= true).</p></div>
Junio C Hamano1025e752007-02-23 07:21:261041</dd>
1042<dt>
Junio C Hamanod526ba92007-07-02 00:17:421043core.worktree
1044</dt>
1045<dd>
1046<p>
1047 Set the path to the working tree. The value will not be
1048 used in combination with repositories found automatically in
1049 a .git directory (i.e. $GIT_DIR is not set).
Junio C Hamano764a6672007-10-23 01:23:311050 This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:271051 variable and the <em>--work-tree</em> command line option. It can be
1052 a absolute path or relative path to the directory specified by
1053 --git-dir or GIT_DIR.
1054 Note: If --git-dir or GIT_DIR are specified but none of
1055 --work-tree, GIT_WORK_TREE and core.worktree is specified,
1056 the current working directory is regarded as the top directory
1057 of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:421058</p>
1059</dd>
1060<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481061core.logAllRefUpdates
1062</dt>
1063<dd>
1064<p>
Junio C Hamanocae86272007-08-21 02:20:491065 Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
Junio C Hamano7ad22dc2007-01-29 02:55:481066 "$GIT_DIR/logs/&lt;ref&gt;", by appending the new and old
1067 SHA1, the date/time and the reason of the update, but
1068 only when the file exists. If this configuration
1069 variable is set to true, missing "$GIT_DIR/logs/&lt;ref&gt;"
1070 file is automatically created for branch heads.
1071</p>
Junio C Hamanoba4b9282008-07-06 05:20:311072<div class="para"><p>This information can be used to determine what commit
1073was the tip of a branch "2 days ago".</p></div>
1074<div class="para"><p>This value is true by default in a repository that has
Junio C Hamano7ad22dc2007-01-29 02:55:481075a working directory associated with it, and false by
Junio C Hamanoba4b9282008-07-06 05:20:311076default in a bare repository.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:481077</dd>
1078<dt>
1079core.repositoryFormatVersion
1080</dt>
1081<dd>
1082<p>
1083 Internal variable identifying the repository format and layout
1084 version.
1085</p>
1086</dd>
1087<dt>
1088core.sharedRepository
1089</dt>
1090<dd>
1091<p>
1092 When <em>group</em> (or <em>true</em>), the repository is made shareable between
1093 several users in a group (making sure all the files and objects are
1094 group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
1095 repository will be readable by all users, additionally to being
1096 group-shareable. When <em>umask</em> (or <em>false</em>), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:371097 reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
1098 files in the repository will have this mode value. <em>0xxx</em> will override
1099 user's umask value, and thus, users with a safe umask (0077) can use
1100 this option. Examples: <em>0660</em> is equivalent to <em>group</em>. <em>0640</em> is a
1101 repository that is group-readable but not group-writable.
1102 See <a href="git-init.html">git-init(1)</a>. False by default.
Junio C Hamano7ad22dc2007-01-29 02:55:481103</p>
1104</dd>
1105<dt>
1106core.warnAmbiguousRefs
1107</dt>
1108<dd>
1109<p>
1110 If true, git will warn you if the ref name you passed it is ambiguous
1111 and might match multiple refs in the .git/refs/ tree. True by default.
1112</p>
1113</dd>
1114<dt>
1115core.compression
1116</dt>
1117<dd>
1118<p>
Junio C Hamanof2ce2972007-05-20 19:12:091119 An integer -1..9, indicating a default compression level.
1120 -1 is the zlib default. 0 means no compression,
1121 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:421122 If set, this provides a default to other compression variables,
1123 such as <em>core.loosecompression</em> and <em>pack.compression</em>.
Junio C Hamano7ad22dc2007-01-29 02:55:481124</p>
1125</dd>
1126<dt>
Junio C Hamanof2ce2972007-05-20 19:12:091127core.loosecompression
Junio C Hamano7ad22dc2007-01-29 02:55:481128</dt>
1129<dd>
1130<p>
Junio C Hamanof2ce2972007-05-20 19:12:091131 An integer -1..9, indicating the compression level for objects that
1132 are not in a pack file. -1 is the zlib default. 0 means no
1133 compression, and 1..9 are various speed/size tradeoffs, 9 being
1134 slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421135 not set, defaults to 1 (best speed).
Junio C Hamano7ad22dc2007-01-29 02:55:481136</p>
1137</dd>
1138<dt>
1139core.packedGitWindowSize
1140</dt>
1141<dd>
1142<p>
1143 Number of bytes of a pack file to map into memory in a
1144 single mapping operation. Larger window sizes may allow
1145 your system to process a smaller number of large pack files
1146 more quickly. Smaller window sizes will negatively affect
1147 performance due to increased calls to the operating system's
1148 memory manager, but may improve performance when accessing
1149 a large number of large pack files.
1150</p>
Junio C Hamanoba4b9282008-07-06 05:20:311151<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:481152MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
1153be reasonable for all users/operating systems. You probably do
Junio C Hamanoba4b9282008-07-06 05:20:311154not need to adjust this value.</p></div>
1155<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:481156</dd>
1157<dt>
1158core.packedGitLimit
1159</dt>
1160<dd>
1161<p>
1162 Maximum number of bytes to map simultaneously into memory
1163 from pack files. If Git needs to access more than this many
1164 bytes at once to complete an operation it will unmap existing
1165 regions to reclaim virtual address space within the process.
1166</p>
Junio C Hamanoba4b9282008-07-06 05:20:311167<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:481168This should be reasonable for all users/operating systems, except on
Junio C Hamanoba4b9282008-07-06 05:20:311169the largest projects. You 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 Hamano7ad22dc2007-01-29 02:55:481171</dd>
1172<dt>
Junio C Hamanob8c51282007-03-19 10:43:301173core.deltaBaseCacheLimit
1174</dt>
1175<dd>
1176<p>
1177 Maximum number of bytes to reserve for caching base objects
1178 that multiple deltafied objects reference. By storing the
1179 entire decompressed base objects in a cache Git is able
1180 to avoid unpacking and decompressing frequently used base
1181 objects multiple times.
1182</p>
Junio C Hamanoba4b9282008-07-06 05:20:311183<div class="para"><p>Default is 16 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:301184for all users/operating systems, except on the largest projects.
Junio C Hamanoba4b9282008-07-06 05:20:311185You probably do not need to adjust this value.</p></div>
1186<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:301187</dd>
1188<dt>
Junio C Hamano1d90cb02007-07-03 07:05:311189core.excludesfile
Junio C Hamano5e284b42007-05-22 07:23:371190</dt>
1191<dd>
1192<p>
1193 In addition to <em>.gitignore</em> (per-directory) and
1194 <em>.git/info/exclude</em>, git looks into this file for patterns
Junio C Hamano679d22d2007-06-02 21:13:441195 of files which are not meant to be tracked. See
1196 <a href="gitignore.html">gitignore(5)</a>.
Junio C Hamano5e284b42007-05-22 07:23:371197</p>
1198</dd>
1199<dt>
Junio C Hamanof6002a92007-07-20 10:28:221200core.editor
1201</dt>
1202<dd>
1203<p>
1204 Commands such as <tt>commit</tt> and <tt>tag</tt> that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:271205 messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:221206 variable when it is set, and the environment variable
1207 <tt>GIT_EDITOR</tt> is not set. The order of preference is
Junio C Hamanode9879a2007-07-22 09:33:421208 <tt>GIT_EDITOR</tt> environment, <tt>core.editor</tt>, <tt>VISUAL</tt> and
1209 <tt>EDITOR</tt> environment variables and then finally <tt>vi</tt>.
Junio C Hamanof6002a92007-07-20 10:28:221210</p>
1211</dd>
1212<dt>
Junio C Hamano28d8ede2007-07-05 05:51:381213core.pager
1214</dt>
1215<dd>
1216<p>
Junio C Hamano0551f6a2008-08-25 00:33:331217 The command that git will use to paginate output. Can
1218 be overridden with the <tt>GIT_PAGER</tt> environment
1219 variable. Note that git sets the <tt>LESS</tt> environment
1220 variable to <tt>FRSX</tt> if it is unset when it runs the
1221 pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:421222 <tt>LESS</tt> variable to some other value. Alternately,
1223 these settings can be overridden on a project or
1224 global basis by setting the <tt>core.pager</tt> option.
1225 Setting <tt>core.pager</tt> has no affect on the <tt>LESS</tt>
1226 environment variable behaviour above, so if you want
1227 to override git's default settings this way, you need
1228 to be explicit. For example, to disable the S option
1229 in a backward compatible manner, set <tt>core.pager</tt>
1230 to "<tt>less -+$LESS -FRX</tt>". This will be passed to the
1231 shell by git, which will translate the final command to
1232 "<tt>LESS=FRSX less -+FRSX -FRX</tt>".
Junio C Hamano28d8ede2007-07-05 05:51:381233</p>
1234</dd>
1235<dt>
Junio C Hamano942b35e2007-12-09 10:19:331236core.whitespace
1237</dt>
1238<dd>
1239<p>
1240 A comma separated list of common whitespace problems to
Junio C Hamanoba4b9282008-07-06 05:20:311241 notice. <em>git-diff</em> will use <tt>color.diff.whitespace</tt> to
1242 highlight them, and <em>git-apply --whitespace=error</em> will
Junio C Hamano3db8b412008-07-26 06:45:591243 consider them as errors. You can prefix <tt>-</tt> to disable
1244 any of them (e.g. <tt>-trailing-space</tt>):
Junio C Hamano942b35e2007-12-09 10:19:331245</p>
Junio C Hamanoba4b9282008-07-06 05:20:311246<div class="ilist"><ul>
Junio C Hamano942b35e2007-12-09 10:19:331247<li>
1248<p>
1249<tt>trailing-space</tt> treats trailing whitespaces at the end of the line
1250 as an error (enabled by default).
1251</p>
1252</li>
1253<li>
1254<p>
1255<tt>space-before-tab</tt> treats a space character that appears immediately
1256 before a tab character in the initial indent part of the line as an
1257 error (enabled by default).
1258</p>
1259</li>
1260<li>
1261<p>
1262<tt>indent-with-non-tab</tt> treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:421263 space characters as an error (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:331264</p>
1265</li>
Junio C Hamano601f3e52008-02-25 08:40:421266<li>
1267<p>
1268<tt>cr-at-eol</tt> treats a carriage-return at the end of line as
1269 part of the line terminator, i.e. with it, <tt>trailing-space</tt>
1270 does not trigger if the character before such a carriage-return
1271 is not a whitespace (not enabled by default).
1272</p>
1273</li>
Junio C Hamanoba4b9282008-07-06 05:20:311274</ul></div>
Junio C Hamano942b35e2007-12-09 10:19:331275</dd>
1276<dt>
Junio C Hamano9eb57532008-06-26 06:33:461277core.fsyncobjectfiles
1278</dt>
1279<dd>
1280<p>
1281 This boolean will enable <em>fsync()</em> when writing object files.
1282</p>
Junio C Hamanoba4b9282008-07-06 05:20:311283<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:461284data writes properly, but can be useful for filesystems that do not use
1285journalling (traditional UNIX filesystems) or that only journal metadata
Junio C Hamanoba4b9282008-07-06 05:20:311286and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").</p></div>
Junio C Hamano9eb57532008-06-26 06:33:461287</dd>
1288<dt>
Junio C Hamano610d1762008-11-28 06:27:131289core.preloadindex
1290</dt>
1291<dd>
1292<p>
1293 Enable parallel index preload for operations like <em>git diff</em>
1294</p>
1295<div class="para"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
1296on filesystems like NFS that have weak caching semantics and thus
1297relatively high IO latencies. With this set to <em>true</em>, git will do the
1298index comparison to the filesystem data in parallel, allowing
1299overlapping IO's.</p></div>
1300</dd>
1301<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481302alias.*
1303</dt>
1304<dd>
1305<p>
1306 Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
1307 after defining "alias.last = cat-file commit HEAD", the invocation
1308 "git last" is equivalent to "git cat-file commit HEAD". To avoid
1309 confusion and troubles with script usage, aliases that
1310 hide existing git commands are ignored. Arguments are split by
1311 spaces, the usual shell quoting and escaping is supported.
1312 quote pair and a backslash can be used to quote them.
1313</p>
Junio C Hamanoba4b9282008-07-06 05:20:311314<div class="para"><p>If the alias expansion is prefixed with an exclamation point,
Junio C Hamano9cb74f22007-02-12 04:15:051315it will be treated as a shell command. For example, defining
1316"alias.new = !gitk --all --not ORIG_HEAD", the invocation
1317"git new" is equivalent to running the shell command
Junio C Hamanoba4b9282008-07-06 05:20:311318"gitk --all --not ORIG_HEAD".</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:481319</dd>
1320<dt>
1321apply.whitespace
1322</dt>
1323<dd>
1324<p>
Junio C Hamanoba4b9282008-07-06 05:20:311325 Tells <em>git-apply</em> how to handle whitespaces, in the same way
Junio C Hamano7ad22dc2007-01-29 02:55:481326 as the <em>--whitespace</em> option. See <a href="git-apply.html">git-apply(1)</a>.
1327</p>
1328</dd>
1329<dt>
Junio C Hamano7fd84172007-05-24 07:00:321330branch.autosetupmerge
1331</dt>
1332<dd>
1333<p>
Junio C Hamanoba4b9282008-07-06 05:20:311334 Tells <em>git-branch</em> and <em>git-checkout</em> to setup new branches
Junio C Hamano24bc09a2008-02-28 00:27:441335 so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
1336 starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:321337 this behavior can be chosen per-branch using the <tt>--track</tt>
Junio C Hamano24bc09a2008-02-28 00:27:441338 and <tt>--no-track</tt> options. The valid settings are: <tt>false</tt> &#8212; no
1339 automatic setup is done; <tt>true</tt> &#8212; automatic setup is done when the
1340 starting point is a remote branch; <tt>always</tt> &#8212; automatic setup is
1341 done when the starting point is either a local branch or remote
1342 branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:321343</p>
1344</dd>
1345<dt>
Junio C Hamano869bb802008-05-12 00:29:471346branch.autosetuprebase
1347</dt>
1348<dd>
1349<p>
Junio C Hamanoba4b9282008-07-06 05:20:311350 When a new branch is created with <em>git-branch</em> or <em>git-checkout</em>
Junio C Hamano869bb802008-05-12 00:29:471351 that tracks another branch, this variable tells git to set
1352 up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
1353 When <tt>never</tt>, rebase is never automatically set to true.
1354 When <tt>local</tt>, rebase is set to true for tracked branches of
1355 other local branches.
1356 When <tt>remote</tt>, rebase is set to true for tracked branches of
1357 remote branches.
1358 When <tt>always</tt>, rebase will be set to true for all tracking
1359 branches.
1360 See "branch.autosetupmerge" for details on how to set up a
1361 branch to track another branch.
1362 This option defaults to never.
1363</p>
1364</dd>
1365<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481366branch.&lt;name&gt;.remote
1367</dt>
1368<dd>
1369<p>
Junio C Hamanoba4b9282008-07-06 05:20:311370 When in branch &lt;name&gt;, it tells <em>git-fetch</em> which remote to fetch.
1371 If this option is not given, <em>git-fetch</em> defaults to remote "origin".
Junio C Hamano7ad22dc2007-01-29 02:55:481372</p>
1373</dd>
1374<dt>
1375branch.&lt;name&gt;.merge
1376</dt>
1377<dd>
1378<p>
Junio C Hamanoba4b9282008-07-06 05:20:311379 When in branch &lt;name&gt;, it tells <em>git-fetch</em> the default
Junio C Hamanoc2b47092007-10-25 06:50:311380 refspec to be marked for merging in FETCH_HEAD. The value is
1381 handled like the remote part of a refspec, and must match a
1382 ref which is fetched from the remote given by
1383 "branch.&lt;name&gt;.remote".
Junio C Hamanoba4b9282008-07-06 05:20:311384 The merge information is used by <em>git-pull</em> (which at first calls
1385 <em>git-fetch</em>) to lookup the default branch for merging. Without
1386 this option, <em>git-pull</em> defaults to merge the first refspec fetched.
Junio C Hamano7ad22dc2007-01-29 02:55:481387 Specify multiple values to get an octopus merge.
Junio C Hamanoba4b9282008-07-06 05:20:311388 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:071389 another branch in the local repository, you can point
1390 branch.&lt;name&gt;.merge to the desired branch, and use the special setting
1391 <tt>.</tt> (a period) for branch.&lt;name&gt;.remote.
Junio C Hamano7ad22dc2007-01-29 02:55:481392</p>
1393</dd>
1394<dt>
Junio C Hamano1b50ce92007-10-03 12:05:531395branch.&lt;name&gt;.mergeoptions
1396</dt>
1397<dd>
1398<p>
1399 Sets default options for merging into branch &lt;name&gt;. The syntax and
1400 supported options are equal to that of <a href="git-merge.html">git-merge(1)</a>, but
1401 option values containing whitespace characters are currently not
1402 supported.
1403</p>
1404</dd>
1405<dt>
Junio C Hamano0c999702007-12-03 09:57:551406branch.&lt;name&gt;.rebase
1407</dt>
1408<dd>
1409<p>
1410 When true, rebase the branch &lt;name&gt; on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:081411 instead of merging the default branch from the default remote when
1412 "git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:551413 <strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
1414 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
1415 for details).
1416</p>
1417</dd>
1418<dt>
Junio C Hamano8760ea62008-03-14 08:58:451419browser.&lt;tool&gt;.cmd
1420</dt>
1421<dd>
1422<p>
1423 Specify the command to invoke the specified browser. The
1424 specified command is evaluated in shell with the URLs passed
1425 as arguments. (See <a href="git-web--browse.html">git-web--browse(1)</a>.)
1426</p>
1427</dd>
1428<dt>
Junio C Hamanoe35a6fc2008-01-29 09:46:271429browser.&lt;tool&gt;.path
1430</dt>
1431<dd>
1432<p>
1433 Override the path for the given tool that may be used to
1434 browse HTML help (see <em>-w</em> option in <a href="git-help.html">git-help(1)</a>) or a
1435 working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
1436</p>
1437</dd>
1438<dt>
Junio C Hamano47b9acd2007-04-24 07:34:341439clean.requireForce
1440</dt>
1441<dd>
1442<p>
Junio C Hamano422cfec2007-11-08 08:07:451443 A boolean to make git-clean do nothing unless given -f
1444 or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:341445</p>
1446</dd>
1447<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481448color.branch
1449</dt>
1450<dd>
1451<p>
1452 A boolean to enable/disable color in the output of
Junio C Hamano0fc8cd92007-12-06 03:26:211453 <a href="git-branch.html">git-branch(1)</a>. May be set to <tt>always</tt>,
1454 <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:481455 only when the output is to a terminal. Defaults to false.
1456</p>
1457</dd>
1458<dt>
1459color.branch.&lt;slot&gt;
1460</dt>
1461<dd>
1462<p>
1463 Use customized color for branch coloration. <tt>&lt;slot&gt;</tt> is one of
1464 <tt>current</tt> (the current branch), <tt>local</tt> (a local branch),
1465 <tt>remote</tt> (a tracking branch in refs/remotes/), <tt>plain</tt> (other
1466 refs).
1467</p>
Junio C Hamanoba4b9282008-07-06 05:20:311468<div class="para"><p>The value for these configuration variables is a list of colors (at most
Junio C Hamano7ad22dc2007-01-29 02:55:481469two) and attributes (at most one), separated by spaces. The colors
1470accepted are <tt>normal</tt>, <tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>,
1471<tt>magenta</tt>, <tt>cyan</tt> and <tt>white</tt>; the attributes are <tt>bold</tt>, <tt>dim</tt>, <tt>ul</tt>,
1472<tt>blink</tt> and <tt>reverse</tt>. The first color given is the foreground; the
1473second is the background. The position of the attribute, if any,
Junio C Hamanoba4b9282008-07-06 05:20:311474doesn't matter.</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:481475</dd>
1476<dt>
1477color.diff
1478</dt>
1479<dd>
1480<p>
Junio C Hamano0fc8cd92007-12-06 03:26:211481 When set to <tt>always</tt>, always use colors in patch.
1482 When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use
1483 colors only when the output is to the terminal. Defaults to false.
Junio C Hamano7ad22dc2007-01-29 02:55:481484</p>
1485</dd>
1486<dt>
1487color.diff.&lt;slot&gt;
1488</dt>
1489<dd>
1490<p>
1491 Use customized color for diff colorization. <tt>&lt;slot&gt;</tt> specifies
1492 which part of the patch to use the specified color, and is one
1493 of <tt>plain</tt> (context text), <tt>meta</tt> (metainformation), <tt>frag</tt>
1494 (hunk header), <tt>old</tt> (removed lines), <tt>new</tt> (added lines),
Junio C Hamano942b35e2007-12-09 10:19:331495 <tt>commit</tt> (commit headers), or <tt>whitespace</tt> (highlighting
1496 whitespace errors). The values of these variables may be specified as
Junio C Hamano7ad22dc2007-01-29 02:55:481497 in color.branch.&lt;slot&gt;.
1498</p>
1499</dd>
1500<dt>
Junio C Hamano00b8b632007-12-07 09:50:491501color.interactive
1502</dt>
1503<dd>
1504<p>
Junio C Hamano35738e82008-01-07 07:55:461505 When set to <tt>always</tt>, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:311506 and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:491507 When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use
1508 colors only when the output is to the terminal. Defaults to false.
1509</p>
1510</dd>
1511<dt>
1512color.interactive.&lt;slot&gt;
1513</dt>
1514<dd>
1515<p>
Junio C Hamanoba4b9282008-07-06 05:20:311516 Use customized color for <em>git-add --interactive</em>
Junio C Hamano00b8b632007-12-07 09:50:491517 output. <tt>&lt;slot&gt;</tt> may be <tt>prompt</tt>, <tt>header</tt>, or <tt>help</tt>, for
1518 three distinct types of normal output from interactive
1519 programs. The values of these variables may be specified as
1520 in color.branch.&lt;slot&gt;.
1521</p>
1522</dd>
1523<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481524color.pager
1525</dt>
1526<dd>
1527<p>
1528 A boolean to enable/disable colored output when the pager is in
1529 use (default is true).
1530</p>
1531</dd>
1532<dt>
1533color.status
1534</dt>
1535<dd>
1536<p>
1537 A boolean to enable/disable color in the output of
Junio C Hamano0fc8cd92007-12-06 03:26:211538 <a href="git-status.html">git-status(1)</a>. May be set to <tt>always</tt>,
1539 <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:481540 only when the output is to a terminal. Defaults to false.
1541</p>
1542</dd>
1543<dt>
1544color.status.&lt;slot&gt;
1545</dt>
1546<dd>
1547<p>
1548 Use customized color for status colorization. <tt>&lt;slot&gt;</tt> is
1549 one of <tt>header</tt> (the header text of the status message),
1550 <tt>added</tt> or <tt>updated</tt> (files which are added but not committed),
1551 <tt>changed</tt> (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:301552 <tt>untracked</tt> (files which are not tracked by git), or
1553 <tt>nobranch</tt> (the color the <em>no branch</em> warning is shown in, defaulting
1554 to red). The values of these variables may be specified as in
1555 color.branch.&lt;slot&gt;.
Junio C Hamano7ad22dc2007-01-29 02:55:481556</p>
1557</dd>
1558<dt>
Junio C Hamano83d46a22008-02-21 02:29:421559color.ui
1560</dt>
1561<dd>
1562<p>
1563 When set to <tt>always</tt>, always use colors in all git commands which
1564 are capable of colored output. When false (or <tt>never</tt>), never. When
1565 set to <tt>true</tt> or <tt>auto</tt>, use colors only when the output is to the
1566 terminal. When more specific variables of color.* are set, they always
1567 take precedence over this setting. Defaults to false.
1568</p>
1569</dd>
1570<dt>
Junio C Hamano4653c6f2008-11-26 22:50:201571commit.template
1572</dt>
1573<dd>
1574<p>
1575 Specify a file to use as the template for new commit messages.
1576</p>
1577</dd>
1578<dt>
Junio C Hamanodbb64592007-09-01 11:17:391579diff.autorefreshindex
1580</dt>
1581<dd>
1582<p>
Junio C Hamanoba4b9282008-07-06 05:20:311583 When using <em>git-diff</em> to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:391584 files, do not consider stat-only change as changed.
1585 Instead, silently run <tt>git update-index --refresh</tt> to
1586 update the cached stat information for paths whose
1587 contents in the work tree match the contents in the
1588 index. This option defaults to true. Note that this
Junio C Hamanoba4b9282008-07-06 05:20:311589 affects only <em>git-diff</em> Porcelain, and not lower level
1590 <em>diff</em> commands, such as <em>git-diff-files</em>.
Junio C Hamanodbb64592007-09-01 11:17:391591</p>
1592</dd>
1593<dt>
Junio C Hamano1fbbbc12007-12-18 07:01:271594diff.external
1595</dt>
1596<dd>
1597<p>
1598 If this config variable is set, diff generation is not
1599 performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:311600 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
1601 environment variable. The command is called with parameters
1602 as described under "git Diffs" in <a href="git.html">git(1)</a>. Note: if
1603 you want to use an external diff program only on a subset of
1604 your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
Junio C Hamano1fbbbc12007-12-18 07:01:271605</p>
1606</dd>
1607<dt>
Junio C Hamano5e4d8de2008-09-19 06:27:021608diff.mnemonicprefix
1609</dt>
1610<dd>
1611<p>
1612 If set, <em>git-diff</em> uses a prefix pair that is different from the
1613 standard "a/" and "b/" depending on what is being compared. When
1614 this configuration is in effect, reverse diff output also swaps
1615 the order of the prefixes:
1616</p>
1617<div class="vlist"><dl>
1618<dt>
1619<em>git-diff</em>
1620</dt>
1621<dd>
1622<p>
1623 compares the (i)ndex and the (w)ork tree;
1624</p>
1625</dd>
1626<dt>
1627<em>git-diff HEAD</em>
1628</dt>
1629<dd>
1630<p>
1631 compares a (c)ommit and the (w)ork tree;
1632</p>
1633</dd>
1634<dt>
1635<em>git diff --cached</em>
1636</dt>
1637<dd>
1638<p>
1639 compares a (c)ommit and the (i)ndex;
1640</p>
1641</dd>
1642<dt>
1643<em>git-diff HEAD:file1 file2</em>
1644</dt>
1645<dd>
1646<p>
1647 compares an (o)bject and a (w)ork tree entity;
1648</p>
1649</dd>
1650<dt>
1651<em>git diff --no-index a b</em>
1652</dt>
1653<dd>
1654<p>
1655 compares two non-git things (1) and (2).
1656</p>
1657</dd>
1658</dl></div>
1659</dd>
1660<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481661diff.renameLimit
1662</dt>
1663<dd>
1664<p>
1665 The number of files to consider when performing the copy/rename
Junio C Hamanoba4b9282008-07-06 05:20:311666 detection; equivalent to the <em>git-diff</em> option <em>-l</em>.
Junio C Hamano7ad22dc2007-01-29 02:55:481667</p>
1668</dd>
1669<dt>
1670diff.renames
1671</dt>
1672<dd>
1673<p>
1674 Tells git to detect renames. If set to any boolean value, it
1675 will enable basic rename detection. If set to "copies" or
1676 "copy", it will detect copies, as well.
1677</p>
1678</dd>
1679<dt>
Junio C Hamanobc4852e2009-01-21 10:51:141680diff.suppressBlankEmpty
Junio C Hamanof1231492008-12-22 08:27:211681</dt>
1682<dd>
1683<p>
1684 A boolean to inhibit the standard behavior of printing a space
1685 before each empty output line. Defaults to false.
1686</p>
1687</dd>
1688<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481689fetch.unpackLimit
1690</dt>
1691<dd>
1692<p>
1693 If the number of objects fetched over the git native
1694 transfer is below this
1695 limit, then the objects will be unpacked into loose object
1696 files. However if the number of received objects equals or
1697 exceeds this limit then the received pack will be stored as
1698 a pack, after adding any missing delta bases. Storing the
1699 pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171700 especially on slow filesystems. If not set, the value of
1701 <tt>transfer.unpackLimit</tt> is used instead.
Junio C Hamano7ad22dc2007-01-29 02:55:481702</p>
1703</dd>
1704<dt>
Junio C Hamano8c5802d2007-11-15 00:13:361705format.numbered
1706</dt>
1707<dd>
1708<p>
Junio C Hamano7d06a8a2008-10-20 05:42:331709 A boolean which can enable or disable sequence numbers in patch
1710 subjects. It defaults to "auto" which enables it only if there
1711 is more than one patch. It can be enabled or disabled for all
1712 messages by setting it to "true" or "false". See --numbered
1713 option in <a href="git-format-patch.html">git-format-patch(1)</a>.
Junio C Hamano8c5802d2007-11-15 00:13:361714</p>
1715</dd>
1716<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481717format.headers
1718</dt>
1719<dd>
1720<p>
1721 Additional email headers to include in a patch to be submitted
1722 by mail. See <a href="git-format-patch.html">git-format-patch(1)</a>.
1723</p>
1724</dd>
1725<dt>
Junio C Hamanod4c8e112007-03-04 10:32:381726format.suffix
1727</dt>
1728<dd>
1729<p>
1730 The default for format-patch is to output files with the suffix
1731 <tt>.patch</tt>. Use this variable to change that suffix (make sure to
1732 include the dot if you want it).
1733</p>
1734</dd>
1735<dt>
Junio C Hamano86bcccc2008-03-08 09:33:551736format.pretty
1737</dt>
1738<dd>
1739<p>
1740 The default pretty format for log/show/whatchanged command,
1741 See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
1742 <a href="git-whatchanged.html">git-whatchanged(1)</a>.
1743</p>
1744</dd>
1745<dt>
Junio C Hamanof2ce2972007-05-20 19:12:091746gc.aggressiveWindow
1747</dt>
1748<dd>
1749<p>
1750 The window size parameter used in the delta compression
Junio C Hamanoba4b9282008-07-06 05:20:311751 algorithm used by <em>git-gc --aggressive</em>. This defaults
Junio C Hamanof2ce2972007-05-20 19:12:091752 to 10.
1753</p>
1754</dd>
1755<dt>
Junio C Hamano1b50ce92007-10-03 12:05:531756gc.auto
1757</dt>
1758<dd>
1759<p>
1760 When there are approximately more than this many loose
1761 objects in the repository, <tt>git gc --auto</tt> will pack them.
1762 Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171763 light-weight garbage collection from time to time. The
1764 default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531765</p>
1766</dd>
1767<dt>
1768gc.autopacklimit
1769</dt>
1770<dd>
1771<p>
1772 When there are more than this many packs that are not
1773 marked with <tt>*.keep</tt> file in the repository, <tt>git gc
Junio C Hamanoe77b0152008-01-12 06:44:171774 --auto</tt> consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371775 default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531776</p>
1777</dd>
1778<dt>
Junio C Hamano9d52e572007-02-13 23:48:201779gc.packrefs
1780</dt>
1781<dd>
1782<p>
Junio C Hamanoba4b9282008-07-06 05:20:311783 <em>git-gc</em> does not run <tt>git pack-refs</tt> in a bare repository by
Junio C Hamano9d52e572007-02-13 23:48:201784 default so that older dumb-transport clients can still fetch
Junio C Hamanoba4b9282008-07-06 05:20:311785 from the repository. Setting this to <tt>true</tt> lets <em>git-gc</em>
1786 to run <tt>git pack-refs</tt>. Setting this to <tt>false</tt> tells
1787 <em>git-gc</em> never to run <tt>git pack-refs</tt>. The default setting is
Junio C Hamano9d52e572007-02-13 23:48:201788 <tt>notbare</tt>. Enable it only when you know you do not have to
1789 support such clients. The default setting will change to <tt>true</tt>
1790 at some stage, and setting this to <tt>false</tt> will continue to
Junio C Hamanoba4b9282008-07-06 05:20:311791 prevent <tt>git pack-refs</tt> from being run from <em>git-gc</em>.
Junio C Hamano9d52e572007-02-13 23:48:201792</p>
1793</dd>
1794<dt>
Junio C Hamano09a926d2008-03-13 07:55:291795gc.pruneexpire
1796</dt>
1797<dd>
1798<p>
Junio C Hamanoba4b9282008-07-06 05:20:311799 When <em>git-gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>.
Junio C Hamanoa3148f52009-01-14 08:49:571800 Override the grace period with this config variable. The value
1801 "now" may be used to disable this grace period and always prune
1802 unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291803</p>
1804</dd>
1805<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481806gc.reflogexpire
1807</dt>
1808<dd>
1809<p>
Junio C Hamanoba4b9282008-07-06 05:20:311810 <em>git-reflog expire</em> removes reflog entries older than
Junio C Hamano7ad22dc2007-01-29 02:55:481811 this time; defaults to 90 days.
1812</p>
1813</dd>
1814<dt>
1815gc.reflogexpireunreachable
1816</dt>
1817<dd>
1818<p>
Junio C Hamanoba4b9282008-07-06 05:20:311819 <em>git-reflog expire</em> removes reflog entries older than
Junio C Hamano7ad22dc2007-01-29 02:55:481820 this time and are not reachable from the current tip;
1821 defaults to 30 days.
1822</p>
1823</dd>
1824<dt>
1825gc.rerereresolved
1826</dt>
1827<dd>
1828<p>
1829 Records of conflicted merge you resolved earlier are
Junio C Hamanoba4b9282008-07-06 05:20:311830 kept for this many days when <em>git-rerere gc</em> is run.
Junio C Hamano7ad22dc2007-01-29 02:55:481831 The default is 60 days. See <a href="git-rerere.html">git-rerere(1)</a>.
1832</p>
1833</dd>
1834<dt>
1835gc.rerereunresolved
1836</dt>
1837<dd>
1838<p>
1839 Records of conflicted merge you have not resolved are
Junio C Hamanoba4b9282008-07-06 05:20:311840 kept for this many days when <em>git-rerere gc</em> is run.
Junio C Hamano7ad22dc2007-01-29 02:55:481841 The default is 15 days. See <a href="git-rerere.html">git-rerere(1)</a>.
1842</p>
1843</dd>
1844<dt>
Junio C Hamanoa3148f52009-01-14 08:49:571845gitcvs.commitmsgannotation
1846</dt>
1847<dd>
1848<p>
1849 Append this string to each commit message. Set to empty string
1850 to disable this feature. Defaults to "via git-CVS emulator".
1851</p>
1852</dd>
1853<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:481854gitcvs.enabled
1855</dt>
1856<dd>
1857<p>
Junio C Hamanoa6387422007-08-25 03:54:271858 Whether the CVS server interface is enabled for this repository.
Junio C Hamano7ad22dc2007-01-29 02:55:481859 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
1860</p>
1861</dd>
1862<dt>
1863gitcvs.logfile
1864</dt>
1865<dd>
1866<p>
Junio C Hamanoa6387422007-08-25 03:54:271867 Path to a log file where the CVS server interface well&#8230; logs
Junio C Hamano7ad22dc2007-01-29 02:55:481868 various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
1869</p>
1870</dd>
Junio C Hamano17bd2272008-09-01 06:11:171871<dt>
1872gitcvs.usecrlfattr
1873</dt>
1874<dd>
1875<p>
Junio C Hamanodfccbb02008-05-26 01:16:141876 If true, the server will look up the <tt>crlf</tt> attribute for
1877 files to determine the <em>-k</em> modes to use. If <tt>crlf</tt> is set,
1878 the <em>-k</em> mode will be left blank, so cvs clients will
1879 treat it as text. If <tt>crlf</tt> is explicitly unset, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331880 will be set with <em>-kb</em> mode, which suppresses any newline munging
Junio C Hamanodfccbb02008-05-26 01:16:141881 the client might otherwise do. If <tt>crlf</tt> is not specified,
Junio C Hamano17bd2272008-09-01 06:11:171882 then <em>gitcvs.allbinary</em> is used. See <a href="gitattributes.html">gitattributes(5)</a>.
1883</p>
1884</dd>
Junio C Hamano7ad22dc2007-01-29 02:55:481885<dt>
Junio C Hamanod9e0e5d2007-04-14 16:22:041886gitcvs.allbinary
1887</dt>
1888<dd>
1889<p>
Junio C Hamanodfccbb02008-05-26 01:16:141890 This is used if <em>gitcvs.usecrlfattr</em> does not resolve
1891 the correct <em>-kb</em> mode to use. If true, all
1892 unresolved files are sent to the client in
1893 mode <em>-kb</em>. This causes the client to treat them
1894 as binary files, which suppresses any newline munging it
1895 otherwise might do. Alternatively, if it is set to "guess",
1896 then the contents of the file are examined to decide if
1897 it is binary, similar to <em>core.autocrlf</em>.
Junio C Hamanoa2ad99e2007-04-18 09:57:041898</p>
1899</dd>
1900<dt>
1901gitcvs.dbname
1902</dt>
1903<dd>
1904<p>
1905 Database used by git-cvsserver to cache revision information
1906 derived from the git repository. The exact meaning depends on the
1907 used database driver, for SQLite (which is the default driver) this
1908 is a filename. Supports variable substitution (see
1909 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<tt>;</tt>).
1910 Default: <em>%Ggitcvs.%m.sqlite</em>
1911</p>
1912</dd>
1913<dt>
1914gitcvs.dbdriver
1915</dt>
1916<dd>
1917<p>
1918 Used Perl DBI driver. You can specify any available driver
1919 for this here, but it might not work. git-cvsserver is tested
1920 with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
1921 reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
1922 May not contain double colons (<tt>:</tt>). Default: <em>SQLite</em>.
Junio C Hamanod9e0e5d2007-04-14 16:22:041923 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
1924</p>
1925</dd>
1926<dt>
Junio C Hamanoa2ad99e2007-04-18 09:57:041927gitcvs.dbuser, gitcvs.dbpass
1928</dt>
1929<dd>
1930<p>
1931 Database user and password. Only useful if setting <em>gitcvs.dbdriver</em>,
1932 since SQLite has no concept of database users and/or passwords.
1933 <em>gitcvs.dbuser</em> supports variable substitution (see
1934 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
1935</p>
1936</dd>
Junio C Hamanoa74efce2008-04-02 08:39:081937<dt>
1938gitcvs.dbTableNamePrefix
1939</dt>
1940<dd>
1941<p>
1942 Database table name prefix. Prepended to the names of any
1943 database tables used, allowing a single database to be used
1944 for several repositories. Supports variable substitution (see
1945 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). Any non-alphabetic
1946 characters will be replaced with underscores.
1947</p>
1948</dd>
Junio C Hamanoba4b9282008-07-06 05:20:311949</dl></div>
1950<div class="para"><p>All gitcvs variables except for <em>gitcvs.usecrlfattr</em> and
Junio C Hamanodfccbb02008-05-26 01:16:141951<em>gitcvs.allbinary</em> can also be specified as
1952<em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
Junio C Hamanoa6387422007-08-25 03:54:271953is one of "ext" and "pserver") to make them apply only for the given
Junio C Hamanoba4b9282008-07-06 05:20:311954access method.</p></div>
1955<div class="vlist"><dl>
Junio C Hamanoa2ad99e2007-04-18 09:57:041956<dt>
Junio C Hamano6d76d612008-05-09 05:46:081957gui.commitmsgwidth
1958</dt>
1959<dd>
1960<p>
1961 Defines how wide the commit message window is in the
1962 <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
1963</p>
1964</dd>
1965<dt>
1966gui.diffcontext
1967</dt>
1968<dd>
1969<p>
1970 Specifies how many context lines should be used in calls to diff
1971 made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
1972</p>
1973</dd>
1974<dt>
Junio C Hamanod3452a02008-11-15 08:07:551975gui.encoding
1976</dt>
1977<dd>
1978<p>
1979 Specifies the default encoding to use for displaying of
1980 file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
1981 It can be overridden by setting the <em>encoding</em> attribute
1982 for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
1983 If this option is not set, the tools default to the
1984 locale encoding.
1985</p>
1986</dd>
1987<dt>
Junio C Hamano6d76d612008-05-09 05:46:081988gui.matchtrackingbranch
1989</dt>
1990<dd>
1991<p>
1992 Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
1993 default to tracking remote branches with matching names or
1994 not. Default: "false".
1995</p>
1996</dd>
1997<dt>
1998gui.newbranchtemplate
1999</dt>
2000<dd>
2001<p>
2002 Is used as suggested name when creating new branches using the
2003 <a href="git-gui.html">git-gui(1)</a>.
2004</p>
2005</dd>
2006<dt>
2007gui.pruneduringfetch
2008</dt>
2009<dd>
2010<p>
2011 "true" if <a href="git-gui.html">git-gui(1)</a> should prune tracking branches when
2012 performing a fetch. The default value is "false".
2013</p>
2014</dd>
2015<dt>
2016gui.trustmtime
2017</dt>
2018<dd>
2019<p>
2020 Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
2021 timestamp or not. By default the timestamps are not trusted.
2022</p>
2023</dd>
2024<dt>
2025gui.spellingdictionary
2026</dt>
2027<dd>
2028<p>
2029 Specifies the dictionary used for spell checking commit messages in
2030 the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
2031 off.
2032</p>
2033</dd>
2034<dt>
Junio C Hamanod3452a02008-11-15 08:07:552035gui.fastcopyblame
2036</dt>
2037<dd>
2038<p>
2039 If true, <em>git gui blame</em> uses <em>-C</em> instead of <em>-C -C</em> for original
2040 location detection. It makes blame significantly faster on huge
2041 repositories at the expense of less thorough copy detection.
2042</p>
2043</dd>
2044<dt>
2045gui.copyblamethreshold
2046</dt>
2047<dd>
2048<p>
Junio C Hamano610d1762008-11-28 06:27:132049 Specifies the threshold to use in <em>git gui blame</em> original location
Junio C Hamanod3452a02008-11-15 08:07:552050 detection, measured in alphanumeric characters. See the
2051 <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
2052</p>
2053</dd>
2054<dt>
2055gui.blamehistoryctx
2056</dt>
2057<dd>
2058<p>
2059 Specifies the radius of history context in days to show in
2060 <a href="gitk.html">gitk(1)</a> for the selected commit, when the <tt>Show History
2061 Context</tt> menu item is invoked from <em>git gui blame</em>. If this
2062 variable is set to zero, the whole history is shown.
2063</p>
2064</dd>
2065<dt>
Junio C Hamano92d312a2008-12-15 07:22:202066guitool.&lt;name&gt;.cmd
2067</dt>
2068<dd>
2069<p>
2070 Specifies the shell command line to execute when the corresponding item
2071 of the <a href="git-gui.html">git-gui(1)</a> <tt>Tools</tt> menu is invoked. This option is
2072 mandatory for every tool. The command is executed from the root of
2073 the working directory, and in the environment it receives the name of
2074 the tool as <em>GIT_GUITOOL</em>, the name of the currently selected file as
2075 <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
2076 the head is detached, <em>CUR_BRANCH</em> is empty).
2077</p>
2078</dd>
2079<dt>
2080guitool.&lt;name&gt;.needsfile
2081</dt>
2082<dd>
2083<p>
2084 Run the tool only if a diff is selected in the GUI. It guarantees
2085 that <em>FILENAME</em> is not empty.
2086</p>
2087</dd>
2088<dt>
2089guitool.&lt;name&gt;.noconsole
2090</dt>
2091<dd>
2092<p>
2093 Run the command silently, without creating a window to display its
2094 output.
2095</p>
2096</dd>
2097<dt>
2098guitool.&lt;name&gt;.norescan
2099</dt>
2100<dd>
2101<p>
2102 Don't rescan the working directory for changes after the tool
2103 finishes execution.
2104</p>
2105</dd>
2106<dt>
2107guitool.&lt;name&gt;.confirm
2108</dt>
2109<dd>
2110<p>
2111 Show a confirmation dialog before actually running the tool.
2112</p>
2113</dd>
2114<dt>
2115guitool.&lt;name&gt;.argprompt
2116</dt>
2117<dd>
2118<p>
2119 Request a string argument from the user, and pass it to the tool
2120 through the <em>ARGS</em> environment variable. Since requesting an
2121 argument implies confirmation, the <em>confirm</em> option has no effect
2122 if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
2123 the dialog uses a built-in generic prompt; otherwise the exact
2124 value of the variable is used.
2125</p>
2126</dd>
2127<dt>
2128guitool.&lt;name&gt;.revprompt
2129</dt>
2130<dd>
2131<p>
2132 Request a single valid revision from the user, and set the
2133 <em>REVISION</em> environment variable. In other aspects this option
2134 is similar to <em>argprompt</em>, and can be used together with it.
2135</p>
2136</dd>
2137<dt>
2138guitool.&lt;name&gt;.revunmerged
2139</dt>
2140<dd>
2141<p>
2142 Show only unmerged branches in the <em>revprompt</em> subdialog.
2143 This is useful for tools similar to merge or rebase, but not
2144 for things like checkout or reset.
2145</p>
2146</dd>
2147<dt>
2148guitool.&lt;name&gt;.title
2149</dt>
2150<dd>
2151<p>
2152 Specifies the title to use for the prompt dialog. The default
2153 is the tool name.
2154</p>
2155</dd>
2156<dt>
2157guitool.&lt;name&gt;.prompt
2158</dt>
2159<dd>
2160<p>
2161 Specifies the general prompt string to display at the top of
2162 the dialog, before subsections for <em>argprompt</em> and <em>revprompt</em>.
2163 The default value includes the actual command.
2164</p>
2165</dd>
2166<dt>
Junio C Hamano4e272312008-01-08 09:13:212167help.browser
2168</dt>
2169<dd>
2170<p>
2171 Specify the browser that will be used to display help in the
2172 <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
2173</p>
2174</dd>
2175<dt>
2176help.format
2177</dt>
2178<dd>
2179<p>
2180 Override the default help format used by <a href="git-help.html">git-help(1)</a>.
2181 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
2182 the default. <em>web</em> and <em>html</em> are the same.
2183</p>
2184</dd>
2185<dt>
Junio C Hamanof24b8062008-09-09 01:34:392186help.autocorrect
2187</dt>
2188<dd>
2189<p>
2190 Automatically correct and execute mistyped commands after
2191 waiting for the given number of deciseconds (0.1 sec). If more
2192 than one command can be deduced from the entered text, nothing
2193 will be executed. If the value of this option is negative,
2194 the corrected command will be executed immediately. If the
2195 value is 0 - the command will be just shown but not executed.
2196 This is the default.
2197</p>
2198</dd>
2199<dt>
Junio C Hamano58256872007-12-04 08:31:132200http.proxy
2201</dt>
2202<dd>
2203<p>
2204 Override the HTTP proxy, normally configured using the <em>http_proxy</em>
2205 environment variable (see <a href="curl.html">curl(1)</a>). This can be overridden
2206 on a per-remote basis; see remote.&lt;name&gt;.proxy
2207</p>
2208</dd>
2209<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482210http.sslVerify
2211</dt>
2212<dd>
2213<p>
2214 Whether to verify the SSL certificate when fetching or pushing
2215 over HTTPS. Can be overridden by the <em>GIT_SSL_NO_VERIFY</em> environment
2216 variable.
2217</p>
2218</dd>
2219<dt>
2220http.sslCert
2221</dt>
2222<dd>
2223<p>
2224 File containing the SSL certificate when fetching or pushing
2225 over HTTPS. Can be overridden by the <em>GIT_SSL_CERT</em> environment
2226 variable.
2227</p>
2228</dd>
2229<dt>
2230http.sslKey
2231</dt>
2232<dd>
2233<p>
2234 File containing the SSL private key when fetching or pushing
2235 over HTTPS. Can be overridden by the <em>GIT_SSL_KEY</em> environment
2236 variable.
2237</p>
2238</dd>
2239<dt>
2240http.sslCAInfo
2241</dt>
2242<dd>
2243<p>
2244 File containing the certificates to verify the peer with when
2245 fetching or pushing over HTTPS. Can be overridden by the
2246 <em>GIT_SSL_CAINFO</em> environment variable.
2247</p>
2248</dd>
2249<dt>
2250http.sslCAPath
2251</dt>
2252<dd>
2253<p>
2254 Path containing files with the CA certificates to verify the peer
2255 with when fetching or pushing over HTTPS. Can be overridden
2256 by the <em>GIT_SSL_CAPATH</em> environment variable.
2257</p>
2258</dd>
2259<dt>
2260http.maxRequests
2261</dt>
2262<dd>
2263<p>
2264 How many HTTP requests to launch in parallel. Can be overridden
2265 by the <em>GIT_HTTP_MAX_REQUESTS</em> environment variable. Default is 5.
2266</p>
2267</dd>
2268<dt>
2269http.lowSpeedLimit, http.lowSpeedTime
2270</dt>
2271<dd>
2272<p>
2273 If the HTTP transfer speed is less than <em>http.lowSpeedLimit</em>
2274 for longer than <em>http.lowSpeedTime</em> seconds, the transfer is aborted.
2275 Can be overridden by the <em>GIT_HTTP_LOW_SPEED_LIMIT</em> and
2276 <em>GIT_HTTP_LOW_SPEED_TIME</em> environment variables.
2277</p>
2278</dd>
2279<dt>
2280http.noEPSV
2281</dt>
2282<dd>
2283<p>
2284 A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:042285 This can helpful with some "poor" ftp servers which don't
Junio C Hamano7ad22dc2007-01-29 02:55:482286 support EPSV mode. Can be overridden by the <em>GIT_CURL_FTP_NO_EPSV</em>
2287 environment variable. Default is false (curl will use EPSV).
2288</p>
2289</dd>
2290<dt>
2291i18n.commitEncoding
2292</dt>
2293<dd>
2294<p>
2295 Character encoding the commit messages are stored in; git itself
2296 does not care per se, but this information is necessary e.g. when
2297 importing commits from emails or in the gitk graphical history
2298 browser (and possibly at other places in the future or in other
2299 porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
2300</p>
2301</dd>
2302<dt>
2303i18n.logOutputEncoding
2304</dt>
2305<dd>
2306<p>
2307 Character encoding the commit messages are converted to when
Junio C Hamanoba4b9282008-07-06 05:20:312308 running <em>git-log</em> and friends.
Junio C Hamano7ad22dc2007-01-29 02:55:482309</p>
2310</dd>
2311<dt>
Junio C Hamano4653c6f2008-11-26 22:50:202312imap
2313</dt>
2314<dd>
2315<p>
2316 The configuration variables in the <em>imap</em> section are described
2317 in <a href="git-imap-send.html">git-imap-send(1)</a>.
2318</p>
2319</dd>
2320<dt>
Junio C Hamano4e272312008-01-08 09:13:212321instaweb.browser
2322</dt>
2323<dd>
2324<p>
2325 Specify the program that will be used to browse your working
2326 repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
2327</p>
2328</dd>
2329<dt>
2330instaweb.httpd
2331</dt>
2332<dd>
2333<p>
2334 The HTTP daemon command-line to start gitweb on your working
2335 repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
2336</p>
2337</dd>
2338<dt>
2339instaweb.local
2340</dt>
2341<dd>
2342<p>
2343 If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
2344 be bound to the local IP (127.0.0.1).
2345</p>
2346</dd>
2347<dt>
2348instaweb.modulepath
2349</dt>
2350<dd>
2351<p>
2352 The module path for an apache httpd used by <a href="git-instaweb.html">git-instaweb(1)</a>.
2353</p>
2354</dd>
2355<dt>
2356instaweb.port
2357</dt>
2358<dd>
2359<p>
2360 The port number to bind the gitweb httpd to. See
2361 <a href="git-instaweb.html">git-instaweb(1)</a>.
2362</p>
2363</dd>
2364<dt>
Junio C Hamanob713ff12008-05-24 01:12:302365log.date
2366</dt>
2367<dd>
2368<p>
2369 Set default date-time mode for the log command. Setting log.date
Junio C Hamanoba4b9282008-07-06 05:20:312370 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:302371 following alternatives: {relative,local,default,iso,rfc,short}.
2372 See <a href="git-log.html">git-log(1)</a>.
2373</p>
2374</dd>
2375<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482376log.showroot
2377</dt>
2378<dd>
2379<p>
2380 If true, the initial commit will be shown as a big creation event.
2381 This is equivalent to a diff against an empty tree.
2382 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
2383 normally hide the root commit will now show it. True by default.
2384</p>
2385</dd>
2386<dt>
Junio C Hamano8b588d52008-03-15 09:48:372387man.viewer
2388</dt>
2389<dd>
2390<p>
2391 Specify the programs that may be used to display help in the
2392 <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
2393</p>
2394</dd>
2395<dt>
Junio C Hamano4653c6f2008-11-26 22:50:202396man.&lt;tool&gt;.cmd
Junio C Hamano6d76d612008-05-09 05:46:082397</dt>
2398<dd>
2399<p>
Junio C Hamano4653c6f2008-11-26 22:50:202400 Specify the command to invoke the specified man viewer. The
2401 specified command is evaluated in shell with the man page
2402 passed as argument. (See <a href="git-help.html">git-help(1)</a>.)
2403</p>
2404</dd>
2405<dt>
2406man.&lt;tool&gt;.path
2407</dt>
2408<dd>
2409<p>
2410 Override the path for the given tool that may be used to
2411 display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
2412</p>
2413</dd>
2414<dt>
2415merge.conflictstyle
2416</dt>
2417<dd>
2418<p>
2419 Specify the style in which conflicted hunks are written out to
2420 working tree files upon merge. The default is "merge", which
Junio C Hamanoec87f522008-12-10 08:35:252421 shows a <tt>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</tt> conflict marker, changes made by one side,
2422 a <tt>=======</tt> marker, changes made by the other side, and then
2423 a <tt>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</tt> marker. An alternate style, "diff3", adds a <tt>|||||||</tt>
2424 marker and the original text before the <tt>=======</tt> marker.
Junio C Hamano6d76d612008-05-09 05:46:082425</p>
2426</dd>
2427<dt>
2428merge.log
Junio C Hamano7ad22dc2007-01-29 02:55:482429</dt>
2430<dd>
2431<p>
2432 Whether to include summaries of merged commits in newly created
2433 merge commit messages. False by default.
2434</p>
2435</dd>
2436<dt>
Junio C Hamano2fbcd212008-05-14 22:26:072437merge.renameLimit
2438</dt>
2439<dd>
2440<p>
2441 The number of files to consider when performing rename detection
2442 during a merge; if not specified, defaults to the value of
2443 diff.renameLimit.
2444</p>
2445</dd>
2446<dt>
Junio C Hamano4653c6f2008-11-26 22:50:202447merge.stat
2448</dt>
2449<dd>
2450<p>
2451 Whether to print the diffstat between ORIG_HEAD and the merge result
2452 at the end of the merge. True by default.
2453</p>
2454</dd>
2455<dt>
Junio C Hamano103ad7f2007-03-14 11:19:262456merge.tool
2457</dt>
2458<dd>
2459<p>
2460 Controls which merge resolution program is used by
Junio C Hamano86bcccc2008-03-08 09:33:552461 <a href="git-mergetool.html">git-mergetool(1)</a>. Valid built-in values are: "kdiff3",
2462 "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and
2463 "opendiff". Any other value is treated is custom merge tool
Junio C Hamanocb1c44f2008-08-06 06:19:332464 and there must be a corresponding mergetool.&lt;tool&gt;.cmd option.
Junio C Hamano103ad7f2007-03-14 11:19:262465</p>
2466</dd>
2467<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482468merge.verbosity
2469</dt>
2470<dd>
2471<p>
2472 Controls the amount of output shown by the recursive merge
2473 strategy. Level 0 outputs nothing except a final error
2474 message if conflicts were detected. Level 1 outputs only
2475 conflicts, 2 outputs conflicts and file changes. Level 5 and
2476 above outputs debugging information. The default is level 2.
Junio C Hamanoec87f522008-12-10 08:35:252477 Can be overridden by the <em>GIT_MERGE_VERBOSITY</em> environment variable.
Junio C Hamano7ad22dc2007-01-29 02:55:482478</p>
2479</dd>
2480<dt>
Junio C Hamanoe90436a2007-04-22 07:22:132481merge.&lt;driver&gt;.name
2482</dt>
2483<dd>
2484<p>
Junio C Hamanoec87f522008-12-10 08:35:252485 Defines a human-readable name for a custom low-level
Junio C Hamanoe90436a2007-04-22 07:22:132486 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
2487</p>
2488</dd>
2489<dt>
2490merge.&lt;driver&gt;.driver
2491</dt>
2492<dd>
2493<p>
2494 Defines the command that implements a custom low-level
2495 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
2496</p>
2497</dd>
2498<dt>
2499merge.&lt;driver&gt;.recursive
2500</dt>
2501<dd>
2502<p>
2503 Names a low-level merge driver to be used when
2504 performing an internal merge between common ancestors.
2505 See <a href="gitattributes.html">gitattributes(5)</a> for details.
2506</p>
2507</dd>
2508<dt>
Junio C Hamano1fbbbc12007-12-18 07:01:272509mergetool.&lt;tool&gt;.path
2510</dt>
2511<dd>
2512<p>
2513 Override the path for the given tool. This is useful in case
2514 your tool is not in the PATH.
2515</p>
2516</dd>
2517<dt>
Junio C Hamano86bcccc2008-03-08 09:33:552518mergetool.&lt;tool&gt;.cmd
2519</dt>
2520<dd>
2521<p>
2522 Specify the command to invoke the specified merge tool. The
2523 specified command is evaluated in shell with the following
2524 variables available: <em>BASE</em> is the name of a temporary file
2525 containing the common base of the files to be merged, if available;
2526 <em>LOCAL</em> is the name of a temporary file containing the contents of
2527 the file on the current branch; <em>REMOTE</em> is the name of a temporary
2528 file containing the contents of the file from the branch being
2529 merged; <em>MERGED</em> contains the name of the file to which the merge
2530 tool should write the results of a successful merge.
2531</p>
2532</dd>
2533<dt>
2534mergetool.&lt;tool&gt;.trustExitCode
2535</dt>
2536<dd>
2537<p>
2538 For a custom merge command, specify whether the exit code of
2539 the merge command can be used to determine whether the merge was
2540 successful. If this is not set to true then the merge target file
2541 timestamp is checked and the merge assumed to have been successful
2542 if the file has been updated, otherwise the user is prompted to
2543 indicate the success of the merge.
2544</p>
2545</dd>
2546<dt>
2547mergetool.keepBackup
2548</dt>
2549<dd>
2550<p>
2551 After performing a merge, the original file with conflict markers
2552 can be saved as a file with a <tt>.orig</tt> extension. If this variable
2553 is set to <tt>false</tt> then this file is not preserved. Defaults to
2554 <tt>true</tt> (i.e. keep the backup files).
2555</p>
2556</dd>
2557<dt>
Junio C Hamano10b7a342009-01-01 22:05:172558mergetool.keepTemporaries
2559</dt>
2560<dd>
2561<p>
2562 When invoking a custom merge tool, git uses a set of temporary
2563 files to pass to the tool. If the tool returns an error and this
2564 variable is set to <tt>true</tt>, then these temporary files will be
2565 preserved, otherwise they will be removed after the tool has
2566 exited. Defaults to <tt>false</tt>.
2567</p>
2568</dd>
2569<dt>
2570mergetool.prompt
2571</dt>
2572<dd>
2573<p>
2574 Prompt before each invocation of the merge resolution program.
2575</p>
2576</dd>
2577<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482578pack.window
2579</dt>
2580<dd>
2581<p>
2582 The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
2583 window size is given on the command line. Defaults to 10.
2584</p>
2585</dd>
2586<dt>
Junio C Hamano91d44c52007-05-09 07:16:072587pack.depth
2588</dt>
2589<dd>
2590<p>
2591 The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
2592 maximum depth is given on the command line. Defaults to 50.
2593</p>
2594</dd>
2595<dt>
Junio C Hamano235d53f2007-07-13 00:25:152596pack.windowMemory
2597</dt>
2598<dd>
2599<p>
2600 The window memory size limit used by <a href="git-pack-objects.html">git-pack-objects(1)</a>
2601 when no limit is given on the command line. The value can be
2602 suffixed with "k", "m", or "g". Defaults to 0, meaning no
2603 limit.
2604</p>
2605</dd>
2606<dt>
Junio C Hamanof2ce2972007-05-20 19:12:092607pack.compression
2608</dt>
2609<dd>
2610<p>
2611 An integer -1..9, indicating the compression level for objects
2612 in a pack file. -1 is the zlib default. 0 means no
2613 compression, and 1..9 are various speed/size tradeoffs, 9 being
2614 slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:422615 not set, defaults to -1, the zlib default, which is "a default
2616 compromise between speed and compression (currently equivalent
2617 to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:092618</p>
2619</dd>
2620<dt>
Junio C Hamano679d22d2007-06-02 21:13:442621pack.deltaCacheSize
2622</dt>
2623<dd>
2624<p>
Junio C Hamanoa6387422007-08-25 03:54:272625 The maximum memory in bytes used for caching deltas in
Junio C Hamano679d22d2007-06-02 21:13:442626 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
2627 A value of 0 means no limit. Defaults to 0.
2628</p>
2629</dd>
2630<dt>
2631pack.deltaCacheLimit
2632</dt>
2633<dd>
2634<p>
Junio C Hamano58155b42007-09-15 07:46:142635 The maximum size of a delta, that is cached in
Junio C Hamano679d22d2007-06-02 21:13:442636 <a href="git-pack-objects.html">git-pack-objects(1)</a>. Defaults to 1000.
2637</p>
2638</dd>
2639<dt>
Junio C Hamano58155b42007-09-15 07:46:142640pack.threads
2641</dt>
2642<dd>
2643<p>
2644 Specifies the number of threads to spawn when searching for best
2645 delta matches. This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
2646 be compiled with pthreads otherwise this option is ignored with a
2647 warning. This is meant to reduce packing time on multiprocessor
2648 machines. The required amount of memory for the delta search window
2649 is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:442650 Specifying 0 will cause git to auto-detect the number of CPU's
2651 and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:142652</p>
2653</dd>
2654<dt>
Junio C Hamanod814b6d2007-11-04 11:13:492655pack.indexVersion
2656</dt>
2657<dd>
2658<p>
2659 Specify the default pack index version. Valid values are 1 for
2660 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2661 the new pack index with capabilities for packs larger than 4 GB
2662 as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:382663 packs. Version 2 is the default. Note that version 2 is enforced
2664 and this config option ignored whenever the corresponding pack is
2665 larger than 2 GB.
Junio C Hamanod814b6d2007-11-04 11:13:492666</p>
Junio C Hamanoba4b9282008-07-06 05:20:312667<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:382668cloning or fetching over a non native protocol (e.g. "http" and "rsync")
2669that will copy both <tt>&#42;.pack</tt> file and corresponding <tt>&#42;.idx</tt> file from the
2670other side may give you a repository that cannot be accessed with your
2671older version of git. If the <tt>&#42;.pack</tt> file is smaller than 2 GB, however,
2672you 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:312673the <tt>&#42;.idx</tt> file.</p></div>
Junio C Hamanod814b6d2007-11-04 11:13:492674</dd>
Junio C Hamano09a926d2008-03-13 07:55:292675<dt>
2676pack.packSizeLimit
2677</dt>
2678<dd>
2679<p>
Junio C Hamano49dccaf2008-02-10 10:48:012680 The default maximum size of a pack. This setting only affects
2681 packing to a file, i.e. the git:// protocol is unaffected. It
2682 can be overridden by the <tt>--max-pack-size</tt> option of
Junio C Hamano09a926d2008-03-13 07:55:292683 <a href="git-repack.html">git-repack(1)</a>.
2684</p>
2685</dd>
Junio C Hamanod814b6d2007-11-04 11:13:492686<dt>
Junio C Hamano9e96a1a2008-08-16 10:23:182687pager.&lt;cmd&gt;
2688</dt>
2689<dd>
2690<p>
Junio C Hamano0551f6a2008-08-25 00:33:332691 Allows turning on or off pagination of the output of a
2692 particular git subcommand when writing to a tty. If
2693 <tt>--paginate</tt> or <tt>--no-pager</tt> is specified on the command line,
2694 it takes precedence over this option. To disable pagination for
2695 all commands, set <tt>core.pager</tt> or <em>GIT_PAGER</em> to "<tt>cat</tt>".
Junio C Hamano9e96a1a2008-08-16 10:23:182696</p>
2697</dd>
2698<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482699pull.octopus
2700</dt>
2701<dd>
2702<p>
2703 The default merge strategy to use when pulling multiple branches
2704 at once.
2705</p>
2706</dd>
2707<dt>
2708pull.twohead
2709</dt>
2710<dd>
2711<p>
2712 The default merge strategy to use when pulling a single branch.
2713</p>
2714</dd>
2715<dt>
Junio C Hamano4653c6f2008-11-26 22:50:202716receive.fsckObjects
2717</dt>
2718<dd>
2719<p>
2720 If it is set to true, git-receive-pack will check all received
2721 objects. It will abort in the case of a malformed object or a
2722 broken link. The result of an abort are only dangling objects.
2723 Defaults to false.
2724</p>
2725</dd>
2726<dt>
2727receive.unpackLimit
2728</dt>
2729<dd>
2730<p>
2731 If the number of objects received in a push is below this
2732 limit then the objects will be unpacked into loose object
2733 files. However if the number of received objects equals or
2734 exceeds this limit then the received pack will be stored as
2735 a pack, after adding any missing delta bases. Storing the
2736 pack from a push can make the push operation complete faster,
2737 especially on slow filesystems. If not set, the value of
2738 <tt>transfer.unpackLimit</tt> is used instead.
2739</p>
2740</dd>
2741<dt>
2742receive.denyDeletes
2743</dt>
2744<dd>
2745<p>
2746 If set to true, git-receive-pack will deny a ref update that deletes
2747 the ref. Use this to prevent such a ref deletion via a push.
2748</p>
2749</dd>
2750<dt>
2751receive.denyCurrentBranch
2752</dt>
2753<dd>
2754<p>
2755 If set to true or "refuse", receive-pack will deny a ref update
2756 to the currently checked out branch of a non-bare repository.
2757 Such a push is potentially dangerous because it brings the HEAD
2758 out of sync with the index and working tree. If set to "warn",
2759 print a warning of such a push to stderr, but allow the push to
2760 proceed. If set to false or "ignore", allow such pushes with no
2761 message. Defaults to "warn".
2762</p>
2763</dd>
2764<dt>
2765receive.denyNonFastForwards
2766</dt>
2767<dd>
2768<p>
2769 If set to true, git-receive-pack will deny a ref update which is
2770 not a fast forward. Use this to prevent such an update via a push,
2771 even if that push is forced. This configuration variable is
2772 set when initializing a shared repository.
2773</p>
2774</dd>
2775<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482776remote.&lt;name&gt;.url
2777</dt>
2778<dd>
2779<p>
2780 The URL of a remote repository. See <a href="git-fetch.html">git-fetch(1)</a> or
2781 <a href="git-push.html">git-push(1)</a>.
2782</p>
2783</dd>
2784<dt>
Junio C Hamano58256872007-12-04 08:31:132785remote.&lt;name&gt;.proxy
2786</dt>
2787<dd>
2788<p>
2789 For remotes that require curl (http, https and ftp), the URL to
2790 the proxy to use for that remote. Set to the empty string to
2791 disable proxying for that remote.
2792</p>
2793</dd>
2794<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482795remote.&lt;name&gt;.fetch
2796</dt>
2797<dd>
2798<p>
2799 The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
2800 <a href="git-fetch.html">git-fetch(1)</a>.
2801</p>
2802</dd>
2803<dt>
2804remote.&lt;name&gt;.push
2805</dt>
2806<dd>
2807<p>
2808 The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
2809 <a href="git-push.html">git-push(1)</a>.
2810</p>
2811</dd>
2812<dt>
Junio C Hamano47d68a52008-05-06 06:35:402813remote.&lt;name&gt;.mirror
2814</dt>
2815<dd>
2816<p>
2817 If true, pushing to this remote will automatically behave
2818 as if the <tt>--mirror</tt> option was given on the command line.
2819</p>
2820</dd>
2821<dt>
Junio C Hamano118d2772007-02-21 20:24:102822remote.&lt;name&gt;.skipDefaultUpdate
2823</dt>
2824<dd>
2825<p>
2826 If true, this remote will be skipped by default when updating
Junio C Hamano618bdde2008-01-02 10:51:082827 using the update subcommand of <a href="git-remote.html">git-remote(1)</a>.
Junio C Hamano118d2772007-02-21 20:24:102828</p>
2829</dd>
2830<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482831remote.&lt;name&gt;.receivepack
2832</dt>
2833<dd>
2834<p>
2835 The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:552836 option --receive-pack of <a href="git-push.html">git-push(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:482837</p>
2838</dd>
2839<dt>
2840remote.&lt;name&gt;.uploadpack
2841</dt>
2842<dd>
2843<p>
2844 The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:552845 option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:482846</p>
2847</dd>
2848<dt>
Junio C Hamano17dde0e2007-02-26 09:50:212849remote.&lt;name&gt;.tagopt
2850</dt>
2851<dd>
2852<p>
Junio C Hamano86bcccc2008-03-08 09:33:552853 Setting this value to --no-tags disables automatic tag following when
2854 fetching from remote &lt;name&gt;
Junio C Hamano17dde0e2007-02-26 09:50:212855</p>
2856</dd>
2857<dt>
Junio C Hamano118d2772007-02-21 20:24:102858remotes.&lt;group&gt;
2859</dt>
2860<dd>
2861<p>
2862 The list of remotes which are fetched by "git remote update
2863 &lt;group&gt;". See <a href="git-remote.html">git-remote(1)</a>.
2864</p>
2865</dd>
2866<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482867repack.usedeltabaseoffset
2868</dt>
2869<dd>
2870<p>
Junio C Hamanofce7c7e2008-07-02 03:06:382871 By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
2872 delta-base offset. If you need to share your repository with
2873 git older than version 1.4.4, either directly or via a dumb
2874 protocol such as http, then you need to set this option to
2875 "false" and repack. Access from old git versions over the
2876 native protocol are unaffected by this option.
Junio C Hamano7ad22dc2007-01-29 02:55:482877</p>
2878</dd>
2879<dt>
Junio C Hamano4653c6f2008-11-26 22:50:202880rerere.autoupdate
2881</dt>
2882<dd>
2883<p>
2884 When set to true, <tt>git-rerere</tt> updates the index with the
2885 resulting contents after it cleanly resolves conflicts using
2886 previously recorded resolution. Defaults to false.
2887</p>
2888</dd>
2889<dt>
2890rerere.enabled
2891</dt>
2892<dd>
2893<p>
2894 Activate recording of resolved conflicts, so that identical
2895 conflict hunks can be resolved automatically, should they
2896 be encountered again. <a href="git-rerere.html">git-rerere(1)</a> command is by
2897 default enabled if you create <tt>rr-cache</tt> directory under
2898 <tt>$GIT_DIR</tt>, but can be disabled by setting this option to false.
2899</p>
2900</dd>
2901<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482902showbranch.default
2903</dt>
2904<dd>
2905<p>
2906 The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
2907 See <a href="git-show-branch.html">git-show-branch(1)</a>.
2908</p>
2909</dd>
2910<dt>
Junio C Hamano942b35e2007-12-09 10:19:332911status.relativePaths
2912</dt>
2913<dd>
2914<p>
2915 By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
2916 current directory. Setting this variable to <tt>false</tt> shows paths
2917 relative to the repository root (this was the default for git
2918 prior to v1.5.4).
2919</p>
2920</dd>
2921<dt>
Junio C Hamano4224f992008-06-23 07:14:082922status.showUntrackedFiles
2923</dt>
2924<dd>
2925<p>
2926 By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
2927 files which are not currently tracked by Git. Directories which
2928 contain only untracked files, are shown with the directory name
2929 only. Showing untracked files means that Git needs to lstat() all
2930 all the files in the whole repository, which might be slow on some
2931 systems. So, this variable controls how the commands displays
2932 the untracked files. Possible values are:
2933</p>
Junio C Hamanoba4b9282008-07-06 05:20:312934<div class="ilist"><ul>
Junio C Hamano4224f992008-06-23 07:14:082935<li>
2936<p>
2937<em>no</em> - Show no untracked files
2938</p>
2939</li>
2940<li>
2941<p>
2942<em>normal</em> - Shows untracked files and directories
2943</p>
2944</li>
2945<li>
2946<p>
2947<em>all</em> - Shows also individual files in untracked directories.
2948</p>
2949</li>
Junio C Hamanoba4b9282008-07-06 05:20:312950</ul></div>
2951<div class="para"><p>If this variable is not specified, it defaults to <em>normal</em>.
Junio C Hamano4224f992008-06-23 07:14:082952This variable can be overridden with the -u|--untracked-files option
Junio C Hamanoba4b9282008-07-06 05:20:312953of <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:082954</dd>
2955<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482956tar.umask
2957</dt>
2958<dd>
2959<p>
Junio C Hamanobdebabb2007-08-23 00:25:092960 This variable can be used to restrict the permission bits of
2961 tar archive entries. The default is 0002, which turns off the
2962 world write bit. The special value "user" indicates that the
2963 archiving user's umask will be used instead. See umask(2) and
2964 <a href="git-archive.html">git-archive(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:482965</p>
2966</dd>
2967<dt>
Junio C Hamano4653c6f2008-11-26 22:50:202968transfer.unpackLimit
2969</dt>
2970<dd>
2971<p>
2972 When <tt>fetch.unpackLimit</tt> or <tt>receive.unpackLimit</tt> are
2973 not set, the value of this variable is used instead.
2974 The default value is 100.
2975</p>
2976</dd>
2977<dt>
Junio C Hamano24bc09a2008-02-28 00:27:442978url.&lt;base&gt;.insteadOf
2979</dt>
2980<dd>
2981<p>
2982 Any URL that starts with this value will be rewritten to
2983 start, instead, with &lt;base&gt;. In cases where some site serves a
2984 large number of repositories, and serves them with multiple
2985 access methods, and some users need to use different access
2986 methods, this feature allows people to specify any of the
2987 equivalent URLs and have git automatically rewrite the URL to
2988 the best alternative for the particular user, even for a
2989 never-before-seen repository on the site. When more than one
2990 insteadOf strings match a given URL, the longest match is used.
2991</p>
2992</dd>
2993<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:482994user.email
2995</dt>
2996<dd>
2997<p>
2998 Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:342999 Can be overridden by the <em>GIT_AUTHOR_EMAIL</em>, <em>GIT_COMMITTER_EMAIL</em>, and
3000 <em>EMAIL</em> environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
Junio C Hamano7ad22dc2007-01-29 02:55:483001</p>
3002</dd>
3003<dt>
3004user.name
3005</dt>
3006<dd>
3007<p>
3008 Your full name to be recorded in any newly created commits.
3009 Can be overridden by the <em>GIT_AUTHOR_NAME</em> and <em>GIT_COMMITTER_NAME</em>
3010 environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
3011</p>
3012</dd>
3013<dt>
3014user.signingkey
3015</dt>
3016<dd>
3017<p>
3018 If <a href="git-tag.html">git-tag(1)</a> is not selecting the key you want it to
3019 automatically when creating a signed tag, you can override the
3020 default selection with this variable. This option is passed
3021 unchanged to gpg's --local-user parameter, so you may specify a key
3022 using any method that gpg supports.
3023</p>
3024</dd>
3025<dt>
Junio C Hamano4e272312008-01-08 09:13:213026web.browser
3027</dt>
3028<dd>
3029<p>
3030 Specify a web browser that may be used by some commands.
3031 Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
3032 may use it.
3033</p>
3034</dd>
Junio C Hamanoba4b9282008-07-06 05:20:313035</dl></div>
Junio C Hamano7ad22dc2007-01-29 02:55:483036</div>
Junio C Hamanoba4b9282008-07-06 05:20:313037<h2 id="_author">Author</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:483038<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:313039<div class="para"><p>Written by Johannes Schindelin &lt;Johannes.Schindelin@gmx.de&gt;</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:483040</div>
Junio C Hamanoba4b9282008-07-06 05:20:313041<h2 id="_documentation">Documentation</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:483042<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:313043<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:483044</div>
Junio C Hamanoba4b9282008-07-06 05:20:313045<h2 id="_git">GIT</h2>
Junio C Hamano7ad22dc2007-01-29 02:55:483046<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:313047<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano7ad22dc2007-01-29 02:55:483048</div>
3049<div id="footer">
3050<div id="footer-text">
Junio C Hamanobc4852e2009-01-21 10:51:143051Last updated 2009-01-21 10:51:01 UTC
Junio C Hamano7ad22dc2007-01-29 02:55:483052</div>
3053</div>
3054</body>
3055</html>