| blob | ae69fbcd56b29e4bce3cbe4dd661a6f22bfe949a |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
129 }
133 }
135 /* Block element titles. */
143 }
146 }
150 }
153 }
156 }
162 }
168 }
176 }
181 }
185 }
189 }
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
193 }
202 }
206 }
211 }
217 dl {
220 }
221 dt {
226 }
229 }
233 }
236 }
239 }
242 }
245 }
248 }
255 }
259 }
263 }
264 tfoot {
266 }
269 }
272 }
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
276 }
280 }
284 }
290 }
293 }
296 }
302 }
305 }
309 }
313 }
317 }
321 }
326 }
330 }
340 }
345 }
347 div#toc {
349 }
351 div#toctitle {
358 }
363 }
367 }
371 }
375 }
376 /* Overrides for manpage documents */
377 h1 {
382 }
383 h2 {
385 }
388 }
392 }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
400 }
407 }
413 }
418 }
422 }
426 }
431 }
433 /* IE6 sets dynamically generated links as visited. */
435 </style>
437 /*<![CDATA[*/
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
468 }
470 }
476 }
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
490 }
492 }
493 }
494 }
497 }
512 }
515 },
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
547 }
548 }
552 // Process footnoterefs.
561 }
562 }
563 }
564 }
566 }
567 /*]]>*/
568 </script>
569 </head>
570 <body>
572 <h1>
573 git-config(1) Manual Page
574 </h1>
577 <p>git-config -
578 Get and set repository or global options
579 </p>
580 </div>
581 </div>
586 <div class="verseblock-content"><em>git config</em> [<file-option>] [type] [-z|--null] name [value [value_regex]]
591 <em>git config</em> [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex]
601 </div></div>
602 </div>
605 <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is
606 actually the section and the key separated by a dot, and the value will be
607 escaped.</p></div>
608 <div class="paragraph"><p>Multiple lines can be added to an option by using the <em>--add</em> option.
609 If you want to update or unset an option which can occur on multiple
611 existing values that match the regexp are updated or unset. If
613 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>).</p></div>
614 <div class="paragraph"><p>The type specifier can be either <em>--int</em> or <em>--bool</em>, to make
616 convert the value to the canonical form (simple decimal number for int,
619 checks or transformations are performed on the value.</p></div>
620 <div class="paragraph"><p>The file-option can be one of <em>--system</em>, <em>--global</em> or <em>--file</em>
621 which specify where the values will be read from or written to.
622 The default is to assume the config file of the current repository,
623 .git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
627 <li>
628 <p>
629 The config file is invalid (ret=3),
630 </p>
631 </li>
632 <li>
633 <p>
634 can not write to the config file (ret=4),
635 </p>
636 </li>
637 <li>
638 <p>
639 no section or name was provided (ret=2),
640 </p>
641 </li>
642 <li>
643 <p>
644 the section or key is invalid (ret=1),
645 </p>
646 </li>
647 <li>
648 <p>
649 you try to unset an option which does not exist (ret=5),
650 </p>
651 </li>
652 <li>
653 <p>
654 you try to unset/set an option for which multiple lines match (ret=5),
655 </p>
656 </li>
657 <li>
658 <p>
659 you try to use an invalid regexp (ret=6), or
660 </p>
661 </li>
662 <li>
663 <p>
665 </p>
666 </li>
667 </ol></div>
669 </div>
674 --replace-all
675 </dt>
676 <dd>
677 <p>
678 Default behavior is to replace at most one line. This replaces
679 all lines matching the key (and optionally the value_regex).
680 </p>
681 </dd>
683 --add
684 </dt>
685 <dd>
686 <p>
687 Adds a new line to the option without altering any existing
690 </p>
691 </dd>
693 --get
694 </dt>
695 <dd>
696 <p>
697 Get the value for a given key (optionally filtered by a regex
698 matching the value). Returns error code 1 if the key was not
699 found and error code 2 if multiple key values were found.
700 </p>
701 </dd>
703 --get-all
704 </dt>
705 <dd>
706 <p>
707 Like get, but does not fail if the number of values for the key
708 is not exactly one.
709 </p>
710 </dd>
712 --get-regexp
713 </dt>
714 <dd>
715 <p>
716 Like --get-all, but interprets the name as a regular expression.
717 Also outputs the key names.
718 </p>
719 </dd>
721 --global
722 </dt>
723 <dd>
724 <p>
725 For writing options: write to global ~/.gitconfig file rather than
726 the repository .git/config.
727 </p>
729 from all available files.</p></div>
731 </dd>
733 --system
734 </dt>
735 <dd>
736 <p>
737 For writing options: write to system-wide $(prefix)/etc/gitconfig
738 rather than the repository .git/config.
739 </p>
740 <div class="paragraph"><p>For reading options: read only from system-wide $(prefix)/etc/gitconfig
741 rather than from all available files.</p></div>
743 </dd>
745 -f config-file
746 </dt>
748 --file config-file
749 </dt>
750 <dd>
751 <p>
752 Use the given config file instead of the one specified by GIT_CONFIG.
753 </p>
754 </dd>
756 --remove-section
757 </dt>
758 <dd>
759 <p>
760 Remove the given section from the configuration file.
761 </p>
762 </dd>
764 --rename-section
765 </dt>
766 <dd>
767 <p>
768 Rename the given section to a new name.
769 </p>
770 </dd>
772 --unset
773 </dt>
774 <dd>
775 <p>
776 Remove the line matching the key from config file.
777 </p>
778 </dd>
780 --unset-all
781 </dt>
782 <dd>
783 <p>
784 Remove all lines matching the key from config file.
785 </p>
786 </dd>
788 -l
789 </dt>
791 --list
792 </dt>
793 <dd>
794 <p>
795 List all variables set in config file.
796 </p>
797 </dd>
799 --bool
800 </dt>
801 <dd>
802 <p>
804 </p>
805 </dd>
807 --int
808 </dt>
809 <dd>
810 <p>
813 in the config file will cause the value to be multiplied
815 </p>
816 </dd>
818 --bool-or-int
819 </dt>
820 <dd>
821 <p>
823 either --bool or --int, as described above.
824 </p>
825 </dd>
827 --path
828 </dt>
829 <dd>
830 <p>
833 specified user. This option has no effect when setting the
835 command line to let your shell do the expansion).
836 </p>
837 </dd>
839 -z
840 </dt>
842 --null
843 </dt>
844 <dd>
845 <p>
846 For all options that output values and/or keys, always
847 end values with the null character (instead of a
848 newline). Use newline instead as a delimiter between
849 key and value. This allows for secure parsing of the
850 output without getting confused e.g. by values that
851 contain line breaks.
852 </p>
853 </dd>
855 --get-colorbool name [stdout-is-tty]
856 </dt>
857 <dd>
858 <p>
861 "false", and is taken into account when configuration says
863 output of the command itself, and exits with status 0 if color
864 is to be used, or exits with status 1 otherwise.
867 </p>
868 </dd>
870 --get-color name [default]
871 </dt>
872 <dd>
873 <p>
875 output it as the ANSI color escape sequence to the standard
878 </p>
879 </dd>
881 -e
882 </dt>
884 --edit
885 </dt>
886 <dd>
887 <p>
888 Opens an editor to modify the specified config file; either
890 </p>
891 </dd>
892 </dl></div>
893 </div>
896 <div class="paragraph"><p>If not set explicitly with <em>--file</em>, there are three files where
900 $GIT_DIR/config
901 </dt>
902 <dd>
903 <p>
904 Repository specific configuration file. (The filename is
905 of course relative to the repository root, not the working
906 directory.)
907 </p>
908 </dd>
910 ~/.gitconfig
911 </dt>
912 <dd>
913 <p>
914 User-specific configuration file. Also called "global"
915 configuration file.
916 </p>
917 </dd>
919 $(prefix)/etc/gitconfig
920 </dt>
921 <dd>
922 <p>
923 System-wide configuration file.
924 </p>
925 </dd>
926 </dl></div>
927 <div class="paragraph"><p>If no further options are given, all reading options will read all of these
928 files that are available. If the global or the system-wide configuration
929 file are not available they will be ignored. If the repository configuration
931 error code. However, in neither case will an error message be issued.</p></div>
934 and <em>--unset</em>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
935 <div class="paragraph"><p>You can override these rules either by command line options or by environment
937 to the global or system-wide file respectively. The GIT_CONFIG environment
938 variable has a similar effect, but you can specify any filename you want.</p></div>
939 </div>
944 GIT_CONFIG
945 </dt>
946 <dd>
947 <p>
948 Take the configuration from the given file instead of .git/config.
949 Using the "--global" option forces this to ~/.gitconfig. Using the
950 "--system" option forces this to $(prefix)/etc/gitconfig.
951 </p>
952 </dd>
953 </dl></div>
955 </div>
961 <pre><tt>#
962 # This is the config file, and
963 # a '#' or ';' character indicates
964 # a comment
965 #</tt></pre>
966 </div></div>
969 <pre><tt>; core variables
970 [core]
971 ; Don't trust file modes
972 filemode = false</tt></pre>
973 </div></div>
976 <pre><tt>; Our diff algorithm
977 [diff]
978 external = /usr/local/bin/diff-wrapper
979 renames = true</tt></pre>
980 </div></div>
983 <pre><tt>; Proxy settings
984 [core]
986 gitproxy=default-proxy ; for all the rest</tt></pre>
987 </div></div>
992 </div></div>
993 <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
994 what URL they apply to. Here is how to change the entry for kernel.org
999 </div></div>
1000 <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
1005 </div></div>
1006 <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
1007 you have to provide a regex matching the value of exactly one line.</p></div>
1012 </div></div>
1017 </div></div>
1022 </div></div>
1027 </div></div>
1028 <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
1029 new one with</p></div>
1033 </div></div>
1034 <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
1039 </div></div>
1040 <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
1044 </div></div>
1045 <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
1049 </div></div>
1051 script:</p></div>
1054 <pre><tt>#!/bin/sh
1055 WS=$(git config --get-color color.diff.whitespace "blue reverse")
1058 </div></div>
1059 </div>
1062 <div class="paragraph"><p>The git configuration file contains a number of variables that affect
1064 is used to store the configuration for that repository, and
1067 can be used to store a system-wide default configuration.</p></div>
1069 and the porcelains. The variables are divided into sections, wherein
1070 the fully qualified variable name of the variable itself is the last
1071 dot-separated segment and the section name is everything before the last
1072 dot. The variable names are case-insensitive and only alphanumeric
1073 characters are allowed. Some variables may appear multiple times.</p></div>
1077 blank lines are ignored.</p></div>
1079 the name of the section in square brackets and continues until the next
1080 section begins. Section names are not case sensitive. Only alphanumeric
1082 must belong to some section, which means that there must be a section
1083 header before the first setting of a variable.</p></div>
1084 <div class="paragraph"><p>Sections can be further divided into subsections. To begin a subsection
1085 put its name in double quotes, separated by space from the section name,
1086 in the section header, like in the example below:</p></div>
1090 </div></div>
1091 <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
1092 newline (doublequote <tt>"</tt> and backslash have to be escaped as <tt>\"</tt> and <tt>\\</tt>,
1093 respectively). Section headers cannot span multiple
1094 lines. Variables may belong directly to a section or to a given subsection.
1097 <div class="paragraph"><p>There is also a case insensitive alternative <tt>[section.subsection]</tt> syntax.
1098 In this syntax, subsection names follow the same restrictions as for section
1099 names.</p></div>
1101 header) are recognized as setting variables, in the form
1104 The variable names are case-insensitive and only alphanumeric
1106 for a given variable; we say then that variable is multivalued.</p></div>
1108 Internal whitespace within a variable value is retained verbatim.</p></div>
1109 <div class="paragraph"><p>The values following the equals sign in variable assign are all either
1110 a string, an integer, or a boolean. Boolean values may be given as yes/no,
1114 <div class="paragraph"><p>String values may be entirely or partially enclosed in double quotes.
1115 You need to enclose variable values in double quotes if you want to
1116 preserve leading or trailing whitespace, or if the variable value contains
1120 <div class="paragraph"><p>The following escape sequences (beside <tt>\"</tt> and <tt>\\</tt>) are recognized:
1123 char sequences are valid.</p></div>
1124 <div class="paragraph"><p>Variable values ending in a <tt>\</tt> are continued on the next line in the
1125 customary UNIX fashion.</p></div>
1130 <pre><tt># Core variables
1131 [core]
1132 ; Don't trust file modes
1133 filemode = false</tt></pre>
1134 </div></div>
1137 <pre><tt># Our diff algorithm
1138 [diff]
1139 external = /usr/local/bin/diff-wrapper
1140 renames = true</tt></pre>
1141 </div></div>
1145 remote = origin
1146 merge = refs/heads/devel</tt></pre>
1147 </div></div>
1150 <pre><tt># Proxy settings
1151 [core]
1153 gitProxy=default-proxy ; for the rest</tt></pre>
1154 </div></div>
1156 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
1157 For command-specific variables, you will find a more detailed description
1158 in the appropriate manual page. You will find a description of non-core
1159 porcelain configuration variables in the respective porcelain documentation.</p></div>
1162 advice.*
1163 </dt>
1164 <dd>
1165 <p>
1168 are:
1169 </p>
1172 pushNonFastForward
1173 </dt>
1174 <dd>
1175 <p>
1177 non-fast-forward refs. Default: true.
1178 </p>
1179 </dd>
1181 statusHints
1182 </dt>
1183 <dd>
1184 <p>
1185 Directions on how to stage/unstage/add shown in the
1187 when writing commit messages. Default: true.
1188 </p>
1189 </dd>
1191 commitBeforeMerge
1192 </dt>
1193 <dd>
1194 <p>
1196 merge to avoid overwriting local changes.
1197 Default: true.
1198 </p>
1199 </dd>
1201 resolveConflict
1202 </dt>
1203 <dd>
1204 <p>
1205 Advices shown by various commands when conflicts
1206 prevent the operation from being performed.
1207 Default: true.
1208 </p>
1209 </dd>
1211 implicitIdentity
1212 </dt>
1213 <dd>
1214 <p>
1215 Advice on how to set your identity configuration when
1216 your information is guessed from the system username and
1217 domain name. Default: true.
1218 </p>
1219 </dd>
1221 detachedHead
1222 </dt>
1223 <dd>
1224 <p>
1226 move to the detach HEAD state, to instruct how to create
1227 a local branch after the fact. Default: true.
1228 </p>
1229 </dd>
1230 </dl></div>
1231 </dd>
1233 core.fileMode
1234 </dt>
1235 <dd>
1236 <p>
1237 If false, the executable bit differences between the index and
1238 the working tree are ignored; useful on broken filesystems like FAT.
1240 </p>
1241 <div class="paragraph"><p>The default is true, except <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a>
1242 will probe and set core.fileMode false if appropriate when the
1243 repository is created.</p></div>
1244 </dd>
1246 core.ignoreCygwinFSTricks
1247 </dt>
1248 <dd>
1249 <p>
1250 This option is only used by Cygwin implementation of Git. If false,
1251 the Cygwin stat() and lstat() functions are used. This may be useful
1252 if your repository consists of a few separate directories joined in
1253 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
1254 whenever it is possible and falls back to Cygwin functions only to
1255 handle symbol links. The native mode is more than twice faster than
1256 normal Cygwin l/stat() functions. True by default, unless core.filemode
1257 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin’s
1258 POSIX emulation is required to support core.filemode.
1259 </p>
1260 </dd>
1262 core.ignorecase
1263 </dt>
1264 <dd>
1265 <p>
1266 If true, this option enables various workarounds to enable
1267 git to work better on filesystems that are not case sensitive,
1268 like FAT. For example, if a directory listing finds
1270 it is really the same file, and continue to remember it as
1271 "Makefile".
1272 </p>
1273 <div class="paragraph"><p>The default is false, except <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a>
1274 will probe and set core.ignorecase true if appropriate when the repository
1275 is created.</p></div>
1276 </dd>
1278 core.trustctime
1279 </dt>
1280 <dd>
1281 <p>
1282 If false, the ctime differences between the index and the
1283 working tree are ignored; useful when the inode change time
1284 is regularly modified by something outside Git (file system
1285 crawlers and some backup systems).
1287 </p>
1288 </dd>
1290 core.quotepath
1291 </dt>
1292 <dd>
1293 <p>
1296 "unusual" characters in the pathname by enclosing the
1297 pathname in a double-quote pair and with backslashes the
1298 same way strings in C source code are quoted. If this
1299 variable is set to false, the bytes higher than 0x80 are
1300 not quoted but output as verbatim. Note that double
1301 quote, backslash and control characters are always
1303 variable.
1304 </p>
1305 </dd>
1307 core.eol
1308 </dt>
1309 <dd>
1310 <p>
1311 Sets the line ending type to use in the working directory for
1316 conversion.
1317 </p>
1318 </dd>
1320 core.safecrlf
1321 </dt>
1322 <dd>
1323 <p>
1325 end-of-line conversion is active. Git will verify if a command
1326 modifies a file in the work tree either directly or indirectly.
1327 For example, committing a file followed by checking out the
1328 same file should yield the original file in the work tree. If
1329 this is not the case for the current setting of
1331 be set to "warn", in which case git will only warn about an
1332 irreversible conversion but continue the operation.
1333 </p>
1335 When it is enabled, git will convert CRLF to LF during commit and LF to
1336 CRLF during checkout. A file that contains a mixture of LF and
1337 CRLF before the commit cannot be recreated by git. For text
1338 files this is the right thing to do: it corrects line endings
1339 such that we have only LF line endings in the repository.
1340 But for binary files that are accidentally classified as text the
1341 conversion can corrupt data.</p></div>
1343 setting the conversion type explicitly in .gitattributes. Right
1344 after committing you still have the original file in your work
1345 tree and this file is not yet corrupted. You can explicitly tell
1346 git that this file is binary and git will handle the file
1347 appropriately.</p></div>
1349 mixed line endings and the undesired effect of corrupting binary
1350 files cannot be distinguished. In both cases CRLFs are removed
1351 in an irreversible way. For text files this is the right thing
1352 to do because CRLFs are line endings, while for binary files
1353 converting CRLFs corrupts data.</p></div>
1354 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
1355 file identical to the original file for a different setting of
1363 mechanism.</p></div>
1364 </dd>
1366 core.autocrlf
1367 </dt>
1368 <dd>
1369 <p>
1370 Setting this variable to "true" is almost the same as setting
1372 files are not guaranteed to be normalized: files that contain
1375 working directory even though the repository does not have
1377 in which case no output conversion is performed.
1378 </p>
1379 </dd>
1381 core.symlinks
1382 </dt>
1383 <dd>
1384 <p>
1385 If false, symbolic links are checked out as small plain files that
1388 file. Useful on filesystems like FAT that do not support
1389 symbolic links.
1390 </p>
1391 <div class="paragraph"><p>The default is true, except <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a>
1392 will probe and set core.symlinks false if appropriate when the repository
1393 is created.</p></div>
1394 </dd>
1396 core.gitProxy
1397 </dt>
1398 <dd>
1399 <p>
1401 of establishing direct connection to the remote server when
1402 using the git protocol for fetching. If the variable value is
1403 in the "COMMAND for DOMAIN" format, the command is applied only
1404 on hostnames ending with the specified domain string. This variable
1405 may be set multiple times and is matched in the given order;
1406 the first match wins.
1407 </p>
1408 <div class="paragraph"><p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable
1409 (which always applies universally, without the special "for"
1410 handling).</p></div>
1412 specify that no proxy be used for a given domain pattern.
1413 This is useful for excluding servers inside a firewall from
1414 proxy use, while defaulting to a common proxy for external domains.</p></div>
1415 </dd>
1417 core.ignoreStat
1418 </dt>
1419 <dd>
1420 <p>
1421 If true, commands which modify both the working tree and the index
1422 will mark the updated paths with the "assume unchanged" bit in the
1423 index. These marked files are then assumed to stay unchanged in the
1424 working tree, until you mark them otherwise manually - Git will not
1425 detect the file changes by lstat() calls. This is useful on systems
1426 where those are very slow, such as Microsoft Windows.
1428 False by default.
1429 </p>
1430 </dd>
1432 core.preferSymlinkRefs
1433 </dt>
1434 <dd>
1435 <p>
1436 Instead of the default "symref" format for HEAD
1437 and other symbolic reference files, use symbolic links.
1438 This is sometimes needed to work with old scripts that
1439 expect HEAD to be a symbolic link.
1440 </p>
1441 </dd>
1443 core.bare
1444 </dt>
1445 <dd>
1446 <p>
1448 working directory associated with it. If this is the case a
1449 number of commands that require a working directory will be
1450 disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
1451 </p>
1452 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
1454 repository that ends in "/.git" is assumed to be not bare (bare =
1455 false), while all other repositories are assumed to be bare (bare
1456 = true).</p></div>
1457 </dd>
1459 core.worktree
1460 </dt>
1461 <dd>
1462 <p>
1463 Set the path to the root of the working tree.
1464 This can be overridden by the GIT_WORK_TREE environment
1466 The value can be an absolute path or relative to the path to
1467 the .git directory, which is either specified by --git-dir
1468 or GIT_DIR, or automatically discovered.
1469 If --git-dir or GIT_DIR is specified but none of
1470 --work-tree, GIT_WORK_TREE and core.worktree is specified,
1471 the current working directory is regarded as the top level
1472 of your working tree.
1473 </p>
1475 file in a ".git" subdirectory of a directory and its value differs
1476 from the latter directory (e.g. "/path/to/.git/config" has
1477 core.worktree set to "/different/path"), which is most likely a
1478 misconfiguration. Running git commands in the "/path/to" directory will
1479 still use "/different/path" as the root of the work tree and can cause
1480 confusion unless you know what you are doing (e.g. you are creating a
1481 read-only snapshot of the same index to a location different from the
1483 </dd>
1485 core.logAllRefUpdates
1486 </dt>
1487 <dd>
1488 <p>
1490 "$GIT_DIR/logs/<ref>", by appending the new and old
1491 SHA1, the date/time and the reason of the update, but
1492 only when the file exists. If this configuration
1493 variable is set to true, missing "$GIT_DIR/logs/<ref>"
1494 file is automatically created for branch heads (i.e. under
1495 refs/heads/), remote refs (i.e. under refs/remotes/),
1496 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
1497 </p>
1501 a working directory associated with it, and false by
1502 default in a bare repository.</p></div>
1503 </dd>
1505 core.repositoryFormatVersion
1506 </dt>
1507 <dd>
1508 <p>
1509 Internal variable identifying the repository format and layout
1510 version.
1511 </p>
1512 </dd>
1514 core.sharedRepository
1515 </dt>
1516 <dd>
1517 <p>
1519 several users in a group (making sure all the files and objects are
1521 repository will be readable by all users, additionally to being
1525 user’s umask value (whereas the other options will only override
1527 the repo read/write-able for the owner and group, but inaccessible to
1529 repository that is group-readable but not group-writable.
1531 </p>
1532 </dd>
1534 core.warnAmbiguousRefs
1535 </dt>
1536 <dd>
1537 <p>
1538 If true, git will warn you if the ref name you passed it is ambiguous
1539 and might match multiple refs in the .git/refs/ tree. True by default.
1540 </p>
1541 </dd>
1543 core.compression
1544 </dt>
1545 <dd>
1546 <p>
1550 If set, this provides a default to other compression variables,
1552 </p>
1553 </dd>
1555 core.loosecompression
1556 </dt>
1557 <dd>
1558 <p>
1562 slowest. If not set, defaults to core.compression. If that is
1563 not set, defaults to 1 (best speed).
1564 </p>
1565 </dd>
1567 core.packedGitWindowSize
1568 </dt>
1569 <dd>
1570 <p>
1571 Number of bytes of a pack file to map into memory in a
1572 single mapping operation. Larger window sizes may allow
1573 your system to process a smaller number of large pack files
1574 more quickly. Smaller window sizes will negatively affect
1575 performance due to increased calls to the operating system’s
1576 memory manager, but may improve performance when accessing
1577 a large number of large pack files.
1578 </p>
1581 be reasonable for all users/operating systems. You probably do
1582 not need to adjust this value.</p></div>
1583 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1584 </dd>
1586 core.packedGitLimit
1587 </dt>
1588 <dd>
1589 <p>
1590 Maximum number of bytes to map simultaneously into memory
1591 from pack files. If Git needs to access more than this many
1592 bytes at once to complete an operation it will unmap existing
1593 regions to reclaim virtual address space within the process.
1594 </p>
1595 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
1596 This should be reasonable for all users/operating systems, except on
1597 the largest projects. You probably do not need to adjust this value.</p></div>
1598 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1599 </dd>
1601 core.deltaBaseCacheLimit
1602 </dt>
1603 <dd>
1604 <p>
1605 Maximum number of bytes to reserve for caching base objects
1606 that may be referenced by multiple deltified objects. By storing the
1607 entire decompressed base objects in a cache Git is able
1608 to avoid unpacking and decompressing frequently used base
1609 objects multiple times.
1610 </p>
1612 for all users/operating systems, except on the largest projects.
1613 You probably do not need to adjust this value.</p></div>
1614 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1615 </dd>
1617 core.bigFileThreshold
1618 </dt>
1619 <dd>
1620 <p>
1621 Files larger than this size are stored deflated, without
1622 attempting delta compression. Storing large files without
1623 delta compression avoids excessive memory usage, at the
1624 slight expense of increased disk usage.
1625 </p>
1627 for most projects as source code and other text files can still
1629 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1630 </dd>
1632 core.excludesfile
1633 </dt>
1634 <dd>
1635 <p>
1638 of files which are not meant to be tracked. "~/" is expanded
1641 </p>
1642 </dd>
1644 core.askpass
1645 </dt>
1646 <dd>
1647 <p>
1648 Some commands (e.g. svn and http interfaces) that interactively
1649 ask for a password can be told to use an external program given
1651 environment variable. If not set, fall back to the value of the
1653 prompt. The external program shall be given a suitable prompt as
1654 command line argument and write the password on its STDOUT.
1655 </p>
1656 </dd>
1658 core.attributesfile
1659 </dt>
1660 <dd>
1661 <p>
1666 </p>
1667 </dd>
1669 core.editor
1670 </dt>
1671 <dd>
1672 <p>
1674 messages by launching an editor uses the value of this
1675 variable when it is set, and the environment variable
1677 </p>
1678 </dd>
1680 core.pager
1681 </dt>
1682 <dd>
1683 <p>
1684 The command that git will use to paginate output. Can
1688 pager. One can change these settings by setting the
1690 these settings can be overridden on a project or
1693 environment variable behaviour above, so if you want
1694 to override git’s default settings this way, you need
1695 to be explicit. For example, to disable the S option
1698 shell by git, which will translate the final command to
1700 </p>
1701 </dd>
1703 core.whitespace
1704 </dt>
1705 <dd>
1706 <p>
1707 A comma separated list of common whitespace problems to
1712 </p>
1714 <li>
1715 <p>
1717 as an error (enabled by default).
1718 </p>
1719 </li>
1720 <li>
1721 <p>
1723 before a tab character in the initial indent part of the line as an
1724 error (enabled by default).
1725 </p>
1726 </li>
1727 <li>
1728 <p>
1730 space characters as an error (not enabled by default).
1731 </p>
1732 </li>
1733 <li>
1734 <p>
1736 the line as an error (not enabled by default).
1737 </p>
1738 </li>
1739 <li>
1740 <p>
1742 (enabled by default).
1743 </p>
1744 </li>
1745 <li>
1746 <p>
1749 </p>
1750 </li>
1751 <li>
1752 <p>
1755 does not trigger if the character before such a carriage-return
1756 is not a whitespace (not enabled by default).
1757 </p>
1758 </li>
1759 <li>
1760 <p>
1764 </p>
1765 </li>
1766 </ul></div>
1767 </dd>
1769 core.fsyncobjectfiles
1770 </dt>
1771 <dd>
1772 <p>
1774 </p>
1776 data writes properly, but can be useful for filesystems that do not use
1777 journalling (traditional UNIX filesystems) or that only journal metadata
1779 </dd>
1781 core.preloadindex
1782 </dt>
1783 <dd>
1784 <p>
1786 </p>
1787 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
1788 on filesystems like NFS that have weak caching semantics and thus
1790 index comparison to the filesystem data in parallel, allowing
1792 </dd>
1794 core.createObject
1795 </dt>
1796 <dd>
1797 <p>
1799 a delete of the source are used to make sure that object creation
1800 will not overwrite existing objects.
1801 </p>
1802 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
1804 check that makes sure that existing object files will not get overwritten.</p></div>
1805 </dd>
1807 core.notesRef
1808 </dt>
1809 <dd>
1810 <p>
1811 When showing commit messages, also show notes which are stored in
1812 the given ref. The ref must be fully qualified. If the given
1813 ref does not exist, it is not an error but means that no
1814 notes should be printed.
1815 </p>
1816 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
1817 the <em>GIT_NOTES_REF</em> environment variable. See <a href="git-notes.html">git-notes(1)</a>.</p></div>
1818 </dd>
1820 core.sparseCheckout
1821 </dt>
1822 <dd>
1823 <p>
1826 </p>
1827 </dd>
1829 core.abbrev
1830 </dt>
1831 <dd>
1832 <p>
1833 Set the length object names are abbreviated to. If unspecified,
1834 many commands abbreviate to 7 hexdigits, which may not be enough
1835 for abbreviated object names to stay unique for sufficiently long
1836 time.
1837 </p>
1838 </dd>
1840 add.ignore-errors
1841 </dt>
1843 add.ignoreErrors
1844 </dt>
1845 <dd>
1846 <p>
1851 convention for configuration variables. Newer versions of git
1853 </p>
1854 </dd>
1856 alias.*
1857 </dt>
1858 <dd>
1859 <p>
1861 after defining "alias.last = cat-file commit HEAD", the invocation
1863 confusion and troubles with script usage, aliases that
1864 hide existing git commands are ignored. Arguments are split by
1865 spaces, the usual shell quoting and escaping is supported.
1866 quote pair and a backslash can be used to quote them.
1867 </p>
1869 it will be treated as a shell command. For example, defining
1870 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
1871 "git new" is equivalent to running the shell command
1872 "gitk --all --not ORIG_HEAD". Note that shell commands will be
1873 executed from the top-level directory of a repository, which may
1874 not necessarily be the current directory.
1876 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
1877 </dd>
1879 am.keepcr
1880 </dt>
1881 <dd>
1882 <p>
1883 If true, git-am will call git-mailsplit for patches in mbox format
1888 </p>
1889 </dd>
1891 apply.ignorewhitespace
1892 </dt>
1893 <dd>
1894 <p>
1897 option.
1899 respect all whitespace differences.
1901 </p>
1902 </dd>
1904 apply.whitespace
1905 </dt>
1906 <dd>
1907 <p>
1910 </p>
1911 </dd>
1913 branch.autosetupmerge
1914 </dt>
1915 <dd>
1916 <p>
1919 starting point branch. Note that even if this option is not set,
1923 starting point is a remote-tracking branch; <tt>always</tt> —  automatic setup is done when the starting point is either a
1924 local branch or remote-tracking
1925 branch. This option defaults to true.
1926 </p>
1927 </dd>
1929 branch.autosetuprebase
1930 </dt>
1931 <dd>
1932 <p>
1934 that tracks another branch, this variable tells git to set
1935 up pull to rebase instead of merge (see "branch.<name>.rebase").
1938 other local branches.
1940 remote-tracking branches.
1942 branches.
1943 See "branch.autosetupmerge" for details on how to set up a
1944 branch to track another branch.
1945 This option defaults to never.
1946 </p>
1947 </dd>
1950 </dt>
1951 <dd>
1952 <p>
1956 </p>
1957 </dd>
1960 </dt>
1961 <dd>
1962 <p>
1967 refspec to be marked for merging in FETCH_HEAD. The value is
1968 handled like the remote part of a refspec, and must match a
1969 ref which is fetched from the remote given by
1970 "branch.<name>.remote".
1974 Specify multiple values to get an octopus merge.
1976 another branch in the local repository, you can point
1979 </p>
1980 </dd>
1983 </dt>
1984 <dd>
1985 <p>
1988 option values containing whitespace characters are currently not
1989 supported.
1990 </p>
1991 </dd>
1994 </dt>
1995 <dd>
1996 <p>
1998 instead of merging the default branch from the default remote when
1999 "git pull" is run.
2002 for details).
2003 </p>
2004 </dd>
2007 </dt>
2008 <dd>
2009 <p>
2010 Specify the command to invoke the specified browser. The
2011 specified command is evaluated in shell with the URLs passed
2013 </p>
2014 </dd>
2017 </dt>
2018 <dd>
2019 <p>
2020 Override the path for the given tool that may be used to
2023 </p>
2024 </dd>
2026 clean.requireForce
2027 </dt>
2028 <dd>
2029 <p>
2030 A boolean to make git-clean do nothing unless given -f
2031 or -n. Defaults to true.
2032 </p>
2033 </dd>
2035 color.branch
2036 </dt>
2037 <dd>
2038 <p>
2039 A boolean to enable/disable color in the output of
2041 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
2042 only when the output is to a terminal. Defaults to false.
2043 </p>
2044 </dd>
2047 </dt>
2048 <dd>
2049 <p>
2053 refs).
2054 </p>
2055 <div class="paragraph"><p>The value for these configuration variables is a list of colors (at most
2056 two) and attributes (at most one), separated by spaces. The colors
2057 accepted are <tt>normal</tt>, <tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>,
2058 <tt>magenta</tt>, <tt>cyan</tt> and <tt>white</tt>; the attributes are <tt>bold</tt>, <tt>dim</tt>, <tt>ul</tt>,
2060 second is the background. The position of the attribute, if any,
2062 </dd>
2064 color.diff
2065 </dt>
2066 <dd>
2067 <p>
2068 Whether to use ANSI escape sequences to add color to patches.
2070 <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
2072 commands will only use color when output is to the terminal.
2073 Defaults to false.
2074 </p>
2075 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> nor the
2078 </dd>
2081 </dt>
2082 <dd>
2083 <p>
2085 which part of the patch to use the specified color, and is one
2089 (highlighting whitespace errors). The values of these variables may be
2091 </p>
2092 </dd>
2095 </dt>
2096 <dd>
2097 <p>
2099 of <tt>branch</tt>, <tt>remoteBranch</tt>, <tt>tag</tt>, <tt>stash</tt> or <tt>HEAD</tt> for local
2100 branches, remote-tracking branches, tags, stash and HEAD, respectively.
2101 </p>
2102 </dd>
2104 color.grep
2105 </dt>
2106 <dd>
2107 <p>
2111 </p>
2112 </dd>
2115 </dt>
2116 <dd>
2117 <p>
2119 part of the line to use the specified color, and is one of
2120 </p>
2124 </dt>
2125 <dd>
2126 <p>
2128 </p>
2129 </dd>
2132 </dt>
2133 <dd>
2134 <p>
2136 </p>
2137 </dd>
2140 </dt>
2141 <dd>
2142 <p>
2144 </p>
2145 </dd>
2148 </dt>
2149 <dd>
2150 <p>
2152 </p>
2153 </dd>
2156 </dt>
2157 <dd>
2158 <p>
2159 matching text
2160 </p>
2161 </dd>
2164 </dt>
2165 <dd>
2166 <p>
2167 non-matching text in selected lines
2168 </p>
2169 </dd>
2172 </dt>
2173 <dd>
2174 <p>
2177 </p>
2178 </dd>
2179 </dl></div>
2180 <div class="paragraph"><p>The values of these variables may be specified as in color.branch.<slot>.</p></div>
2181 </dd>
2183 color.interactive
2184 </dt>
2185 <dd>
2186 <p>
2188 and displays (such as those used by "git-add --interactive").
2190 colors only when the output is to the terminal. Defaults to false.
2191 </p>
2192 </dd>
2195 </dt>
2196 <dd>
2197 <p>
2199 output. <tt><slot></tt> may be <tt>prompt</tt>, <tt>header</tt>, <tt>help</tt> or <tt>error</tt>, for
2200 four distinct types of normal output from interactive
2201 commands. The values of these variables may be specified as
2203 </p>
2204 </dd>
2206 color.pager
2207 </dt>
2208 <dd>
2209 <p>
2210 A boolean to enable/disable colored output when the pager is in
2211 use (default is true).
2212 </p>
2213 </dd>
2215 color.showbranch
2216 </dt>
2217 <dd>
2218 <p>
2219 A boolean to enable/disable color in the output of
2221 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
2222 only when the output is to a terminal. Defaults to false.
2223 </p>
2224 </dd>
2226 color.status
2227 </dt>
2228 <dd>
2229 <p>
2230 A boolean to enable/disable color in the output of
2232 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
2233 only when the output is to a terminal. Defaults to false.
2234 </p>
2235 </dd>
2238 </dt>
2239 <dd>
2240 <p>
2248 to red). The values of these variables may be specified as in
2250 </p>
2251 </dd>
2253 color.ui
2254 </dt>
2255 <dd>
2256 <p>
2257 This variable determines the default value for variables such
2259 per command family. Its scope will expand as more commands learn
2266 </p>
2267 </dd>
2269 commit.status
2270 </dt>
2271 <dd>
2272 <p>
2273 A boolean to enable/disable inclusion of status information in the
2274 commit message template when using an editor to prepare the commit
2275 message. Defaults to true.
2276 </p>
2277 </dd>
2279 commit.template
2280 </dt>
2281 <dd>
2282 <p>
2283 Specify a file to use as the template for new commit messages.
2285 specified user’s home directory.
2286 </p>
2287 </dd>
2289 diff.autorefreshindex
2290 </dt>
2291 <dd>
2292 <p>
2294 files, do not consider stat-only change as changed.
2296 update the cached stat information for paths whose
2297 contents in the work tree match the contents in the
2298 index. This option defaults to true. Note that this
2301 </p>
2302 </dd>
2304 diff.dirstat
2305 </dt>
2306 <dd>
2307 <p>
2310 and friends. The defaults can be overridden on the command line
2313 The following parameters are available:
2314 </p>
2318 </dt>
2319 <dd>
2320 <p>
2321 Compute the dirstat numbers by counting the lines that have been
2322 removed from the source, or added to the destination. This ignores
2323 the amount of pure code movements within a file. In other words,
2324 rearranging lines in a file is not counted as much as other changes.
2325 This is the default behavior when no parameter is given.
2326 </p>
2327 </dd>
2330 </dt>
2331 <dd>
2332 <p>
2333 Compute the dirstat numbers by doing the regular line-based diff
2334 analysis, and summing the removed/added line counts. (For binary
2335 files, count 64-byte chunks instead, since binary files have no
2338 lines within a file as much as other changes. The resulting output
2340 </p>
2341 </dd>
2344 </dt>
2345 <dd>
2346 <p>
2347 Compute the dirstat numbers by counting the number of files changed.
2348 Each changed file counts equally in the dirstat analysis. This is
2350 not have to look at the file contents at all.
2351 </p>
2352 </dd>
2355 </dt>
2356 <dd>
2357 <p>
2358 Count changes in a child directory for the parent directory as well.
2360 reported may exceed 100%. The default (non-cumulative) behavior can
2362 </p>
2363 </dd>
2366 </dt>
2367 <dd>
2368 <p>
2369 An integer parameter specifies a cut-off percent (3% by default).
2370 Directories contributing less than this percentage of the changes
2371 are not shown in the output.
2372 </p>
2373 </dd>
2374 </dl></div>
2376 directories with less than 10% of the total amount of changed files,
2377 and accumulating child directory counts in the parent directories:
2379 </dd>
2381 diff.external
2382 </dt>
2383 <dd>
2384 <p>
2385 If this config variable is set, diff generation is not
2386 performed using the internal diff machinery, but using the
2388 environment variable. The command is called with parameters
2390 you want to use an external diff program only on a subset of
2392 </p>
2393 </dd>
2395 diff.ignoreSubmodules
2396 </dt>
2397 <dd>
2398 <p>
2399 Sets the default value of --ignore-submodules. Note that this
2402 this setting when reporting uncommitted changes.
2403 </p>
2404 </dd>
2406 diff.mnemonicprefix
2407 </dt>
2408 <dd>
2409 <p>
2412 this configuration is in effect, reverse diff output also swaps
2413 the order of the prefixes:
2414 </p>
2418 </dt>
2419 <dd>
2420 <p>
2421 compares the (i)ndex and the (w)ork tree;
2422 </p>
2423 </dd>
2426 </dt>
2427 <dd>
2428 <p>
2429 compares a (c)ommit and the (w)ork tree;
2430 </p>
2431 </dd>
2434 </dt>
2435 <dd>
2436 <p>
2437 compares a (c)ommit and the (i)ndex;
2438 </p>
2439 </dd>
2442 </dt>
2443 <dd>
2444 <p>
2445 compares an (o)bject and a (w)ork tree entity;
2446 </p>
2447 </dd>
2450 </dt>
2451 <dd>
2452 <p>
2454 </p>
2455 </dd>
2456 </dl></div>
2457 </dd>
2459 diff.noprefix
2460 </dt>
2461 <dd>
2462 <p>
2464 </p>
2465 </dd>
2467 diff.renameLimit
2468 </dt>
2469 <dd>
2470 <p>
2471 The number of files to consider when performing the copy/rename
2473 </p>
2474 </dd>
2476 diff.renames
2477 </dt>
2478 <dd>
2479 <p>
2480 Tells git to detect renames. If set to any boolean value, it
2481 will enable basic rename detection. If set to "copies" or
2482 "copy", it will detect copies, as well.
2483 </p>
2484 </dd>
2486 diff.suppressBlankEmpty
2487 </dt>
2488 <dd>
2489 <p>
2490 A boolean to inhibit the standard behavior of printing a space
2491 before each empty output line. Defaults to false.
2492 </p>
2493 </dd>
2496 </dt>
2497 <dd>
2498 <p>
2500 for details.
2501 </p>
2502 </dd>
2505 </dt>
2506 <dd>
2507 <p>
2508 The regular expression that the diff driver should use to
2509 recognize the hunk header. A built-in pattern may also be used.
2511 </p>
2512 </dd>
2515 </dt>
2516 <dd>
2517 <p>
2518 Set this option to true to make the diff driver treat files as
2520 </p>
2521 </dd>
2524 </dt>
2525 <dd>
2526 <p>
2527 The command that the diff driver should call to generate the
2528 text-converted version of a file. The result of the
2529 conversion is used to generate a human-readable diff. See
2531 </p>
2532 </dd>
2535 </dt>
2536 <dd>
2537 <p>
2538 The regular expression that the diff driver should use to
2540 details.
2541 </p>
2542 </dd>
2545 </dt>
2546 <dd>
2547 <p>
2548 Set this option to true to make the diff driver cache the text
2550 </p>
2551 </dd>
2553 diff.tool
2554 </dt>
2555 <dd>
2556 <p>
2560 "kompare". Any other value is treated as a custom diff tool,
2562 option.
2563 </p>
2564 </dd>
2567 </dt>
2568 <dd>
2569 <p>
2570 Override the path for the given tool. This is useful in case
2571 your tool is not in the PATH.
2572 </p>
2573 </dd>
2576 </dt>
2577 <dd>
2578 <p>
2579 Specify the command to invoke the specified diff tool.
2580 The specified command is evaluated in shell with the following
2583 is set to the name of the temporary file containing the contents
2584 of the diff post-image.
2585 </p>
2586 </dd>
2588 difftool.prompt
2589 </dt>
2590 <dd>
2591 <p>
2592 Prompt before each invocation of the diff tool.
2593 </p>
2594 </dd>
2596 diff.wordRegex
2597 </dt>
2598 <dd>
2599 <p>
2600 A POSIX Extended Regular Expression used to determine what is a "word"
2601 when performing word-by-word difference calculations. Character
2602 sequences that match the regular expression are "words", all other
2604 </p>
2605 </dd>
2607 fetch.recurseSubmodules
2608 </dt>
2609 <dd>
2610 <p>
2612 Setting it to a boolean changes the behavior of fetch and pull to
2613 unconditionally recurse into submodules when set to true or to not
2615 value), fetch and pull will only recurse into a populated submodule
2616 when its superproject retrieves a commit that updates the submodule’s
2617 reference.
2618 </p>
2619 </dd>
2621 fetch.fsckObjects
2622 </dt>
2623 <dd>
2624 <p>
2625 If it is set to true, git-fetch-pack will check all fetched
2626 objects. It will abort in the case of a malformed object or a
2627 broken link. The result of an abort are only dangling objects.
2629 is used instead.
2630 </p>
2631 </dd>
2633 fetch.unpackLimit
2634 </dt>
2635 <dd>
2636 <p>
2637 If the number of objects fetched over the git native
2638 transfer is below this
2639 limit, then the objects will be unpacked into loose object
2640 files. However if the number of received objects equals or
2641 exceeds this limit then the received pack will be stored as
2642 a pack, after adding any missing delta bases. Storing the
2643 pack from a push can make the push operation complete faster,
2644 especially on slow filesystems. If not set, the value of
2646 </p>
2647 </dd>
2649 format.attach
2650 </dt>
2651 <dd>
2652 <p>
2653 Enable multipart/mixed attachments as the default for
2655 which will enable attachments as the default and set the
2656 value as the boundary. See the --attach option in
2658 </p>
2659 </dd>
2661 format.numbered
2662 </dt>
2663 <dd>
2664 <p>
2665 A boolean which can enable or disable sequence numbers in patch
2666 subjects. It defaults to "auto" which enables it only if there
2667 is more than one patch. It can be enabled or disabled for all
2670 </p>
2671 </dd>
2673 format.headers
2674 </dt>
2675 <dd>
2676 <p>
2677 Additional email headers to include in a patch to be submitted
2679 </p>
2680 </dd>
2682 format.to
2683 </dt>
2685 format.cc
2686 </dt>
2687 <dd>
2688 <p>
2689 Additional recipients to include in a patch to be submitted
2690 by mail. See the --to and --cc options in
2692 </p>
2693 </dd>
2695 format.subjectprefix
2696 </dt>
2697 <dd>
2698 <p>
2700 subject prefix. Use this variable to change that prefix.
2701 </p>
2702 </dd>
2704 format.signature
2705 </dt>
2706 <dd>
2707 <p>
2708 The default for format-patch is to output a signature containing
2709 the git version number. Use this variable to change that default.
2710 Set this variable to the empty string ("") to suppress
2711 signature generation.
2712 </p>
2713 </dd>
2715 format.suffix
2716 </dt>
2717 <dd>
2718 <p>
2719 The default for format-patch is to output files with the suffix
2721 include the dot if you want it).
2722 </p>
2723 </dd>
2725 format.pretty
2726 </dt>
2727 <dd>
2728 <p>
2729 The default pretty format for log/show/whatchanged command,
2732 </p>
2733 </dd>
2735 format.thread
2736 </dt>
2737 <dd>
2738 <p>
2741 makes every mail a reply to the head of the series,
2742 where the head is chosen from the cover letter, the
2746 value disables threading.
2747 </p>
2748 </dd>
2750 format.signoff
2751 </dt>
2752 <dd>
2753 <p>
2756 patch should be a conscious act and means that you certify you have
2757 the rights to submit this work under the same open source license.
2759 </p>
2760 </dd>
2763 </dt>
2764 <dd>
2765 <p>
2766 The command which is used to convert the content of a worktree
2768 details.
2769 </p>
2770 </dd>
2773 </dt>
2774 <dd>
2775 <p>
2776 The command which is used to convert the content of a blob
2777 object to a worktree file upon checkout. See
2779 </p>
2780 </dd>
2782 gc.aggressiveWindow
2783 </dt>
2784 <dd>
2785 <p>
2786 The window size parameter used in the delta compression
2788 to 250.
2789 </p>
2790 </dd>
2792 gc.auto
2793 </dt>
2794 <dd>
2795 <p>
2796 When there are approximately more than this many loose
2798 Some Porcelain commands use this command to perform a
2799 light-weight garbage collection from time to time. The
2801 </p>
2802 </dd>
2804 gc.autopacklimit
2805 </dt>
2806 <dd>
2807 <p>
2808 When there are more than this many packs that are not
2810 --auto</tt> consolidates them into one larger pack. The
2812 </p>
2813 </dd>
2815 gc.packrefs
2816 </dt>
2817 <dd>
2818 <p>
2820 unclonable by Git versions prior to 1.5.1.2 over dumb
2821 transports such as HTTP. This variable determines whether
2823 to enable it within all non-bare repos or it can be set to a
2825 </p>
2826 </dd>
2828 gc.pruneexpire
2829 </dt>
2830 <dd>
2831 <p>
2833 Override the grace period with this config variable. The value
2834 "now" may be used to disable this grace period and always prune
2835 unreachable objects immediately.
2836 </p>
2837 </dd>
2839 gc.reflogexpire
2840 </dt>
2843 </dt>
2844 <dd>
2845 <p>
2848 "refs/stash") in the middle the setting applies only to
2850 </p>
2851 </dd>
2853 gc.reflogexpireunreachable
2854 </dt>
2857 </dt>
2858 <dd>
2859 <p>
2861 this time and are not reachable from the current tip;
2863 in the middle, the setting applies only to the refs that
2865 </p>
2866 </dd>
2868 gc.rerereresolved
2869 </dt>
2870 <dd>
2871 <p>
2872 Records of conflicted merge you resolved earlier are
2875 </p>
2876 </dd>
2878 gc.rerereunresolved
2879 </dt>
2880 <dd>
2881 <p>
2882 Records of conflicted merge you have not resolved are
2885 </p>
2886 </dd>
2888 gitcvs.commitmsgannotation
2889 </dt>
2890 <dd>
2891 <p>
2892 Append this string to each commit message. Set to empty string
2893 to disable this feature. Defaults to "via git-CVS emulator".
2894 </p>
2895 </dd>
2897 gitcvs.enabled
2898 </dt>
2899 <dd>
2900 <p>
2901 Whether the CVS server interface is enabled for this repository.
2903 </p>
2904 </dd>
2906 gitcvs.logfile
2907 </dt>
2908 <dd>
2909 <p>
2910 Path to a log file where the CVS server interface well… logs
2912 </p>
2913 </dd>
2915 gitcvs.usecrlfattr
2916 </dt>
2917 <dd>
2918 <p>
2919 If true, the server will look up the end-of-line conversion
2921 the attributes force git to treat a file as text,
2923 treat it as text. If they suppress text conversion, the file
2925 the client might otherwise do. If the attributes do not allow
2928 </p>
2929 </dd>
2931 gitcvs.allbinary
2932 </dt>
2933 <dd>
2934 <p>
2937 unresolved files are sent to the client in
2939 as binary files, which suppresses any newline munging it
2940 otherwise might do. Alternatively, if it is set to "guess",
2941 then the contents of the file are examined to decide if
2943 </p>
2944 </dd>
2946 gitcvs.dbname
2947 </dt>
2948 <dd>
2949 <p>
2950 Database used by git-cvsserver to cache revision information
2951 derived from the git repository. The exact meaning depends on the
2952 used database driver, for SQLite (which is the default driver) this
2953 is a filename. Supports variable substitution (see
2954 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<tt>;</tt>).
2956 </p>
2957 </dd>
2959 gitcvs.dbdriver
2960 </dt>
2961 <dd>
2962 <p>
2963 Used Perl DBI driver. You can specify any available driver
2964 for this here, but it might not work. git-cvsserver is tested
2969 </p>
2970 </dd>
2972 gitcvs.dbuser, gitcvs.dbpass
2973 </dt>
2974 <dd>
2975 <p>
2977 since SQLite has no concept of database users and/or passwords.
2980 </p>
2981 </dd>
2983 gitcvs.dbTableNamePrefix
2984 </dt>
2985 <dd>
2986 <p>
2987 Database table name prefix. Prepended to the names of any
2988 database tables used, allowing a single database to be used
2989 for several repositories. Supports variable substitution (see
2991 characters will be replaced with underscores.
2992 </p>
2993 </dd>
2994 </dl></div>
2999 access method.</p></div>
3002 gitweb.category
3003 </dt>
3005 gitweb.description
3006 </dt>
3008 gitweb.owner
3009 </dt>
3011 gitweb.url
3012 </dt>
3013 <dd>
3014 <p>
3016 </p>
3017 </dd>
3019 gitweb.avatar
3020 </dt>
3022 gitweb.blame
3023 </dt>
3025 gitweb.grep
3026 </dt>
3028 gitweb.highlight
3029 </dt>
3031 gitweb.patches
3032 </dt>
3034 gitweb.pickaxe
3035 </dt>
3037 gitweb.remote_heads
3038 </dt>
3040 gitweb.showsizes
3041 </dt>
3043 gitweb.snapshot
3044 </dt>
3045 <dd>
3046 <p>
3048 </p>
3049 </dd>
3051 grep.lineNumber
3052 </dt>
3053 <dd>
3054 <p>
3056 </p>
3057 </dd>
3059 grep.extendedRegexp
3060 </dt>
3061 <dd>
3062 <p>
3064 </p>
3065 </dd>
3067 gui.commitmsgwidth
3068 </dt>
3069 <dd>
3070 <p>
3071 Defines how wide the commit message window is in the
3073 </p>
3074 </dd>
3076 gui.diffcontext
3077 </dt>
3078 <dd>
3079 <p>
3080 Specifies how many context lines should be used in calls to diff
3082 </p>
3083 </dd>
3085 gui.encoding
3086 </dt>
3087 <dd>
3088 <p>
3089 Specifies the default encoding to use for displaying of
3093 If this option is not set, the tools default to the
3094 locale encoding.
3095 </p>
3096 </dd>
3098 gui.matchtrackingbranch
3099 </dt>
3100 <dd>
3101 <p>
3103 default to tracking remote branches with matching names or
3104 not. Default: "false".
3105 </p>
3106 </dd>
3108 gui.newbranchtemplate
3109 </dt>
3110 <dd>
3111 <p>
3112 Is used as suggested name when creating new branches using the
3114 </p>
3115 </dd>
3117 gui.pruneduringfetch
3118 </dt>
3119 <dd>
3120 <p>
3122 performing a fetch. The default value is "false".
3123 </p>
3124 </dd>
3126 gui.trustmtime
3127 </dt>
3128 <dd>
3129 <p>
3131 timestamp or not. By default the timestamps are not trusted.
3132 </p>
3133 </dd>
3135 gui.spellingdictionary
3136 </dt>
3137 <dd>
3138 <p>
3139 Specifies the dictionary used for spell checking commit messages in
3141 off.
3142 </p>
3143 </dd>
3145 gui.fastcopyblame
3146 </dt>
3147 <dd>
3148 <p>
3150 location detection. It makes blame significantly faster on huge
3151 repositories at the expense of less thorough copy detection.
3152 </p>
3153 </dd>
3155 gui.copyblamethreshold
3156 </dt>
3157 <dd>
3158 <p>
3160 detection, measured in alphanumeric characters. See the
3162 </p>
3163 </dd>
3165 gui.blamehistoryctx
3166 </dt>
3167 <dd>
3168 <p>
3169 Specifies the radius of history context in days to show in
3172 variable is set to zero, the whole history is shown.
3173 </p>
3174 </dd>
3177 </dt>
3178 <dd>
3179 <p>
3180 Specifies the shell command line to execute when the corresponding item
3182 mandatory for every tool. The command is executed from the root of
3183 the working directory, and in the environment it receives the name of
3187 </p>
3188 </dd>
3191 </dt>
3192 <dd>
3193 <p>
3194 Run the tool only if a diff is selected in the GUI. It guarantees
3196 </p>
3197 </dd>
3200 </dt>
3201 <dd>
3202 <p>
3203 Run the command silently, without creating a window to display its
3204 output.
3205 </p>
3206 </dd>
3209 </dt>
3210 <dd>
3211 <p>
3212 Don’t rescan the working directory for changes after the tool
3213 finishes execution.
3214 </p>
3215 </dd>
3218 </dt>
3219 <dd>
3220 <p>
3221 Show a confirmation dialog before actually running the tool.
3222 </p>
3223 </dd>
3226 </dt>
3227 <dd>
3228 <p>
3229 Request a string argument from the user, and pass it to the tool
3233 the dialog uses a built-in generic prompt; otherwise the exact
3234 value of the variable is used.
3235 </p>
3236 </dd>
3239 </dt>
3240 <dd>
3241 <p>
3242 Request a single valid revision from the user, and set the
3245 </p>
3246 </dd>
3249 </dt>
3250 <dd>
3251 <p>
3253 This is useful for tools similar to merge or rebase, but not
3254 for things like checkout or reset.
3255 </p>
3256 </dd>
3259 </dt>
3260 <dd>
3261 <p>
3262 Specifies the title to use for the prompt dialog. The default
3263 is the tool name.
3264 </p>
3265 </dd>
3268 </dt>
3269 <dd>
3270 <p>
3271 Specifies the general prompt string to display at the top of
3273 The default value includes the actual command.
3274 </p>
3275 </dd>
3277 help.browser
3278 </dt>
3279 <dd>
3280 <p>
3281 Specify the browser that will be used to display help in the
3283 </p>
3284 </dd>
3286 help.format
3287 </dt>
3288 <dd>
3289 <p>
3291 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
3293 </p>
3294 </dd>
3296 help.autocorrect
3297 </dt>
3298 <dd>
3299 <p>
3300 Automatically correct and execute mistyped commands after
3301 waiting for the given number of deciseconds (0.1 sec). If more
3302 than one command can be deduced from the entered text, nothing
3303 will be executed. If the value of this option is negative,
3304 the corrected command will be executed immediately. If the
3305 value is 0 - the command will be just shown but not executed.
3306 This is the default.
3307 </p>
3308 </dd>
3310 http.proxy
3311 </dt>
3312 <dd>
3313 <p>
3317 </p>
3318 </dd>
3320 http.cookiefile
3321 </dt>
3322 <dd>
3323 <p>
3324 File containing previously stored cookie lines which should be used
3325 in the git http session, if they match the server. The file format
3326 of the file to read cookies from should be plain HTTP headers or
3328 NOTE that the file specified with http.cookiefile is only used as
3329 input. No cookies will be stored in the file.
3330 </p>
3331 </dd>
3333 http.sslVerify
3334 </dt>
3335 <dd>
3336 <p>
3337 Whether to verify the SSL certificate when fetching or pushing
3339 variable.
3340 </p>
3341 </dd>
3343 http.sslCert
3344 </dt>
3345 <dd>
3346 <p>
3347 File containing the SSL certificate when fetching or pushing
3349 variable.
3350 </p>
3351 </dd>
3353 http.sslKey
3354 </dt>
3355 <dd>
3356 <p>
3357 File containing the SSL private key when fetching or pushing
3359 variable.
3360 </p>
3361 </dd>
3363 http.sslCertPasswordProtected
3364 </dt>
3365 <dd>
3366 <p>
3367 Enable git’s password prompt for the SSL certificate. Otherwise
3368 OpenSSL will prompt the user, possibly many times, if the
3369 certificate or private key is encrypted. Can be overridden by the
3371 </p>
3372 </dd>
3374 http.sslCAInfo
3375 </dt>
3376 <dd>
3377 <p>
3378 File containing the certificates to verify the peer with when
3379 fetching or pushing over HTTPS. Can be overridden by the
3381 </p>
3382 </dd>
3384 http.sslCAPath
3385 </dt>
3386 <dd>
3387 <p>
3388 Path containing files with the CA certificates to verify the peer
3389 with when fetching or pushing over HTTPS. Can be overridden
3391 </p>
3392 </dd>
3394 http.maxRequests
3395 </dt>
3396 <dd>
3397 <p>
3398 How many HTTP requests to launch in parallel. Can be overridden
3400 </p>
3401 </dd>
3403 http.minSessions
3404 </dt>
3405 <dd>
3406 <p>
3407 The number of curl sessions (counted across slots) to be kept across
3408 requests. They will not be ended with curl_easy_cleanup() until
3409 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
3411 </p>
3412 </dd>
3414 http.postBuffer
3415 </dt>
3416 <dd>
3417 <p>
3418 Maximum size in bytes of the buffer used by smart HTTP
3419 transports when POSTing data to the remote system.
3420 For requests larger than this buffer size, HTTP/1.1 and
3421 Transfer-Encoding: chunked is used to avoid creating a
3422 massive pack file locally. Default is 1 MiB, which is
3423 sufficient for most requests.
3424 </p>
3425 </dd>
3427 http.lowSpeedLimit, http.lowSpeedTime
3428 </dt>
3429 <dd>
3430 <p>
3435 </p>
3436 </dd>
3438 http.noEPSV
3439 </dt>
3440 <dd>
3441 <p>
3442 A boolean which disables using of EPSV ftp command by curl.
3445 environment variable. Default is false (curl will use EPSV).
3446 </p>
3447 </dd>
3449 http.useragent
3450 </dt>
3451 <dd>
3452 <p>
3453 The HTTP USER_AGENT string presented to an HTTP server. The default
3454 value represents the version of the client git such as git/1.7.1.
3455 This option allows you to override this value to a more common value
3456 such as Mozilla/4.0. This may be necessary, for instance, if
3457 connecting through a firewall that restricts HTTP connections to a set
3458 of common USER_AGENT strings (but not including those like git/1.7.1).
3460 </p>
3461 </dd>
3463 i18n.commitEncoding
3464 </dt>
3465 <dd>
3466 <p>
3467 Character encoding the commit messages are stored in; git itself
3468 does not care per se, but this information is necessary e.g. when
3469 importing commits from emails or in the gitk graphical history
3470 browser (and possibly at other places in the future or in other
3471 porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
3472 </p>
3473 </dd>
3475 i18n.logOutputEncoding
3476 </dt>
3477 <dd>
3478 <p>
3479 Character encoding the commit messages are converted to when
3481 </p>
3482 </dd>
3484 imap
3485 </dt>
3486 <dd>
3487 <p>
3490 </p>
3491 </dd>
3493 init.templatedir
3494 </dt>
3495 <dd>
3496 <p>
3497 Specify the directory from which templates will be copied.
3499 </p>
3500 </dd>
3502 instaweb.browser
3503 </dt>
3504 <dd>
3505 <p>
3506 Specify the program that will be used to browse your working
3508 </p>
3509 </dd>
3511 instaweb.httpd
3512 </dt>
3513 <dd>
3514 <p>
3515 The HTTP daemon command-line to start gitweb on your working
3517 </p>
3518 </dd>
3520 instaweb.local
3521 </dt>
3522 <dd>
3523 <p>
3525 be bound to the local IP (127.0.0.1).
3526 </p>
3527 </dd>
3529 instaweb.modulepath
3530 </dt>
3531 <dd>
3532 <p>
3534 instead of /usr/lib/apache2/modules. Only used if httpd
3535 is Apache.
3536 </p>
3537 </dd>
3539 instaweb.port
3540 </dt>
3541 <dd>
3542 <p>
3543 The port number to bind the gitweb httpd to. See
3545 </p>
3546 </dd>
3548 interactive.singlekey
3549 </dt>
3550 <dd>
3551 <p>
3552 In interactive commands, allow the user to provide one-letter
3553 input with a single key (i.e., without hitting enter).
3555 <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
3556 <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>. Note that this
3557 setting is silently ignored if portable keystroke input
3558 is not available.
3559 </p>
3560 </dd>
3562 log.abbrevCommit
3563 </dt>
3564 <dd>
3565 <p>
3566 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
3569 </p>
3570 </dd>
3572 log.date
3573 </dt>
3574 <dd>
3575 <p>
3579 <tt>default</tt>, <tt>iso</tt>, <tt>rfc</tt>, and <tt>short</tt>; see <a href="git-log.html">git-log(1)</a>
3580 for details.
3581 </p>
3582 </dd>
3584 log.decorate
3585 </dt>
3586 <dd>
3587 <p>
3588 Print out the ref names of any commits that are shown by the log
3591 specified, the full ref name (including prefix) will be printed.
3593 </p>
3594 </dd>
3596 log.showroot
3597 </dt>
3598 <dd>
3599 <p>
3600 If true, the initial commit will be shown as a big creation event.
3601 This is equivalent to a diff against an empty tree.
3602 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
3603 normally hide the root commit will now show it. True by default.
3604 </p>
3605 </dd>
3607 mailmap.file
3608 </dt>
3609 <dd>
3610 <p>
3611 The location of an augmenting mailmap file. The default
3612 mailmap, located in the root of the repository, is loaded
3613 first, then the mailmap file pointed to by this variable.
3614 The location of the mailmap file may be in a repository
3615 subdirectory, or somewhere outside of the repository itself.
3616 See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
3617 </p>
3618 </dd>
3620 man.viewer
3621 </dt>
3622 <dd>
3623 <p>
3624 Specify the programs that may be used to display help in the
3626 </p>
3627 </dd>
3630 </dt>
3631 <dd>
3632 <p>
3633 Specify the command to invoke the specified man viewer. The
3634 specified command is evaluated in shell with the man page
3636 </p>
3637 </dd>
3640 </dt>
3641 <dd>
3642 <p>
3643 Override the path for the given tool that may be used to
3645 </p>
3646 </dd>
3648 merge.conflictstyle
3649 </dt>
3650 <dd>
3651 <p>
3652 Specify the style in which conflicted hunks are written out to
3653 working tree files upon merge. The default is "merge", which
3656 a <tt>>>>>>>></tt> marker. An alternate style, "diff3", adds a <tt>|||||||</tt>
3658 </p>
3659 </dd>
3661 merge.defaultToUpstream
3662 </dt>
3663 <dd>
3664 <p>
3665 If merge is called without any commit argument, merge the upstream
3666 branches configured for the current branch by using their last
3667 observed values stored in their remote tracking branches.
3671 to their corresponding remote tracking branches, and the tips of
3672 these tracking branches are merged.
3673 </p>
3674 </dd>
3676 merge.ff
3677 </dt>
3678 <dd>
3679 <p>
3680 By default, git does not create an extra merge commit when merging
3681 a commit that is a descendant of the current commit. Instead, the
3683 this variable tells git to create an extra merge commit in such
3687 command line).
3688 </p>
3689 </dd>
3691 merge.log
3692 </dt>
3693 <dd>
3694 <p>
3695 In addition to branch names, populate the log message with at
3696 most the specified number of one-line descriptions from the
3697 actual commits that are being merged. Defaults to false, and
3698 true is a synonym for 20.
3699 </p>
3700 </dd>
3702 merge.renameLimit
3703 </dt>
3704 <dd>
3705 <p>
3706 The number of files to consider when performing rename detection
3707 during a merge; if not specified, defaults to the value of
3708 diff.renameLimit.
3709 </p>
3710 </dd>
3712 merge.renormalize
3713 </dt>
3714 <dd>
3715 <p>
3716 Tell git that canonical representation of files in the
3717 repository has changed over time (e.g. earlier commits record
3718 text files with CRLF line endings, but recent ones use LF line
3719 endings). In such a repository, git can convert the data
3720 recorded in commits to a canonical form before performing a
3721 merge to reduce unnecessary conflicts. For more information,
3722 see section "Merging branches with differing checkin/checkout
3724 </p>
3725 </dd>
3727 merge.stat
3728 </dt>
3729 <dd>
3730 <p>
3731 Whether to print the diffstat between ORIG_HEAD and the merge result
3732 at the end of the merge. True by default.
3733 </p>
3734 </dd>
3736 merge.tool
3737 </dt>
3738 <dd>
3739 <p>
3740 Controls which merge resolution program is used by
3744 and "xxdiff". Any other value is treated is custom merge tool
3746 </p>
3747 </dd>
3749 merge.verbosity
3750 </dt>
3751 <dd>
3752 <p>
3753 Controls the amount of output shown by the recursive merge
3754 strategy. Level 0 outputs nothing except a final error
3755 message if conflicts were detected. Level 1 outputs only
3757 above outputs debugging information. The default is level 2.
3759 </p>
3760 </dd>
3763 </dt>
3764 <dd>
3765 <p>
3766 Defines a human-readable name for a custom low-level
3768 </p>
3769 </dd>
3772 </dt>
3773 <dd>
3774 <p>
3775 Defines the command that implements a custom low-level
3777 </p>
3778 </dd>
3781 </dt>
3782 <dd>
3783 <p>
3784 Names a low-level merge driver to be used when
3785 performing an internal merge between common ancestors.
3787 </p>
3788 </dd>
3791 </dt>
3792 <dd>
3793 <p>
3794 Override the path for the given tool. This is useful in case
3795 your tool is not in the PATH.
3796 </p>
3797 </dd>
3800 </dt>
3801 <dd>
3802 <p>
3803 Specify the command to invoke the specified merge tool. The
3804 specified command is evaluated in shell with the following
3806 containing the common base of the files to be merged, if available;
3809 file containing the contents of the file from the branch being
3811 tool should write the results of a successful merge.
3812 </p>
3813 </dd>
3816 </dt>
3817 <dd>
3818 <p>
3819 For a custom merge command, specify whether the exit code of
3820 the merge command can be used to determine whether the merge was
3821 successful. If this is not set to true then the merge target file
3822 timestamp is checked and the merge assumed to have been successful
3823 if the file has been updated, otherwise the user is prompted to
3824 indicate the success of the merge.
3825 </p>
3826 </dd>
3828 mergetool.keepBackup
3829 </dt>
3830 <dd>
3831 <p>
3832 After performing a merge, the original file with conflict markers
3836 </p>
3837 </dd>
3839 mergetool.keepTemporaries
3840 </dt>
3841 <dd>
3842 <p>
3843 When invoking a custom merge tool, git uses a set of temporary
3844 files to pass to the tool. If the tool returns an error and this
3846 preserved, otherwise they will be removed after the tool has
3848 </p>
3849 </dd>
3851 mergetool.prompt
3852 </dt>
3853 <dd>
3854 <p>
3855 Prompt before each invocation of the merge resolution program.
3856 </p>
3857 </dd>
3859 notes.displayRef
3860 </dt>
3861 <dd>
3862 <p>
3863 The (fully qualified) refname from which to show notes when
3864 showing commit messages. The value of this variable can be set
3865 to a glob, in which case notes from all matching refs will be
3866 shown. You may also specify this configuration variable
3867 several times. A warning will be issued for refs that do not
3868 exist, but a glob that does not match any refs is silently
3869 ignored.
3870 </p>
3871 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_DISPLAY_REF</tt>
3872 environment variable, which must be a colon separated list of refs or
3873 globs.</p></div>
3875 GIT_NOTES_REF) is also implicitly added to the list of refs to be
3876 displayed.</p></div>
3877 </dd>
3880 </dt>
3881 <dd>
3882 <p>
3885 automatically copies your notes from the original to the
3887 "notes.rewriteRef" below.
3888 </p>
3889 </dd>
3891 notes.rewriteMode
3892 </dt>
3893 <dd>
3894 <p>
3895 When copying notes during a rewrite (see the
3896 "notes.rewrite.<command>" option), determines what to do if
3897 the target commit already has a note. Must be one of
3900 </p>
3901 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_MODE</tt>
3902 environment variable.</p></div>
3903 </dd>
3905 notes.rewriteRef
3906 </dt>
3907 <dd>
3908 <p>
3909 When copying notes during a rewrite, specifies the (fully
3910 qualified) ref whose notes should be copied. The ref may be a
3911 glob, in which case notes in all matching refs will be copied.
3912 You may also specify this configuration several times.
3913 </p>
3916 rewriting for the default commit notes.</p></div>
3917 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_REF</tt>
3918 environment variable, which must be a colon separated list of refs or
3919 globs.</p></div>
3920 </dd>
3922 pack.window
3923 </dt>
3924 <dd>
3925 <p>
3927 window size is given on the command line. Defaults to 10.
3928 </p>
3929 </dd>
3931 pack.depth
3932 </dt>
3933 <dd>
3934 <p>
3935 The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
3936 maximum depth is given on the command line. Defaults to 50.
3937 </p>
3938 </dd>
3940 pack.windowMemory
3941 </dt>
3942 <dd>
3943 <p>
3945 when no limit is given on the command line. The value can be
3947 limit.
3948 </p>
3949 </dd>
3951 pack.compression
3952 </dt>
3953 <dd>
3954 <p>
3958 slowest. If not set, defaults to core.compression. If that is
3960 compromise between speed and compression (currently equivalent
3961 to level 6)."
3962 </p>
3963 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
3964 all existing objects. You can force recompression by passing the -F option
3966 </dd>
3968 pack.deltaCacheSize
3969 </dt>
3970 <dd>
3971 <p>
3972 The maximum memory in bytes used for caching deltas in
3974 This cache is used to speed up the writing object phase by not
3975 having to recompute the final delta result once the best match
3976 for all objects is found. Repacking large repositories on machines
3977 which are tight with memory might be badly impacted by this though,
3978 especially if this cache pushes the system into swapping.
3980 used to virtually disable this cache. Defaults to 256 MiB.
3981 </p>
3982 </dd>
3984 pack.deltaCacheLimit
3985 </dt>
3986 <dd>
3987 <p>
3988 The maximum size of a delta, that is cached in
3990 writing object phase by not having to recompute the final delta
3991 result once the best match for all objects is found. Defaults to 1000.
3992 </p>
3993 </dd>
3995 pack.threads
3996 </dt>
3997 <dd>
3998 <p>
3999 Specifies the number of threads to spawn when searching for best
4001 be compiled with pthreads otherwise this option is ignored with a
4002 warning. This is meant to reduce packing time on multiprocessor
4003 machines. The required amount of memory for the delta search window
4004 is however multiplied by the number of threads.
4006 and set the number of threads accordingly.
4007 </p>
4008 </dd>
4010 pack.indexVersion
4011 </dt>
4012 <dd>
4013 <p>
4014 Specify the default pack index version. Valid values are 1 for
4016 the new pack index with capabilities for packs larger than 4 GB
4017 as well as proper protection against the repacking of corrupted
4019 and this config option ignored whenever the corresponding pack is
4020 larger than 2 GB.
4021 </p>
4022 <div class="paragraph"><p>If you have an old git that does not understand the version 2 <tt>*.idx</tt> file,
4024 that will copy both <tt>*.pack</tt> file and corresponding <tt>*.idx</tt> file from the
4025 other side may give you a repository that cannot be accessed with your
4027 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
4029 </dd>
4031 pack.packSizeLimit
4032 </dt>
4033 <dd>
4034 <p>
4035 The maximum size of a pack. This setting only affects
4036 packing to a file when repacking, i.e. the git:// protocol
4039 limited to 1 MiB. The default is unlimited.
4041 supported.
4042 </p>
4043 </dd>
4046 </dt>
4047 <dd>
4048 <p>
4049 If the value is boolean, turns on or off pagination of the
4050 output of a particular git subcommand when writing to a tty.
4051 Otherwise, turns on pagination for the subcommand using the
4054 precedence over this option. To disable pagination for all
4056 </p>
4057 </dd>
4060 </dt>
4061 <dd>
4062 <p>
4063 Alias for a --pretty= format string, as specified in
4065 as the built-in pretty formats could. For example,
4069 Note that an alias with the same name as a built-in format
4070 will be silently ignored.
4071 </p>
4072 </dd>
4074 pull.octopus
4075 </dt>
4076 <dd>
4077 <p>
4078 The default merge strategy to use when pulling multiple branches
4079 at once.
4080 </p>
4081 </dd>
4083 pull.twohead
4084 </dt>
4085 <dd>
4086 <p>
4087 The default merge strategy to use when pulling a single branch.
4088 </p>
4089 </dd>
4091 push.default
4092 </dt>
4093 <dd>
4094 <p>
4095 Defines the action git push should take if no refspec is given
4096 on the command line, no refspec is configured in the remote, and
4097 no refspec is implied by any of the options given on the command
4098 line. Possible values are:
4099 </p>
4101 <li>
4102 <p>
4104 </p>
4105 </li>
4106 <li>
4107 <p>
4109 All branches having the same name in both ends are considered to be
4110 matching. This is the default.
4111 </p>
4112 </li>
4113 <li>
4114 <p>
4116 </p>
4117 </li>
4118 <li>
4119 <p>
4121 </p>
4122 </li>
4123 <li>
4124 <p>
4126 </p>
4127 </li>
4128 </ul></div>
4129 </dd>
4131 rebase.stat
4132 </dt>
4133 <dd>
4134 <p>
4135 Whether to show a diffstat of what changed upstream since the last
4136 rebase. False by default.
4137 </p>
4138 </dd>
4140 rebase.autosquash
4141 </dt>
4142 <dd>
4143 <p>
4145 </p>
4146 </dd>
4148 receive.autogc
4149 </dt>
4150 <dd>
4151 <p>
4152 By default, git-receive-pack will run "git-gc --auto" after
4153 receiving data from git-push and updating refs. You can stop
4154 it by setting this variable to false.
4155 </p>
4156 </dd>
4158 receive.fsckObjects
4159 </dt>
4160 <dd>
4161 <p>
4162 If it is set to true, git-receive-pack will check all received
4163 objects. It will abort in the case of a malformed object or a
4164 broken link. The result of an abort are only dangling objects.
4166 is used instead.
4167 </p>
4168 </dd>
4170 receive.unpackLimit
4171 </dt>
4172 <dd>
4173 <p>
4174 If the number of objects received in a push is below this
4175 limit then the objects will be unpacked into loose object
4176 files. However if the number of received objects equals or
4177 exceeds this limit then the received pack will be stored as
4178 a pack, after adding any missing delta bases. Storing the
4179 pack from a push can make the push operation complete faster,
4180 especially on slow filesystems. If not set, the value of
4182 </p>
4183 </dd>
4185 receive.denyDeletes
4186 </dt>
4187 <dd>
4188 <p>
4189 If set to true, git-receive-pack will deny a ref update that deletes
4190 the ref. Use this to prevent such a ref deletion via a push.
4191 </p>
4192 </dd>
4194 receive.denyDeleteCurrent
4195 </dt>
4196 <dd>
4197 <p>
4198 If set to true, git-receive-pack will deny a ref update that
4199 deletes the currently checked out branch of a non-bare repository.
4200 </p>
4201 </dd>
4203 receive.denyCurrentBranch
4204 </dt>
4205 <dd>
4206 <p>
4207 If set to true or "refuse", git-receive-pack will deny a ref update
4208 to the currently checked out branch of a non-bare repository.
4209 Such a push is potentially dangerous because it brings the HEAD
4210 out of sync with the index and working tree. If set to "warn",
4211 print a warning of such a push to stderr, but allow the push to
4212 proceed. If set to false or "ignore", allow such pushes with no
4213 message. Defaults to "refuse".
4214 </p>
4215 </dd>
4217 receive.denyNonFastForwards
4218 </dt>
4219 <dd>
4220 <p>
4221 If set to true, git-receive-pack will deny a ref update which is
4222 not a fast-forward. Use this to prevent such an update via a push,
4223 even if that push is forced. This configuration variable is
4224 set when initializing a shared repository.
4225 </p>
4226 </dd>
4228 receive.updateserverinfo
4229 </dt>
4230 <dd>
4231 <p>
4232 If set to true, git-receive-pack will run git-update-server-info
4233 after receiving data from git-push and updating refs.
4234 </p>
4235 </dd>
4238 </dt>
4239 <dd>
4240 <p>
4243 </p>
4244 </dd>
4247 </dt>
4248 <dd>
4249 <p>
4251 </p>
4252 </dd>
4255 </dt>
4256 <dd>
4257 <p>
4258 For remotes that require curl (http, https and ftp), the URL to
4259 the proxy to use for that remote. Set to the empty string to
4260 disable proxying for that remote.
4261 </p>
4262 </dd>
4265 </dt>
4266 <dd>
4267 <p>
4270 </p>
4271 </dd>
4274 </dt>
4275 <dd>
4276 <p>
4279 </p>
4280 </dd>
4283 </dt>
4284 <dd>
4285 <p>
4286 If true, pushing to this remote will automatically behave
4288 </p>
4289 </dd>
4292 </dt>
4293 <dd>
4294 <p>
4295 If true, this remote will be skipped by default when updating
4298 </p>
4299 </dd>
4302 </dt>
4303 <dd>
4304 <p>
4305 If true, this remote will be skipped by default when updating
4308 </p>
4309 </dd>
4312 </dt>
4313 <dd>
4314 <p>
4315 The default program to execute on the remote side when pushing. See
4317 </p>
4318 </dd>
4321 </dt>
4322 <dd>
4323 <p>
4324 The default program to execute on the remote side when fetching. See
4326 </p>
4327 </dd>
4330 </dt>
4331 <dd>
4332 <p>
4333 Setting this value to --no-tags disables automatic tag following when
4337 override this setting. See options --tags and --no-tags of
4339 </p>
4340 </dd>
4343 </dt>
4344 <dd>
4345 <p>
4348 </p>
4349 </dd>
4352 </dt>
4353 <dd>
4354 <p>
4355 The list of remotes which are fetched by "git remote update
4357 </p>
4358 </dd>
4360 repack.usedeltabaseoffset
4361 </dt>
4362 <dd>
4363 <p>
4365 delta-base offset. If you need to share your repository with
4366 git older than version 1.4.4, either directly or via a dumb
4367 protocol such as http, then you need to set this option to
4368 "false" and repack. Access from old git versions over the
4369 native protocol are unaffected by this option.
4370 </p>
4371 </dd>
4373 rerere.autoupdate
4374 </dt>
4375 <dd>
4376 <p>
4378 resulting contents after it cleanly resolves conflicts using
4379 previously recorded resolution. Defaults to false.
4380 </p>
4381 </dd>
4383 rerere.enabled
4384 </dt>
4385 <dd>
4386 <p>
4387 Activate recording of resolved conflicts, so that identical
4388 conflict hunks can be resolved automatically, should they
4392 </p>
4393 </dd>
4395 sendemail.identity
4396 </dt>
4397 <dd>
4398 <p>
4399 A configuration identity. When given, causes values in the
4403 </p>
4404 </dd>
4406 sendemail.smtpencryption
4407 </dt>
4408 <dd>
4409 <p>
4412 </p>
4413 </dd>
4415 sendemail.smtpssl
4416 </dt>
4417 <dd>
4418 <p>
4420 </p>
4421 </dd>
4424 </dt>
4425 <dd>
4426 <p>
4428 found below, taking precedence over those when the this
4429 identity is selected, through command-line or
4431 </p>
4432 </dd>
4434 sendemail.aliasesfile
4435 </dt>
4437 sendemail.aliasfiletype
4438 </dt>
4440 sendemail.bcc
4441 </dt>
4443 sendemail.cc
4444 </dt>
4446 sendemail.cccmd
4447 </dt>
4449 sendemail.chainreplyto
4450 </dt>
4452 sendemail.confirm
4453 </dt>
4455 sendemail.envelopesender
4456 </dt>
4458 sendemail.from
4459 </dt>
4461 sendemail.multiedit
4462 </dt>
4464 sendemail.signedoffbycc
4465 </dt>
4467 sendemail.smtppass
4468 </dt>
4470 sendemail.suppresscc
4471 </dt>
4473 sendemail.suppressfrom
4474 </dt>
4476 sendemail.to
4477 </dt>
4479 sendemail.smtpdomain
4480 </dt>
4482 sendemail.smtpserver
4483 </dt>
4485 sendemail.smtpserverport
4486 </dt>
4488 sendemail.smtpserveroption
4489 </dt>
4491 sendemail.smtpuser
4492 </dt>
4494 sendemail.thread
4495 </dt>
4497 sendemail.validate
4498 </dt>
4499 <dd>
4500 <p>
4502 </p>
4503 </dd>
4505 sendemail.signedoffcc
4506 </dt>
4507 <dd>
4508 <p>
4510 </p>
4511 </dd>
4513 showbranch.default
4514 </dt>
4515 <dd>
4516 <p>
4519 </p>
4520 </dd>
4522 status.relativePaths
4523 </dt>
4524 <dd>
4525 <p>
4528 relative to the repository root (this was the default for git
4529 prior to v1.5.4).
4530 </p>
4531 </dd>
4533 status.showUntrackedFiles
4534 </dt>
4535 <dd>
4536 <p>
4537 By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
4538 files which are not currently tracked by Git. Directories which
4539 contain only untracked files, are shown with the directory name
4540 only. Showing untracked files means that Git needs to lstat() all
4541 all the files in the whole repository, which might be slow on some
4542 systems. So, this variable controls how the commands displays
4543 the untracked files. Possible values are:
4544 </p>
4546 <li>
4547 <p>
4549 </p>
4550 </li>
4551 <li>
4552 <p>
4554 </p>
4555 </li>
4556 <li>
4557 <p>
4559 </p>
4560 </li>
4561 </ul></div>
4563 This variable can be overridden with the -u|--untracked-files option
4564 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
4565 </dd>
4567 status.submodulesummary
4568 </dt>
4569 <dd>
4570 <p>
4571 Defaults to false.
4572 If this is set to a non zero number or true (identical to -1 or an
4573 unlimited number), the submodule summary will be enabled and a
4574 summary of commits for modified submodules will be shown (see
4576 </p>
4577 </dd>
4580 </dt>
4583 </dt>
4586 </dt>
4587 <dd>
4588 <p>
4589 The path within this project, URL, and the updating strategy
4590 for a submodule. These variables are initially populated
4593 <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
4594 </p>
4595 </dd>
4598 </dt>
4599 <dd>
4600 <p>
4601 This option can be used to control recursive fetching of this
4602 submodule. It can be overridden by using the --[no-]recurse-submodules
4605 file.
4606 </p>
4607 </dd>
4610 </dt>
4611 <dd>
4612 <p>
4613 Defines under what circumstances "git status" and the diff family show
4614 a submodule as modified. When set to "all", it will never be considered
4615 modified, "dirty" will ignore all changes to the submodules work tree and
4616 takes only differences between the HEAD of the submodule and the commit
4617 recorded in the superproject into account. "untracked" will additionally
4618 let submodules with modified tracked files in their work tree show up.
4619 Using "none" (the default when this option is not set) also shows
4620 submodules that have untracked files in their work tree as changed.
4621 This setting overrides any setting made in .gitmodules for this submodule,
4622 both settings can be overridden on the command line by using the
4623 "--ignore-submodules" option.
4624 </p>
4625 </dd>
4627 tar.umask
4628 </dt>
4629 <dd>
4630 <p>
4631 This variable can be used to restrict the permission bits of
4632 tar archive entries. The default is 0002, which turns off the
4633 world write bit. The special value "user" indicates that the
4636 </p>
4637 </dd>
4639 transfer.fsckObjects
4640 </dt>
4641 <dd>
4642 <p>
4644 not set, the value of this variable is used instead.
4645 Defaults to false.
4646 </p>
4647 </dd>
4649 transfer.unpackLimit
4650 </dt>
4651 <dd>
4652 <p>
4654 not set, the value of this variable is used instead.
4655 The default value is 100.
4656 </p>
4657 </dd>
4660 </dt>
4661 <dd>
4662 <p>
4663 Any URL that starts with this value will be rewritten to
4665 large number of repositories, and serves them with multiple
4666 access methods, and some users need to use different access
4667 methods, this feature allows people to specify any of the
4668 equivalent URLs and have git automatically rewrite the URL to
4669 the best alternative for the particular user, even for a
4670 never-before-seen repository on the site. When more than one
4671 insteadOf strings match a given URL, the longest match is used.
4672 </p>
4673 </dd>
4676 </dt>
4677 <dd>
4678 <p>
4679 Any URL that starts with this value will not be pushed to;
4681 resulting URL will be pushed to. In cases where some site serves
4682 a large number of repositories, and serves them with multiple
4683 access methods, some of which do not allow push, this feature
4684 allows people to specify a pull-only URL and have git
4685 automatically use an appropriate URL to push, even for a
4686 never-before-seen repository on the site. When more than one
4687 pushInsteadOf strings match a given URL, the longest match is
4688 used. If a remote has an explicit pushurl, git will ignore this
4689 setting for that remote.
4690 </p>
4691 </dd>
4693 user.email
4694 </dt>
4695 <dd>
4696 <p>
4697 Your email address to be recorded in any newly created commits.
4699 <em>EMAIL</em> environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
4700 </p>
4701 </dd>
4703 user.name
4704 </dt>
4705 <dd>
4706 <p>
4707 Your full name to be recorded in any newly created commits.
4710 </p>
4711 </dd>
4713 user.signingkey
4714 </dt>
4715 <dd>
4716 <p>
4718 automatically when creating a signed tag, you can override the
4719 default selection with this variable. This option is passed
4720 unchanged to gpg’s --local-user parameter, so you may specify a key
4721 using any method that gpg supports.
4722 </p>
4723 </dd>
4725 web.browser
4726 </dt>
4727 <dd>
4728 <p>
4729 Specify a web browser that may be used by some commands.
4730 Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
4731 may use it.
4732 </p>
4733 </dd>
4734 </dl></div>
4735 </div>
4739 </div>
4740 </div>
4745 </div>
4746 </div>
4747 </body>
4748 </html>