| blob | 2d0c5b0a337530dd554b8479fd1c7346e74a7741 |
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 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-config(1) Manual Page
407 </h1>
410 <p>git-config -
411 Get and set repository or global options
412 </p>
413 </div>
414 </div>
418 <div class="verseblock-content"><em>git config</em> [<file-option>] [type] [-z|--null] name [value [value_regex]]
423 <em>git config</em> [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex]
433 </div></div>
434 </div>
437 <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is
438 actually the section and the key separated by a dot, and the value will be
439 escaped.</p></div>
440 <div class="paragraph"><p>Multiple lines can be added to an option by using the <em>--add</em> option.
441 If you want to update or unset an option which can occur on multiple
443 existing values that match the regexp are updated or unset. If
445 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>).</p></div>
446 <div class="paragraph"><p>The type specifier can be either <em>--int</em> or <em>--bool</em>, to make
448 convert the value to the canonical form (simple decimal number for int,
451 checks or transformations are performed on the value.</p></div>
452 <div class="paragraph"><p>The file-option can be one of <em>--system</em>, <em>--global</em> or <em>--file</em>
453 which specify where the values will be read from or written to.
454 The default is to assume the config file of the current repository,
455 .git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
459 <li>
460 <p>
461 The config file is invalid,
462 </p>
463 </li>
464 <li>
465 <p>
466 Can not write to the config file,
467 </p>
468 </li>
469 <li>
470 <p>
471 no section was provided,
472 </p>
473 </li>
474 <li>
475 <p>
476 the section or key is invalid,
477 </p>
478 </li>
479 <li>
480 <p>
481 you try to unset an option which does not exist,
482 </p>
483 </li>
484 <li>
485 <p>
486 you try to unset/set an option for which multiple lines match, or
487 </p>
488 </li>
489 <li>
490 <p>
492 </p>
493 </li>
494 </ol></div>
495 </div>
500 --replace-all
501 </dt>
502 <dd>
503 <p>
504 Default behavior is to replace at most one line. This replaces
505 all lines matching the key (and optionally the value_regex).
506 </p>
507 </dd>
509 --add
510 </dt>
511 <dd>
512 <p>
513 Adds a new line to the option without altering any existing
516 </p>
517 </dd>
519 --get
520 </dt>
521 <dd>
522 <p>
523 Get the value for a given key (optionally filtered by a regex
524 matching the value). Returns error code 1 if the key was not
525 found and error code 2 if multiple key values were found.
526 </p>
527 </dd>
529 --get-all
530 </dt>
531 <dd>
532 <p>
533 Like get, but does not fail if the number of values for the key
534 is not exactly one.
535 </p>
536 </dd>
538 --get-regexp
539 </dt>
540 <dd>
541 <p>
542 Like --get-all, but interprets the name as a regular expression.
543 Also outputs the key names.
544 </p>
545 </dd>
547 --global
548 </dt>
549 <dd>
550 <p>
551 For writing options: write to global ~/.gitconfig file rather than
552 the repository .git/config.
553 </p>
555 from all available files.</p></div>
557 </dd>
559 --system
560 </dt>
561 <dd>
562 <p>
563 For writing options: write to system-wide $(prefix)/etc/gitconfig
564 rather than the repository .git/config.
565 </p>
566 <div class="paragraph"><p>For reading options: read only from system-wide $(prefix)/etc/gitconfig
567 rather than from all available files.</p></div>
569 </dd>
571 -f config-file
572 </dt>
574 --file config-file
575 </dt>
576 <dd>
577 <p>
578 Use the given config file instead of the one specified by GIT_CONFIG.
579 </p>
580 </dd>
582 --remove-section
583 </dt>
584 <dd>
585 <p>
586 Remove the given section from the configuration file.
587 </p>
588 </dd>
590 --rename-section
591 </dt>
592 <dd>
593 <p>
594 Rename the given section to a new name.
595 </p>
596 </dd>
598 --unset
599 </dt>
600 <dd>
601 <p>
602 Remove the line matching the key from config file.
603 </p>
604 </dd>
606 --unset-all
607 </dt>
608 <dd>
609 <p>
610 Remove all lines matching the key from config file.
611 </p>
612 </dd>
614 -l
615 </dt>
617 --list
618 </dt>
619 <dd>
620 <p>
621 List all variables set in config file.
622 </p>
623 </dd>
625 --bool
626 </dt>
627 <dd>
628 <p>
630 </p>
631 </dd>
633 --int
634 </dt>
635 <dd>
636 <p>
639 in the config file will cause the value to be multiplied
641 </p>
642 </dd>
644 --bool-or-int
645 </dt>
646 <dd>
647 <p>
649 either --bool or --int, as described above.
650 </p>
651 </dd>
653 --path
654 </dt>
655 <dd>
656 <p>
659 specified user. This option has no effect when setting the
661 command line to let your shell do the expansion).
662 </p>
663 </dd>
665 -z
666 </dt>
668 --null
669 </dt>
670 <dd>
671 <p>
672 For all options that output values and/or keys, always
673 end values with the null character (instead of a
674 newline). Use newline instead as a delimiter between
675 key and value. This allows for secure parsing of the
676 output without getting confused e.g. by values that
677 contain line breaks.
678 </p>
679 </dd>
681 --get-colorbool name [stdout-is-tty]
682 </dt>
683 <dd>
684 <p>
687 "false", and is taken into account when configuration says
689 output of the command itself, and exits with status 0 if color
690 is to be used, or exits with status 1 otherwise.
693 </p>
694 </dd>
696 --get-color name [default]
697 </dt>
698 <dd>
699 <p>
701 output it as the ANSI color escape sequence to the standard
704 </p>
705 </dd>
707 -e
708 </dt>
710 --edit
711 </dt>
712 <dd>
713 <p>
714 Opens an editor to modify the specified config file; either
716 </p>
717 </dd>
718 </dl></div>
719 </div>
722 <div class="paragraph"><p>If not set explicitly with <em>--file</em>, there are three files where
726 $GIT_DIR/config
727 </dt>
728 <dd>
729 <p>
730 Repository specific configuration file. (The filename is
731 of course relative to the repository root, not the working
732 directory.)
733 </p>
734 </dd>
736 ~/.gitconfig
737 </dt>
738 <dd>
739 <p>
740 User-specific configuration file. Also called "global"
741 configuration file.
742 </p>
743 </dd>
745 $(prefix)/etc/gitconfig
746 </dt>
747 <dd>
748 <p>
749 System-wide configuration file.
750 </p>
751 </dd>
752 </dl></div>
753 <div class="paragraph"><p>If no further options are given, all reading options will read all of these
754 files that are available. If the global or the system-wide configuration
755 file are not available they will be ignored. If the repository configuration
757 error code. However, in neither case will an error message be issued.</p></div>
760 and <em>--unset</em>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
761 <div class="paragraph"><p>You can override these rules either by command line options or by environment
763 to the global or system-wide file respectively. The GIT_CONFIG environment
764 variable has a similar effect, but you can specify any filename you want.</p></div>
765 </div>
770 GIT_CONFIG
771 </dt>
772 <dd>
773 <p>
774 Take the configuration from the given file instead of .git/config.
775 Using the "--global" option forces this to ~/.gitconfig. Using the
776 "--system" option forces this to $(prefix)/etc/gitconfig.
777 </p>
778 </dd>
779 </dl></div>
781 </div>
787 <pre><tt>#
788 # This is the config file, and
789 # a '#' or ';' character indicates
790 # a comment
791 #</tt></pre>
792 </div></div>
795 <pre><tt>; core variables
796 [core]
797 ; Don't trust file modes
798 filemode = false</tt></pre>
799 </div></div>
802 <pre><tt>; Our diff algorithm
803 [diff]
804 external = /usr/local/bin/diff-wrapper
805 renames = true</tt></pre>
806 </div></div>
809 <pre><tt>; Proxy settings
810 [core]
812 gitproxy=default-proxy ; for all the rest</tt></pre>
813 </div></div>
818 </div></div>
819 <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
820 what URL they apply to. Here is how to change the entry for kernel.org
825 </div></div>
826 <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
831 </div></div>
832 <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
833 you have to provide a regex matching the value of exactly one line.</p></div>
838 </div></div>
843 </div></div>
848 </div></div>
853 </div></div>
854 <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
855 new one with</p></div>
859 </div></div>
860 <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
865 </div></div>
866 <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
870 </div></div>
871 <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
875 </div></div>
877 script:</p></div>
880 <pre><tt>#!/bin/sh
881 WS=$(git config --get-color color.diff.whitespace "blue reverse")
884 </div></div>
885 </div>
890 is used to store the configuration for that repository, and
893 can be used to store a system-wide default configuration.</p></div>
895 and the porcelains. The variables are divided into sections, wherein
896 the fully qualified variable name of the variable itself is the last
897 dot-separated segment and the section name is everything before the last
898 dot. The variable names are case-insensitive and only alphanumeric
899 characters are allowed. Some variables may appear multiple times.</p></div>
903 blank lines are ignored.</p></div>
905 the name of the section in square brackets and continues until the next
906 section begins. Section names are not case sensitive. Only alphanumeric
908 must belong to some section, which means that there must be a section
909 header before the first setting of a variable.</p></div>
910 <div class="paragraph"><p>Sections can be further divided into subsections. To begin a subsection
911 put its name in double quotes, separated by space from the section name,
912 in the section header, like in the example below:</p></div>
916 </div></div>
917 <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
918 newline (doublequote <tt>"</tt> and backslash have to be escaped as <tt>\"</tt> and <tt>\\</tt>,
919 respectively). Section headers cannot span multiple
920 lines. Variables may belong directly to a section or to a given subsection.
923 <div class="paragraph"><p>There is also a case insensitive alternative <tt>[section.subsection]</tt> syntax.
924 In this syntax, subsection names follow the same restrictions as for section
925 names.</p></div>
927 header) are recognized as setting variables, in the form
930 The variable names are case-insensitive and only alphanumeric
932 for a given variable; we say then that variable is multivalued.</p></div>
934 Internal whitespace within a variable value is retained verbatim.</p></div>
935 <div class="paragraph"><p>The values following the equals sign in variable assign are all either
936 a string, an integer, or a boolean. Boolean values may be given as yes/no,
941 You need to enclose variable values in double quotes if you want to
942 preserve leading or trailing whitespace, or if the variable value contains
946 <div class="paragraph"><p>The following escape sequences (beside <tt>\"</tt> and <tt>\\</tt>) are recognized:
949 char sequences are valid.</p></div>
950 <div class="paragraph"><p>Variable values ending in a <tt>\</tt> are continued on the next line in the
951 customary UNIX fashion.</p></div>
956 <pre><tt># Core variables
957 [core]
958 ; Don't trust file modes
959 filemode = false</tt></pre>
960 </div></div>
963 <pre><tt># Our diff algorithm
964 [diff]
965 external = /usr/local/bin/diff-wrapper
966 renames = true</tt></pre>
967 </div></div>
971 remote = origin
972 merge = refs/heads/devel</tt></pre>
973 </div></div>
976 <pre><tt># Proxy settings
977 [core]
979 gitProxy=default-proxy ; for the rest</tt></pre>
980 </div></div>
982 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
983 For command-specific variables, you will find a more detailed description
984 in the appropriate manual page. You will find a description of non-core
985 porcelain configuration variables in the respective porcelain documentation.</p></div>
988 advice.*
989 </dt>
990 <dd>
991 <p>
994 are:
995 </p>
998 pushNonFastForward
999 </dt>
1000 <dd>
1001 <p>
1003 non-fast-forward refs. Default: true.
1004 </p>
1005 </dd>
1007 statusHints
1008 </dt>
1009 <dd>
1010 <p>
1011 Directions on how to stage/unstage/add shown in the
1013 when writing commit messages. Default: true.
1014 </p>
1015 </dd>
1017 commitBeforeMerge
1018 </dt>
1019 <dd>
1020 <p>
1022 merge to avoid overwriting local changes.
1023 Default: true.
1024 </p>
1025 </dd>
1027 resolveConflict
1028 </dt>
1029 <dd>
1030 <p>
1031 Advices shown by various commands when conflicts
1032 prevent the operation from being performed.
1033 Default: true.
1034 </p>
1035 </dd>
1037 implicitIdentity
1038 </dt>
1039 <dd>
1040 <p>
1041 Advice on how to set your identity configuration when
1042 your information is guessed from the system username and
1043 domain name. Default: true.
1044 </p>
1045 </dd>
1047 detachedHead
1048 </dt>
1049 <dd>
1050 <p>
1052 move to the detach HEAD state, to instruct how to create
1053 a local branch after the fact. Default: true.
1054 </p>
1055 </dd>
1056 </dl></div>
1057 </dd>
1059 core.fileMode
1060 </dt>
1061 <dd>
1062 <p>
1063 If false, the executable bit differences between the index and
1064 the working copy are ignored; useful on broken filesystems like FAT.
1066 </p>
1067 <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>
1068 will probe and set core.fileMode false if appropriate when the
1069 repository is created.</p></div>
1070 </dd>
1072 core.ignoreCygwinFSTricks
1073 </dt>
1074 <dd>
1075 <p>
1076 This option is only used by Cygwin implementation of Git. If false,
1077 the Cygwin stat() and lstat() functions are used. This may be useful
1078 if your repository consists of a few separate directories joined in
1079 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
1080 whenever it is possible and falls back to Cygwin functions only to
1081 handle symbol links. The native mode is more than twice faster than
1082 normal Cygwin l/stat() functions. True by default, unless core.filemode
1083 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin’s
1084 POSIX emulation is required to support core.filemode.
1085 </p>
1086 </dd>
1088 core.ignorecase
1089 </dt>
1090 <dd>
1091 <p>
1092 If true, this option enables various workarounds to enable
1093 git to work better on filesystems that are not case sensitive,
1094 like FAT. For example, if a directory listing finds
1096 it is really the same file, and continue to remember it as
1097 "Makefile".
1098 </p>
1099 <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>
1100 will probe and set core.ignorecase true if appropriate when the repository
1101 is created.</p></div>
1102 </dd>
1104 core.trustctime
1105 </dt>
1106 <dd>
1107 <p>
1108 If false, the ctime differences between the index and the
1109 working copy are ignored; useful when the inode change time
1110 is regularly modified by something outside Git (file system
1111 crawlers and some backup systems).
1113 </p>
1114 </dd>
1116 core.quotepath
1117 </dt>
1118 <dd>
1119 <p>
1122 "unusual" characters in the pathname by enclosing the
1123 pathname in a double-quote pair and with backslashes the
1124 same way strings in C source code are quoted. If this
1125 variable is set to false, the bytes higher than 0x80 are
1126 not quoted but output as verbatim. Note that double
1127 quote, backslash and control characters are always
1129 variable.
1130 </p>
1131 </dd>
1133 core.eol
1134 </dt>
1135 <dd>
1136 <p>
1137 Sets the line ending type to use in the working directory for
1142 conversion.
1143 </p>
1144 </dd>
1146 core.safecrlf
1147 </dt>
1148 <dd>
1149 <p>
1151 end-of-line conversion is active. Git will verify if a command
1152 modifies a file in the work tree either directly or indirectly.
1153 For example, committing a file followed by checking out the
1154 same file should yield the original file in the work tree. If
1155 this is not the case for the current setting of
1157 be set to "warn", in which case git will only warn about an
1158 irreversible conversion but continue the operation.
1159 </p>
1161 When it is enabled, git will convert CRLF to LF during commit and LF to
1162 CRLF during checkout. A file that contains a mixture of LF and
1163 CRLF before the commit cannot be recreated by git. For text
1164 files this is the right thing to do: it corrects line endings
1165 such that we have only LF line endings in the repository.
1166 But for binary files that are accidentally classified as text the
1167 conversion can corrupt data.</p></div>
1169 setting the conversion type explicitly in .gitattributes. Right
1170 after committing you still have the original file in your work
1171 tree and this file is not yet corrupted. You can explicitly tell
1172 git that this file is binary and git will handle the file
1173 appropriately.</p></div>
1175 mixed line endings and the undesired effect of corrupting binary
1176 files cannot be distinguished. In both cases CRLFs are removed
1177 in an irreversible way. For text files this is the right thing
1178 to do because CRLFs are line endings, while for binary files
1179 converting CRLFs corrupts data.</p></div>
1180 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
1181 file identical to the original file for a different setting of
1189 mechanism.</p></div>
1190 </dd>
1192 core.autocrlf
1193 </dt>
1194 <dd>
1195 <p>
1196 Setting this variable to "true" is almost the same as setting
1198 files are not guaranteed to be normalized: files that contain
1201 working directory even though the repository does not have
1203 in which case no output conversion is performed.
1204 </p>
1205 </dd>
1207 core.symlinks
1208 </dt>
1209 <dd>
1210 <p>
1211 If false, symbolic links are checked out as small plain files that
1214 file. Useful on filesystems like FAT that do not support
1215 symbolic links.
1216 </p>
1217 <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>
1218 will probe and set core.symlinks false if appropriate when the repository
1219 is created.</p></div>
1220 </dd>
1222 core.gitProxy
1223 </dt>
1224 <dd>
1225 <p>
1227 of establishing direct connection to the remote server when
1228 using the git protocol for fetching. If the variable value is
1229 in the "COMMAND for DOMAIN" format, the command is applied only
1230 on hostnames ending with the specified domain string. This variable
1231 may be set multiple times and is matched in the given order;
1232 the first match wins.
1233 </p>
1234 <div class="paragraph"><p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable
1235 (which always applies universally, without the special "for"
1236 handling).</p></div>
1238 specify that no proxy be used for a given domain pattern.
1239 This is useful for excluding servers inside a firewall from
1240 proxy use, while defaulting to a common proxy for external domains.</p></div>
1241 </dd>
1243 core.ignoreStat
1244 </dt>
1245 <dd>
1246 <p>
1247 If true, commands which modify both the working tree and the index
1248 will mark the updated paths with the "assume unchanged" bit in the
1249 index. These marked files are then assumed to stay unchanged in the
1250 working copy, until you mark them otherwise manually - Git will not
1251 detect the file changes by lstat() calls. This is useful on systems
1252 where those are very slow, such as Microsoft Windows.
1254 False by default.
1255 </p>
1256 </dd>
1258 core.preferSymlinkRefs
1259 </dt>
1260 <dd>
1261 <p>
1262 Instead of the default "symref" format for HEAD
1263 and other symbolic reference files, use symbolic links.
1264 This is sometimes needed to work with old scripts that
1265 expect HEAD to be a symbolic link.
1266 </p>
1267 </dd>
1269 core.bare
1270 </dt>
1271 <dd>
1272 <p>
1274 working directory associated with it. If this is the case a
1275 number of commands that require a working directory will be
1276 disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
1277 </p>
1278 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
1280 repository that ends in "/.git" is assumed to be not bare (bare =
1281 false), while all other repositories are assumed to be bare (bare
1282 = true).</p></div>
1283 </dd>
1285 core.worktree
1286 </dt>
1287 <dd>
1288 <p>
1289 Set the path to the root of the working tree.
1290 This can be overridden by the GIT_WORK_TREE environment
1292 The value can be an absolute path or relative to the path to
1293 the .git directory, which is either specified by --git-dir
1294 or GIT_DIR, or automatically discovered.
1295 If --git-dir or GIT_DIR is specified but none of
1296 --work-tree, GIT_WORK_TREE and core.worktree is specified,
1297 the current working directory is regarded as the top level
1298 of your working tree.
1299 </p>
1301 file in a ".git" subdirectory of a directory and its value differs
1302 from the latter directory (e.g. "/path/to/.git/config" has
1303 core.worktree set to "/different/path"), which is most likely a
1304 misconfiguration. Running git commands in the "/path/to" directory will
1305 still use "/different/path" as the root of the work tree and can cause
1306 confusion unless you know what you are doing (e.g. you are creating a
1307 read-only snapshot of the same index to a location different from the
1309 </dd>
1311 core.logAllRefUpdates
1312 </dt>
1313 <dd>
1314 <p>
1316 "$GIT_DIR/logs/<ref>", by appending the new and old
1317 SHA1, the date/time and the reason of the update, but
1318 only when the file exists. If this configuration
1319 variable is set to true, missing "$GIT_DIR/logs/<ref>"
1320 file is automatically created for branch heads.
1321 </p>
1325 a working directory associated with it, and false by
1326 default in a bare repository.</p></div>
1327 </dd>
1329 core.repositoryFormatVersion
1330 </dt>
1331 <dd>
1332 <p>
1333 Internal variable identifying the repository format and layout
1334 version.
1335 </p>
1336 </dd>
1338 core.sharedRepository
1339 </dt>
1340 <dd>
1341 <p>
1343 several users in a group (making sure all the files and objects are
1345 repository will be readable by all users, additionally to being
1349 user’s umask value (whereas the other options will only override
1351 the repo read/write-able for the owner and group, but inaccessible to
1353 repository that is group-readable but not group-writable.
1355 </p>
1356 </dd>
1358 core.warnAmbiguousRefs
1359 </dt>
1360 <dd>
1361 <p>
1362 If true, git will warn you if the ref name you passed it is ambiguous
1363 and might match multiple refs in the .git/refs/ tree. True by default.
1364 </p>
1365 </dd>
1367 core.compression
1368 </dt>
1369 <dd>
1370 <p>
1374 If set, this provides a default to other compression variables,
1376 </p>
1377 </dd>
1379 core.loosecompression
1380 </dt>
1381 <dd>
1382 <p>
1386 slowest. If not set, defaults to core.compression. If that is
1387 not set, defaults to 1 (best speed).
1388 </p>
1389 </dd>
1391 core.packedGitWindowSize
1392 </dt>
1393 <dd>
1394 <p>
1395 Number of bytes of a pack file to map into memory in a
1396 single mapping operation. Larger window sizes may allow
1397 your system to process a smaller number of large pack files
1398 more quickly. Smaller window sizes will negatively affect
1399 performance due to increased calls to the operating system’s
1400 memory manager, but may improve performance when accessing
1401 a large number of large pack files.
1402 </p>
1405 be reasonable for all users/operating systems. You probably do
1406 not need to adjust this value.</p></div>
1407 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1408 </dd>
1410 core.packedGitLimit
1411 </dt>
1412 <dd>
1413 <p>
1414 Maximum number of bytes to map simultaneously into memory
1415 from pack files. If Git needs to access more than this many
1416 bytes at once to complete an operation it will unmap existing
1417 regions to reclaim virtual address space within the process.
1418 </p>
1419 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
1420 This should be reasonable for all users/operating systems, except on
1421 the largest projects. You probably do not need to adjust this value.</p></div>
1422 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1423 </dd>
1425 core.deltaBaseCacheLimit
1426 </dt>
1427 <dd>
1428 <p>
1429 Maximum number of bytes to reserve for caching base objects
1430 that may be referenced by multiple deltified objects. By storing the
1431 entire decompressed base objects in a cache Git is able
1432 to avoid unpacking and decompressing frequently used base
1433 objects multiple times.
1434 </p>
1436 for all users/operating systems, except on the largest projects.
1437 You probably do not need to adjust this value.</p></div>
1438 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1439 </dd>
1441 core.bigFileThreshold
1442 </dt>
1443 <dd>
1444 <p>
1445 Files larger than this size are stored deflated, without
1446 attempting delta compression. Storing large files without
1447 delta compression avoids excessive memory usage, at the
1448 slight expense of increased disk usage.
1449 </p>
1451 for most projects as source code and other text files can still
1453 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1454 </dd>
1456 core.excludesfile
1457 </dt>
1458 <dd>
1459 <p>
1462 of files which are not meant to be tracked. "~/" is expanded
1465 </p>
1466 </dd>
1468 core.askpass
1469 </dt>
1470 <dd>
1471 <p>
1472 Some commands (e.g. svn and http interfaces) that interactively
1473 ask for a password can be told to use an external program given
1475 environment variable. If not set, fall back to the value of the
1477 prompt. The external program shall be given a suitable prompt as
1478 command line argument and write the password on its STDOUT.
1479 </p>
1480 </dd>
1482 core.attributesfile
1483 </dt>
1484 <dd>
1485 <p>
1490 </p>
1491 </dd>
1493 core.editor
1494 </dt>
1495 <dd>
1496 <p>
1498 messages by launching an editor uses the value of this
1499 variable when it is set, and the environment variable
1501 </p>
1502 </dd>
1504 core.pager
1505 </dt>
1506 <dd>
1507 <p>
1508 The command that git will use to paginate output. Can
1512 pager. One can change these settings by setting the
1514 these settings can be overridden on a project or
1517 environment variable behaviour above, so if you want
1518 to override git’s default settings this way, you need
1519 to be explicit. For example, to disable the S option
1522 shell by git, which will translate the final command to
1524 </p>
1525 </dd>
1527 core.whitespace
1528 </dt>
1529 <dd>
1530 <p>
1531 A comma separated list of common whitespace problems to
1536 </p>
1538 <li>
1539 <p>
1541 as an error (enabled by default).
1542 </p>
1543 </li>
1544 <li>
1545 <p>
1547 before a tab character in the initial indent part of the line as an
1548 error (enabled by default).
1549 </p>
1550 </li>
1551 <li>
1552 <p>
1554 space characters as an error (not enabled by default).
1555 </p>
1556 </li>
1557 <li>
1558 <p>
1560 the line as an error (not enabled by default).
1561 </p>
1562 </li>
1563 <li>
1564 <p>
1566 (enabled by default).
1567 </p>
1568 </li>
1569 <li>
1570 <p>
1573 </p>
1574 </li>
1575 <li>
1576 <p>
1579 does not trigger if the character before such a carriage-return
1580 is not a whitespace (not enabled by default).
1581 </p>
1582 </li>
1583 <li>
1584 <p>
1588 </p>
1589 </li>
1590 </ul></div>
1591 </dd>
1593 core.fsyncobjectfiles
1594 </dt>
1595 <dd>
1596 <p>
1598 </p>
1600 data writes properly, but can be useful for filesystems that do not use
1601 journalling (traditional UNIX filesystems) or that only journal metadata
1603 </dd>
1605 core.preloadindex
1606 </dt>
1607 <dd>
1608 <p>
1610 </p>
1611 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
1612 on filesystems like NFS that have weak caching semantics and thus
1614 index comparison to the filesystem data in parallel, allowing
1616 </dd>
1618 core.createObject
1619 </dt>
1620 <dd>
1621 <p>
1623 a delete of the source are used to make sure that object creation
1624 will not overwrite existing objects.
1625 </p>
1626 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
1628 check that makes sure that existing object files will not get overwritten.</p></div>
1629 </dd>
1631 core.notesRef
1632 </dt>
1633 <dd>
1634 <p>
1635 When showing commit messages, also show notes which are stored in
1636 the given ref. The ref must be fully qualified. If the given
1637 ref does not exist, it is not an error but means that no
1638 notes should be printed.
1639 </p>
1640 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
1641 the <em>GIT_NOTES_REF</em> environment variable. See <a href="git-notes.html">git-notes(1)</a>.</p></div>
1642 </dd>
1644 core.sparseCheckout
1645 </dt>
1646 <dd>
1647 <p>
1650 </p>
1651 </dd>
1653 core.abbrev
1654 </dt>
1655 <dd>
1656 <p>
1657 Set the length object names are abbreviated to. If unspecified,
1658 many commands abbreviate to 7 hexdigits, which may not be enough
1659 for abbreviated object names to stay unique for sufficiently long
1660 time.
1661 </p>
1662 </dd>
1664 add.ignore-errors
1665 </dt>
1667 add.ignoreErrors
1668 </dt>
1669 <dd>
1670 <p>
1675 convention for configuration variables. Newer versions of git
1677 </p>
1678 </dd>
1680 alias.*
1681 </dt>
1682 <dd>
1683 <p>
1685 after defining "alias.last = cat-file commit HEAD", the invocation
1687 confusion and troubles with script usage, aliases that
1688 hide existing git commands are ignored. Arguments are split by
1689 spaces, the usual shell quoting and escaping is supported.
1690 quote pair and a backslash can be used to quote them.
1691 </p>
1693 it will be treated as a shell command. For example, defining
1694 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
1695 "git new" is equivalent to running the shell command
1696 "gitk --all --not ORIG_HEAD". Note that shell commands will be
1697 executed from the top-level directory of a repository, which may
1698 not necessarily be the current directory.
1700 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
1701 </dd>
1703 am.keepcr
1704 </dt>
1705 <dd>
1706 <p>
1707 If true, git-am will call git-mailsplit for patches in mbox format
1712 </p>
1713 </dd>
1715 apply.ignorewhitespace
1716 </dt>
1717 <dd>
1718 <p>
1721 option.
1723 respect all whitespace differences.
1725 </p>
1726 </dd>
1728 apply.whitespace
1729 </dt>
1730 <dd>
1731 <p>
1734 </p>
1735 </dd>
1737 branch.autosetupmerge
1738 </dt>
1739 <dd>
1740 <p>
1743 starting point branch. Note that even if this option is not set,
1747 starting point is a remote-tracking branch; <tt>always</tt> —  automatic setup is done when the starting point is either a
1748 local branch or remote-tracking
1749 branch. This option defaults to true.
1750 </p>
1751 </dd>
1753 branch.autosetuprebase
1754 </dt>
1755 <dd>
1756 <p>
1758 that tracks another branch, this variable tells git to set
1759 up pull to rebase instead of merge (see "branch.<name>.rebase").
1762 other local branches.
1764 remote-tracking branches.
1766 branches.
1767 See "branch.autosetupmerge" for details on how to set up a
1768 branch to track another branch.
1769 This option defaults to never.
1770 </p>
1771 </dd>
1774 </dt>
1775 <dd>
1776 <p>
1780 </p>
1781 </dd>
1784 </dt>
1785 <dd>
1786 <p>
1791 refspec to be marked for merging in FETCH_HEAD. The value is
1792 handled like the remote part of a refspec, and must match a
1793 ref which is fetched from the remote given by
1794 "branch.<name>.remote".
1798 Specify multiple values to get an octopus merge.
1800 another branch in the local repository, you can point
1803 </p>
1804 </dd>
1807 </dt>
1808 <dd>
1809 <p>
1812 option values containing whitespace characters are currently not
1813 supported.
1814 </p>
1815 </dd>
1818 </dt>
1819 <dd>
1820 <p>
1822 instead of merging the default branch from the default remote when
1823 "git pull" is run.
1826 for details).
1827 </p>
1828 </dd>
1831 </dt>
1832 <dd>
1833 <p>
1834 Specify the command to invoke the specified browser. The
1835 specified command is evaluated in shell with the URLs passed
1837 </p>
1838 </dd>
1841 </dt>
1842 <dd>
1843 <p>
1844 Override the path for the given tool that may be used to
1847 </p>
1848 </dd>
1850 clean.requireForce
1851 </dt>
1852 <dd>
1853 <p>
1854 A boolean to make git-clean do nothing unless given -f
1855 or -n. Defaults to true.
1856 </p>
1857 </dd>
1859 color.branch
1860 </dt>
1861 <dd>
1862 <p>
1863 A boolean to enable/disable color in the output of
1865 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
1866 only when the output is to a terminal. Defaults to false.
1867 </p>
1868 </dd>
1871 </dt>
1872 <dd>
1873 <p>
1877 refs).
1878 </p>
1879 <div class="paragraph"><p>The value for these configuration variables is a list of colors (at most
1880 two) and attributes (at most one), separated by spaces. The colors
1881 accepted are <tt>normal</tt>, <tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>,
1882 <tt>magenta</tt>, <tt>cyan</tt> and <tt>white</tt>; the attributes are <tt>bold</tt>, <tt>dim</tt>, <tt>ul</tt>,
1884 second is the background. The position of the attribute, if any,
1886 </dd>
1888 color.diff
1889 </dt>
1890 <dd>
1891 <p>
1892 Whether to use ANSI escape sequences to add color to patches.
1894 <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
1896 commands will only use color when output is to the terminal.
1897 Defaults to false.
1898 </p>
1899 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> nor the
1902 </dd>
1905 </dt>
1906 <dd>
1907 <p>
1909 which part of the patch to use the specified color, and is one
1913 (highlighting whitespace errors). The values of these variables may be
1915 </p>
1916 </dd>
1919 </dt>
1920 <dd>
1921 <p>
1923 of <tt>branch</tt>, <tt>remoteBranch</tt>, <tt>tag</tt>, <tt>stash</tt> or <tt>HEAD</tt> for local
1924 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1925 </p>
1926 </dd>
1928 color.grep
1929 </dt>
1930 <dd>
1931 <p>
1935 </p>
1936 </dd>
1939 </dt>
1940 <dd>
1941 <p>
1943 part of the line to use the specified color, and is one of
1944 </p>
1948 </dt>
1949 <dd>
1950 <p>
1952 </p>
1953 </dd>
1956 </dt>
1957 <dd>
1958 <p>
1960 </p>
1961 </dd>
1964 </dt>
1965 <dd>
1966 <p>
1968 </p>
1969 </dd>
1972 </dt>
1973 <dd>
1974 <p>
1976 </p>
1977 </dd>
1980 </dt>
1981 <dd>
1982 <p>
1983 matching text
1984 </p>
1985 </dd>
1988 </dt>
1989 <dd>
1990 <p>
1991 non-matching text in selected lines
1992 </p>
1993 </dd>
1996 </dt>
1997 <dd>
1998 <p>
2001 </p>
2002 </dd>
2003 </dl></div>
2004 <div class="paragraph"><p>The values of these variables may be specified as in color.branch.<slot>.</p></div>
2005 </dd>
2007 color.interactive
2008 </dt>
2009 <dd>
2010 <p>
2012 and displays (such as those used by "git-add --interactive").
2014 colors only when the output is to the terminal. Defaults to false.
2015 </p>
2016 </dd>
2019 </dt>
2020 <dd>
2021 <p>
2023 output. <tt><slot></tt> may be <tt>prompt</tt>, <tt>header</tt>, <tt>help</tt> or <tt>error</tt>, for
2024 four distinct types of normal output from interactive
2025 commands. The values of these variables may be specified as
2027 </p>
2028 </dd>
2030 color.pager
2031 </dt>
2032 <dd>
2033 <p>
2034 A boolean to enable/disable colored output when the pager is in
2035 use (default is true).
2036 </p>
2037 </dd>
2039 color.showbranch
2040 </dt>
2041 <dd>
2042 <p>
2043 A boolean to enable/disable color in the output of
2045 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
2046 only when the output is to a terminal. Defaults to false.
2047 </p>
2048 </dd>
2050 color.status
2051 </dt>
2052 <dd>
2053 <p>
2054 A boolean to enable/disable color in the output of
2056 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
2057 only when the output is to a terminal. Defaults to false.
2058 </p>
2059 </dd>
2062 </dt>
2063 <dd>
2064 <p>
2072 to red). The values of these variables may be specified as in
2074 </p>
2075 </dd>
2077 color.ui
2078 </dt>
2079 <dd>
2080 <p>
2081 This variable determines the default value for variables such
2083 per command family. Its scope will expand as more commands learn
2090 </p>
2091 </dd>
2093 commit.status
2094 </dt>
2095 <dd>
2096 <p>
2097 A boolean to enable/disable inclusion of status information in the
2098 commit message template when using an editor to prepare the commit
2099 message. Defaults to true.
2100 </p>
2101 </dd>
2103 commit.template
2104 </dt>
2105 <dd>
2106 <p>
2107 Specify a file to use as the template for new commit messages.
2109 specified user’s home directory.
2110 </p>
2111 </dd>
2113 diff.autorefreshindex
2114 </dt>
2115 <dd>
2116 <p>
2118 files, do not consider stat-only change as changed.
2120 update the cached stat information for paths whose
2121 contents in the work tree match the contents in the
2122 index. This option defaults to true. Note that this
2125 </p>
2126 </dd>
2128 diff.external
2129 </dt>
2130 <dd>
2131 <p>
2132 If this config variable is set, diff generation is not
2133 performed using the internal diff machinery, but using the
2135 environment variable. The command is called with parameters
2137 you want to use an external diff program only on a subset of
2139 </p>
2140 </dd>
2142 diff.ignoreSubmodules
2143 </dt>
2144 <dd>
2145 <p>
2146 Sets the default value of --ignore-submodules. Note that this
2149 this setting when reporting uncommitted changes.
2150 </p>
2151 </dd>
2153 diff.mnemonicprefix
2154 </dt>
2155 <dd>
2156 <p>
2159 this configuration is in effect, reverse diff output also swaps
2160 the order of the prefixes:
2161 </p>
2165 </dt>
2166 <dd>
2167 <p>
2168 compares the (i)ndex and the (w)ork tree;
2169 </p>
2170 </dd>
2173 </dt>
2174 <dd>
2175 <p>
2176 compares a (c)ommit and the (w)ork tree;
2177 </p>
2178 </dd>
2181 </dt>
2182 <dd>
2183 <p>
2184 compares a (c)ommit and the (i)ndex;
2185 </p>
2186 </dd>
2189 </dt>
2190 <dd>
2191 <p>
2192 compares an (o)bject and a (w)ork tree entity;
2193 </p>
2194 </dd>
2197 </dt>
2198 <dd>
2199 <p>
2201 </p>
2202 </dd>
2203 </dl></div>
2204 </dd>
2206 diff.noprefix
2207 </dt>
2208 <dd>
2209 <p>
2211 </p>
2212 </dd>
2214 diff.renameLimit
2215 </dt>
2216 <dd>
2217 <p>
2218 The number of files to consider when performing the copy/rename
2220 </p>
2221 </dd>
2223 diff.renames
2224 </dt>
2225 <dd>
2226 <p>
2227 Tells git to detect renames. If set to any boolean value, it
2228 will enable basic rename detection. If set to "copies" or
2229 "copy", it will detect copies, as well.
2230 </p>
2231 </dd>
2233 diff.suppressBlankEmpty
2234 </dt>
2235 <dd>
2236 <p>
2237 A boolean to inhibit the standard behavior of printing a space
2238 before each empty output line. Defaults to false.
2239 </p>
2240 </dd>
2243 </dt>
2244 <dd>
2245 <p>
2247 for details.
2248 </p>
2249 </dd>
2252 </dt>
2253 <dd>
2254 <p>
2255 The regular expression that the diff driver should use to
2256 recognize the hunk header. A built-in pattern may also be used.
2258 </p>
2259 </dd>
2262 </dt>
2263 <dd>
2264 <p>
2265 Set this option to true to make the diff driver treat files as
2267 </p>
2268 </dd>
2271 </dt>
2272 <dd>
2273 <p>
2274 The command that the diff driver should call to generate the
2275 text-converted version of a file. The result of the
2276 conversion is used to generate a human-readable diff. See
2278 </p>
2279 </dd>
2282 </dt>
2283 <dd>
2284 <p>
2285 The regular expression that the diff driver should use to
2287 details.
2288 </p>
2289 </dd>
2292 </dt>
2293 <dd>
2294 <p>
2295 Set this option to true to make the diff driver cache the text
2297 </p>
2298 </dd>
2300 diff.tool
2301 </dt>
2302 <dd>
2303 <p>
2307 "kompare". Any other value is treated as a custom diff tool,
2309 option.
2310 </p>
2311 </dd>
2314 </dt>
2315 <dd>
2316 <p>
2317 Override the path for the given tool. This is useful in case
2318 your tool is not in the PATH.
2319 </p>
2320 </dd>
2323 </dt>
2324 <dd>
2325 <p>
2326 Specify the command to invoke the specified diff tool.
2327 The specified command is evaluated in shell with the following
2330 is set to the name of the temporary file containing the contents
2331 of the diff post-image.
2332 </p>
2333 </dd>
2335 difftool.prompt
2336 </dt>
2337 <dd>
2338 <p>
2339 Prompt before each invocation of the diff tool.
2340 </p>
2341 </dd>
2343 diff.wordRegex
2344 </dt>
2345 <dd>
2346 <p>
2347 A POSIX Extended Regular Expression used to determine what is a "word"
2348 when performing word-by-word difference calculations. Character
2349 sequences that match the regular expression are "words", all other
2351 </p>
2352 </dd>
2354 fetch.recurseSubmodules
2355 </dt>
2356 <dd>
2357 <p>
2359 Setting it to a boolean changes the behavior of fetch and pull to
2360 unconditionally recurse into submodules when set to true or to not
2362 value), fetch and pull will only recurse into a populated submodule
2363 when its superproject retrieves a commit that updates the submodule’s
2364 reference.
2365 </p>
2366 </dd>
2368 fetch.unpackLimit
2369 </dt>
2370 <dd>
2371 <p>
2372 If the number of objects fetched over the git native
2373 transfer is below this
2374 limit, then the objects will be unpacked into loose object
2375 files. However if the number of received objects equals or
2376 exceeds this limit then the received pack will be stored as
2377 a pack, after adding any missing delta bases. Storing the
2378 pack from a push can make the push operation complete faster,
2379 especially on slow filesystems. If not set, the value of
2381 </p>
2382 </dd>
2384 format.attach
2385 </dt>
2386 <dd>
2387 <p>
2388 Enable multipart/mixed attachments as the default for
2390 which will enable attachments as the default and set the
2391 value as the boundary. See the --attach option in
2393 </p>
2394 </dd>
2396 format.numbered
2397 </dt>
2398 <dd>
2399 <p>
2400 A boolean which can enable or disable sequence numbers in patch
2401 subjects. It defaults to "auto" which enables it only if there
2402 is more than one patch. It can be enabled or disabled for all
2405 </p>
2406 </dd>
2408 format.headers
2409 </dt>
2410 <dd>
2411 <p>
2412 Additional email headers to include in a patch to be submitted
2414 </p>
2415 </dd>
2417 format.to
2418 </dt>
2420 format.cc
2421 </dt>
2422 <dd>
2423 <p>
2424 Additional recipients to include in a patch to be submitted
2425 by mail. See the --to and --cc options in
2427 </p>
2428 </dd>
2430 format.subjectprefix
2431 </dt>
2432 <dd>
2433 <p>
2435 subject prefix. Use this variable to change that prefix.
2436 </p>
2437 </dd>
2439 format.signature
2440 </dt>
2441 <dd>
2442 <p>
2443 The default for format-patch is to output a signature containing
2444 the git version number. Use this variable to change that default.
2445 Set this variable to the empty string ("") to suppress
2446 signature generation.
2447 </p>
2448 </dd>
2450 format.suffix
2451 </dt>
2452 <dd>
2453 <p>
2454 The default for format-patch is to output files with the suffix
2456 include the dot if you want it).
2457 </p>
2458 </dd>
2460 format.pretty
2461 </dt>
2462 <dd>
2463 <p>
2464 The default pretty format for log/show/whatchanged command,
2467 </p>
2468 </dd>
2470 format.thread
2471 </dt>
2472 <dd>
2473 <p>
2476 makes every mail a reply to the head of the series,
2477 where the head is chosen from the cover letter, the
2481 value disables threading.
2482 </p>
2483 </dd>
2485 format.signoff
2486 </dt>
2487 <dd>
2488 <p>
2491 patch should be a conscious act and means that you certify you have
2492 the rights to submit this work under the same open source license.
2494 </p>
2495 </dd>
2498 </dt>
2499 <dd>
2500 <p>
2501 The command which is used to convert the content of a worktree
2503 details.
2504 </p>
2505 </dd>
2508 </dt>
2509 <dd>
2510 <p>
2511 The command which is used to convert the content of a blob
2512 object to a worktree file upon checkout. See
2514 </p>
2515 </dd>
2517 gc.aggressiveWindow
2518 </dt>
2519 <dd>
2520 <p>
2521 The window size parameter used in the delta compression
2523 to 250.
2524 </p>
2525 </dd>
2527 gc.auto
2528 </dt>
2529 <dd>
2530 <p>
2531 When there are approximately more than this many loose
2533 Some Porcelain commands use this command to perform a
2534 light-weight garbage collection from time to time. The
2536 </p>
2537 </dd>
2539 gc.autopacklimit
2540 </dt>
2541 <dd>
2542 <p>
2543 When there are more than this many packs that are not
2545 --auto</tt> consolidates them into one larger pack. The
2547 </p>
2548 </dd>
2550 gc.packrefs
2551 </dt>
2552 <dd>
2553 <p>
2555 unclonable by Git versions prior to 1.5.1.2 over dumb
2556 transports such as HTTP. This variable determines whether
2558 to enable it within all non-bare repos or it can be set to a
2560 </p>
2561 </dd>
2563 gc.pruneexpire
2564 </dt>
2565 <dd>
2566 <p>
2568 Override the grace period with this config variable. The value
2569 "now" may be used to disable this grace period and always prune
2570 unreachable objects immediately.
2571 </p>
2572 </dd>
2574 gc.reflogexpire
2575 </dt>
2578 </dt>
2579 <dd>
2580 <p>
2583 "refs/stash") in the middle the setting applies only to
2585 </p>
2586 </dd>
2588 gc.reflogexpireunreachable
2589 </dt>
2592 </dt>
2593 <dd>
2594 <p>
2596 this time and are not reachable from the current tip;
2598 in the middle, the setting applies only to the refs that
2600 </p>
2601 </dd>
2603 gc.rerereresolved
2604 </dt>
2605 <dd>
2606 <p>
2607 Records of conflicted merge you resolved earlier are
2610 </p>
2611 </dd>
2613 gc.rerereunresolved
2614 </dt>
2615 <dd>
2616 <p>
2617 Records of conflicted merge you have not resolved are
2620 </p>
2621 </dd>
2623 gitcvs.commitmsgannotation
2624 </dt>
2625 <dd>
2626 <p>
2627 Append this string to each commit message. Set to empty string
2628 to disable this feature. Defaults to "via git-CVS emulator".
2629 </p>
2630 </dd>
2632 gitcvs.enabled
2633 </dt>
2634 <dd>
2635 <p>
2636 Whether the CVS server interface is enabled for this repository.
2638 </p>
2639 </dd>
2641 gitcvs.logfile
2642 </dt>
2643 <dd>
2644 <p>
2645 Path to a log file where the CVS server interface well… logs
2647 </p>
2648 </dd>
2650 gitcvs.usecrlfattr
2651 </dt>
2652 <dd>
2653 <p>
2654 If true, the server will look up the end-of-line conversion
2656 the attributes force git to treat a file as text,
2658 treat it as text. If they suppress text conversion, the file
2660 the client might otherwise do. If the attributes do not allow
2663 </p>
2664 </dd>
2666 gitcvs.allbinary
2667 </dt>
2668 <dd>
2669 <p>
2672 unresolved files are sent to the client in
2674 as binary files, which suppresses any newline munging it
2675 otherwise might do. Alternatively, if it is set to "guess",
2676 then the contents of the file are examined to decide if
2678 </p>
2679 </dd>
2681 gitcvs.dbname
2682 </dt>
2683 <dd>
2684 <p>
2685 Database used by git-cvsserver to cache revision information
2686 derived from the git repository. The exact meaning depends on the
2687 used database driver, for SQLite (which is the default driver) this
2688 is a filename. Supports variable substitution (see
2689 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<tt>;</tt>).
2691 </p>
2692 </dd>
2694 gitcvs.dbdriver
2695 </dt>
2696 <dd>
2697 <p>
2698 Used Perl DBI driver. You can specify any available driver
2699 for this here, but it might not work. git-cvsserver is tested
2704 </p>
2705 </dd>
2707 gitcvs.dbuser, gitcvs.dbpass
2708 </dt>
2709 <dd>
2710 <p>
2712 since SQLite has no concept of database users and/or passwords.
2715 </p>
2716 </dd>
2718 gitcvs.dbTableNamePrefix
2719 </dt>
2720 <dd>
2721 <p>
2722 Database table name prefix. Prepended to the names of any
2723 database tables used, allowing a single database to be used
2724 for several repositories. Supports variable substitution (see
2726 characters will be replaced with underscores.
2727 </p>
2728 </dd>
2729 </dl></div>
2734 access method.</p></div>
2737 grep.lineNumber
2738 </dt>
2739 <dd>
2740 <p>
2742 </p>
2743 </dd>
2745 grep.extendedRegexp
2746 </dt>
2747 <dd>
2748 <p>
2750 </p>
2751 </dd>
2753 gui.commitmsgwidth
2754 </dt>
2755 <dd>
2756 <p>
2757 Defines how wide the commit message window is in the
2759 </p>
2760 </dd>
2762 gui.diffcontext
2763 </dt>
2764 <dd>
2765 <p>
2766 Specifies how many context lines should be used in calls to diff
2768 </p>
2769 </dd>
2771 gui.encoding
2772 </dt>
2773 <dd>
2774 <p>
2775 Specifies the default encoding to use for displaying of
2779 If this option is not set, the tools default to the
2780 locale encoding.
2781 </p>
2782 </dd>
2784 gui.matchtrackingbranch
2785 </dt>
2786 <dd>
2787 <p>
2789 default to tracking remote branches with matching names or
2790 not. Default: "false".
2791 </p>
2792 </dd>
2794 gui.newbranchtemplate
2795 </dt>
2796 <dd>
2797 <p>
2798 Is used as suggested name when creating new branches using the
2800 </p>
2801 </dd>
2803 gui.pruneduringfetch
2804 </dt>
2805 <dd>
2806 <p>
2808 performing a fetch. The default value is "false".
2809 </p>
2810 </dd>
2812 gui.trustmtime
2813 </dt>
2814 <dd>
2815 <p>
2817 timestamp or not. By default the timestamps are not trusted.
2818 </p>
2819 </dd>
2821 gui.spellingdictionary
2822 </dt>
2823 <dd>
2824 <p>
2825 Specifies the dictionary used for spell checking commit messages in
2827 off.
2828 </p>
2829 </dd>
2831 gui.fastcopyblame
2832 </dt>
2833 <dd>
2834 <p>
2836 location detection. It makes blame significantly faster on huge
2837 repositories at the expense of less thorough copy detection.
2838 </p>
2839 </dd>
2841 gui.copyblamethreshold
2842 </dt>
2843 <dd>
2844 <p>
2846 detection, measured in alphanumeric characters. See the
2848 </p>
2849 </dd>
2851 gui.blamehistoryctx
2852 </dt>
2853 <dd>
2854 <p>
2855 Specifies the radius of history context in days to show in
2858 variable is set to zero, the whole history is shown.
2859 </p>
2860 </dd>
2863 </dt>
2864 <dd>
2865 <p>
2866 Specifies the shell command line to execute when the corresponding item
2868 mandatory for every tool. The command is executed from the root of
2869 the working directory, and in the environment it receives the name of
2873 </p>
2874 </dd>
2877 </dt>
2878 <dd>
2879 <p>
2880 Run the tool only if a diff is selected in the GUI. It guarantees
2882 </p>
2883 </dd>
2886 </dt>
2887 <dd>
2888 <p>
2889 Run the command silently, without creating a window to display its
2890 output.
2891 </p>
2892 </dd>
2895 </dt>
2896 <dd>
2897 <p>
2898 Don’t rescan the working directory for changes after the tool
2899 finishes execution.
2900 </p>
2901 </dd>
2904 </dt>
2905 <dd>
2906 <p>
2907 Show a confirmation dialog before actually running the tool.
2908 </p>
2909 </dd>
2912 </dt>
2913 <dd>
2914 <p>
2915 Request a string argument from the user, and pass it to the tool
2919 the dialog uses a built-in generic prompt; otherwise the exact
2920 value of the variable is used.
2921 </p>
2922 </dd>
2925 </dt>
2926 <dd>
2927 <p>
2928 Request a single valid revision from the user, and set the
2931 </p>
2932 </dd>
2935 </dt>
2936 <dd>
2937 <p>
2939 This is useful for tools similar to merge or rebase, but not
2940 for things like checkout or reset.
2941 </p>
2942 </dd>
2945 </dt>
2946 <dd>
2947 <p>
2948 Specifies the title to use for the prompt dialog. The default
2949 is the tool name.
2950 </p>
2951 </dd>
2954 </dt>
2955 <dd>
2956 <p>
2957 Specifies the general prompt string to display at the top of
2959 The default value includes the actual command.
2960 </p>
2961 </dd>
2963 help.browser
2964 </dt>
2965 <dd>
2966 <p>
2967 Specify the browser that will be used to display help in the
2969 </p>
2970 </dd>
2972 help.format
2973 </dt>
2974 <dd>
2975 <p>
2977 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
2979 </p>
2980 </dd>
2982 help.autocorrect
2983 </dt>
2984 <dd>
2985 <p>
2986 Automatically correct and execute mistyped commands after
2987 waiting for the given number of deciseconds (0.1 sec). If more
2988 than one command can be deduced from the entered text, nothing
2989 will be executed. If the value of this option is negative,
2990 the corrected command will be executed immediately. If the
2991 value is 0 - the command will be just shown but not executed.
2992 This is the default.
2993 </p>
2994 </dd>
2996 http.proxy
2997 </dt>
2998 <dd>
2999 <p>
3003 </p>
3004 </dd>
3006 http.sslVerify
3007 </dt>
3008 <dd>
3009 <p>
3010 Whether to verify the SSL certificate when fetching or pushing
3012 variable.
3013 </p>
3014 </dd>
3016 http.sslCert
3017 </dt>
3018 <dd>
3019 <p>
3020 File containing the SSL certificate when fetching or pushing
3022 variable.
3023 </p>
3024 </dd>
3026 http.sslKey
3027 </dt>
3028 <dd>
3029 <p>
3030 File containing the SSL private key when fetching or pushing
3032 variable.
3033 </p>
3034 </dd>
3036 http.sslCertPasswordProtected
3037 </dt>
3038 <dd>
3039 <p>
3040 Enable git’s password prompt for the SSL certificate. Otherwise
3041 OpenSSL will prompt the user, possibly many times, if the
3042 certificate or private key is encrypted. Can be overridden by the
3044 </p>
3045 </dd>
3047 http.sslCAInfo
3048 </dt>
3049 <dd>
3050 <p>
3051 File containing the certificates to verify the peer with when
3052 fetching or pushing over HTTPS. Can be overridden by the
3054 </p>
3055 </dd>
3057 http.sslCAPath
3058 </dt>
3059 <dd>
3060 <p>
3061 Path containing files with the CA certificates to verify the peer
3062 with when fetching or pushing over HTTPS. Can be overridden
3064 </p>
3065 </dd>
3067 http.maxRequests
3068 </dt>
3069 <dd>
3070 <p>
3071 How many HTTP requests to launch in parallel. Can be overridden
3073 </p>
3074 </dd>
3076 http.minSessions
3077 </dt>
3078 <dd>
3079 <p>
3080 The number of curl sessions (counted across slots) to be kept across
3081 requests. They will not be ended with curl_easy_cleanup() until
3082 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
3084 </p>
3085 </dd>
3087 http.postBuffer
3088 </dt>
3089 <dd>
3090 <p>
3091 Maximum size in bytes of the buffer used by smart HTTP
3092 transports when POSTing data to the remote system.
3093 For requests larger than this buffer size, HTTP/1.1 and
3094 Transfer-Encoding: chunked is used to avoid creating a
3095 massive pack file locally. Default is 1 MiB, which is
3096 sufficient for most requests.
3097 </p>
3098 </dd>
3100 http.lowSpeedLimit, http.lowSpeedTime
3101 </dt>
3102 <dd>
3103 <p>
3108 </p>
3109 </dd>
3111 http.noEPSV
3112 </dt>
3113 <dd>
3114 <p>
3115 A boolean which disables using of EPSV ftp command by curl.
3118 environment variable. Default is false (curl will use EPSV).
3119 </p>
3120 </dd>
3122 http.useragent
3123 </dt>
3124 <dd>
3125 <p>
3126 The HTTP USER_AGENT string presented to an HTTP server. The default
3127 value represents the version of the client git such as git/1.7.1.
3128 This option allows you to override this value to a more common value
3129 such as Mozilla/4.0. This may be necessary, for instance, if
3130 connecting through a firewall that restricts HTTP connections to a set
3131 of common USER_AGENT strings (but not including those like git/1.7.1).
3133 </p>
3134 </dd>
3136 i18n.commitEncoding
3137 </dt>
3138 <dd>
3139 <p>
3140 Character encoding the commit messages are stored in; git itself
3141 does not care per se, but this information is necessary e.g. when
3142 importing commits from emails or in the gitk graphical history
3143 browser (and possibly at other places in the future or in other
3144 porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
3145 </p>
3146 </dd>
3148 i18n.logOutputEncoding
3149 </dt>
3150 <dd>
3151 <p>
3152 Character encoding the commit messages are converted to when
3154 </p>
3155 </dd>
3157 imap
3158 </dt>
3159 <dd>
3160 <p>
3163 </p>
3164 </dd>
3166 init.templatedir
3167 </dt>
3168 <dd>
3169 <p>
3170 Specify the directory from which templates will be copied.
3172 </p>
3173 </dd>
3175 instaweb.browser
3176 </dt>
3177 <dd>
3178 <p>
3179 Specify the program that will be used to browse your working
3181 </p>
3182 </dd>
3184 instaweb.httpd
3185 </dt>
3186 <dd>
3187 <p>
3188 The HTTP daemon command-line to start gitweb on your working
3190 </p>
3191 </dd>
3193 instaweb.local
3194 </dt>
3195 <dd>
3196 <p>
3198 be bound to the local IP (127.0.0.1).
3199 </p>
3200 </dd>
3202 instaweb.modulepath
3203 </dt>
3204 <dd>
3205 <p>
3207 instead of /usr/lib/apache2/modules. Only used if httpd
3208 is Apache.
3209 </p>
3210 </dd>
3212 instaweb.port
3213 </dt>
3214 <dd>
3215 <p>
3216 The port number to bind the gitweb httpd to. See
3218 </p>
3219 </dd>
3221 interactive.singlekey
3222 </dt>
3223 <dd>
3224 <p>
3225 In interactive commands, allow the user to provide one-letter
3226 input with a single key (i.e., without hitting enter).
3229 ignored if portable keystroke input is not available.
3230 </p>
3231 </dd>
3233 log.date
3234 </dt>
3235 <dd>
3236 <p>
3240 <tt>default</tt>, <tt>iso</tt>, <tt>rfc</tt>, and <tt>short</tt>; see <a href="git-log.html">git-log(1)</a>
3241 for details.
3242 </p>
3243 </dd>
3245 log.decorate
3246 </dt>
3247 <dd>
3248 <p>
3249 Print out the ref names of any commits that are shown by the log
3252 specified, the full ref name (including prefix) will be printed.
3254 </p>
3255 </dd>
3257 log.showroot
3258 </dt>
3259 <dd>
3260 <p>
3261 If true, the initial commit will be shown as a big creation event.
3262 This is equivalent to a diff against an empty tree.
3263 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
3264 normally hide the root commit will now show it. True by default.
3265 </p>
3266 </dd>
3268 mailmap.file
3269 </dt>
3270 <dd>
3271 <p>
3272 The location of an augmenting mailmap file. The default
3273 mailmap, located in the root of the repository, is loaded
3274 first, then the mailmap file pointed to by this variable.
3275 The location of the mailmap file may be in a repository
3276 subdirectory, or somewhere outside of the repository itself.
3277 See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
3278 </p>
3279 </dd>
3281 man.viewer
3282 </dt>
3283 <dd>
3284 <p>
3285 Specify the programs that may be used to display help in the
3287 </p>
3288 </dd>
3291 </dt>
3292 <dd>
3293 <p>
3294 Specify the command to invoke the specified man viewer. The
3295 specified command is evaluated in shell with the man page
3297 </p>
3298 </dd>
3301 </dt>
3302 <dd>
3303 <p>
3304 Override the path for the given tool that may be used to
3306 </p>
3307 </dd>
3309 merge.conflictstyle
3310 </dt>
3311 <dd>
3312 <p>
3313 Specify the style in which conflicted hunks are written out to
3314 working tree files upon merge. The default is "merge", which
3317 a <tt>>>>>>>></tt> marker. An alternate style, "diff3", adds a <tt>|||||||</tt>
3319 </p>
3320 </dd>
3322 merge.defaultToUpstream
3323 </dt>
3324 <dd>
3325 <p>
3326 If merge is called without any commit argument, merge the upstream
3327 branches configured for the current branch by using their last
3328 observed values stored in their remote tracking branches.
3332 to their corresponding remote tracking branches, and the tips of
3333 these tracking branches are merged.
3334 </p>
3335 </dd>
3337 merge.log
3338 </dt>
3339 <dd>
3340 <p>
3341 In addition to branch names, populate the log message with at
3342 most the specified number of one-line descriptions from the
3343 actual commits that are being merged. Defaults to false, and
3344 true is a synonym for 20.
3345 </p>
3346 </dd>
3348 merge.renameLimit
3349 </dt>
3350 <dd>
3351 <p>
3352 The number of files to consider when performing rename detection
3353 during a merge; if not specified, defaults to the value of
3354 diff.renameLimit.
3355 </p>
3356 </dd>
3358 merge.renormalize
3359 </dt>
3360 <dd>
3361 <p>
3362 Tell git that canonical representation of files in the
3363 repository has changed over time (e.g. earlier commits record
3364 text files with CRLF line endings, but recent ones use LF line
3365 endings). In such a repository, git can convert the data
3366 recorded in commits to a canonical form before performing a
3367 merge to reduce unnecessary conflicts. For more information,
3368 see section "Merging branches with differing checkin/checkout
3370 </p>
3371 </dd>
3373 merge.stat
3374 </dt>
3375 <dd>
3376 <p>
3377 Whether to print the diffstat between ORIG_HEAD and the merge result
3378 at the end of the merge. True by default.
3379 </p>
3380 </dd>
3382 merge.tool
3383 </dt>
3384 <dd>
3385 <p>
3386 Controls which merge resolution program is used by
3390 and "xxdiff". Any other value is treated is custom merge tool
3392 </p>
3393 </dd>
3395 merge.verbosity
3396 </dt>
3397 <dd>
3398 <p>
3399 Controls the amount of output shown by the recursive merge
3400 strategy. Level 0 outputs nothing except a final error
3401 message if conflicts were detected. Level 1 outputs only
3403 above outputs debugging information. The default is level 2.
3405 </p>
3406 </dd>
3409 </dt>
3410 <dd>
3411 <p>
3412 Defines a human-readable name for a custom low-level
3414 </p>
3415 </dd>
3418 </dt>
3419 <dd>
3420 <p>
3421 Defines the command that implements a custom low-level
3423 </p>
3424 </dd>
3427 </dt>
3428 <dd>
3429 <p>
3430 Names a low-level merge driver to be used when
3431 performing an internal merge between common ancestors.
3433 </p>
3434 </dd>
3437 </dt>
3438 <dd>
3439 <p>
3440 Override the path for the given tool. This is useful in case
3441 your tool is not in the PATH.
3442 </p>
3443 </dd>
3446 </dt>
3447 <dd>
3448 <p>
3449 Specify the command to invoke the specified merge tool. The
3450 specified command is evaluated in shell with the following
3452 containing the common base of the files to be merged, if available;
3455 file containing the contents of the file from the branch being
3457 tool should write the results of a successful merge.
3458 </p>
3459 </dd>
3462 </dt>
3463 <dd>
3464 <p>
3465 For a custom merge command, specify whether the exit code of
3466 the merge command can be used to determine whether the merge was
3467 successful. If this is not set to true then the merge target file
3468 timestamp is checked and the merge assumed to have been successful
3469 if the file has been updated, otherwise the user is prompted to
3470 indicate the success of the merge.
3471 </p>
3472 </dd>
3474 mergetool.keepBackup
3475 </dt>
3476 <dd>
3477 <p>
3478 After performing a merge, the original file with conflict markers
3482 </p>
3483 </dd>
3485 mergetool.keepTemporaries
3486 </dt>
3487 <dd>
3488 <p>
3489 When invoking a custom merge tool, git uses a set of temporary
3490 files to pass to the tool. If the tool returns an error and this
3492 preserved, otherwise they will be removed after the tool has
3494 </p>
3495 </dd>
3497 mergetool.prompt
3498 </dt>
3499 <dd>
3500 <p>
3501 Prompt before each invocation of the merge resolution program.
3502 </p>
3503 </dd>
3505 notes.displayRef
3506 </dt>
3507 <dd>
3508 <p>
3509 The (fully qualified) refname from which to show notes when
3510 showing commit messages. The value of this variable can be set
3511 to a glob, in which case notes from all matching refs will be
3512 shown. You may also specify this configuration variable
3513 several times. A warning will be issued for refs that do not
3514 exist, but a glob that does not match any refs is silently
3515 ignored.
3516 </p>
3517 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_DISPLAY_REF</tt>
3518 environment variable, which must be a colon separated list of refs or
3519 globs.</p></div>
3521 GIT_NOTES_REF) is also implicitly added to the list of refs to be
3522 displayed.</p></div>
3523 </dd>
3526 </dt>
3527 <dd>
3528 <p>
3531 automatically copies your notes from the original to the
3533 "notes.rewriteRef" below.
3534 </p>
3535 </dd>
3537 notes.rewriteMode
3538 </dt>
3539 <dd>
3540 <p>
3541 When copying notes during a rewrite (see the
3542 "notes.rewrite.<command>" option), determines what to do if
3543 the target commit already has a note. Must be one of
3546 </p>
3547 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_MODE</tt>
3548 environment variable.</p></div>
3549 </dd>
3551 notes.rewriteRef
3552 </dt>
3553 <dd>
3554 <p>
3555 When copying notes during a rewrite, specifies the (fully
3556 qualified) ref whose notes should be copied. The ref may be a
3557 glob, in which case notes in all matching refs will be copied.
3558 You may also specify this configuration several times.
3559 </p>
3561 enable note rewriting.</p></div>
3562 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_REF</tt>
3563 environment variable, which must be a colon separated list of refs or
3564 globs.</p></div>
3565 </dd>
3567 pack.window
3568 </dt>
3569 <dd>
3570 <p>
3572 window size is given on the command line. Defaults to 10.
3573 </p>
3574 </dd>
3576 pack.depth
3577 </dt>
3578 <dd>
3579 <p>
3580 The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
3581 maximum depth is given on the command line. Defaults to 50.
3582 </p>
3583 </dd>
3585 pack.windowMemory
3586 </dt>
3587 <dd>
3588 <p>
3590 when no limit is given on the command line. The value can be
3592 limit.
3593 </p>
3594 </dd>
3596 pack.compression
3597 </dt>
3598 <dd>
3599 <p>
3603 slowest. If not set, defaults to core.compression. If that is
3605 compromise between speed and compression (currently equivalent
3606 to level 6)."
3607 </p>
3608 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
3609 all existing objects. You can force recompression by passing the -F option
3611 </dd>
3613 pack.deltaCacheSize
3614 </dt>
3615 <dd>
3616 <p>
3617 The maximum memory in bytes used for caching deltas in
3619 This cache is used to speed up the writing object phase by not
3620 having to recompute the final delta result once the best match
3621 for all objects is found. Repacking large repositories on machines
3622 which are tight with memory might be badly impacted by this though,
3623 especially if this cache pushes the system into swapping.
3625 used to virtually disable this cache. Defaults to 256 MiB.
3626 </p>
3627 </dd>
3629 pack.deltaCacheLimit
3630 </dt>
3631 <dd>
3632 <p>
3633 The maximum size of a delta, that is cached in
3635 writing object phase by not having to recompute the final delta
3636 result once the best match for all objects is found. Defaults to 1000.
3637 </p>
3638 </dd>
3640 pack.threads
3641 </dt>
3642 <dd>
3643 <p>
3644 Specifies the number of threads to spawn when searching for best
3646 be compiled with pthreads otherwise this option is ignored with a
3647 warning. This is meant to reduce packing time on multiprocessor
3648 machines. The required amount of memory for the delta search window
3649 is however multiplied by the number of threads.
3651 and set the number of threads accordingly.
3652 </p>
3653 </dd>
3655 pack.indexVersion
3656 </dt>
3657 <dd>
3658 <p>
3659 Specify the default pack index version. Valid values are 1 for
3661 the new pack index with capabilities for packs larger than 4 GB
3662 as well as proper protection against the repacking of corrupted
3664 and this config option ignored whenever the corresponding pack is
3665 larger than 2 GB.
3666 </p>
3667 <div class="paragraph"><p>If you have an old git that does not understand the version 2 <tt>*.idx</tt> file,
3669 that will copy both <tt>*.pack</tt> file and corresponding <tt>*.idx</tt> file from the
3670 other side may give you a repository that cannot be accessed with your
3672 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
3674 </dd>
3676 pack.packSizeLimit
3677 </dt>
3678 <dd>
3679 <p>
3680 The maximum size of a pack. This setting only affects
3681 packing to a file when repacking, i.e. the git:// protocol
3684 limited to 1 MiB. The default is unlimited.
3686 supported.
3687 </p>
3688 </dd>
3691 </dt>
3692 <dd>
3693 <p>
3694 If the value is boolean, turns on or off pagination of the
3695 output of a particular git subcommand when writing to a tty.
3696 Otherwise, turns on pagination for the subcommand using the
3699 precedence over this option. To disable pagination for all
3701 </p>
3702 </dd>
3705 </dt>
3706 <dd>
3707 <p>
3708 Alias for a --pretty= format string, as specified in
3710 as the built-in pretty formats could. For example,
3714 Note that an alias with the same name as a built-in format
3715 will be silently ignored.
3716 </p>
3717 </dd>
3719 pull.octopus
3720 </dt>
3721 <dd>
3722 <p>
3723 The default merge strategy to use when pulling multiple branches
3724 at once.
3725 </p>
3726 </dd>
3728 pull.twohead
3729 </dt>
3730 <dd>
3731 <p>
3732 The default merge strategy to use when pulling a single branch.
3733 </p>
3734 </dd>
3736 push.default
3737 </dt>
3738 <dd>
3739 <p>
3740 Defines the action git push should take if no refspec is given
3741 on the command line, no refspec is configured in the remote, and
3742 no refspec is implied by any of the options given on the command
3743 line. Possible values are:
3744 </p>
3746 <li>
3747 <p>
3749 </p>
3750 </li>
3751 <li>
3752 <p>
3754 All branches having the same name in both ends are considered to be
3755 matching. This is the default.
3756 </p>
3757 </li>
3758 <li>
3759 <p>
3761 </p>
3762 </li>
3763 <li>
3764 <p>
3766 </p>
3767 </li>
3768 <li>
3769 <p>
3771 </p>
3772 </li>
3773 </ul></div>
3774 </dd>
3776 rebase.stat
3777 </dt>
3778 <dd>
3779 <p>
3780 Whether to show a diffstat of what changed upstream since the last
3781 rebase. False by default.
3782 </p>
3783 </dd>
3785 rebase.autosquash
3786 </dt>
3787 <dd>
3788 <p>
3790 </p>
3791 </dd>
3793 receive.autogc
3794 </dt>
3795 <dd>
3796 <p>
3797 By default, git-receive-pack will run "git-gc --auto" after
3798 receiving data from git-push and updating refs. You can stop
3799 it by setting this variable to false.
3800 </p>
3801 </dd>
3803 receive.fsckObjects
3804 </dt>
3805 <dd>
3806 <p>
3807 If it is set to true, git-receive-pack will check all received
3808 objects. It will abort in the case of a malformed object or a
3809 broken link. The result of an abort are only dangling objects.
3810 Defaults to false.
3811 </p>
3812 </dd>
3814 receive.unpackLimit
3815 </dt>
3816 <dd>
3817 <p>
3818 If the number of objects received in a push is below this
3819 limit then the objects will be unpacked into loose object
3820 files. However if the number of received objects equals or
3821 exceeds this limit then the received pack will be stored as
3822 a pack, after adding any missing delta bases. Storing the
3823 pack from a push can make the push operation complete faster,
3824 especially on slow filesystems. If not set, the value of
3826 </p>
3827 </dd>
3829 receive.denyDeletes
3830 </dt>
3831 <dd>
3832 <p>
3833 If set to true, git-receive-pack will deny a ref update that deletes
3834 the ref. Use this to prevent such a ref deletion via a push.
3835 </p>
3836 </dd>
3838 receive.denyDeleteCurrent
3839 </dt>
3840 <dd>
3841 <p>
3842 If set to true, git-receive-pack will deny a ref update that
3843 deletes the currently checked out branch of a non-bare repository.
3844 </p>
3845 </dd>
3847 receive.denyCurrentBranch
3848 </dt>
3849 <dd>
3850 <p>
3851 If set to true or "refuse", git-receive-pack will deny a ref update
3852 to the currently checked out branch of a non-bare repository.
3853 Such a push is potentially dangerous because it brings the HEAD
3854 out of sync with the index and working tree. If set to "warn",
3855 print a warning of such a push to stderr, but allow the push to
3856 proceed. If set to false or "ignore", allow such pushes with no
3857 message. Defaults to "refuse".
3858 </p>
3859 </dd>
3861 receive.denyNonFastForwards
3862 </dt>
3863 <dd>
3864 <p>
3865 If set to true, git-receive-pack will deny a ref update which is
3866 not a fast-forward. Use this to prevent such an update via a push,
3867 even if that push is forced. This configuration variable is
3868 set when initializing a shared repository.
3869 </p>
3870 </dd>
3872 receive.updateserverinfo
3873 </dt>
3874 <dd>
3875 <p>
3876 If set to true, git-receive-pack will run git-update-server-info
3877 after receiving data from git-push and updating refs.
3878 </p>
3879 </dd>
3882 </dt>
3883 <dd>
3884 <p>
3887 </p>
3888 </dd>
3891 </dt>
3892 <dd>
3893 <p>
3895 </p>
3896 </dd>
3899 </dt>
3900 <dd>
3901 <p>
3902 For remotes that require curl (http, https and ftp), the URL to
3903 the proxy to use for that remote. Set to the empty string to
3904 disable proxying for that remote.
3905 </p>
3906 </dd>
3909 </dt>
3910 <dd>
3911 <p>
3914 </p>
3915 </dd>
3918 </dt>
3919 <dd>
3920 <p>
3923 </p>
3924 </dd>
3927 </dt>
3928 <dd>
3929 <p>
3930 If true, pushing to this remote will automatically behave
3932 </p>
3933 </dd>
3936 </dt>
3937 <dd>
3938 <p>
3939 If true, this remote will be skipped by default when updating
3942 </p>
3943 </dd>
3946 </dt>
3947 <dd>
3948 <p>
3949 If true, this remote will be skipped by default when updating
3952 </p>
3953 </dd>
3956 </dt>
3957 <dd>
3958 <p>
3959 The default program to execute on the remote side when pushing. See
3961 </p>
3962 </dd>
3965 </dt>
3966 <dd>
3967 <p>
3968 The default program to execute on the remote side when fetching. See
3970 </p>
3971 </dd>
3974 </dt>
3975 <dd>
3976 <p>
3977 Setting this value to --no-tags disables automatic tag following when
3981 override this setting. See options --tags and --no-tags of
3983 </p>
3984 </dd>
3987 </dt>
3988 <dd>
3989 <p>
3992 </p>
3993 </dd>
3996 </dt>
3997 <dd>
3998 <p>
3999 The list of remotes which are fetched by "git remote update
4001 </p>
4002 </dd>
4004 repack.usedeltabaseoffset
4005 </dt>
4006 <dd>
4007 <p>
4009 delta-base offset. If you need to share your repository with
4010 git older than version 1.4.4, either directly or via a dumb
4011 protocol such as http, then you need to set this option to
4012 "false" and repack. Access from old git versions over the
4013 native protocol are unaffected by this option.
4014 </p>
4015 </dd>
4017 rerere.autoupdate
4018 </dt>
4019 <dd>
4020 <p>
4022 resulting contents after it cleanly resolves conflicts using
4023 previously recorded resolution. Defaults to false.
4024 </p>
4025 </dd>
4027 rerere.enabled
4028 </dt>
4029 <dd>
4030 <p>
4031 Activate recording of resolved conflicts, so that identical
4032 conflict hunks can be resolved automatically, should they
4036 </p>
4037 </dd>
4039 sendemail.identity
4040 </dt>
4041 <dd>
4042 <p>
4043 A configuration identity. When given, causes values in the
4047 </p>
4048 </dd>
4050 sendemail.smtpencryption
4051 </dt>
4052 <dd>
4053 <p>
4056 </p>
4057 </dd>
4059 sendemail.smtpssl
4060 </dt>
4061 <dd>
4062 <p>
4064 </p>
4065 </dd>
4068 </dt>
4069 <dd>
4070 <p>
4072 found below, taking precedence over those when the this
4073 identity is selected, through command-line or
4075 </p>
4076 </dd>
4078 sendemail.aliasesfile
4079 </dt>
4081 sendemail.aliasfiletype
4082 </dt>
4084 sendemail.bcc
4085 </dt>
4087 sendemail.cc
4088 </dt>
4090 sendemail.cccmd
4091 </dt>
4093 sendemail.chainreplyto
4094 </dt>
4096 sendemail.confirm
4097 </dt>
4099 sendemail.envelopesender
4100 </dt>
4102 sendemail.from
4103 </dt>
4105 sendemail.multiedit
4106 </dt>
4108 sendemail.signedoffbycc
4109 </dt>
4111 sendemail.smtppass
4112 </dt>
4114 sendemail.suppresscc
4115 </dt>
4117 sendemail.suppressfrom
4118 </dt>
4120 sendemail.to
4121 </dt>
4123 sendemail.smtpdomain
4124 </dt>
4126 sendemail.smtpserver
4127 </dt>
4129 sendemail.smtpserverport
4130 </dt>
4132 sendemail.smtpserveroption
4133 </dt>
4135 sendemail.smtpuser
4136 </dt>
4138 sendemail.thread
4139 </dt>
4141 sendemail.validate
4142 </dt>
4143 <dd>
4144 <p>
4146 </p>
4147 </dd>
4149 sendemail.signedoffcc
4150 </dt>
4151 <dd>
4152 <p>
4154 </p>
4155 </dd>
4157 showbranch.default
4158 </dt>
4159 <dd>
4160 <p>
4163 </p>
4164 </dd>
4166 status.relativePaths
4167 </dt>
4168 <dd>
4169 <p>
4172 relative to the repository root (this was the default for git
4173 prior to v1.5.4).
4174 </p>
4175 </dd>
4177 status.showUntrackedFiles
4178 </dt>
4179 <dd>
4180 <p>
4181 By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
4182 files which are not currently tracked by Git. Directories which
4183 contain only untracked files, are shown with the directory name
4184 only. Showing untracked files means that Git needs to lstat() all
4185 all the files in the whole repository, which might be slow on some
4186 systems. So, this variable controls how the commands displays
4187 the untracked files. Possible values are:
4188 </p>
4190 <li>
4191 <p>
4193 </p>
4194 </li>
4195 <li>
4196 <p>
4198 </p>
4199 </li>
4200 <li>
4201 <p>
4203 </p>
4204 </li>
4205 </ul></div>
4207 This variable can be overridden with the -u|--untracked-files option
4208 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
4209 </dd>
4211 status.submodulesummary
4212 </dt>
4213 <dd>
4214 <p>
4215 Defaults to false.
4216 If this is set to a non zero number or true (identical to -1 or an
4217 unlimited number), the submodule summary will be enabled and a
4218 summary of commits for modified submodules will be shown (see
4220 </p>
4221 </dd>
4224 </dt>
4227 </dt>
4230 </dt>
4231 <dd>
4232 <p>
4233 The path within this project, URL, and the updating strategy
4234 for a submodule. These variables are initially populated
4237 <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
4238 </p>
4239 </dd>
4242 </dt>
4243 <dd>
4244 <p>
4245 This option can be used to control recursive fetching of this
4246 submodule. It can be overridden by using the --[no-]recurse-submodules
4249 file.
4250 </p>
4251 </dd>
4254 </dt>
4255 <dd>
4256 <p>
4257 Defines under what circumstances "git status" and the diff family show
4258 a submodule as modified. When set to "all", it will never be considered
4259 modified, "dirty" will ignore all changes to the submodules work tree and
4260 takes only differences between the HEAD of the submodule and the commit
4261 recorded in the superproject into account. "untracked" will additionally
4262 let submodules with modified tracked files in their work tree show up.
4263 Using "none" (the default when this option is not set) also shows
4264 submodules that have untracked files in their work tree as changed.
4265 This setting overrides any setting made in .gitmodules for this submodule,
4266 both settings can be overridden on the command line by using the
4267 "--ignore-submodules" option.
4268 </p>
4269 </dd>
4271 tar.umask
4272 </dt>
4273 <dd>
4274 <p>
4275 This variable can be used to restrict the permission bits of
4276 tar archive entries. The default is 0002, which turns off the
4277 world write bit. The special value "user" indicates that the
4280 </p>
4281 </dd>
4283 transfer.unpackLimit
4284 </dt>
4285 <dd>
4286 <p>
4288 not set, the value of this variable is used instead.
4289 The default value is 100.
4290 </p>
4291 </dd>
4294 </dt>
4295 <dd>
4296 <p>
4297 Any URL that starts with this value will be rewritten to
4299 large number of repositories, and serves them with multiple
4300 access methods, and some users need to use different access
4301 methods, this feature allows people to specify any of the
4302 equivalent URLs and have git automatically rewrite the URL to
4303 the best alternative for the particular user, even for a
4304 never-before-seen repository on the site. When more than one
4305 insteadOf strings match a given URL, the longest match is used.
4306 </p>
4307 </dd>
4310 </dt>
4311 <dd>
4312 <p>
4313 Any URL that starts with this value will not be pushed to;
4315 resulting URL will be pushed to. In cases where some site serves
4316 a large number of repositories, and serves them with multiple
4317 access methods, some of which do not allow push, this feature
4318 allows people to specify a pull-only URL and have git
4319 automatically use an appropriate URL to push, even for a
4320 never-before-seen repository on the site. When more than one
4321 pushInsteadOf strings match a given URL, the longest match is
4322 used. If a remote has an explicit pushurl, git will ignore this
4323 setting for that remote.
4324 </p>
4325 </dd>
4327 user.email
4328 </dt>
4329 <dd>
4330 <p>
4331 Your email address to be recorded in any newly created commits.
4333 <em>EMAIL</em> environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
4334 </p>
4335 </dd>
4337 user.name
4338 </dt>
4339 <dd>
4340 <p>
4341 Your full name to be recorded in any newly created commits.
4344 </p>
4345 </dd>
4347 user.signingkey
4348 </dt>
4349 <dd>
4350 <p>
4352 automatically when creating a signed tag, you can override the
4353 default selection with this variable. This option is passed
4354 unchanged to gpg’s --local-user parameter, so you may specify a key
4355 using any method that gpg supports.
4356 </p>
4357 </dd>
4359 web.browser
4360 </dt>
4361 <dd>
4362 <p>
4363 Specify a web browser that may be used by some commands.
4364 Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
4365 may use it.
4366 </p>
4367 </dd>
4368 </dl></div>
4369 </div>
4373 </div>
4377 </div>
4378 </div>
4379 </body>
4380 </html>