Autogenerated HTML docs for v1.6.5.2-74-g610f9
[git/jnareb-git.git] / git-config.html
blob11b50fe99cc108059a3c8d6c7d6313ff3c3ca9d8
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.2.5" />
7 <style type="text/css">
8 /* Debug borders */
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11 border: 1px solid red;
15 body {
16 margin: 1em 5% 1em 5%;
19 a {
20 color: blue;
21 text-decoration: underline;
23 a:visited {
24 color: fuchsia;
27 em {
28 font-style: italic;
31 strong {
32 font-weight: bold;
35 tt {
36 color: navy;
39 h1, 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;
47 h1, h2, h3 {
48 border-bottom: 2px solid silver;
50 h2 {
51 padding-top: 0.5em;
53 h3 {
54 float: left;
56 h3 + * {
57 clear: left;
60 div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
65 hr {
66 border: 1px solid silver;
69 p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
74 pre {
75 padding: 0;
76 margin: 0;
79 span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
83 font-size: 1.1em;
85 span#email {
87 span#revision {
88 font-family: sans-serif;
91 div#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;
98 div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
102 div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
107 div#preamble,
108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110 div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
115 div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
120 div.content { /* Block element content. */
121 padding: 0;
124 /* Block element titles. */
125 div.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;
132 div.title + * {
133 margin-top: 0;
136 td div.title:first-child {
137 margin-top: 0.0em;
139 div.content div.title:first-child {
140 margin-top: 0.0em;
142 div.content + div.title {
143 margin-top: 0.0em;
146 div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
152 div.listingblock {
153 margin-right: 0%;
155 div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
161 div.quoteblock > div.content {
162 padding-left: 2.0em;
165 div.attribution {
166 text-align: right;
168 div.verseblock + div.attribution {
169 text-align: left;
172 div.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;
180 div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
185 div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
190 div.verseblock div.content {
191 white-space: pre;
194 div.imageblock div.content { padding-left: 0; }
195 div.imageblock img { border: 1px solid silver; }
196 span.image img { border-style: none; }
198 dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
202 dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
207 dd > *:first-child {
208 margin-top: 0;
211 ul, ol {
212 list-style-position: outside;
214 div.olist2 ol {
215 list-style-type: lower-alpha;
218 div.tableblock > table {
219 border: 3px solid #527bbd;
221 thead {
222 font-family: sans-serif;
223 font-weight: bold;
225 tfoot {
226 font-weight: bold;
229 div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
233 div.hlist td {
234 padding-bottom: 5px;
236 td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
241 td.hlist2 {
242 vertical-align: top;
245 @media print {
246 div#footer-badges { display: none; }
249 div#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;
258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
262 div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
266 div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
270 div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
274 include1::./stylesheets/xhtml11-manpage.css[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
282 div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
289 div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
295 div.quoteblock-content {
296 padding-left: 2.0em;
299 div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc a:visited { color: blue; }
306 </style>
307 <title>git-config(1)</title>
308 </head>
309 <body>
310 <div id="header">
311 <h1>
312 git-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">
324 <div class="content"><em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] name [value [value_regex]]
325 <em>git config</em> [&lt;file-option&gt;] [type] --add name value
326 <em>git config</em> [&lt;file-option&gt;] [type] --replace-all name value [value_regex]
327 <em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get name [value_regex]
328 <em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get-all name [value_regex]
329 <em>git config</em> [&lt;file-option&gt;] [type] [-z|--null] --get-regexp name_regex [value_regex]
330 <em>git config</em> [&lt;file-option&gt;] --unset name [value_regex]
331 <em>git config</em> [&lt;file-option&gt;] --unset-all name [value_regex]
332 <em>git config</em> [&lt;file-option&gt;] --rename-section old_name new_name
333 <em>git config</em> [&lt;file-option&gt;] --remove-section name
334 <em>git config</em> [&lt;file-option&gt;] [-z|--null] -l | --list
335 <em>git config</em> [&lt;file-option&gt;] --get-color name [default]
336 <em>git config</em> [&lt;file-option&gt;] --get-colorbool name [stdout-is-tty]
337 <em>git config</em> [&lt;file-option&gt;] -e | --edit</div></div>
338 </div>
339 <h2 id="_description">DESCRIPTION</h2>
340 <div class="sectionbody">
341 <div class="para"><p>You can query/set/replace/unset options with this command. The name is
342 actually the section and the key separated by a dot, and the value will be
343 escaped.</p></div>
344 <div class="para"><p>Multiple lines can be added to an option by using the <em>--add</em> option.
345 If you want to update or unset an option which can occur on multiple
346 lines, a POSIX regexp <tt>value_regex</tt> needs to be given. Only the
347 existing values that match the regexp are updated or unset. If
348 you want to handle the lines that do <strong>not</strong> match the regex, just
349 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>).</p></div>
350 <div class="para"><p>The type specifier can be either <em>--int</em> or <em>--bool</em>, which will make
351 <em>git-config</em> ensure that the variable(s) are of the given type and
352 convert the value to the canonical form (simple decimal number for int,
353 a "true" or "false" string for bool). If no type specifier is passed,
354 no checks or transformations are performed on the value.</p></div>
355 <div class="para"><p>The file-option can be one of <em>--system</em>, <em>--global</em> or <em>--file</em>
356 which specify where the values will be read from or written to.
357 The default is to assume the config file of the current repository,
358 .git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
359 (see <a href="#FILES">[FILES]</a>).</p></div>
360 <div class="para"><p>This command will fail if:</p></div>
361 <div class="olist"><ol>
362 <li>
364 The config file is invalid,
365 </p>
366 </li>
367 <li>
369 Can not write to the config file,
370 </p>
371 </li>
372 <li>
374 no section was provided,
375 </p>
376 </li>
377 <li>
379 the section or key is invalid,
380 </p>
381 </li>
382 <li>
384 you try to unset an option which does not exist,
385 </p>
386 </li>
387 <li>
389 you try to unset/set an option for which multiple lines match, or
390 </p>
391 </li>
392 <li>
394 you use <em>--global</em> option without $HOME being properly set.
395 </p>
396 </li>
397 </ol></div>
398 </div>
399 <h2 id="_options">OPTIONS</h2>
400 <div class="sectionbody">
401 <div class="vlist"><dl>
402 <dt>
403 --replace-all
404 </dt>
405 <dd>
407 Default behavior is to replace at most one line. This replaces
408 all lines matching the key (and optionally the value_regex).
409 </p>
410 </dd>
411 <dt>
412 --add
413 </dt>
414 <dd>
416 Adds a new line to the option without altering any existing
417 values. This is the same as providing <em>^$</em> as the value_regex
418 in <tt>--replace-all</tt>.
419 </p>
420 </dd>
421 <dt>
422 --get
423 </dt>
424 <dd>
426 Get the value for a given key (optionally filtered by a regex
427 matching the value). Returns error code 1 if the key was not
428 found and error code 2 if multiple key values were found.
429 </p>
430 </dd>
431 <dt>
432 --get-all
433 </dt>
434 <dd>
436 Like get, but does not fail if the number of values for the key
437 is not exactly one.
438 </p>
439 </dd>
440 <dt>
441 --get-regexp
442 </dt>
443 <dd>
445 Like --get-all, but interprets the name as a regular expression.
446 Also outputs the key names.
447 </p>
448 </dd>
449 <dt>
450 --global
451 </dt>
452 <dd>
454 For writing options: write to global ~/.gitconfig file rather than
455 the repository .git/config.
456 </p>
457 <div class="para"><p>For reading options: read only from global ~/.gitconfig rather than
458 from all available files.</p></div>
459 <div class="para"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
460 </dd>
461 <dt>
462 --system
463 </dt>
464 <dd>
466 For writing options: write to system-wide $(prefix)/etc/gitconfig
467 rather than the repository .git/config.
468 </p>
469 <div class="para"><p>For reading options: read only from system-wide $(prefix)/etc/gitconfig
470 rather than from all available files.</p></div>
471 <div class="para"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
472 </dd>
473 <dt>
474 -f config-file
475 </dt>
476 <dt>
477 --file config-file
478 </dt>
479 <dd>
481 Use the given config file instead of the one specified by GIT_CONFIG.
482 </p>
483 </dd>
484 <dt>
485 --remove-section
486 </dt>
487 <dd>
489 Remove the given section from the configuration file.
490 </p>
491 </dd>
492 <dt>
493 --rename-section
494 </dt>
495 <dd>
497 Rename the given section to a new name.
498 </p>
499 </dd>
500 <dt>
501 --unset
502 </dt>
503 <dd>
505 Remove the line matching the key from config file.
506 </p>
507 </dd>
508 <dt>
509 --unset-all
510 </dt>
511 <dd>
513 Remove all lines matching the key from config file.
514 </p>
515 </dd>
516 <dt>
518 </dt>
519 <dt>
520 --list
521 </dt>
522 <dd>
524 List all variables set in config file.
525 </p>
526 </dd>
527 <dt>
528 --bool
529 </dt>
530 <dd>
532 <em>git-config</em> will ensure that the output is "true" or "false"
533 </p>
534 </dd>
535 <dt>
536 --int
537 </dt>
538 <dd>
540 <em>git-config</em> will ensure that the output is a simple
541 decimal number. An optional value suffix of <em>k</em>, <em>m</em>, or <em>g</em>
542 in the config file will cause the value to be multiplied
543 by 1024, 1048576, or 1073741824 prior to output.
544 </p>
545 </dd>
546 <dt>
547 --bool-or-int
548 </dt>
549 <dd>
551 <em>git-config</em> will ensure that the output matches the format of
552 either --bool or --int, as described above.
553 </p>
554 </dd>
555 <dt>
557 </dt>
558 <dt>
559 --null
560 </dt>
561 <dd>
563 For all options that output values and/or keys, always
564 end values with the null character (instead of a
565 newline). Use newline instead as a delimiter between
566 key and value. This allows for secure parsing of the
567 output without getting confused e.g. by values that
568 contain line breaks.
569 </p>
570 </dd>
571 <dt>
572 --get-colorbool name [stdout-is-tty]
573 </dt>
574 <dd>
576 Find the color setting for <tt>name</tt> (e.g. <tt>color.diff</tt>) and output
577 "true" or "false". <tt>stdout-is-tty</tt> should be either "true" or
578 "false", and is taken into account when configuration says
579 "auto". If <tt>stdout-is-tty</tt> is missing, then checks the standard
580 output of the command itself, and exits with status 0 if color
581 is to be used, or exits with status 1 otherwise.
582 When the color setting for <tt>name</tt> is undefined, the command uses
583 <tt>color.ui</tt> as fallback.
584 </p>
585 </dd>
586 <dt>
587 --get-color name [default]
588 </dt>
589 <dd>
591 Find the color configured for <tt>name</tt> (e.g. <tt>color.diff.new</tt>) and
592 output it as the ANSI color escape sequence to the standard
593 output. The optional <tt>default</tt> parameter is used instead, if
594 there is no color configured for <tt>name</tt>.
595 </p>
596 </dd>
597 <dt>
599 </dt>
600 <dt>
601 --edit
602 </dt>
603 <dd>
605 Opens an editor to modify the specified config file; either
606 <em>--system</em>, <em>--global</em>, or repository (default).
607 </p>
608 </dd>
609 </dl></div>
610 </div>
611 <h2 id="FILES">FILES</h2>
612 <div class="sectionbody">
613 <div class="para"><p>If not set explicitly with <em>--file</em>, there are three files where
614 <em>git-config</em> will search for configuration options:</p></div>
615 <div class="vlist"><dl>
616 <dt>
617 $GIT_DIR/config
618 </dt>
619 <dd>
621 Repository specific configuration file. (The filename is
622 of course relative to the repository root, not the working
623 directory.)
624 </p>
625 </dd>
626 <dt>
627 ~/.gitconfig
628 </dt>
629 <dd>
631 User-specific configuration file. Also called "global"
632 configuration file.
633 </p>
634 </dd>
635 <dt>
636 $(prefix)/etc/gitconfig
637 </dt>
638 <dd>
640 System-wide configuration file.
641 </p>
642 </dd>
643 </dl></div>
644 <div class="para"><p>If no further options are given, all reading options will read all of these
645 files that are available. If the global or the system-wide configuration
646 file are not available they will be ignored. If the repository configuration
647 file is not available or readable, <em>git-config</em> will exit with a non-zero
648 error code. However, in neither case will an error message be issued.</p></div>
649 <div class="para"><p>All writing options will per default write to the repository specific
650 configuration file. Note that this also affects options like <em>--replace-all</em>
651 and <em>--unset</em>. <strong><em>git-config</em> will only ever change one file at a time</strong>.</p></div>
652 <div class="para"><p>You can override these rules either by command line options or by environment
653 variables. The <em>--global</em> and the <em>--system</em> options will limit the file used
654 to the global or system-wide file respectively. The GIT_CONFIG environment
655 variable has a similar effect, but you can specify any filename you want.</p></div>
656 </div>
657 <h2 id="_environment">ENVIRONMENT</h2>
658 <div class="sectionbody">
659 <div class="vlist"><dl>
660 <dt>
661 GIT_CONFIG
662 </dt>
663 <dd>
665 Take the configuration from the given file instead of .git/config.
666 Using the "--global" option forces this to ~/.gitconfig. Using the
667 "--system" option forces this to $(prefix)/etc/gitconfig.
668 </p>
669 </dd>
670 </dl></div>
671 <div class="para"><p>See also <a href="#FILES">[FILES]</a>.</p></div>
672 </div>
673 <h2 id="EXAMPLES">EXAMPLES</h2>
674 <div class="sectionbody">
675 <div class="para"><p>Given a .git/config like this:</p></div>
676 <div class="literalblock">
677 <div class="content">
678 <pre><tt>#
679 # This is the config file, and
680 # a '#' or ';' character indicates
681 # a comment
682 #</tt></pre>
683 </div></div>
684 <div class="literalblock">
685 <div class="content">
686 <pre><tt>; core variables
687 [core]
688 ; Don't trust file modes
689 filemode = false</tt></pre>
690 </div></div>
691 <div class="literalblock">
692 <div class="content">
693 <pre><tt>; Our diff algorithm
694 [diff]
695 external = /usr/local/bin/diff-wrapper
696 renames = true</tt></pre>
697 </div></div>
698 <div class="literalblock">
699 <div class="content">
700 <pre><tt>; Proxy settings
701 [core]
702 gitproxy="proxy-command" for kernel.org
703 gitproxy=default-proxy ; for all the rest</tt></pre>
704 </div></div>
705 <div class="para"><p>you can set the filemode to true with</p></div>
706 <div class="listingblock">
707 <div class="content">
708 <pre><tt>% git config core.filemode true</tt></pre>
709 </div></div>
710 <div class="para"><p>The hypothetical proxy command entries actually have a postfix to discern
711 what URL they apply to. Here is how to change the entry for kernel.org
712 to "ssh".</p></div>
713 <div class="listingblock">
714 <div class="content">
715 <pre><tt>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</tt></pre>
716 </div></div>
717 <div class="para"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
718 <div class="para"><p>To delete the entry for renames, do</p></div>
719 <div class="listingblock">
720 <div class="content">
721 <pre><tt>% git config --unset diff.renames</tt></pre>
722 </div></div>
723 <div class="para"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
724 you have to provide a regex matching the value of exactly one line.</p></div>
725 <div class="para"><p>To query the value for a given key, do</p></div>
726 <div class="listingblock">
727 <div class="content">
728 <pre><tt>% git config --get core.filemode</tt></pre>
729 </div></div>
730 <div class="para"><p>or</p></div>
731 <div class="listingblock">
732 <div class="content">
733 <pre><tt>% git config core.filemode</tt></pre>
734 </div></div>
735 <div class="para"><p>or, to query a multivar:</p></div>
736 <div class="listingblock">
737 <div class="content">
738 <pre><tt>% git config --get core.gitproxy "for kernel.org$"</tt></pre>
739 </div></div>
740 <div class="para"><p>If you want to know all the values for a multivar, do:</p></div>
741 <div class="listingblock">
742 <div class="content">
743 <pre><tt>% git config --get-all core.gitproxy</tt></pre>
744 </div></div>
745 <div class="para"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
746 new one with</p></div>
747 <div class="listingblock">
748 <div class="content">
749 <pre><tt>% git config --replace-all core.gitproxy ssh</tt></pre>
750 </div></div>
751 <div class="para"><p>However, if you really only want to replace the line for the default proxy,
752 i.e. the one without a "for &#8230;" postfix, do something like this:</p></div>
753 <div class="listingblock">
754 <div class="content">
755 <pre><tt>% git config core.gitproxy ssh '! for '</tt></pre>
756 </div></div>
757 <div class="para"><p>To actually match only values with an exclamation mark, you have to</p></div>
758 <div class="listingblock">
759 <div class="content">
760 <pre><tt>% git config section.key value '[!]'</tt></pre>
761 </div></div>
762 <div class="para"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
763 <div class="listingblock">
764 <div class="content">
765 <pre><tt>% git config core.gitproxy '"proxy-command" for example.com'</tt></pre>
766 </div></div>
767 <div class="para"><p>An example to use customized color from the configuration in your
768 script:</p></div>
769 <div class="listingblock">
770 <div class="content">
771 <pre><tt>#!/bin/sh
772 WS=$(git config --get-color color.diff.whitespace "blue reverse")
773 RESET=$(git config --get-color "" "reset")
774 echo "${WS}your whitespace color or blue reverse${RESET}"</tt></pre>
775 </div></div>
776 </div>
777 <h2 id="_configuration_file">CONFIGURATION FILE</h2>
778 <div class="sectionbody">
779 <div class="para"><p>The git configuration file contains a number of variables that affect
780 the git command's behavior. The <tt>.git/config</tt> file in each repository
781 is used to store the configuration for that repository, and
782 <tt>$HOME/.gitconfig</tt> is used to store a per-user configuration as
783 fallback values for the <tt>.git/config</tt> file. The file <tt>/etc/gitconfig</tt>
784 can be used to store a system-wide default configuration.</p></div>
785 <div class="para"><p>The configuration variables are used by both the git plumbing
786 and the porcelains. The variables are divided into sections, wherein
787 the fully qualified variable name of the variable itself is the last
788 dot-separated segment and the section name is everything before the last
789 dot. The variable names are case-insensitive and only alphanumeric
790 characters are allowed. Some variables may appear multiple times.</p></div>
791 <h3 id="_syntax">Syntax</h3><div style="clear:left"></div>
792 <div class="para"><p>The syntax is fairly flexible and permissive; whitespaces are mostly
793 ignored. The <em>#</em> and <em>;</em> characters begin comments to the end of line,
794 blank lines are ignored.</p></div>
795 <div class="para"><p>The file consists of sections and variables. A section begins with
796 the name of the section in square brackets and continues until the next
797 section begins. Section names are not case sensitive. Only alphanumeric
798 characters, <tt>-</tt> and <tt>.</tt> are allowed in section names. Each variable
799 must belong to some section, which means that there must be a section
800 header before the first setting of a variable.</p></div>
801 <div class="para"><p>Sections can be further divided into subsections. To begin a subsection
802 put its name in double quotes, separated by space from the section name,
803 in the section header, like in the example below:</p></div>
804 <div class="listingblock">
805 <div class="content">
806 <pre><tt> [section "subsection"]
807 </tt></pre>
808 </div></div>
809 <div class="para"><p>Subsection names are case sensitive and can contain any characters except
810 newline (doublequote <tt>"</tt> and backslash have to be escaped as <tt>\"</tt> and <tt>\\</tt>,
811 respectively). Section headers cannot span multiple
812 lines. Variables may belong directly to a section or to a given subsection.
813 You can have <tt>[section]</tt> if you have <tt>[section "subsection"]</tt>, but you
814 don't need to.</p></div>
815 <div class="para"><p>There is also a case insensitive alternative <tt>[section.subsection]</tt> syntax.
816 In this syntax, subsection names follow the same restrictions as for section
817 names.</p></div>
818 <div class="para"><p>All the other lines (and the remainder of the line after the section
819 header) are recognized as setting variables, in the form
820 <em>name = value</em>. If there is no equal sign on the line, the entire line
821 is taken as <em>name</em> and the variable is recognized as boolean "true".
822 The variable names are case-insensitive and only alphanumeric
823 characters and <tt>-</tt> are allowed. There can be more than one value
824 for a given variable; we say then that variable is multivalued.</p></div>
825 <div class="para"><p>Leading and trailing whitespace in a variable value is discarded.
826 Internal whitespace within a variable value is retained verbatim.</p></div>
827 <div class="para"><p>The values following the equals sign in variable assign are all either
828 a string, an integer, or a boolean. Boolean values may be given as yes/no,
829 0/1, true/false or on/off. Case is not significant in boolean values, when
830 converting value to the canonical form using <em>--bool</em> type specifier;
831 <em>git-config</em> will ensure that the output is "true" or "false".</p></div>
832 <div class="para"><p>String values may be entirely or partially enclosed in double quotes.
833 You need to enclose variable values in double quotes if you want to
834 preserve leading or trailing whitespace, or if the variable value contains
835 comment characters (i.e. it contains <em>#</em> or <em>;</em>).
836 Double quote <tt>"</tt> and backslash <tt>\</tt> characters in variable values must
837 be escaped: use <tt>\"</tt> for <tt>"</tt> and <tt>\\</tt> for <tt>\</tt>.</p></div>
838 <div class="para"><p>The following escape sequences (beside <tt>\"</tt> and <tt>\\</tt>) are recognized:
839 <tt>\n</tt> for newline character (NL), <tt>\t</tt> for horizontal tabulation (HT, TAB)
840 and <tt>\b</tt> for backspace (BS). No other char escape sequence, nor octal
841 char sequences are valid.</p></div>
842 <div class="para"><p>Variable values ending in a <tt>\</tt> are continued on the next line in the
843 customary UNIX fashion.</p></div>
844 <div class="para"><p>Some variables may require a special value format.</p></div>
845 <h3 id="_example">Example</h3><div style="clear:left"></div>
846 <div class="literalblock">
847 <div class="content">
848 <pre><tt># Core variables
849 [core]
850 ; Don't trust file modes
851 filemode = false</tt></pre>
852 </div></div>
853 <div class="literalblock">
854 <div class="content">
855 <pre><tt># Our diff algorithm
856 [diff]
857 external = /usr/local/bin/diff-wrapper
858 renames = true</tt></pre>
859 </div></div>
860 <div class="literalblock">
861 <div class="content">
862 <pre><tt>[branch "devel"]
863 remote = origin
864 merge = refs/heads/devel</tt></pre>
865 </div></div>
866 <div class="literalblock">
867 <div class="content">
868 <pre><tt># Proxy settings
869 [core]
870 gitProxy="ssh" for "kernel.org"
871 gitProxy=default-proxy ; for the rest</tt></pre>
872 </div></div>
873 <h3 id="_variables">Variables</h3><div style="clear:left"></div>
874 <div class="para"><p>Note that this list is non-comprehensive and not necessarily complete.
875 For command-specific variables, you will find a more detailed description
876 in the appropriate manual page. You will find a description of non-core
877 porcelain configuration variables in the respective porcelain documentation.</p></div>
878 <div class="vlist"><dl>
879 <dt>
880 advice.*
881 </dt>
882 <dd>
884 When set to <em>true</em>, display the given optional help message.
885 When set to <em>false</em>, do not display. The configuration variables
886 are:
887 </p>
888 <div class="vlist"><dl>
889 <dt>
890 pushNonFastForward
891 </dt>
892 <dd>
894 Advice shown when <a href="git-push.html">git-push(1)</a> refuses
895 non-fast-forward refs. Default: true.
896 </p>
897 </dd>
898 <dt>
899 statusHints
900 </dt>
901 <dd>
903 Directions on how to stage/unstage/add shown in the
904 output of <a href="git-status.html">git-status(1)</a> and the template shown
905 when writing commit messages. Default: true.
906 </p>
907 </dd>
908 </dl></div>
909 </dd>
910 <dt>
911 core.fileMode
912 </dt>
913 <dd>
915 If false, the executable bit differences between the index and
916 the working copy are ignored; useful on broken filesystems like FAT.
917 See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
918 </p>
919 </dd>
920 <dt>
921 core.ignoreCygwinFSTricks
922 </dt>
923 <dd>
925 This option is only used by Cygwin implementation of Git. If false,
926 the Cygwin stat() and lstat() functions are used. This may be useful
927 if your repository consists of a few separate directories joined in
928 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
929 whenever it is possible and falls back to Cygwin functions only to
930 handle symbol links. The native mode is more than twice faster than
931 normal Cygwin l/stat() functions. True by default, unless core.filemode
932 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
933 POSIX emulation is required to support core.filemode.
934 </p>
935 </dd>
936 <dt>
937 core.trustctime
938 </dt>
939 <dd>
941 If false, the ctime differences between the index and the
942 working copy are ignored; useful when the inode change time
943 is regularly modified by something outside Git (file system
944 crawlers and some backup systems).
945 See <a href="git-update-index.html">git-update-index(1)</a>. True by default.
946 </p>
947 </dd>
948 <dt>
949 core.quotepath
950 </dt>
951 <dd>
953 The commands that output paths (e.g. <em>ls-files</em>,
954 <em>diff</em>), when not given the <tt>-z</tt> option, will quote
955 "unusual" characters in the pathname by enclosing the
956 pathname in a double-quote pair and with backslashes the
957 same way strings in C source code are quoted. If this
958 variable is set to false, the bytes higher than 0x80 are
959 not quoted but output as verbatim. Note that double
960 quote, backslash and control characters are always
961 quoted without <tt>-z</tt> regardless of the setting of this
962 variable.
963 </p>
964 </dd>
965 <dt>
966 core.autocrlf
967 </dt>
968 <dd>
970 If true, makes git convert <tt>CRLF</tt> at the end of lines in text files to
971 <tt>LF</tt> when reading from the filesystem, and convert in reverse when
972 writing to the filesystem. The variable can be set to
973 <em>input</em>, in which case the conversion happens only while
974 reading from the filesystem but files are written out with
975 <tt>LF</tt> at the end of lines. Currently, which paths to consider
976 "text" (i.e. be subjected to the autocrlf mechanism) is
977 decided purely based on the contents.
978 </p>
979 </dd>
980 <dt>
981 core.safecrlf
982 </dt>
983 <dd>
985 If true, makes git check if converting <tt>CRLF</tt> as controlled by
986 <tt>core.autocrlf</tt> is reversible. Git will verify if a command
987 modifies a file in the work tree either directly or indirectly.
988 For example, committing a file followed by checking out the
989 same file should yield the original file in the work tree. If
990 this is not the case for the current setting of
991 <tt>core.autocrlf</tt>, git will reject the file. The variable can
992 be set to "warn", in which case git will only warn about an
993 irreversible conversion but continue the operation.
994 </p>
995 <div class="para"><p>CRLF conversion bears a slight chance of corrupting data.
996 autocrlf=true will convert CRLF to LF during commit and LF to
997 CRLF during checkout. A file that contains a mixture of LF and
998 CRLF before the commit cannot be recreated by git. For text
999 files this is the right thing to do: it corrects line endings
1000 such that we have only LF line endings in the repository.
1001 But for binary files that are accidentally classified as text the
1002 conversion can corrupt data.</p></div>
1003 <div class="para"><p>If you recognize such corruption early you can easily fix it by
1004 setting the conversion type explicitly in .gitattributes. Right
1005 after committing you still have the original file in your work
1006 tree and this file is not yet corrupted. You can explicitly tell
1007 git that this file is binary and git will handle the file
1008 appropriately.</p></div>
1009 <div class="para"><p>Unfortunately, the desired effect of cleaning up text files with
1010 mixed line endings and the undesired effect of corrupting binary
1011 files cannot be distinguished. In both cases CRLFs are removed
1012 in an irreversible way. For text files this is the right thing
1013 to do because CRLFs are line endings, while for binary files
1014 converting CRLFs corrupts data.</p></div>
1015 <div class="para"><p>Note, this safety check does not mean that a checkout will generate a
1016 file identical to the original file for a different setting of
1017 <tt>core.autocrlf</tt>, but only for the current one. For example, a text
1018 file with <tt>LF</tt> would be accepted with <tt>core.autocrlf=input</tt> and could
1019 later be checked out with <tt>core.autocrlf=true</tt>, in which case the
1020 resulting file would contain <tt>CRLF</tt>, although the original file
1021 contained <tt>LF</tt>. However, in both work trees the line endings would be
1022 consistent, that is either all <tt>LF</tt> or all <tt>CRLF</tt>, but never mixed. A
1023 file with mixed line endings would be reported by the <tt>core.safecrlf</tt>
1024 mechanism.</p></div>
1025 </dd>
1026 <dt>
1027 core.symlinks
1028 </dt>
1029 <dd>
1031 If false, symbolic links are checked out as small plain files that
1032 contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
1033 <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
1034 file. Useful on filesystems like FAT that do not support
1035 symbolic links. True by default.
1036 </p>
1037 </dd>
1038 <dt>
1039 core.gitProxy
1040 </dt>
1041 <dd>
1043 A "proxy command" to execute (as <em>command host port</em>) instead
1044 of establishing direct connection to the remote server when
1045 using the git protocol for fetching. If the variable value is
1046 in the "COMMAND for DOMAIN" format, the command is applied only
1047 on hostnames ending with the specified domain string. This variable
1048 may be set multiple times and is matched in the given order;
1049 the first match wins.
1050 </p>
1051 <div class="para"><p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable
1052 (which always applies universally, without the special "for"
1053 handling).</p></div>
1054 <div class="para"><p>The special string <tt>none</tt> can be used as the proxy command to
1055 specify that no proxy be used for a given domain pattern.
1056 This is useful for excluding servers inside a firewall from
1057 proxy use, while defaulting to a common proxy for external domains.</p></div>
1058 </dd>
1059 <dt>
1060 core.ignoreStat
1061 </dt>
1062 <dd>
1064 If true, commands which modify both the working tree and the index
1065 will mark the updated paths with the "assume unchanged" bit in the
1066 index. These marked files are then assumed to stay unchanged in the
1067 working copy, until you mark them otherwise manually - Git will not
1068 detect the file changes by lstat() calls. This is useful on systems
1069 where those are very slow, such as Microsoft Windows.
1070 See <a href="git-update-index.html">git-update-index(1)</a>.
1071 False by default.
1072 </p>
1073 </dd>
1074 <dt>
1075 core.preferSymlinkRefs
1076 </dt>
1077 <dd>
1079 Instead of the default "symref" format for HEAD
1080 and other symbolic reference files, use symbolic links.
1081 This is sometimes needed to work with old scripts that
1082 expect HEAD to be a symbolic link.
1083 </p>
1084 </dd>
1085 <dt>
1086 core.bare
1087 </dt>
1088 <dd>
1090 If true this repository is assumed to be <em>bare</em> and has no
1091 working directory associated with it. If this is the case a
1092 number of commands that require a working directory will be
1093 disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
1094 </p>
1095 <div class="para"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
1096 <a href="git-init.html">git-init(1)</a> when the repository was created. By default a
1097 repository that ends in "/.git" is assumed to be not bare (bare =
1098 false), while all other repositories are assumed to be bare (bare
1099 = true).</p></div>
1100 </dd>
1101 <dt>
1102 core.worktree
1103 </dt>
1104 <dd>
1106 Set the path to the working tree. The value will not be
1107 used in combination with repositories found automatically in
1108 a .git directory (i.e. $GIT_DIR is not set).
1109 This can be overridden by the GIT_WORK_TREE environment
1110 variable and the <em>--work-tree</em> command line option. It can be
1111 a absolute path or relative path to the directory specified by
1112 --git-dir or GIT_DIR.
1113 Note: If --git-dir or GIT_DIR are specified but none of
1114 --work-tree, GIT_WORK_TREE and core.worktree is specified,
1115 the current working directory is regarded as the top directory
1116 of your working tree.
1117 </p>
1118 </dd>
1119 <dt>
1120 core.logAllRefUpdates
1121 </dt>
1122 <dd>
1124 Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
1125 "$GIT_DIR/logs/&lt;ref&gt;", by appending the new and old
1126 SHA1, the date/time and the reason of the update, but
1127 only when the file exists. If this configuration
1128 variable is set to true, missing "$GIT_DIR/logs/&lt;ref&gt;"
1129 file is automatically created for branch heads.
1130 </p>
1131 <div class="para"><p>This information can be used to determine what commit
1132 was the tip of a branch "2 days ago".</p></div>
1133 <div class="para"><p>This value is true by default in a repository that has
1134 a working directory associated with it, and false by
1135 default in a bare repository.</p></div>
1136 </dd>
1137 <dt>
1138 core.repositoryFormatVersion
1139 </dt>
1140 <dd>
1142 Internal variable identifying the repository format and layout
1143 version.
1144 </p>
1145 </dd>
1146 <dt>
1147 core.sharedRepository
1148 </dt>
1149 <dd>
1151 When <em>group</em> (or <em>true</em>), the repository is made shareable between
1152 several users in a group (making sure all the files and objects are
1153 group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
1154 repository will be readable by all users, additionally to being
1155 group-shareable. When <em>umask</em> (or <em>false</em>), git will use permissions
1156 reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
1157 files in the repository will have this mode value. <em>0xxx</em> will override
1158 user's umask value (whereas the other options will only override
1159 requested parts of the user's umask value). Examples: <em>0660</em> will make
1160 the repo read/write-able for the owner and group, but inaccessible to
1161 others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
1162 repository that is group-readable but not group-writable.
1163 See <a href="git-init.html">git-init(1)</a>. False by default.
1164 </p>
1165 </dd>
1166 <dt>
1167 core.warnAmbiguousRefs
1168 </dt>
1169 <dd>
1171 If true, git will warn you if the ref name you passed it is ambiguous
1172 and might match multiple refs in the .git/refs/ tree. True by default.
1173 </p>
1174 </dd>
1175 <dt>
1176 core.compression
1177 </dt>
1178 <dd>
1180 An integer -1..9, indicating a default compression level.
1181 -1 is the zlib default. 0 means no compression,
1182 and 1..9 are various speed/size tradeoffs, 9 being slowest.
1183 If set, this provides a default to other compression variables,
1184 such as <em>core.loosecompression</em> and <em>pack.compression</em>.
1185 </p>
1186 </dd>
1187 <dt>
1188 core.loosecompression
1189 </dt>
1190 <dd>
1192 An integer -1..9, indicating the compression level for objects that
1193 are not in a pack file. -1 is the zlib default. 0 means no
1194 compression, and 1..9 are various speed/size tradeoffs, 9 being
1195 slowest. If not set, defaults to core.compression. If that is
1196 not set, defaults to 1 (best speed).
1197 </p>
1198 </dd>
1199 <dt>
1200 core.packedGitWindowSize
1201 </dt>
1202 <dd>
1204 Number of bytes of a pack file to map into memory in a
1205 single mapping operation. Larger window sizes may allow
1206 your system to process a smaller number of large pack files
1207 more quickly. Smaller window sizes will negatively affect
1208 performance due to increased calls to the operating system's
1209 memory manager, but may improve performance when accessing
1210 a large number of large pack files.
1211 </p>
1212 <div class="para"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
1213 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
1214 be reasonable for all users/operating systems. You probably do
1215 not need to adjust this value.</p></div>
1216 <div class="para"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1217 </dd>
1218 <dt>
1219 core.packedGitLimit
1220 </dt>
1221 <dd>
1223 Maximum number of bytes to map simultaneously into memory
1224 from pack files. If Git needs to access more than this many
1225 bytes at once to complete an operation it will unmap existing
1226 regions to reclaim virtual address space within the process.
1227 </p>
1228 <div class="para"><p>Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
1229 This should be reasonable for all users/operating systems, except on
1230 the largest projects. You probably do not need to adjust this value.</p></div>
1231 <div class="para"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1232 </dd>
1233 <dt>
1234 core.deltaBaseCacheLimit
1235 </dt>
1236 <dd>
1238 Maximum number of bytes to reserve for caching base objects
1239 that multiple deltafied objects reference. By storing the
1240 entire decompressed base objects in a cache Git is able
1241 to avoid unpacking and decompressing frequently used base
1242 objects multiple times.
1243 </p>
1244 <div class="para"><p>Default is 16 MiB on all platforms. This should be reasonable
1245 for all users/operating systems, except on the largest projects.
1246 You probably do not need to adjust this value.</p></div>
1247 <div class="para"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1248 </dd>
1249 <dt>
1250 core.excludesfile
1251 </dt>
1252 <dd>
1254 In addition to <em>.gitignore</em> (per-directory) and
1255 <em>.git/info/exclude</em>, git looks into this file for patterns
1256 of files which are not meant to be tracked. See
1257 <a href="gitignore.html">gitignore(5)</a>.
1258 </p>
1259 </dd>
1260 <dt>
1261 core.editor
1262 </dt>
1263 <dd>
1265 Commands such as <tt>commit</tt> and <tt>tag</tt> that lets you edit
1266 messages by launching an editor uses the value of this
1267 variable when it is set, and the environment variable
1268 <tt>GIT_EDITOR</tt> is not set. The order of preference is
1269 <tt>GIT_EDITOR</tt> environment, <tt>core.editor</tt>, <tt>VISUAL</tt> and
1270 <tt>EDITOR</tt> environment variables and then finally <tt>vi</tt>.
1271 </p>
1272 </dd>
1273 <dt>
1274 core.pager
1275 </dt>
1276 <dd>
1278 The command that git will use to paginate output. Can
1279 be overridden with the <tt>GIT_PAGER</tt> environment
1280 variable. Note that git sets the <tt>LESS</tt> environment
1281 variable to <tt>FRSX</tt> if it is unset when it runs the
1282 pager. One can change these settings by setting the
1283 <tt>LESS</tt> variable to some other value. Alternately,
1284 these settings can be overridden on a project or
1285 global basis by setting the <tt>core.pager</tt> option.
1286 Setting <tt>core.pager</tt> has no affect on the <tt>LESS</tt>
1287 environment variable behaviour above, so if you want
1288 to override git's default settings this way, you need
1289 to be explicit. For example, to disable the S option
1290 in a backward compatible manner, set <tt>core.pager</tt>
1291 to <tt>less -+$LESS -FRX</tt>. This will be passed to the
1292 shell by git, which will translate the final command to
1293 <tt>LESS=FRSX less -+FRSX -FRX</tt>.
1294 </p>
1295 </dd>
1296 <dt>
1297 core.whitespace
1298 </dt>
1299 <dd>
1301 A comma separated list of common whitespace problems to
1302 notice. <em>git-diff</em> will use <tt>color.diff.whitespace</tt> to
1303 highlight them, and <em>git-apply --whitespace=error</em> will
1304 consider them as errors. You can prefix <tt>-</tt> to disable
1305 any of them (e.g. <tt>-trailing-space</tt>):
1306 </p>
1307 <div class="ilist"><ul>
1308 <li>
1310 <tt>blank-at-eol</tt> treats trailing whitespaces at the end of the line
1311 as an error (enabled by default).
1312 </p>
1313 </li>
1314 <li>
1316 <tt>space-before-tab</tt> treats a space character that appears immediately
1317 before a tab character in the initial indent part of the line as an
1318 error (enabled by default).
1319 </p>
1320 </li>
1321 <li>
1323 <tt>indent-with-non-tab</tt> treats a line that is indented with 8 or more
1324 space characters as an error (not enabled by default).
1325 </p>
1326 </li>
1327 <li>
1329 <tt>blank-at-eof</tt> treats blank lines added at the end of file as an error
1330 (enabled by default).
1331 </p>
1332 </li>
1333 <li>
1335 <tt>trailing-space</tt> is a short-hand to cover both <tt>blank-at-eol</tt> and
1336 <tt>blank-at-eof</tt>.
1337 </p>
1338 </li>
1339 <li>
1341 <tt>cr-at-eol</tt> treats a carriage-return at the end of line as
1342 part of the line terminator, i.e. with it, <tt>trailing-space</tt>
1343 does not trigger if the character before such a carriage-return
1344 is not a whitespace (not enabled by default).
1345 </p>
1346 </li>
1347 </ul></div>
1348 </dd>
1349 <dt>
1350 core.fsyncobjectfiles
1351 </dt>
1352 <dd>
1354 This boolean will enable <em>fsync()</em> when writing object files.
1355 </p>
1356 <div class="para"><p>This is a total waste of time and effort on a filesystem that orders
1357 data writes properly, but can be useful for filesystems that do not use
1358 journalling (traditional UNIX filesystems) or that only journal metadata
1359 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").</p></div>
1360 </dd>
1361 <dt>
1362 core.preloadindex
1363 </dt>
1364 <dd>
1366 Enable parallel index preload for operations like <em>git diff</em>
1367 </p>
1368 <div class="para"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
1369 on filesystems like NFS that have weak caching semantics and thus
1370 relatively high IO latencies. With this set to <em>true</em>, git will do the
1371 index comparison to the filesystem data in parallel, allowing
1372 overlapping IO's.</p></div>
1373 </dd>
1374 <dt>
1375 core.createObject
1376 </dt>
1377 <dd>
1379 You can set this to <em>link</em>, in which case a hardlink followed by
1380 a delete of the source are used to make sure that object creation
1381 will not overwrite existing objects.
1382 </p>
1383 <div class="para"><p>On some file system/operating system combinations, this is unreliable.
1384 Set this config setting to <em>rename</em> there; However, This will remove the
1385 check that makes sure that existing object files will not get overwritten.</p></div>
1386 </dd>
1387 <dt>
1388 add.ignore-errors
1389 </dt>
1390 <dd>
1392 Tells <em>git-add</em> to continue adding files when some files cannot be
1393 added due to indexing errors. Equivalent to the <em>--ignore-errors</em>
1394 option of <a href="git-add.html">git-add(1)</a>.
1395 </p>
1396 </dd>
1397 <dt>
1398 alias.*
1399 </dt>
1400 <dd>
1402 Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
1403 after defining "alias.last = cat-file commit HEAD", the invocation
1404 "git last" is equivalent to "git cat-file commit HEAD". To avoid
1405 confusion and troubles with script usage, aliases that
1406 hide existing git commands are ignored. Arguments are split by
1407 spaces, the usual shell quoting and escaping is supported.
1408 quote pair and a backslash can be used to quote them.
1409 </p>
1410 <div class="para"><p>If the alias expansion is prefixed with an exclamation point,
1411 it will be treated as a shell command. For example, defining
1412 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
1413 "git new" is equivalent to running the shell command
1414 "gitk --all --not ORIG_HEAD". Note that shell commands will be
1415 executed from the top-level directory of a repository, which may
1416 not necessarily be the current directory.</p></div>
1417 </dd>
1418 <dt>
1419 apply.ignorewhitespace
1420 </dt>
1421 <dd>
1423 When set to <em>change</em>, tells <em>git-apply</em> to ignore changes in
1424 whitespace, in the same way as the <em>--ignore-space-change</em>
1425 option.
1426 When set to one of: no, none, never, false tells <em>git-apply</em> to
1427 respect all whitespace differences.
1428 See <a href="git-apply.html">git-apply(1)</a>.
1429 </p>
1430 </dd>
1431 <dt>
1432 apply.whitespace
1433 </dt>
1434 <dd>
1436 Tells <em>git-apply</em> how to handle whitespaces, in the same way
1437 as the <em>--whitespace</em> option. See <a href="git-apply.html">git-apply(1)</a>.
1438 </p>
1439 </dd>
1440 <dt>
1441 branch.autosetupmerge
1442 </dt>
1443 <dd>
1445 Tells <em>git-branch</em> and <em>git-checkout</em> to setup new branches
1446 so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
1447 starting point branch. Note that even if this option is not set,
1448 this behavior can be chosen per-branch using the <tt>--track</tt>
1449 and <tt>--no-track</tt> options. The valid settings are: <tt>false</tt> &#8212; no
1450 automatic setup is done; <tt>true</tt> &#8212; automatic setup is done when the
1451 starting point is a remote branch; <tt>always</tt> &#8212; automatic setup is
1452 done when the starting point is either a local branch or remote
1453 branch. This option defaults to true.
1454 </p>
1455 </dd>
1456 <dt>
1457 branch.autosetuprebase
1458 </dt>
1459 <dd>
1461 When a new branch is created with <em>git-branch</em> or <em>git-checkout</em>
1462 that tracks another branch, this variable tells git to set
1463 up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
1464 When <tt>never</tt>, rebase is never automatically set to true.
1465 When <tt>local</tt>, rebase is set to true for tracked branches of
1466 other local branches.
1467 When <tt>remote</tt>, rebase is set to true for tracked branches of
1468 remote branches.
1469 When <tt>always</tt>, rebase will be set to true for all tracking
1470 branches.
1471 See "branch.autosetupmerge" for details on how to set up a
1472 branch to track another branch.
1473 This option defaults to never.
1474 </p>
1475 </dd>
1476 <dt>
1477 branch.&lt;name&gt;.remote
1478 </dt>
1479 <dd>
1481 When in branch &lt;name&gt;, it tells <em>git-fetch</em> and <em>git-push</em> which
1482 remote to fetch from/push to. It defaults to <tt>origin</tt> if no remote is
1483 configured. <tt>origin</tt> is also used if you are not on any branch.
1484 </p>
1485 </dd>
1486 <dt>
1487 branch.&lt;name&gt;.merge
1488 </dt>
1489 <dd>
1491 Defines, together with branch.&lt;name&gt;.remote, the upstream branch
1492 for the given branch. It tells <em>git-fetch</em>/<em>git-pull</em> which
1493 branch to merge and can also affect <em>git-push</em> (see push.default).
1494 When in branch &lt;name&gt;, it tells <em>git-fetch</em> the default
1495 refspec to be marked for merging in FETCH_HEAD. The value is
1496 handled like the remote part of a refspec, and must match a
1497 ref which is fetched from the remote given by
1498 "branch.&lt;name&gt;.remote".
1499 The merge information is used by <em>git-pull</em> (which at first calls
1500 <em>git-fetch</em>) to lookup the default branch for merging. Without
1501 this option, <em>git-pull</em> defaults to merge the first refspec fetched.
1502 Specify multiple values to get an octopus merge.
1503 If you wish to setup <em>git-pull</em> so that it merges into &lt;name&gt; from
1504 another branch in the local repository, you can point
1505 branch.&lt;name&gt;.merge to the desired branch, and use the special setting
1506 <tt>.</tt> (a period) for branch.&lt;name&gt;.remote.
1507 </p>
1508 </dd>
1509 <dt>
1510 branch.&lt;name&gt;.mergeoptions
1511 </dt>
1512 <dd>
1514 Sets default options for merging into branch &lt;name&gt;. The syntax and
1515 supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
1516 option values containing whitespace characters are currently not
1517 supported.
1518 </p>
1519 </dd>
1520 <dt>
1521 branch.&lt;name&gt;.rebase
1522 </dt>
1523 <dd>
1525 When true, rebase the branch &lt;name&gt; on top of the fetched branch,
1526 instead of merging the default branch from the default remote when
1527 "git pull" is run.
1528 <strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
1529 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
1530 for details).
1531 </p>
1532 </dd>
1533 <dt>
1534 browser.&lt;tool&gt;.cmd
1535 </dt>
1536 <dd>
1538 Specify the command to invoke the specified browser. The
1539 specified command is evaluated in shell with the URLs passed
1540 as arguments. (See <a href="git-web--browse.html">git-web--browse(1)</a>.)
1541 </p>
1542 </dd>
1543 <dt>
1544 browser.&lt;tool&gt;.path
1545 </dt>
1546 <dd>
1548 Override the path for the given tool that may be used to
1549 browse HTML help (see <em>-w</em> option in <a href="git-help.html">git-help(1)</a>) or a
1550 working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).
1551 </p>
1552 </dd>
1553 <dt>
1554 clean.requireForce
1555 </dt>
1556 <dd>
1558 A boolean to make git-clean do nothing unless given -f
1559 or -n. Defaults to true.
1560 </p>
1561 </dd>
1562 <dt>
1563 color.branch
1564 </dt>
1565 <dd>
1567 A boolean to enable/disable color in the output of
1568 <a href="git-branch.html">git-branch(1)</a>. May be set to <tt>always</tt>,
1569 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
1570 only when the output is to a terminal. Defaults to false.
1571 </p>
1572 </dd>
1573 <dt>
1574 color.branch.&lt;slot&gt;
1575 </dt>
1576 <dd>
1578 Use customized color for branch coloration. <tt>&lt;slot&gt;</tt> is one of
1579 <tt>current</tt> (the current branch), <tt>local</tt> (a local branch),
1580 <tt>remote</tt> (a tracking branch in refs/remotes/), <tt>plain</tt> (other
1581 refs).
1582 </p>
1583 <div class="para"><p>The value for these configuration variables is a list of colors (at most
1584 two) and attributes (at most one), separated by spaces. The colors
1585 accepted are <tt>normal</tt>, <tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>,
1586 <tt>magenta</tt>, <tt>cyan</tt> and <tt>white</tt>; the attributes are <tt>bold</tt>, <tt>dim</tt>, <tt>ul</tt>,
1587 <tt>blink</tt> and <tt>reverse</tt>. The first color given is the foreground; the
1588 second is the background. The position of the attribute, if any,
1589 doesn't matter.</p></div>
1590 </dd>
1591 <dt>
1592 color.diff
1593 </dt>
1594 <dd>
1596 When set to <tt>always</tt>, always use colors in patch.
1597 When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use
1598 colors only when the output is to the terminal. Defaults to false.
1599 </p>
1600 </dd>
1601 <dt>
1602 color.diff.&lt;slot&gt;
1603 </dt>
1604 <dd>
1606 Use customized color for diff colorization. <tt>&lt;slot&gt;</tt> specifies
1607 which part of the patch to use the specified color, and is one
1608 of <tt>plain</tt> (context text), <tt>meta</tt> (metainformation), <tt>frag</tt>
1609 (hunk header), <tt>old</tt> (removed lines), <tt>new</tt> (added lines),
1610 <tt>commit</tt> (commit headers), or <tt>whitespace</tt> (highlighting
1611 whitespace errors). The values of these variables may be specified as
1612 in color.branch.&lt;slot&gt;.
1613 </p>
1614 </dd>
1615 <dt>
1616 color.grep
1617 </dt>
1618 <dd>
1620 When set to <tt>always</tt>, always highlight matches. When <tt>false</tt> (or
1621 <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use color only
1622 when the output is written to the terminal. Defaults to <tt>false</tt>.
1623 </p>
1624 </dd>
1625 <dt>
1626 color.grep.external
1627 </dt>
1628 <dd>
1630 The string value of this variable is passed to an external <em>grep</em>
1631 command as a command line option if match highlighting is turned
1632 on. If set to an empty string, no option is passed at all,
1633 turning off coloring for external <em>grep</em> calls; this is the default.
1634 For GNU grep, set it to <tt>--color=always</tt> to highlight matches even
1635 when a pager is used.
1636 </p>
1637 </dd>
1638 <dt>
1639 color.grep.match
1640 </dt>
1641 <dd>
1643 Use customized color for matches. The value of this variable
1644 may be specified as in color.branch.&lt;slot&gt;. It is passed using
1645 the environment variables <em>GREP_COLOR</em> and <em>GREP_COLORS</em> when
1646 calling an external <em>grep</em>.
1647 </p>
1648 </dd>
1649 <dt>
1650 color.interactive
1651 </dt>
1652 <dd>
1654 When set to <tt>always</tt>, always use colors for interactive prompts
1655 and displays (such as those used by "git-add --interactive").
1656 When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use
1657 colors only when the output is to the terminal. Defaults to false.
1658 </p>
1659 </dd>
1660 <dt>
1661 color.interactive.&lt;slot&gt;
1662 </dt>
1663 <dd>
1665 Use customized color for <em>git-add --interactive</em>
1666 output. <tt>&lt;slot&gt;</tt> may be <tt>prompt</tt>, <tt>header</tt>, <tt>help</tt> or <tt>error</tt>, for
1667 four distinct types of normal output from interactive
1668 commands. The values of these variables may be specified as
1669 in color.branch.&lt;slot&gt;.
1670 </p>
1671 </dd>
1672 <dt>
1673 color.pager
1674 </dt>
1675 <dd>
1677 A boolean to enable/disable colored output when the pager is in
1678 use (default is true).
1679 </p>
1680 </dd>
1681 <dt>
1682 color.showbranch
1683 </dt>
1684 <dd>
1686 A boolean to enable/disable color in the output of
1687 <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <tt>always</tt>,
1688 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
1689 only when the output is to a terminal. Defaults to false.
1690 </p>
1691 </dd>
1692 <dt>
1693 color.status
1694 </dt>
1695 <dd>
1697 A boolean to enable/disable color in the output of
1698 <a href="git-status.html">git-status(1)</a>. May be set to <tt>always</tt>,
1699 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
1700 only when the output is to a terminal. Defaults to false.
1701 </p>
1702 </dd>
1703 <dt>
1704 color.status.&lt;slot&gt;
1705 </dt>
1706 <dd>
1708 Use customized color for status colorization. <tt>&lt;slot&gt;</tt> is
1709 one of <tt>header</tt> (the header text of the status message),
1710 <tt>added</tt> or <tt>updated</tt> (files which are added but not committed),
1711 <tt>changed</tt> (files which are changed but not added in the index),
1712 <tt>untracked</tt> (files which are not tracked by git), or
1713 <tt>nobranch</tt> (the color the <em>no branch</em> warning is shown in, defaulting
1714 to red). The values of these variables may be specified as in
1715 color.branch.&lt;slot&gt;.
1716 </p>
1717 </dd>
1718 <dt>
1719 color.ui
1720 </dt>
1721 <dd>
1723 When set to <tt>always</tt>, always use colors in all git commands which
1724 are capable of colored output. When false (or <tt>never</tt>), never. When
1725 set to <tt>true</tt> or <tt>auto</tt>, use colors only when the output is to the
1726 terminal. When more specific variables of color.* are set, they always
1727 take precedence over this setting. Defaults to false.
1728 </p>
1729 </dd>
1730 <dt>
1731 commit.template
1732 </dt>
1733 <dd>
1735 Specify a file to use as the template for new commit messages.
1736 </p>
1737 </dd>
1738 <dt>
1739 diff.autorefreshindex
1740 </dt>
1741 <dd>
1743 When using <em>git-diff</em> to compare with work tree
1744 files, do not consider stat-only change as changed.
1745 Instead, silently run <tt>git update-index --refresh</tt> to
1746 update the cached stat information for paths whose
1747 contents in the work tree match the contents in the
1748 index. This option defaults to true. Note that this
1749 affects only <em>git-diff</em> Porcelain, and not lower level
1750 <em>diff</em> commands, such as <em>git-diff-files</em>.
1751 </p>
1752 </dd>
1753 <dt>
1754 diff.external
1755 </dt>
1756 <dd>
1758 If this config variable is set, diff generation is not
1759 performed using the internal diff machinery, but using the
1760 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
1761 environment variable. The command is called with parameters
1762 as described under "git Diffs" in <a href="git.html">git(1)</a>. Note: if
1763 you want to use an external diff program only on a subset of
1764 your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.
1765 </p>
1766 </dd>
1767 <dt>
1768 diff.mnemonicprefix
1769 </dt>
1770 <dd>
1772 If set, <em>git-diff</em> uses a prefix pair that is different from the
1773 standard "a/" and "b/" depending on what is being compared. When
1774 this configuration is in effect, reverse diff output also swaps
1775 the order of the prefixes:
1776 </p>
1777 <div class="vlist"><dl>
1778 <dt>
1779 <em>git-diff</em>
1780 </dt>
1781 <dd>
1783 compares the (i)ndex and the (w)ork tree;
1784 </p>
1785 </dd>
1786 <dt>
1787 <em>git-diff HEAD</em>
1788 </dt>
1789 <dd>
1791 compares a (c)ommit and the (w)ork tree;
1792 </p>
1793 </dd>
1794 <dt>
1795 <em>git diff --cached</em>
1796 </dt>
1797 <dd>
1799 compares a (c)ommit and the (i)ndex;
1800 </p>
1801 </dd>
1802 <dt>
1803 <em>git-diff HEAD:file1 file2</em>
1804 </dt>
1805 <dd>
1807 compares an (o)bject and a (w)ork tree entity;
1808 </p>
1809 </dd>
1810 <dt>
1811 <em>git diff --no-index a b</em>
1812 </dt>
1813 <dd>
1815 compares two non-git things (1) and (2).
1816 </p>
1817 </dd>
1818 </dl></div>
1819 </dd>
1820 <dt>
1821 diff.renameLimit
1822 </dt>
1823 <dd>
1825 The number of files to consider when performing the copy/rename
1826 detection; equivalent to the <em>git-diff</em> option <em>-l</em>.
1827 </p>
1828 </dd>
1829 <dt>
1830 diff.renames
1831 </dt>
1832 <dd>
1834 Tells git to detect renames. If set to any boolean value, it
1835 will enable basic rename detection. If set to "copies" or
1836 "copy", it will detect copies, as well.
1837 </p>
1838 </dd>
1839 <dt>
1840 diff.suppressBlankEmpty
1841 </dt>
1842 <dd>
1844 A boolean to inhibit the standard behavior of printing a space
1845 before each empty output line. Defaults to false.
1846 </p>
1847 </dd>
1848 <dt>
1849 diff.tool
1850 </dt>
1851 <dd>
1853 Controls which diff tool is used. <tt>diff.tool</tt> overrides
1854 <tt>merge.tool</tt> when used by <a href="git-difftool.html">git-difftool(1)</a> and has
1855 the same valid values as <tt>merge.tool</tt> minus "tortoisemerge"
1856 and plus "kompare".
1857 </p>
1858 </dd>
1859 <dt>
1860 difftool.&lt;tool&gt;.path
1861 </dt>
1862 <dd>
1864 Override the path for the given tool. This is useful in case
1865 your tool is not in the PATH.
1866 </p>
1867 </dd>
1868 <dt>
1869 difftool.&lt;tool&gt;.cmd
1870 </dt>
1871 <dd>
1873 Specify the command to invoke the specified diff tool.
1874 The specified command is evaluated in shell with the following
1875 variables available: <em>LOCAL</em> is set to the name of the temporary
1876 file containing the contents of the diff pre-image and <em>REMOTE</em>
1877 is set to the name of the temporary file containing the contents
1878 of the diff post-image.
1879 </p>
1880 </dd>
1881 <dt>
1882 difftool.prompt
1883 </dt>
1884 <dd>
1886 Prompt before each invocation of the diff tool.
1887 </p>
1888 </dd>
1889 <dt>
1890 diff.wordRegex
1891 </dt>
1892 <dd>
1894 A POSIX Extended Regular Expression used to determine what is a "word"
1895 when performing word-by-word difference calculations. Character
1896 sequences that match the regular expression are "words", all other
1897 characters are <strong>ignorable</strong> whitespace.
1898 </p>
1899 </dd>
1900 <dt>
1901 fetch.unpackLimit
1902 </dt>
1903 <dd>
1905 If the number of objects fetched over the git native
1906 transfer is below this
1907 limit, then the objects will be unpacked into loose object
1908 files. However if the number of received objects equals or
1909 exceeds this limit then the received pack will be stored as
1910 a pack, after adding any missing delta bases. Storing the
1911 pack from a push can make the push operation complete faster,
1912 especially on slow filesystems. If not set, the value of
1913 <tt>transfer.unpackLimit</tt> is used instead.
1914 </p>
1915 </dd>
1916 <dt>
1917 format.attach
1918 </dt>
1919 <dd>
1921 Enable multipart/mixed attachments as the default for
1922 <em>format-patch</em>. The value can also be a double quoted string
1923 which will enable attachments as the default and set the
1924 value as the boundary. See the --attach option in
1925 <a href="git-format-patch.html">git-format-patch(1)</a>.
1926 </p>
1927 </dd>
1928 <dt>
1929 format.numbered
1930 </dt>
1931 <dd>
1933 A boolean which can enable or disable sequence numbers in patch
1934 subjects. It defaults to "auto" which enables it only if there
1935 is more than one patch. It can be enabled or disabled for all
1936 messages by setting it to "true" or "false". See --numbered
1937 option in <a href="git-format-patch.html">git-format-patch(1)</a>.
1938 </p>
1939 </dd>
1940 <dt>
1941 format.headers
1942 </dt>
1943 <dd>
1945 Additional email headers to include in a patch to be submitted
1946 by mail. See <a href="git-format-patch.html">git-format-patch(1)</a>.
1947 </p>
1948 </dd>
1949 <dt>
1950 format.cc
1951 </dt>
1952 <dd>
1954 Additional "Cc:" headers to include in a patch to be submitted
1955 by mail. See the --cc option in <a href="git-format-patch.html">git-format-patch(1)</a>.
1956 </p>
1957 </dd>
1958 <dt>
1959 format.subjectprefix
1960 </dt>
1961 <dd>
1963 The default for format-patch is to output files with the <em>[PATCH]</em>
1964 subject prefix. Use this variable to change that prefix.
1965 </p>
1966 </dd>
1967 <dt>
1968 format.suffix
1969 </dt>
1970 <dd>
1972 The default for format-patch is to output files with the suffix
1973 <tt>.patch</tt>. Use this variable to change that suffix (make sure to
1974 include the dot if you want it).
1975 </p>
1976 </dd>
1977 <dt>
1978 format.pretty
1979 </dt>
1980 <dd>
1982 The default pretty format for log/show/whatchanged command,
1983 See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
1984 <a href="git-whatchanged.html">git-whatchanged(1)</a>.
1985 </p>
1986 </dd>
1987 <dt>
1988 format.thread
1989 </dt>
1990 <dd>
1992 The default threading style for <em>git-format-patch</em>. Can be
1993 either a boolean value, <tt>shallow</tt> or <tt>deep</tt>. <tt>shallow</tt>
1994 threading makes every mail a reply to the head of the series,
1995 where the head is chosen from the cover letter, the
1996 <tt>--in-reply-to</tt>, and the first patch mail, in this order.
1997 <tt>deep</tt> threading makes every mail a reply to the previous one.
1998 A true boolean value is the same as <tt>shallow</tt>, and a false
1999 value disables threading.
2000 </p>
2001 </dd>
2002 <dt>
2003 format.signoff
2004 </dt>
2005 <dd>
2007 A boolean value which lets you enable the <tt>-s/--signoff</tt> option of
2008 format-patch by default. <strong>Note:</strong> Adding the Signed-off-by: line to a
2009 patch should be a conscious act and means that you certify you have
2010 the rights to submit this work under the same open source license.
2011 Please see the <em>SubmittingPatches</em> document for further discussion.
2012 </p>
2013 </dd>
2014 <dt>
2015 gc.aggressiveWindow
2016 </dt>
2017 <dd>
2019 The window size parameter used in the delta compression
2020 algorithm used by <em>git-gc --aggressive</em>. This defaults
2021 to 10.
2022 </p>
2023 </dd>
2024 <dt>
2025 gc.auto
2026 </dt>
2027 <dd>
2029 When there are approximately more than this many loose
2030 objects in the repository, <tt>git gc --auto</tt> will pack them.
2031 Some Porcelain commands use this command to perform a
2032 light-weight garbage collection from time to time. The
2033 default value is 6700. Setting this to 0 disables it.
2034 </p>
2035 </dd>
2036 <dt>
2037 gc.autopacklimit
2038 </dt>
2039 <dd>
2041 When there are more than this many packs that are not
2042 marked with <tt>*.keep</tt> file in the repository, <tt>git gc
2043 --auto</tt> consolidates them into one larger pack. The
2044 default value is 50. Setting this to 0 disables it.
2045 </p>
2046 </dd>
2047 <dt>
2048 gc.packrefs
2049 </dt>
2050 <dd>
2052 <em>git-gc</em> does not run <tt>git pack-refs</tt> in a bare repository by
2053 default so that older dumb-transport clients can still fetch
2054 from the repository. Setting this to <tt>true</tt> lets <em>git-gc</em>
2055 to run <tt>git pack-refs</tt>. Setting this to <tt>false</tt> tells
2056 <em>git-gc</em> never to run <tt>git pack-refs</tt>. The default setting is
2057 <tt>notbare</tt>. Enable it only when you know you do not have to
2058 support such clients. The default setting will change to <tt>true</tt>
2059 at some stage, and setting this to <tt>false</tt> will continue to
2060 prevent <tt>git pack-refs</tt> from being run from <em>git-gc</em>.
2061 </p>
2062 </dd>
2063 <dt>
2064 gc.pruneexpire
2065 </dt>
2066 <dd>
2068 When <em>git-gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>.
2069 Override the grace period with this config variable. The value
2070 "now" may be used to disable this grace period and always prune
2071 unreachable objects immediately.
2072 </p>
2073 </dd>
2074 <dt>
2075 gc.reflogexpire
2076 </dt>
2077 <dd>
2079 <em>git-reflog expire</em> removes reflog entries older than
2080 this time; defaults to 90 days.
2081 </p>
2082 </dd>
2083 <dt>
2084 gc.reflogexpireunreachable
2085 </dt>
2086 <dd>
2088 <em>git-reflog expire</em> removes reflog entries older than
2089 this time and are not reachable from the current tip;
2090 defaults to 30 days.
2091 </p>
2092 </dd>
2093 <dt>
2094 gc.rerereresolved
2095 </dt>
2096 <dd>
2098 Records of conflicted merge you resolved earlier are
2099 kept for this many days when <em>git-rerere gc</em> is run.
2100 The default is 60 days. See <a href="git-rerere.html">git-rerere(1)</a>.
2101 </p>
2102 </dd>
2103 <dt>
2104 gc.rerereunresolved
2105 </dt>
2106 <dd>
2108 Records of conflicted merge you have not resolved are
2109 kept for this many days when <em>git-rerere gc</em> is run.
2110 The default is 15 days. See <a href="git-rerere.html">git-rerere(1)</a>.
2111 </p>
2112 </dd>
2113 <dt>
2114 gitcvs.commitmsgannotation
2115 </dt>
2116 <dd>
2118 Append this string to each commit message. Set to empty string
2119 to disable this feature. Defaults to "via git-CVS emulator".
2120 </p>
2121 </dd>
2122 <dt>
2123 gitcvs.enabled
2124 </dt>
2125 <dd>
2127 Whether the CVS server interface is enabled for this repository.
2128 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
2129 </p>
2130 </dd>
2131 <dt>
2132 gitcvs.logfile
2133 </dt>
2134 <dd>
2136 Path to a log file where the CVS server interface well&#8230; logs
2137 various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
2138 </p>
2139 </dd>
2140 <dt>
2141 gitcvs.usecrlfattr
2142 </dt>
2143 <dd>
2145 If true, the server will look up the <tt>crlf</tt> attribute for
2146 files to determine the <em>-k</em> modes to use. If <tt>crlf</tt> is set,
2147 the <em>-k</em> mode will be left blank, so cvs clients will
2148 treat it as text. If <tt>crlf</tt> is explicitly unset, the file
2149 will be set with <em>-kb</em> mode, which suppresses any newline munging
2150 the client might otherwise do. If <tt>crlf</tt> is not specified,
2151 then <em>gitcvs.allbinary</em> is used. See <a href="gitattributes.html">gitattributes(5)</a>.
2152 </p>
2153 </dd>
2154 <dt>
2155 gitcvs.allbinary
2156 </dt>
2157 <dd>
2159 This is used if <em>gitcvs.usecrlfattr</em> does not resolve
2160 the correct <em>-kb</em> mode to use. If true, all
2161 unresolved files are sent to the client in
2162 mode <em>-kb</em>. This causes the client to treat them
2163 as binary files, which suppresses any newline munging it
2164 otherwise might do. Alternatively, if it is set to "guess",
2165 then the contents of the file are examined to decide if
2166 it is binary, similar to <em>core.autocrlf</em>.
2167 </p>
2168 </dd>
2169 <dt>
2170 gitcvs.dbname
2171 </dt>
2172 <dd>
2174 Database used by git-cvsserver to cache revision information
2175 derived from the git repository. The exact meaning depends on the
2176 used database driver, for SQLite (which is the default driver) this
2177 is a filename. Supports variable substitution (see
2178 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<tt>;</tt>).
2179 Default: <em>%Ggitcvs.%m.sqlite</em>
2180 </p>
2181 </dd>
2182 <dt>
2183 gitcvs.dbdriver
2184 </dt>
2185 <dd>
2187 Used Perl DBI driver. You can specify any available driver
2188 for this here, but it might not work. git-cvsserver is tested
2189 with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
2190 reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
2191 May not contain double colons (<tt>:</tt>). Default: <em>SQLite</em>.
2192 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.
2193 </p>
2194 </dd>
2195 <dt>
2196 gitcvs.dbuser, gitcvs.dbpass
2197 </dt>
2198 <dd>
2200 Database user and password. Only useful if setting <em>gitcvs.dbdriver</em>,
2201 since SQLite has no concept of database users and/or passwords.
2202 <em>gitcvs.dbuser</em> supports variable substitution (see
2203 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).
2204 </p>
2205 </dd>
2206 <dt>
2207 gitcvs.dbTableNamePrefix
2208 </dt>
2209 <dd>
2211 Database table name prefix. Prepended to the names of any
2212 database tables used, allowing a single database to be used
2213 for several repositories. Supports variable substitution (see
2214 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). Any non-alphabetic
2215 characters will be replaced with underscores.
2216 </p>
2217 </dd>
2218 </dl></div>
2219 <div class="para"><p>All gitcvs variables except for <em>gitcvs.usecrlfattr</em> and
2220 <em>gitcvs.allbinary</em> can also be specified as
2221 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
2222 is one of "ext" and "pserver") to make them apply only for the given
2223 access method.</p></div>
2224 <div class="vlist"><dl>
2225 <dt>
2226 gui.commitmsgwidth
2227 </dt>
2228 <dd>
2230 Defines how wide the commit message window is in the
2231 <a href="git-gui.html">git-gui(1)</a>. "75" is the default.
2232 </p>
2233 </dd>
2234 <dt>
2235 gui.diffcontext
2236 </dt>
2237 <dd>
2239 Specifies how many context lines should be used in calls to diff
2240 made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".
2241 </p>
2242 </dd>
2243 <dt>
2244 gui.encoding
2245 </dt>
2246 <dd>
2248 Specifies the default encoding to use for displaying of
2249 file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
2250 It can be overridden by setting the <em>encoding</em> attribute
2251 for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
2252 If this option is not set, the tools default to the
2253 locale encoding.
2254 </p>
2255 </dd>
2256 <dt>
2257 gui.matchtrackingbranch
2258 </dt>
2259 <dd>
2261 Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
2262 default to tracking remote branches with matching names or
2263 not. Default: "false".
2264 </p>
2265 </dd>
2266 <dt>
2267 gui.newbranchtemplate
2268 </dt>
2269 <dd>
2271 Is used as suggested name when creating new branches using the
2272 <a href="git-gui.html">git-gui(1)</a>.
2273 </p>
2274 </dd>
2275 <dt>
2276 gui.pruneduringfetch
2277 </dt>
2278 <dd>
2280 "true" if <a href="git-gui.html">git-gui(1)</a> should prune tracking branches when
2281 performing a fetch. The default value is "false".
2282 </p>
2283 </dd>
2284 <dt>
2285 gui.trustmtime
2286 </dt>
2287 <dd>
2289 Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
2290 timestamp or not. By default the timestamps are not trusted.
2291 </p>
2292 </dd>
2293 <dt>
2294 gui.spellingdictionary
2295 </dt>
2296 <dd>
2298 Specifies the dictionary used for spell checking commit messages in
2299 the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
2300 off.
2301 </p>
2302 </dd>
2303 <dt>
2304 gui.fastcopyblame
2305 </dt>
2306 <dd>
2308 If true, <em>git gui blame</em> uses <em>-C</em> instead of <em>-C -C</em> for original
2309 location detection. It makes blame significantly faster on huge
2310 repositories at the expense of less thorough copy detection.
2311 </p>
2312 </dd>
2313 <dt>
2314 gui.copyblamethreshold
2315 </dt>
2316 <dd>
2318 Specifies the threshold to use in <em>git gui blame</em> original location
2319 detection, measured in alphanumeric characters. See the
2320 <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.
2321 </p>
2322 </dd>
2323 <dt>
2324 gui.blamehistoryctx
2325 </dt>
2326 <dd>
2328 Specifies the radius of history context in days to show in
2329 <a href="gitk.html">gitk(1)</a> for the selected commit, when the <tt>Show History
2330 Context</tt> menu item is invoked from <em>git gui blame</em>. If this
2331 variable is set to zero, the whole history is shown.
2332 </p>
2333 </dd>
2334 <dt>
2335 guitool.&lt;name&gt;.cmd
2336 </dt>
2337 <dd>
2339 Specifies the shell command line to execute when the corresponding item
2340 of the <a href="git-gui.html">git-gui(1)</a> <tt>Tools</tt> menu is invoked. This option is
2341 mandatory for every tool. The command is executed from the root of
2342 the working directory, and in the environment it receives the name of
2343 the tool as <em>GIT_GUITOOL</em>, the name of the currently selected file as
2344 <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
2345 the head is detached, <em>CUR_BRANCH</em> is empty).
2346 </p>
2347 </dd>
2348 <dt>
2349 guitool.&lt;name&gt;.needsfile
2350 </dt>
2351 <dd>
2353 Run the tool only if a diff is selected in the GUI. It guarantees
2354 that <em>FILENAME</em> is not empty.
2355 </p>
2356 </dd>
2357 <dt>
2358 guitool.&lt;name&gt;.noconsole
2359 </dt>
2360 <dd>
2362 Run the command silently, without creating a window to display its
2363 output.
2364 </p>
2365 </dd>
2366 <dt>
2367 guitool.&lt;name&gt;.norescan
2368 </dt>
2369 <dd>
2371 Don't rescan the working directory for changes after the tool
2372 finishes execution.
2373 </p>
2374 </dd>
2375 <dt>
2376 guitool.&lt;name&gt;.confirm
2377 </dt>
2378 <dd>
2380 Show a confirmation dialog before actually running the tool.
2381 </p>
2382 </dd>
2383 <dt>
2384 guitool.&lt;name&gt;.argprompt
2385 </dt>
2386 <dd>
2388 Request a string argument from the user, and pass it to the tool
2389 through the <em>ARGS</em> environment variable. Since requesting an
2390 argument implies confirmation, the <em>confirm</em> option has no effect
2391 if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
2392 the dialog uses a built-in generic prompt; otherwise the exact
2393 value of the variable is used.
2394 </p>
2395 </dd>
2396 <dt>
2397 guitool.&lt;name&gt;.revprompt
2398 </dt>
2399 <dd>
2401 Request a single valid revision from the user, and set the
2402 <em>REVISION</em> environment variable. In other aspects this option
2403 is similar to <em>argprompt</em>, and can be used together with it.
2404 </p>
2405 </dd>
2406 <dt>
2407 guitool.&lt;name&gt;.revunmerged
2408 </dt>
2409 <dd>
2411 Show only unmerged branches in the <em>revprompt</em> subdialog.
2412 This is useful for tools similar to merge or rebase, but not
2413 for things like checkout or reset.
2414 </p>
2415 </dd>
2416 <dt>
2417 guitool.&lt;name&gt;.title
2418 </dt>
2419 <dd>
2421 Specifies the title to use for the prompt dialog. The default
2422 is the tool name.
2423 </p>
2424 </dd>
2425 <dt>
2426 guitool.&lt;name&gt;.prompt
2427 </dt>
2428 <dd>
2430 Specifies the general prompt string to display at the top of
2431 the dialog, before subsections for <em>argprompt</em> and <em>revprompt</em>.
2432 The default value includes the actual command.
2433 </p>
2434 </dd>
2435 <dt>
2436 help.browser
2437 </dt>
2438 <dd>
2440 Specify the browser that will be used to display help in the
2441 <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.
2442 </p>
2443 </dd>
2444 <dt>
2445 help.format
2446 </dt>
2447 <dd>
2449 Override the default help format used by <a href="git-help.html">git-help(1)</a>.
2450 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
2451 the default. <em>web</em> and <em>html</em> are the same.
2452 </p>
2453 </dd>
2454 <dt>
2455 help.autocorrect
2456 </dt>
2457 <dd>
2459 Automatically correct and execute mistyped commands after
2460 waiting for the given number of deciseconds (0.1 sec). If more
2461 than one command can be deduced from the entered text, nothing
2462 will be executed. If the value of this option is negative,
2463 the corrected command will be executed immediately. If the
2464 value is 0 - the command will be just shown but not executed.
2465 This is the default.
2466 </p>
2467 </dd>
2468 <dt>
2469 http.proxy
2470 </dt>
2471 <dd>
2473 Override the HTTP proxy, normally configured using the <em>http_proxy</em>
2474 environment variable (see <a href="curl.html">curl(1)</a>). This can be overridden
2475 on a per-remote basis; see remote.&lt;name&gt;.proxy
2476 </p>
2477 </dd>
2478 <dt>
2479 http.sslVerify
2480 </dt>
2481 <dd>
2483 Whether to verify the SSL certificate when fetching or pushing
2484 over HTTPS. Can be overridden by the <em>GIT_SSL_NO_VERIFY</em> environment
2485 variable.
2486 </p>
2487 </dd>
2488 <dt>
2489 http.sslCert
2490 </dt>
2491 <dd>
2493 File containing the SSL certificate when fetching or pushing
2494 over HTTPS. Can be overridden by the <em>GIT_SSL_CERT</em> environment
2495 variable.
2496 </p>
2497 </dd>
2498 <dt>
2499 http.sslKey
2500 </dt>
2501 <dd>
2503 File containing the SSL private key when fetching or pushing
2504 over HTTPS. Can be overridden by the <em>GIT_SSL_KEY</em> environment
2505 variable.
2506 </p>
2507 </dd>
2508 <dt>
2509 http.sslCertPasswordProtected
2510 </dt>
2511 <dd>
2513 Enable git's password prompt for the SSL certificate. Otherwise
2514 OpenSSL will prompt the user, possibly many times, if the
2515 certificate or private key is encrypted. Can be overridden by the
2516 <em>GIT_SSL_CERT_PASSWORD_PROTECTED</em> environment variable.
2517 </p>
2518 </dd>
2519 <dt>
2520 http.sslCAInfo
2521 </dt>
2522 <dd>
2524 File containing the certificates to verify the peer with when
2525 fetching or pushing over HTTPS. Can be overridden by the
2526 <em>GIT_SSL_CAINFO</em> environment variable.
2527 </p>
2528 </dd>
2529 <dt>
2530 http.sslCAPath
2531 </dt>
2532 <dd>
2534 Path containing files with the CA certificates to verify the peer
2535 with when fetching or pushing over HTTPS. Can be overridden
2536 by the <em>GIT_SSL_CAPATH</em> environment variable.
2537 </p>
2538 </dd>
2539 <dt>
2540 http.maxRequests
2541 </dt>
2542 <dd>
2544 How many HTTP requests to launch in parallel. Can be overridden
2545 by the <em>GIT_HTTP_MAX_REQUESTS</em> environment variable. Default is 5.
2546 </p>
2547 </dd>
2548 <dt>
2549 http.lowSpeedLimit, http.lowSpeedTime
2550 </dt>
2551 <dd>
2553 If the HTTP transfer speed is less than <em>http.lowSpeedLimit</em>
2554 for longer than <em>http.lowSpeedTime</em> seconds, the transfer is aborted.
2555 Can be overridden by the <em>GIT_HTTP_LOW_SPEED_LIMIT</em> and
2556 <em>GIT_HTTP_LOW_SPEED_TIME</em> environment variables.
2557 </p>
2558 </dd>
2559 <dt>
2560 http.noEPSV
2561 </dt>
2562 <dd>
2564 A boolean which disables using of EPSV ftp command by curl.
2565 This can helpful with some "poor" ftp servers which don't
2566 support EPSV mode. Can be overridden by the <em>GIT_CURL_FTP_NO_EPSV</em>
2567 environment variable. Default is false (curl will use EPSV).
2568 </p>
2569 </dd>
2570 <dt>
2571 i18n.commitEncoding
2572 </dt>
2573 <dd>
2575 Character encoding the commit messages are stored in; git itself
2576 does not care per se, but this information is necessary e.g. when
2577 importing commits from emails or in the gitk graphical history
2578 browser (and possibly at other places in the future or in other
2579 porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
2580 </p>
2581 </dd>
2582 <dt>
2583 i18n.logOutputEncoding
2584 </dt>
2585 <dd>
2587 Character encoding the commit messages are converted to when
2588 running <em>git-log</em> and friends.
2589 </p>
2590 </dd>
2591 <dt>
2592 imap
2593 </dt>
2594 <dd>
2596 The configuration variables in the <em>imap</em> section are described
2597 in <a href="git-imap-send.html">git-imap-send(1)</a>.
2598 </p>
2599 </dd>
2600 <dt>
2601 instaweb.browser
2602 </dt>
2603 <dd>
2605 Specify the program that will be used to browse your working
2606 repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.
2607 </p>
2608 </dd>
2609 <dt>
2610 instaweb.httpd
2611 </dt>
2612 <dd>
2614 The HTTP daemon command-line to start gitweb on your working
2615 repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.
2616 </p>
2617 </dd>
2618 <dt>
2619 instaweb.local
2620 </dt>
2621 <dd>
2623 If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
2624 be bound to the local IP (127.0.0.1).
2625 </p>
2626 </dd>
2627 <dt>
2628 instaweb.modulepath
2629 </dt>
2630 <dd>
2632 The module path for an apache httpd used by <a href="git-instaweb.html">git-instaweb(1)</a>.
2633 </p>
2634 </dd>
2635 <dt>
2636 instaweb.port
2637 </dt>
2638 <dd>
2640 The port number to bind the gitweb httpd to. See
2641 <a href="git-instaweb.html">git-instaweb(1)</a>.
2642 </p>
2643 </dd>
2644 <dt>
2645 interactive.singlekey
2646 </dt>
2647 <dd>
2649 In interactive commands, allow the user to provide one-letter
2650 input with a single key (i.e., without hitting enter).
2651 Currently this is used only by the <tt>--patch</tt> mode of
2652 <a href="git-add.html">git-add(1)</a>. Note that this setting is silently
2653 ignored if portable keystroke input is not available.
2654 </p>
2655 </dd>
2656 <dt>
2657 log.date
2658 </dt>
2659 <dd>
2661 Set default date-time mode for the log command. Setting log.date
2662 value is similar to using <em>git-log</em>'s --date option. The value is one of the
2663 following alternatives: {relative,local,default,iso,rfc,short}.
2664 See <a href="git-log.html">git-log(1)</a>.
2665 </p>
2666 </dd>
2667 <dt>
2668 log.showroot
2669 </dt>
2670 <dd>
2672 If true, the initial commit will be shown as a big creation event.
2673 This is equivalent to a diff against an empty tree.
2674 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
2675 normally hide the root commit will now show it. True by default.
2676 </p>
2677 </dd>
2678 <dt>
2679 mailmap.file
2680 </dt>
2681 <dd>
2683 The location of an augmenting mailmap file. The default
2684 mailmap, located in the root of the repository, is loaded
2685 first, then the mailmap file pointed to by this variable.
2686 The location of the mailmap file may be in a repository
2687 subdirectory, or somewhere outside of the repository itself.
2688 See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
2689 </p>
2690 </dd>
2691 <dt>
2692 man.viewer
2693 </dt>
2694 <dd>
2696 Specify the programs that may be used to display help in the
2697 <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
2698 </p>
2699 </dd>
2700 <dt>
2701 man.&lt;tool&gt;.cmd
2702 </dt>
2703 <dd>
2705 Specify the command to invoke the specified man viewer. The
2706 specified command is evaluated in shell with the man page
2707 passed as argument. (See <a href="git-help.html">git-help(1)</a>.)
2708 </p>
2709 </dd>
2710 <dt>
2711 man.&lt;tool&gt;.path
2712 </dt>
2713 <dd>
2715 Override the path for the given tool that may be used to
2716 display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.
2717 </p>
2718 </dd>
2719 <dt>
2720 merge.conflictstyle
2721 </dt>
2722 <dd>
2724 Specify the style in which conflicted hunks are written out to
2725 working tree files upon merge. The default is "merge", which
2726 shows a <tt>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</tt> conflict marker, changes made by one side,
2727 a <tt>=======</tt> marker, changes made by the other side, and then
2728 a <tt>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</tt> marker. An alternate style, "diff3", adds a <tt>|||||||</tt>
2729 marker and the original text before the <tt>=======</tt> marker.
2730 </p>
2731 </dd>
2732 <dt>
2733 merge.log
2734 </dt>
2735 <dd>
2737 Whether to include summaries of merged commits in newly created
2738 merge commit messages. False by default.
2739 </p>
2740 </dd>
2741 <dt>
2742 merge.renameLimit
2743 </dt>
2744 <dd>
2746 The number of files to consider when performing rename detection
2747 during a merge; if not specified, defaults to the value of
2748 diff.renameLimit.
2749 </p>
2750 </dd>
2751 <dt>
2752 merge.stat
2753 </dt>
2754 <dd>
2756 Whether to print the diffstat between ORIG_HEAD and the merge result
2757 at the end of the merge. True by default.
2758 </p>
2759 </dd>
2760 <dt>
2761 merge.tool
2762 </dt>
2763 <dd>
2765 Controls which merge resolution program is used by
2766 <a href="git-mergetool.html">git-mergetool(1)</a>. Valid built-in values are: "kdiff3",
2767 "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff",
2768 "diffuse", "ecmerge", "tortoisemerge", "araxis", and
2769 "opendiff". Any other value is treated is custom merge tool
2770 and there must be a corresponding mergetool.&lt;tool&gt;.cmd option.
2771 </p>
2772 </dd>
2773 <dt>
2774 merge.verbosity
2775 </dt>
2776 <dd>
2778 Controls the amount of output shown by the recursive merge
2779 strategy. Level 0 outputs nothing except a final error
2780 message if conflicts were detected. Level 1 outputs only
2781 conflicts, 2 outputs conflicts and file changes. Level 5 and
2782 above outputs debugging information. The default is level 2.
2783 Can be overridden by the <em>GIT_MERGE_VERBOSITY</em> environment variable.
2784 </p>
2785 </dd>
2786 <dt>
2787 merge.&lt;driver&gt;.name
2788 </dt>
2789 <dd>
2791 Defines a human-readable name for a custom low-level
2792 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
2793 </p>
2794 </dd>
2795 <dt>
2796 merge.&lt;driver&gt;.driver
2797 </dt>
2798 <dd>
2800 Defines the command that implements a custom low-level
2801 merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details.
2802 </p>
2803 </dd>
2804 <dt>
2805 merge.&lt;driver&gt;.recursive
2806 </dt>
2807 <dd>
2809 Names a low-level merge driver to be used when
2810 performing an internal merge between common ancestors.
2811 See <a href="gitattributes.html">gitattributes(5)</a> for details.
2812 </p>
2813 </dd>
2814 <dt>
2815 mergetool.&lt;tool&gt;.path
2816 </dt>
2817 <dd>
2819 Override the path for the given tool. This is useful in case
2820 your tool is not in the PATH.
2821 </p>
2822 </dd>
2823 <dt>
2824 mergetool.&lt;tool&gt;.cmd
2825 </dt>
2826 <dd>
2828 Specify the command to invoke the specified merge tool. The
2829 specified command is evaluated in shell with the following
2830 variables available: <em>BASE</em> is the name of a temporary file
2831 containing the common base of the files to be merged, if available;
2832 <em>LOCAL</em> is the name of a temporary file containing the contents of
2833 the file on the current branch; <em>REMOTE</em> is the name of a temporary
2834 file containing the contents of the file from the branch being
2835 merged; <em>MERGED</em> contains the name of the file to which the merge
2836 tool should write the results of a successful merge.
2837 </p>
2838 </dd>
2839 <dt>
2840 mergetool.&lt;tool&gt;.trustExitCode
2841 </dt>
2842 <dd>
2844 For a custom merge command, specify whether the exit code of
2845 the merge command can be used to determine whether the merge was
2846 successful. If this is not set to true then the merge target file
2847 timestamp is checked and the merge assumed to have been successful
2848 if the file has been updated, otherwise the user is prompted to
2849 indicate the success of the merge.
2850 </p>
2851 </dd>
2852 <dt>
2853 mergetool.keepBackup
2854 </dt>
2855 <dd>
2857 After performing a merge, the original file with conflict markers
2858 can be saved as a file with a <tt>.orig</tt> extension. If this variable
2859 is set to <tt>false</tt> then this file is not preserved. Defaults to
2860 <tt>true</tt> (i.e. keep the backup files).
2861 </p>
2862 </dd>
2863 <dt>
2864 mergetool.keepTemporaries
2865 </dt>
2866 <dd>
2868 When invoking a custom merge tool, git uses a set of temporary
2869 files to pass to the tool. If the tool returns an error and this
2870 variable is set to <tt>true</tt>, then these temporary files will be
2871 preserved, otherwise they will be removed after the tool has
2872 exited. Defaults to <tt>false</tt>.
2873 </p>
2874 </dd>
2875 <dt>
2876 mergetool.prompt
2877 </dt>
2878 <dd>
2880 Prompt before each invocation of the merge resolution program.
2881 </p>
2882 </dd>
2883 <dt>
2884 pack.window
2885 </dt>
2886 <dd>
2888 The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
2889 window size is given on the command line. Defaults to 10.
2890 </p>
2891 </dd>
2892 <dt>
2893 pack.depth
2894 </dt>
2895 <dd>
2897 The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
2898 maximum depth is given on the command line. Defaults to 50.
2899 </p>
2900 </dd>
2901 <dt>
2902 pack.windowMemory
2903 </dt>
2904 <dd>
2906 The window memory size limit used by <a href="git-pack-objects.html">git-pack-objects(1)</a>
2907 when no limit is given on the command line. The value can be
2908 suffixed with "k", "m", or "g". Defaults to 0, meaning no
2909 limit.
2910 </p>
2911 </dd>
2912 <dt>
2913 pack.compression
2914 </dt>
2915 <dd>
2917 An integer -1..9, indicating the compression level for objects
2918 in a pack file. -1 is the zlib default. 0 means no
2919 compression, and 1..9 are various speed/size tradeoffs, 9 being
2920 slowest. If not set, defaults to core.compression. If that is
2921 not set, defaults to -1, the zlib default, which is "a default
2922 compromise between speed and compression (currently equivalent
2923 to level 6)."
2924 </p>
2925 </dd>
2926 <dt>
2927 pack.deltaCacheSize
2928 </dt>
2929 <dd>
2931 The maximum memory in bytes used for caching deltas in
2932 <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
2933 This cache is used to speed up the writing object phase by not
2934 having to recompute the final delta result once the best match
2935 for all objects is found. Repacking large repositories on machines
2936 which are tight with memory might be badly impacted by this though,
2937 especially if this cache pushes the system into swapping.
2938 A value of 0 means no limit. The smallest size of 1 byte may be
2939 used to virtually disable this cache. Defaults to 256 MiB.
2940 </p>
2941 </dd>
2942 <dt>
2943 pack.deltaCacheLimit
2944 </dt>
2945 <dd>
2947 The maximum size of a delta, that is cached in
2948 <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
2949 writing object phase by not having to recompute the final delta
2950 result once the best match for all objects is found. Defaults to 1000.
2951 </p>
2952 </dd>
2953 <dt>
2954 pack.threads
2955 </dt>
2956 <dd>
2958 Specifies the number of threads to spawn when searching for best
2959 delta matches. This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
2960 be compiled with pthreads otherwise this option is ignored with a
2961 warning. This is meant to reduce packing time on multiprocessor
2962 machines. The required amount of memory for the delta search window
2963 is however multiplied by the number of threads.
2964 Specifying 0 will cause git to auto-detect the number of CPU's
2965 and set the number of threads accordingly.
2966 </p>
2967 </dd>
2968 <dt>
2969 pack.indexVersion
2970 </dt>
2971 <dd>
2973 Specify the default pack index version. Valid values are 1 for
2974 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2975 the new pack index with capabilities for packs larger than 4 GB
2976 as well as proper protection against the repacking of corrupted
2977 packs. Version 2 is the default. Note that version 2 is enforced
2978 and this config option ignored whenever the corresponding pack is
2979 larger than 2 GB.
2980 </p>
2981 <div class="para"><p>If you have an old git that does not understand the version 2 <tt>&#42;.idx</tt> file,
2982 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
2983 that will copy both <tt>&#42;.pack</tt> file and corresponding <tt>&#42;.idx</tt> file from the
2984 other side may give you a repository that cannot be accessed with your
2985 older version of git. If the <tt>&#42;.pack</tt> file is smaller than 2 GB, however,
2986 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
2987 the <tt>&#42;.idx</tt> file.</p></div>
2988 </dd>
2989 <dt>
2990 pack.packSizeLimit
2991 </dt>
2992 <dd>
2994 The default maximum size of a pack. This setting only affects
2995 packing to a file, i.e. the git:// protocol is unaffected. It
2996 can be overridden by the <tt>--max-pack-size</tt> option of
2997 <a href="git-repack.html">git-repack(1)</a>.
2998 </p>
2999 </dd>
3000 <dt>
3001 pager.&lt;cmd&gt;
3002 </dt>
3003 <dd>
3005 Allows turning on or off pagination of the output of a
3006 particular git subcommand when writing to a tty. If
3007 <tt>--paginate</tt> or <tt>--no-pager</tt> is specified on the command line,
3008 it takes precedence over this option. To disable pagination for
3009 all commands, set <tt>core.pager</tt> or <tt>GIT_PAGER</tt> to <tt>cat</tt>.
3010 </p>
3011 </dd>
3012 <dt>
3013 pull.octopus
3014 </dt>
3015 <dd>
3017 The default merge strategy to use when pulling multiple branches
3018 at once.
3019 </p>
3020 </dd>
3021 <dt>
3022 pull.twohead
3023 </dt>
3024 <dd>
3026 The default merge strategy to use when pulling a single branch.
3027 </p>
3028 </dd>
3029 <dt>
3030 push.default
3031 </dt>
3032 <dd>
3034 Defines the action git push should take if no refspec is given
3035 on the command line, no refspec is configured in the remote, and
3036 no refspec is implied by any of the options given on the command
3037 line. Possible values are:
3038 </p>
3039 <div class="ilist"><ul>
3040 <li>
3042 <tt>nothing</tt> do not push anything.
3043 </p>
3044 </li>
3045 <li>
3047 <tt>matching</tt> push all matching branches.
3048 All branches having the same name in both ends are considered to be
3049 matching. This is the default.
3050 </p>
3051 </li>
3052 <li>
3054 <tt>tracking</tt> push the current branch to its upstream branch.
3055 </p>
3056 </li>
3057 <li>
3059 <tt>current</tt> push the current branch to a branch of the same name.
3060 </p>
3061 </li>
3062 </ul></div>
3063 </dd>
3064 <dt>
3065 rebase.stat
3066 </dt>
3067 <dd>
3069 Whether to show a diffstat of what changed upstream since the last
3070 rebase. False by default.
3071 </p>
3072 </dd>
3073 <dt>
3074 receive.autogc
3075 </dt>
3076 <dd>
3078 By default, git-receive-pack will run "git-gc --auto" after
3079 receiving data from git-push and updating refs. You can stop
3080 it by setting this variable to false.
3081 </p>
3082 </dd>
3083 <dt>
3084 receive.fsckObjects
3085 </dt>
3086 <dd>
3088 If it is set to true, git-receive-pack will check all received
3089 objects. It will abort in the case of a malformed object or a
3090 broken link. The result of an abort are only dangling objects.
3091 Defaults to false.
3092 </p>
3093 </dd>
3094 <dt>
3095 receive.unpackLimit
3096 </dt>
3097 <dd>
3099 If the number of objects received in a push is below this
3100 limit then the objects will be unpacked into loose object
3101 files. However if the number of received objects equals or
3102 exceeds this limit then the received pack will be stored as
3103 a pack, after adding any missing delta bases. Storing the
3104 pack from a push can make the push operation complete faster,
3105 especially on slow filesystems. If not set, the value of
3106 <tt>transfer.unpackLimit</tt> is used instead.
3107 </p>
3108 </dd>
3109 <dt>
3110 receive.denyDeletes
3111 </dt>
3112 <dd>
3114 If set to true, git-receive-pack will deny a ref update that deletes
3115 the ref. Use this to prevent such a ref deletion via a push.
3116 </p>
3117 </dd>
3118 <dt>
3119 receive.denyCurrentBranch
3120 </dt>
3121 <dd>
3123 If set to true or "refuse", receive-pack will deny a ref update
3124 to the currently checked out branch of a non-bare repository.
3125 Such a push is potentially dangerous because it brings the HEAD
3126 out of sync with the index and working tree. If set to "warn",
3127 print a warning of such a push to stderr, but allow the push to
3128 proceed. If set to false or "ignore", allow such pushes with no
3129 message. Defaults to "warn".
3130 </p>
3131 </dd>
3132 <dt>
3133 receive.denyNonFastForwards
3134 </dt>
3135 <dd>
3137 If set to true, git-receive-pack will deny a ref update which is
3138 not a fast forward. Use this to prevent such an update via a push,
3139 even if that push is forced. This configuration variable is
3140 set when initializing a shared repository.
3141 </p>
3142 </dd>
3143 <dt>
3144 receive.updateserverinfo
3145 </dt>
3146 <dd>
3148 If set to true, git-receive-pack will run git-update-server-info
3149 after receiving data from git-push and updating refs.
3150 </p>
3151 </dd>
3152 <dt>
3153 remote.&lt;name&gt;.url
3154 </dt>
3155 <dd>
3157 The URL of a remote repository. See <a href="git-fetch.html">git-fetch(1)</a> or
3158 <a href="git-push.html">git-push(1)</a>.
3159 </p>
3160 </dd>
3161 <dt>
3162 remote.&lt;name&gt;.pushurl
3163 </dt>
3164 <dd>
3166 The push URL of a remote repository. See <a href="git-push.html">git-push(1)</a>.
3167 </p>
3168 </dd>
3169 <dt>
3170 remote.&lt;name&gt;.proxy
3171 </dt>
3172 <dd>
3174 For remotes that require curl (http, https and ftp), the URL to
3175 the proxy to use for that remote. Set to the empty string to
3176 disable proxying for that remote.
3177 </p>
3178 </dd>
3179 <dt>
3180 remote.&lt;name&gt;.fetch
3181 </dt>
3182 <dd>
3184 The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
3185 <a href="git-fetch.html">git-fetch(1)</a>.
3186 </p>
3187 </dd>
3188 <dt>
3189 remote.&lt;name&gt;.push
3190 </dt>
3191 <dd>
3193 The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
3194 <a href="git-push.html">git-push(1)</a>.
3195 </p>
3196 </dd>
3197 <dt>
3198 remote.&lt;name&gt;.mirror
3199 </dt>
3200 <dd>
3202 If true, pushing to this remote will automatically behave
3203 as if the <tt>--mirror</tt> option was given on the command line.
3204 </p>
3205 </dd>
3206 <dt>
3207 remote.&lt;name&gt;.skipDefaultUpdate
3208 </dt>
3209 <dd>
3211 If true, this remote will be skipped by default when updating
3212 using the update subcommand of <a href="git-remote.html">git-remote(1)</a>.
3213 </p>
3214 </dd>
3215 <dt>
3216 remote.&lt;name&gt;.receivepack
3217 </dt>
3218 <dd>
3220 The default program to execute on the remote side when pushing. See
3221 option --receive-pack of <a href="git-push.html">git-push(1)</a>.
3222 </p>
3223 </dd>
3224 <dt>
3225 remote.&lt;name&gt;.uploadpack
3226 </dt>
3227 <dd>
3229 The default program to execute on the remote side when fetching. See
3230 option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.
3231 </p>
3232 </dd>
3233 <dt>
3234 remote.&lt;name&gt;.tagopt
3235 </dt>
3236 <dd>
3238 Setting this value to --no-tags disables automatic tag following when
3239 fetching from remote &lt;name&gt;
3240 </p>
3241 </dd>
3242 <dt>
3243 remotes.&lt;group&gt;
3244 </dt>
3245 <dd>
3247 The list of remotes which are fetched by "git remote update
3248 &lt;group&gt;". See <a href="git-remote.html">git-remote(1)</a>.
3249 </p>
3250 </dd>
3251 <dt>
3252 repack.usedeltabaseoffset
3253 </dt>
3254 <dd>
3256 By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
3257 delta-base offset. If you need to share your repository with
3258 git older than version 1.4.4, either directly or via a dumb
3259 protocol such as http, then you need to set this option to
3260 "false" and repack. Access from old git versions over the
3261 native protocol are unaffected by this option.
3262 </p>
3263 </dd>
3264 <dt>
3265 rerere.autoupdate
3266 </dt>
3267 <dd>
3269 When set to true, <tt>git-rerere</tt> updates the index with the
3270 resulting contents after it cleanly resolves conflicts using
3271 previously recorded resolution. Defaults to false.
3272 </p>
3273 </dd>
3274 <dt>
3275 rerere.enabled
3276 </dt>
3277 <dd>
3279 Activate recording of resolved conflicts, so that identical
3280 conflict hunks can be resolved automatically, should they
3281 be encountered again. <a href="git-rerere.html">git-rerere(1)</a> command is by
3282 default enabled if you create <tt>rr-cache</tt> directory under
3283 <tt>$GIT_DIR</tt>, but can be disabled by setting this option to false.
3284 </p>
3285 </dd>
3286 <dt>
3287 sendemail.identity
3288 </dt>
3289 <dd>
3291 A configuration identity. When given, causes values in the
3292 <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
3293 values in the <em>sendemail</em> section. The default identity is
3294 the value of <em>sendemail.identity</em>.
3295 </p>
3296 </dd>
3297 <dt>
3298 sendemail.smtpencryption
3299 </dt>
3300 <dd>
3302 See <a href="git-send-email.html">git-send-email(1)</a> for description. Note that this
3303 setting is not subject to the <em>identity</em> mechanism.
3304 </p>
3305 </dd>
3306 <dt>
3307 sendemail.smtpssl
3308 </dt>
3309 <dd>
3311 Deprecated alias for <em>sendemail.smtpencryption = ssl</em>.
3312 </p>
3313 </dd>
3314 <dt>
3315 sendemail.&lt;identity&gt;.*
3316 </dt>
3317 <dd>
3319 Identity-specific versions of the <em>sendemail.*</em> parameters
3320 found below, taking precedence over those when the this
3321 identity is selected, through command-line or
3322 <em>sendemail.identity</em>.
3323 </p>
3324 </dd>
3325 <dt>
3326 sendemail.aliasesfile
3327 </dt>
3328 <dt>
3329 sendemail.aliasfiletype
3330 </dt>
3331 <dt>
3332 sendemail.bcc
3333 </dt>
3334 <dt>
3335 sendemail.cc
3336 </dt>
3337 <dt>
3338 sendemail.cccmd
3339 </dt>
3340 <dt>
3341 sendemail.chainreplyto
3342 </dt>
3343 <dt>
3344 sendemail.confirm
3345 </dt>
3346 <dt>
3347 sendemail.envelopesender
3348 </dt>
3349 <dt>
3350 sendemail.from
3351 </dt>
3352 <dt>
3353 sendemail.multiedit
3354 </dt>
3355 <dt>
3356 sendemail.signedoffbycc
3357 </dt>
3358 <dt>
3359 sendemail.smtppass
3360 </dt>
3361 <dt>
3362 sendemail.suppresscc
3363 </dt>
3364 <dt>
3365 sendemail.suppressfrom
3366 </dt>
3367 <dt>
3368 sendemail.to
3369 </dt>
3370 <dt>
3371 sendemail.smtpserver
3372 </dt>
3373 <dt>
3374 sendemail.smtpserverport
3375 </dt>
3376 <dt>
3377 sendemail.smtpuser
3378 </dt>
3379 <dt>
3380 sendemail.thread
3381 </dt>
3382 <dt>
3383 sendemail.validate
3384 </dt>
3385 <dd>
3387 See <a href="git-send-email.html">git-send-email(1)</a> for description.
3388 </p>
3389 </dd>
3390 <dt>
3391 sendemail.signedoffcc
3392 </dt>
3393 <dd>
3395 Deprecated alias for <em>sendemail.signedoffbycc</em>.
3396 </p>
3397 </dd>
3398 <dt>
3399 showbranch.default
3400 </dt>
3401 <dd>
3403 The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
3404 See <a href="git-show-branch.html">git-show-branch(1)</a>.
3405 </p>
3406 </dd>
3407 <dt>
3408 status.relativePaths
3409 </dt>
3410 <dd>
3412 By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
3413 current directory. Setting this variable to <tt>false</tt> shows paths
3414 relative to the repository root (this was the default for git
3415 prior to v1.5.4).
3416 </p>
3417 </dd>
3418 <dt>
3419 status.showUntrackedFiles
3420 </dt>
3421 <dd>
3423 By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
3424 files which are not currently tracked by Git. Directories which
3425 contain only untracked files, are shown with the directory name
3426 only. Showing untracked files means that Git needs to lstat() all
3427 all the files in the whole repository, which might be slow on some
3428 systems. So, this variable controls how the commands displays
3429 the untracked files. Possible values are:
3430 </p>
3431 <div class="ilist"><ul>
3432 <li>
3434 <em>no</em> - Show no untracked files
3435 </p>
3436 </li>
3437 <li>
3439 <em>normal</em> - Shows untracked files and directories
3440 </p>
3441 </li>
3442 <li>
3444 <em>all</em> - Shows also individual files in untracked directories.
3445 </p>
3446 </li>
3447 </ul></div>
3448 <div class="para"><p>If this variable is not specified, it defaults to <em>normal</em>.
3449 This variable can be overridden with the -u|--untracked-files option
3450 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
3451 </dd>
3452 <dt>
3453 tar.umask
3454 </dt>
3455 <dd>
3457 This variable can be used to restrict the permission bits of
3458 tar archive entries. The default is 0002, which turns off the
3459 world write bit. The special value "user" indicates that the
3460 archiving user's umask will be used instead. See umask(2) and
3461 <a href="git-archive.html">git-archive(1)</a>.
3462 </p>
3463 </dd>
3464 <dt>
3465 transfer.unpackLimit
3466 </dt>
3467 <dd>
3469 When <tt>fetch.unpackLimit</tt> or <tt>receive.unpackLimit</tt> are
3470 not set, the value of this variable is used instead.
3471 The default value is 100.
3472 </p>
3473 </dd>
3474 <dt>
3475 url.&lt;base&gt;.insteadOf
3476 </dt>
3477 <dd>
3479 Any URL that starts with this value will be rewritten to
3480 start, instead, with &lt;base&gt;. In cases where some site serves a
3481 large number of repositories, and serves them with multiple
3482 access methods, and some users need to use different access
3483 methods, this feature allows people to specify any of the
3484 equivalent URLs and have git automatically rewrite the URL to
3485 the best alternative for the particular user, even for a
3486 never-before-seen repository on the site. When more than one
3487 insteadOf strings match a given URL, the longest match is used.
3488 </p>
3489 </dd>
3490 <dt>
3491 url.&lt;base&gt;.pushInsteadOf
3492 </dt>
3493 <dd>
3495 Any URL that starts with this value will not be pushed to;
3496 instead, it will be rewritten to start with &lt;base&gt;, and the
3497 resulting URL will be pushed to. In cases where some site serves
3498 a large number of repositories, and serves them with multiple
3499 access methods, some of which do not allow push, this feature
3500 allows people to specify a pull-only URL and have git
3501 automatically use an appropriate URL to push, even for a
3502 never-before-seen repository on the site. When more than one
3503 pushInsteadOf strings match a given URL, the longest match is
3504 used. If a remote has an explicit pushurl, git will ignore this
3505 setting for that remote.
3506 </p>
3507 </dd>
3508 <dt>
3509 user.email
3510 </dt>
3511 <dd>
3513 Your email address to be recorded in any newly created commits.
3514 Can be overridden by the <em>GIT_AUTHOR_EMAIL</em>, <em>GIT_COMMITTER_EMAIL</em>, and
3515 <em>EMAIL</em> environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
3516 </p>
3517 </dd>
3518 <dt>
3519 user.name
3520 </dt>
3521 <dd>
3523 Your full name to be recorded in any newly created commits.
3524 Can be overridden by the <em>GIT_AUTHOR_NAME</em> and <em>GIT_COMMITTER_NAME</em>
3525 environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
3526 </p>
3527 </dd>
3528 <dt>
3529 user.signingkey
3530 </dt>
3531 <dd>
3533 If <a href="git-tag.html">git-tag(1)</a> is not selecting the key you want it to
3534 automatically when creating a signed tag, you can override the
3535 default selection with this variable. This option is passed
3536 unchanged to gpg's --local-user parameter, so you may specify a key
3537 using any method that gpg supports.
3538 </p>
3539 </dd>
3540 <dt>
3541 web.browser
3542 </dt>
3543 <dd>
3545 Specify a web browser that may be used by some commands.
3546 Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
3547 may use it.
3548 </p>
3549 </dd>
3550 </dl></div>
3551 </div>
3552 <h2 id="_author">Author</h2>
3553 <div class="sectionbody">
3554 <div class="para"><p>Written by Johannes Schindelin &lt;Johannes.Schindelin@gmx.de&gt;</p></div>
3555 </div>
3556 <h2 id="_documentation">Documentation</h2>
3557 <div class="sectionbody">
3558 <div class="para"><p>Documentation by Johannes Schindelin, Petr Baudis and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
3559 </div>
3560 <h2 id="_git">GIT</h2>
3561 <div class="sectionbody">
3562 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
3563 </div>
3564 <div id="footer">
3565 <div id="footer-text">
3566 Last updated 2009-10-26 05:16:27 UTC
3567 </div>
3568 </div>
3569 </body>
3570 </html>