| blob | 809e624ea0f49bfe651ab3cbb7c0b81f0c638f06 |
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 (ret=3),
462 </p>
463 </li>
464 <li>
465 <p>
466 can not write to the config file (ret=4),
467 </p>
468 </li>
469 <li>
470 <p>
471 no section or name was provided (ret=2),
472 </p>
473 </li>
474 <li>
475 <p>
476 the section or key is invalid (ret=1),
477 </p>
478 </li>
479 <li>
480 <p>
481 you try to unset an option which does not exist (ret=5),
482 </p>
483 </li>
484 <li>
485 <p>
486 you try to unset/set an option for which multiple lines match (ret=5),
487 </p>
488 </li>
489 <li>
490 <p>
491 you try to use an invalid regexp (ret=6), or
492 </p>
493 </li>
494 <li>
495 <p>
497 </p>
498 </li>
499 </ol></div>
501 </div>
506 --replace-all
507 </dt>
508 <dd>
509 <p>
510 Default behavior is to replace at most one line. This replaces
511 all lines matching the key (and optionally the value_regex).
512 </p>
513 </dd>
515 --add
516 </dt>
517 <dd>
518 <p>
519 Adds a new line to the option without altering any existing
522 </p>
523 </dd>
525 --get
526 </dt>
527 <dd>
528 <p>
529 Get the value for a given key (optionally filtered by a regex
530 matching the value). Returns error code 1 if the key was not
531 found and error code 2 if multiple key values were found.
532 </p>
533 </dd>
535 --get-all
536 </dt>
537 <dd>
538 <p>
539 Like get, but does not fail if the number of values for the key
540 is not exactly one.
541 </p>
542 </dd>
544 --get-regexp
545 </dt>
546 <dd>
547 <p>
548 Like --get-all, but interprets the name as a regular expression.
549 Also outputs the key names.
550 </p>
551 </dd>
553 --global
554 </dt>
555 <dd>
556 <p>
557 For writing options: write to global ~/.gitconfig file rather than
558 the repository .git/config.
559 </p>
561 from all available files.</p></div>
563 </dd>
565 --system
566 </dt>
567 <dd>
568 <p>
569 For writing options: write to system-wide $(prefix)/etc/gitconfig
570 rather than the repository .git/config.
571 </p>
572 <div class="paragraph"><p>For reading options: read only from system-wide $(prefix)/etc/gitconfig
573 rather than from all available files.</p></div>
575 </dd>
577 -f config-file
578 </dt>
580 --file config-file
581 </dt>
582 <dd>
583 <p>
584 Use the given config file instead of the one specified by GIT_CONFIG.
585 </p>
586 </dd>
588 --remove-section
589 </dt>
590 <dd>
591 <p>
592 Remove the given section from the configuration file.
593 </p>
594 </dd>
596 --rename-section
597 </dt>
598 <dd>
599 <p>
600 Rename the given section to a new name.
601 </p>
602 </dd>
604 --unset
605 </dt>
606 <dd>
607 <p>
608 Remove the line matching the key from config file.
609 </p>
610 </dd>
612 --unset-all
613 </dt>
614 <dd>
615 <p>
616 Remove all lines matching the key from config file.
617 </p>
618 </dd>
620 -l
621 </dt>
623 --list
624 </dt>
625 <dd>
626 <p>
627 List all variables set in config file.
628 </p>
629 </dd>
631 --bool
632 </dt>
633 <dd>
634 <p>
636 </p>
637 </dd>
639 --int
640 </dt>
641 <dd>
642 <p>
645 in the config file will cause the value to be multiplied
647 </p>
648 </dd>
650 --bool-or-int
651 </dt>
652 <dd>
653 <p>
655 either --bool or --int, as described above.
656 </p>
657 </dd>
659 --path
660 </dt>
661 <dd>
662 <p>
665 specified user. This option has no effect when setting the
667 command line to let your shell do the expansion).
668 </p>
669 </dd>
671 -z
672 </dt>
674 --null
675 </dt>
676 <dd>
677 <p>
678 For all options that output values and/or keys, always
679 end values with the null character (instead of a
680 newline). Use newline instead as a delimiter between
681 key and value. This allows for secure parsing of the
682 output without getting confused e.g. by values that
683 contain line breaks.
684 </p>
685 </dd>
687 --get-colorbool name [stdout-is-tty]
688 </dt>
689 <dd>
690 <p>
693 "false", and is taken into account when configuration says
695 output of the command itself, and exits with status 0 if color
696 is to be used, or exits with status 1 otherwise.
699 </p>
700 </dd>
702 --get-color name [default]
703 </dt>
704 <dd>
705 <p>
707 output it as the ANSI color escape sequence to the standard
710 </p>
711 </dd>
713 -e
714 </dt>
716 --edit
717 </dt>
718 <dd>
719 <p>
720 Opens an editor to modify the specified config file; either
722 </p>
723 </dd>
724 </dl></div>
725 </div>
728 <div class="paragraph"><p>If not set explicitly with <em>--file</em>, there are three files where
732 $GIT_DIR/config
733 </dt>
734 <dd>
735 <p>
736 Repository specific configuration file. (The filename is
737 of course relative to the repository root, not the working
738 directory.)
739 </p>
740 </dd>
742 ~/.gitconfig
743 </dt>
744 <dd>
745 <p>
746 User-specific configuration file. Also called "global"
747 configuration file.
748 </p>
749 </dd>
751 $(prefix)/etc/gitconfig
752 </dt>
753 <dd>
754 <p>
755 System-wide configuration file.
756 </p>
757 </dd>
758 </dl></div>
759 <div class="paragraph"><p>If no further options are given, all reading options will read all of these
760 files that are available. If the global or the system-wide configuration
761 file are not available they will be ignored. If the repository configuration
763 error code. However, in neither case will an error message be issued.</p></div>
766 and <em>--unset</em>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div>
767 <div class="paragraph"><p>You can override these rules either by command line options or by environment
769 to the global or system-wide file respectively. The GIT_CONFIG environment
770 variable has a similar effect, but you can specify any filename you want.</p></div>
771 </div>
776 GIT_CONFIG
777 </dt>
778 <dd>
779 <p>
780 Take the configuration from the given file instead of .git/config.
781 Using the "--global" option forces this to ~/.gitconfig. Using the
782 "--system" option forces this to $(prefix)/etc/gitconfig.
783 </p>
784 </dd>
785 </dl></div>
787 </div>
793 <pre><tt>#
794 # This is the config file, and
795 # a '#' or ';' character indicates
796 # a comment
797 #</tt></pre>
798 </div></div>
801 <pre><tt>; core variables
802 [core]
803 ; Don't trust file modes
804 filemode = false</tt></pre>
805 </div></div>
808 <pre><tt>; Our diff algorithm
809 [diff]
810 external = /usr/local/bin/diff-wrapper
811 renames = true</tt></pre>
812 </div></div>
815 <pre><tt>; Proxy settings
816 [core]
818 gitproxy=default-proxy ; for all the rest</tt></pre>
819 </div></div>
824 </div></div>
825 <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
826 what URL they apply to. Here is how to change the entry for kernel.org
831 </div></div>
832 <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div>
837 </div></div>
838 <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
839 you have to provide a regex matching the value of exactly one line.</p></div>
844 </div></div>
849 </div></div>
854 </div></div>
859 </div></div>
860 <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
861 new one with</p></div>
865 </div></div>
866 <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy,
871 </div></div>
872 <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div>
876 </div></div>
877 <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div>
881 </div></div>
883 script:</p></div>
886 <pre><tt>#!/bin/sh
887 WS=$(git config --get-color color.diff.whitespace "blue reverse")
890 </div></div>
891 </div>
896 is used to store the configuration for that repository, and
899 can be used to store a system-wide default configuration.</p></div>
901 and the porcelains. The variables are divided into sections, wherein
902 the fully qualified variable name of the variable itself is the last
903 dot-separated segment and the section name is everything before the last
904 dot. The variable names are case-insensitive and only alphanumeric
905 characters are allowed. Some variables may appear multiple times.</p></div>
909 blank lines are ignored.</p></div>
911 the name of the section in square brackets and continues until the next
912 section begins. Section names are not case sensitive. Only alphanumeric
914 must belong to some section, which means that there must be a section
915 header before the first setting of a variable.</p></div>
916 <div class="paragraph"><p>Sections can be further divided into subsections. To begin a subsection
917 put its name in double quotes, separated by space from the section name,
918 in the section header, like in the example below:</p></div>
922 </div></div>
923 <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except
924 newline (doublequote <tt>"</tt> and backslash have to be escaped as <tt>\"</tt> and <tt>\\</tt>,
925 respectively). Section headers cannot span multiple
926 lines. Variables may belong directly to a section or to a given subsection.
929 <div class="paragraph"><p>There is also a case insensitive alternative <tt>[section.subsection]</tt> syntax.
930 In this syntax, subsection names follow the same restrictions as for section
931 names.</p></div>
933 header) are recognized as setting variables, in the form
936 The variable names are case-insensitive and only alphanumeric
938 for a given variable; we say then that variable is multivalued.</p></div>
940 Internal whitespace within a variable value is retained verbatim.</p></div>
941 <div class="paragraph"><p>The values following the equals sign in variable assign are all either
942 a string, an integer, or a boolean. Boolean values may be given as yes/no,
947 You need to enclose variable values in double quotes if you want to
948 preserve leading or trailing whitespace, or if the variable value contains
952 <div class="paragraph"><p>The following escape sequences (beside <tt>\"</tt> and <tt>\\</tt>) are recognized:
955 char sequences are valid.</p></div>
956 <div class="paragraph"><p>Variable values ending in a <tt>\</tt> are continued on the next line in the
957 customary UNIX fashion.</p></div>
962 <pre><tt># Core variables
963 [core]
964 ; Don't trust file modes
965 filemode = false</tt></pre>
966 </div></div>
969 <pre><tt># Our diff algorithm
970 [diff]
971 external = /usr/local/bin/diff-wrapper
972 renames = true</tt></pre>
973 </div></div>
977 remote = origin
978 merge = refs/heads/devel</tt></pre>
979 </div></div>
982 <pre><tt># Proxy settings
983 [core]
985 gitProxy=default-proxy ; for the rest</tt></pre>
986 </div></div>
988 <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete.
989 For command-specific variables, you will find a more detailed description
990 in the appropriate manual page. You will find a description of non-core
991 porcelain configuration variables in the respective porcelain documentation.</p></div>
994 advice.*
995 </dt>
996 <dd>
997 <p>
1000 are:
1001 </p>
1004 pushNonFastForward
1005 </dt>
1006 <dd>
1007 <p>
1009 non-fast-forward refs. Default: true.
1010 </p>
1011 </dd>
1013 statusHints
1014 </dt>
1015 <dd>
1016 <p>
1017 Directions on how to stage/unstage/add shown in the
1019 when writing commit messages. Default: true.
1020 </p>
1021 </dd>
1023 commitBeforeMerge
1024 </dt>
1025 <dd>
1026 <p>
1028 merge to avoid overwriting local changes.
1029 Default: true.
1030 </p>
1031 </dd>
1033 resolveConflict
1034 </dt>
1035 <dd>
1036 <p>
1037 Advices shown by various commands when conflicts
1038 prevent the operation from being performed.
1039 Default: true.
1040 </p>
1041 </dd>
1043 implicitIdentity
1044 </dt>
1045 <dd>
1046 <p>
1047 Advice on how to set your identity configuration when
1048 your information is guessed from the system username and
1049 domain name. Default: true.
1050 </p>
1051 </dd>
1053 detachedHead
1054 </dt>
1055 <dd>
1056 <p>
1058 move to the detach HEAD state, to instruct how to create
1059 a local branch after the fact. Default: true.
1060 </p>
1061 </dd>
1062 </dl></div>
1063 </dd>
1065 core.fileMode
1066 </dt>
1067 <dd>
1068 <p>
1069 If false, the executable bit differences between the index and
1070 the working copy are ignored; useful on broken filesystems like FAT.
1072 </p>
1073 <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>
1074 will probe and set core.fileMode false if appropriate when the
1075 repository is created.</p></div>
1076 </dd>
1078 core.ignoreCygwinFSTricks
1079 </dt>
1080 <dd>
1081 <p>
1082 This option is only used by Cygwin implementation of Git. If false,
1083 the Cygwin stat() and lstat() functions are used. This may be useful
1084 if your repository consists of a few separate directories joined in
1085 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
1086 whenever it is possible and falls back to Cygwin functions only to
1087 handle symbol links. The native mode is more than twice faster than
1088 normal Cygwin l/stat() functions. True by default, unless core.filemode
1089 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin’s
1090 POSIX emulation is required to support core.filemode.
1091 </p>
1092 </dd>
1094 core.ignorecase
1095 </dt>
1096 <dd>
1097 <p>
1098 If true, this option enables various workarounds to enable
1099 git to work better on filesystems that are not case sensitive,
1100 like FAT. For example, if a directory listing finds
1102 it is really the same file, and continue to remember it as
1103 "Makefile".
1104 </p>
1105 <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>
1106 will probe and set core.ignorecase true if appropriate when the repository
1107 is created.</p></div>
1108 </dd>
1110 core.trustctime
1111 </dt>
1112 <dd>
1113 <p>
1114 If false, the ctime differences between the index and the
1115 working copy are ignored; useful when the inode change time
1116 is regularly modified by something outside Git (file system
1117 crawlers and some backup systems).
1119 </p>
1120 </dd>
1122 core.quotepath
1123 </dt>
1124 <dd>
1125 <p>
1128 "unusual" characters in the pathname by enclosing the
1129 pathname in a double-quote pair and with backslashes the
1130 same way strings in C source code are quoted. If this
1131 variable is set to false, the bytes higher than 0x80 are
1132 not quoted but output as verbatim. Note that double
1133 quote, backslash and control characters are always
1135 variable.
1136 </p>
1137 </dd>
1139 core.eol
1140 </dt>
1141 <dd>
1142 <p>
1143 Sets the line ending type to use in the working directory for
1148 conversion.
1149 </p>
1150 </dd>
1152 core.safecrlf
1153 </dt>
1154 <dd>
1155 <p>
1157 end-of-line conversion is active. Git will verify if a command
1158 modifies a file in the work tree either directly or indirectly.
1159 For example, committing a file followed by checking out the
1160 same file should yield the original file in the work tree. If
1161 this is not the case for the current setting of
1163 be set to "warn", in which case git will only warn about an
1164 irreversible conversion but continue the operation.
1165 </p>
1167 When it is enabled, git will convert CRLF to LF during commit and LF to
1168 CRLF during checkout. A file that contains a mixture of LF and
1169 CRLF before the commit cannot be recreated by git. For text
1170 files this is the right thing to do: it corrects line endings
1171 such that we have only LF line endings in the repository.
1172 But for binary files that are accidentally classified as text the
1173 conversion can corrupt data.</p></div>
1175 setting the conversion type explicitly in .gitattributes. Right
1176 after committing you still have the original file in your work
1177 tree and this file is not yet corrupted. You can explicitly tell
1178 git that this file is binary and git will handle the file
1179 appropriately.</p></div>
1181 mixed line endings and the undesired effect of corrupting binary
1182 files cannot be distinguished. In both cases CRLFs are removed
1183 in an irreversible way. For text files this is the right thing
1184 to do because CRLFs are line endings, while for binary files
1185 converting CRLFs corrupts data.</p></div>
1186 <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a
1187 file identical to the original file for a different setting of
1195 mechanism.</p></div>
1196 </dd>
1198 core.autocrlf
1199 </dt>
1200 <dd>
1201 <p>
1202 Setting this variable to "true" is almost the same as setting
1204 files are not guaranteed to be normalized: files that contain
1207 working directory even though the repository does not have
1209 in which case no output conversion is performed.
1210 </p>
1211 </dd>
1213 core.symlinks
1214 </dt>
1215 <dd>
1216 <p>
1217 If false, symbolic links are checked out as small plain files that
1220 file. Useful on filesystems like FAT that do not support
1221 symbolic links.
1222 </p>
1223 <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>
1224 will probe and set core.symlinks false if appropriate when the repository
1225 is created.</p></div>
1226 </dd>
1228 core.gitProxy
1229 </dt>
1230 <dd>
1231 <p>
1233 of establishing direct connection to the remote server when
1234 using the git protocol for fetching. If the variable value is
1235 in the "COMMAND for DOMAIN" format, the command is applied only
1236 on hostnames ending with the specified domain string. This variable
1237 may be set multiple times and is matched in the given order;
1238 the first match wins.
1239 </p>
1240 <div class="paragraph"><p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable
1241 (which always applies universally, without the special "for"
1242 handling).</p></div>
1244 specify that no proxy be used for a given domain pattern.
1245 This is useful for excluding servers inside a firewall from
1246 proxy use, while defaulting to a common proxy for external domains.</p></div>
1247 </dd>
1249 core.ignoreStat
1250 </dt>
1251 <dd>
1252 <p>
1253 If true, commands which modify both the working tree and the index
1254 will mark the updated paths with the "assume unchanged" bit in the
1255 index. These marked files are then assumed to stay unchanged in the
1256 working copy, until you mark them otherwise manually - Git will not
1257 detect the file changes by lstat() calls. This is useful on systems
1258 where those are very slow, such as Microsoft Windows.
1260 False by default.
1261 </p>
1262 </dd>
1264 core.preferSymlinkRefs
1265 </dt>
1266 <dd>
1267 <p>
1268 Instead of the default "symref" format for HEAD
1269 and other symbolic reference files, use symbolic links.
1270 This is sometimes needed to work with old scripts that
1271 expect HEAD to be a symbolic link.
1272 </p>
1273 </dd>
1275 core.bare
1276 </dt>
1277 <dd>
1278 <p>
1280 working directory associated with it. If this is the case a
1281 number of commands that require a working directory will be
1282 disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.
1283 </p>
1284 <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
1286 repository that ends in "/.git" is assumed to be not bare (bare =
1287 false), while all other repositories are assumed to be bare (bare
1288 = true).</p></div>
1289 </dd>
1291 core.worktree
1292 </dt>
1293 <dd>
1294 <p>
1295 Set the path to the root of the working tree.
1296 This can be overridden by the GIT_WORK_TREE environment
1298 The value can be an absolute path or relative to the path to
1299 the .git directory, which is either specified by --git-dir
1300 or GIT_DIR, or automatically discovered.
1301 If --git-dir or GIT_DIR is specified but none of
1302 --work-tree, GIT_WORK_TREE and core.worktree is specified,
1303 the current working directory is regarded as the top level
1304 of your working tree.
1305 </p>
1307 file in a ".git" subdirectory of a directory and its value differs
1308 from the latter directory (e.g. "/path/to/.git/config" has
1309 core.worktree set to "/different/path"), which is most likely a
1310 misconfiguration. Running git commands in the "/path/to" directory will
1311 still use "/different/path" as the root of the work tree and can cause
1312 confusion unless you know what you are doing (e.g. you are creating a
1313 read-only snapshot of the same index to a location different from the
1315 </dd>
1317 core.logAllRefUpdates
1318 </dt>
1319 <dd>
1320 <p>
1322 "$GIT_DIR/logs/<ref>", by appending the new and old
1323 SHA1, the date/time and the reason of the update, but
1324 only when the file exists. If this configuration
1325 variable is set to true, missing "$GIT_DIR/logs/<ref>"
1326 file is automatically created for branch heads (i.e. under
1327 refs/heads/), remote refs (i.e. under refs/remotes/),
1328 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
1329 </p>
1333 a working directory associated with it, and false by
1334 default in a bare repository.</p></div>
1335 </dd>
1337 core.repositoryFormatVersion
1338 </dt>
1339 <dd>
1340 <p>
1341 Internal variable identifying the repository format and layout
1342 version.
1343 </p>
1344 </dd>
1346 core.sharedRepository
1347 </dt>
1348 <dd>
1349 <p>
1351 several users in a group (making sure all the files and objects are
1353 repository will be readable by all users, additionally to being
1357 user’s umask value (whereas the other options will only override
1359 the repo read/write-able for the owner and group, but inaccessible to
1361 repository that is group-readable but not group-writable.
1363 </p>
1364 </dd>
1366 core.warnAmbiguousRefs
1367 </dt>
1368 <dd>
1369 <p>
1370 If true, git will warn you if the ref name you passed it is ambiguous
1371 and might match multiple refs in the .git/refs/ tree. True by default.
1372 </p>
1373 </dd>
1375 core.compression
1376 </dt>
1377 <dd>
1378 <p>
1382 If set, this provides a default to other compression variables,
1384 </p>
1385 </dd>
1387 core.loosecompression
1388 </dt>
1389 <dd>
1390 <p>
1394 slowest. If not set, defaults to core.compression. If that is
1395 not set, defaults to 1 (best speed).
1396 </p>
1397 </dd>
1399 core.packedGitWindowSize
1400 </dt>
1401 <dd>
1402 <p>
1403 Number of bytes of a pack file to map into memory in a
1404 single mapping operation. Larger window sizes may allow
1405 your system to process a smaller number of large pack files
1406 more quickly. Smaller window sizes will negatively affect
1407 performance due to increased calls to the operating system’s
1408 memory manager, but may improve performance when accessing
1409 a large number of large pack files.
1410 </p>
1413 be reasonable for all users/operating systems. You probably do
1414 not need to adjust this value.</p></div>
1415 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1416 </dd>
1418 core.packedGitLimit
1419 </dt>
1420 <dd>
1421 <p>
1422 Maximum number of bytes to map simultaneously into memory
1423 from pack files. If Git needs to access more than this many
1424 bytes at once to complete an operation it will unmap existing
1425 regions to reclaim virtual address space within the process.
1426 </p>
1427 <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
1428 This should be reasonable for all users/operating systems, except on
1429 the largest projects. You probably do not need to adjust this value.</p></div>
1430 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1431 </dd>
1433 core.deltaBaseCacheLimit
1434 </dt>
1435 <dd>
1436 <p>
1437 Maximum number of bytes to reserve for caching base objects
1438 that may be referenced by multiple deltified objects. By storing the
1439 entire decompressed base objects in a cache Git is able
1440 to avoid unpacking and decompressing frequently used base
1441 objects multiple times.
1442 </p>
1444 for all users/operating systems, except on the largest projects.
1445 You probably do not need to adjust this value.</p></div>
1446 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1447 </dd>
1449 core.bigFileThreshold
1450 </dt>
1451 <dd>
1452 <p>
1453 Files larger than this size are stored deflated, without
1454 attempting delta compression. Storing large files without
1455 delta compression avoids excessive memory usage, at the
1456 slight expense of increased disk usage.
1457 </p>
1459 for most projects as source code and other text files can still
1461 <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
1462 </dd>
1464 core.excludesfile
1465 </dt>
1466 <dd>
1467 <p>
1470 of files which are not meant to be tracked. "~/" is expanded
1473 </p>
1474 </dd>
1476 core.askpass
1477 </dt>
1478 <dd>
1479 <p>
1480 Some commands (e.g. svn and http interfaces) that interactively
1481 ask for a password can be told to use an external program given
1483 environment variable. If not set, fall back to the value of the
1485 prompt. The external program shall be given a suitable prompt as
1486 command line argument and write the password on its STDOUT.
1487 </p>
1488 </dd>
1490 core.attributesfile
1491 </dt>
1492 <dd>
1493 <p>
1498 </p>
1499 </dd>
1501 core.editor
1502 </dt>
1503 <dd>
1504 <p>
1506 messages by launching an editor uses the value of this
1507 variable when it is set, and the environment variable
1509 </p>
1510 </dd>
1512 core.pager
1513 </dt>
1514 <dd>
1515 <p>
1516 The command that git will use to paginate output. Can
1520 pager. One can change these settings by setting the
1522 these settings can be overridden on a project or
1525 environment variable behaviour above, so if you want
1526 to override git’s default settings this way, you need
1527 to be explicit. For example, to disable the S option
1530 shell by git, which will translate the final command to
1532 </p>
1533 </dd>
1535 core.whitespace
1536 </dt>
1537 <dd>
1538 <p>
1539 A comma separated list of common whitespace problems to
1544 </p>
1546 <li>
1547 <p>
1549 as an error (enabled by default).
1550 </p>
1551 </li>
1552 <li>
1553 <p>
1555 before a tab character in the initial indent part of the line as an
1556 error (enabled by default).
1557 </p>
1558 </li>
1559 <li>
1560 <p>
1562 space characters as an error (not enabled by default).
1563 </p>
1564 </li>
1565 <li>
1566 <p>
1568 the line as an error (not enabled by default).
1569 </p>
1570 </li>
1571 <li>
1572 <p>
1574 (enabled by default).
1575 </p>
1576 </li>
1577 <li>
1578 <p>
1581 </p>
1582 </li>
1583 <li>
1584 <p>
1587 does not trigger if the character before such a carriage-return
1588 is not a whitespace (not enabled by default).
1589 </p>
1590 </li>
1591 <li>
1592 <p>
1596 </p>
1597 </li>
1598 </ul></div>
1599 </dd>
1601 core.fsyncobjectfiles
1602 </dt>
1603 <dd>
1604 <p>
1606 </p>
1608 data writes properly, but can be useful for filesystems that do not use
1609 journalling (traditional UNIX filesystems) or that only journal metadata
1611 </dd>
1613 core.preloadindex
1614 </dt>
1615 <dd>
1616 <p>
1618 </p>
1619 <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
1620 on filesystems like NFS that have weak caching semantics and thus
1622 index comparison to the filesystem data in parallel, allowing
1624 </dd>
1626 core.createObject
1627 </dt>
1628 <dd>
1629 <p>
1631 a delete of the source are used to make sure that object creation
1632 will not overwrite existing objects.
1633 </p>
1634 <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable.
1636 check that makes sure that existing object files will not get overwritten.</p></div>
1637 </dd>
1639 core.notesRef
1640 </dt>
1641 <dd>
1642 <p>
1643 When showing commit messages, also show notes which are stored in
1644 the given ref. The ref must be fully qualified. If the given
1645 ref does not exist, it is not an error but means that no
1646 notes should be printed.
1647 </p>
1648 <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by
1649 the <em>GIT_NOTES_REF</em> environment variable. See <a href="git-notes.html">git-notes(1)</a>.</p></div>
1650 </dd>
1652 core.sparseCheckout
1653 </dt>
1654 <dd>
1655 <p>
1658 </p>
1659 </dd>
1661 core.abbrev
1662 </dt>
1663 <dd>
1664 <p>
1665 Set the length object names are abbreviated to. If unspecified,
1666 many commands abbreviate to 7 hexdigits, which may not be enough
1667 for abbreviated object names to stay unique for sufficiently long
1668 time.
1669 </p>
1670 </dd>
1672 add.ignore-errors
1673 </dt>
1675 add.ignoreErrors
1676 </dt>
1677 <dd>
1678 <p>
1683 convention for configuration variables. Newer versions of git
1685 </p>
1686 </dd>
1688 alias.*
1689 </dt>
1690 <dd>
1691 <p>
1693 after defining "alias.last = cat-file commit HEAD", the invocation
1695 confusion and troubles with script usage, aliases that
1696 hide existing git commands are ignored. Arguments are split by
1697 spaces, the usual shell quoting and escaping is supported.
1698 quote pair and a backslash can be used to quote them.
1699 </p>
1701 it will be treated as a shell command. For example, defining
1702 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
1703 "git new" is equivalent to running the shell command
1704 "gitk --all --not ORIG_HEAD". Note that shell commands will be
1705 executed from the top-level directory of a repository, which may
1706 not necessarily be the current directory.
1708 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
1709 </dd>
1711 am.keepcr
1712 </dt>
1713 <dd>
1714 <p>
1715 If true, git-am will call git-mailsplit for patches in mbox format
1720 </p>
1721 </dd>
1723 apply.ignorewhitespace
1724 </dt>
1725 <dd>
1726 <p>
1729 option.
1731 respect all whitespace differences.
1733 </p>
1734 </dd>
1736 apply.whitespace
1737 </dt>
1738 <dd>
1739 <p>
1742 </p>
1743 </dd>
1745 branch.autosetupmerge
1746 </dt>
1747 <dd>
1748 <p>
1751 starting point branch. Note that even if this option is not set,
1755 starting point is a remote-tracking branch; <tt>always</tt> —  automatic setup is done when the starting point is either a
1756 local branch or remote-tracking
1757 branch. This option defaults to true.
1758 </p>
1759 </dd>
1761 branch.autosetuprebase
1762 </dt>
1763 <dd>
1764 <p>
1766 that tracks another branch, this variable tells git to set
1767 up pull to rebase instead of merge (see "branch.<name>.rebase").
1770 other local branches.
1772 remote-tracking branches.
1774 branches.
1775 See "branch.autosetupmerge" for details on how to set up a
1776 branch to track another branch.
1777 This option defaults to never.
1778 </p>
1779 </dd>
1782 </dt>
1783 <dd>
1784 <p>
1788 </p>
1789 </dd>
1792 </dt>
1793 <dd>
1794 <p>
1799 refspec to be marked for merging in FETCH_HEAD. The value is
1800 handled like the remote part of a refspec, and must match a
1801 ref which is fetched from the remote given by
1802 "branch.<name>.remote".
1806 Specify multiple values to get an octopus merge.
1808 another branch in the local repository, you can point
1811 </p>
1812 </dd>
1815 </dt>
1816 <dd>
1817 <p>
1820 option values containing whitespace characters are currently not
1821 supported.
1822 </p>
1823 </dd>
1826 </dt>
1827 <dd>
1828 <p>
1830 instead of merging the default branch from the default remote when
1831 "git pull" is run.
1834 for details).
1835 </p>
1836 </dd>
1839 </dt>
1840 <dd>
1841 <p>
1842 Specify the command to invoke the specified browser. The
1843 specified command is evaluated in shell with the URLs passed
1845 </p>
1846 </dd>
1849 </dt>
1850 <dd>
1851 <p>
1852 Override the path for the given tool that may be used to
1855 </p>
1856 </dd>
1858 clean.requireForce
1859 </dt>
1860 <dd>
1861 <p>
1862 A boolean to make git-clean do nothing unless given -f
1863 or -n. Defaults to true.
1864 </p>
1865 </dd>
1867 color.branch
1868 </dt>
1869 <dd>
1870 <p>
1871 A boolean to enable/disable color in the output of
1873 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
1874 only when the output is to a terminal. Defaults to false.
1875 </p>
1876 </dd>
1879 </dt>
1880 <dd>
1881 <p>
1885 refs).
1886 </p>
1887 <div class="paragraph"><p>The value for these configuration variables is a list of colors (at most
1888 two) and attributes (at most one), separated by spaces. The colors
1889 accepted are <tt>normal</tt>, <tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>,
1890 <tt>magenta</tt>, <tt>cyan</tt> and <tt>white</tt>; the attributes are <tt>bold</tt>, <tt>dim</tt>, <tt>ul</tt>,
1892 second is the background. The position of the attribute, if any,
1894 </dd>
1896 color.diff
1897 </dt>
1898 <dd>
1899 <p>
1900 Whether to use ANSI escape sequences to add color to patches.
1902 <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
1904 commands will only use color when output is to the terminal.
1905 Defaults to false.
1906 </p>
1907 <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> nor the
1910 </dd>
1913 </dt>
1914 <dd>
1915 <p>
1917 which part of the patch to use the specified color, and is one
1921 (highlighting whitespace errors). The values of these variables may be
1923 </p>
1924 </dd>
1927 </dt>
1928 <dd>
1929 <p>
1931 of <tt>branch</tt>, <tt>remoteBranch</tt>, <tt>tag</tt>, <tt>stash</tt> or <tt>HEAD</tt> for local
1932 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1933 </p>
1934 </dd>
1936 color.grep
1937 </dt>
1938 <dd>
1939 <p>
1943 </p>
1944 </dd>
1947 </dt>
1948 <dd>
1949 <p>
1951 part of the line to use the specified color, and is one of
1952 </p>
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>
1984 </p>
1985 </dd>
1988 </dt>
1989 <dd>
1990 <p>
1991 matching text
1992 </p>
1993 </dd>
1996 </dt>
1997 <dd>
1998 <p>
1999 non-matching text in selected lines
2000 </p>
2001 </dd>
2004 </dt>
2005 <dd>
2006 <p>
2009 </p>
2010 </dd>
2011 </dl></div>
2012 <div class="paragraph"><p>The values of these variables may be specified as in color.branch.<slot>.</p></div>
2013 </dd>
2015 color.interactive
2016 </dt>
2017 <dd>
2018 <p>
2020 and displays (such as those used by "git-add --interactive").
2022 colors only when the output is to the terminal. Defaults to false.
2023 </p>
2024 </dd>
2027 </dt>
2028 <dd>
2029 <p>
2031 output. <tt><slot></tt> may be <tt>prompt</tt>, <tt>header</tt>, <tt>help</tt> or <tt>error</tt>, for
2032 four distinct types of normal output from interactive
2033 commands. The values of these variables may be specified as
2035 </p>
2036 </dd>
2038 color.pager
2039 </dt>
2040 <dd>
2041 <p>
2042 A boolean to enable/disable colored output when the pager is in
2043 use (default is true).
2044 </p>
2045 </dd>
2047 color.showbranch
2048 </dt>
2049 <dd>
2050 <p>
2051 A boolean to enable/disable color in the output of
2053 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
2054 only when the output is to a terminal. Defaults to false.
2055 </p>
2056 </dd>
2058 color.status
2059 </dt>
2060 <dd>
2061 <p>
2062 A boolean to enable/disable color in the output of
2064 <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used
2065 only when the output is to a terminal. Defaults to false.
2066 </p>
2067 </dd>
2070 </dt>
2071 <dd>
2072 <p>
2080 to red). The values of these variables may be specified as in
2082 </p>
2083 </dd>
2085 color.ui
2086 </dt>
2087 <dd>
2088 <p>
2089 This variable determines the default value for variables such
2091 per command family. Its scope will expand as more commands learn
2098 </p>
2099 </dd>
2101 commit.status
2102 </dt>
2103 <dd>
2104 <p>
2105 A boolean to enable/disable inclusion of status information in the
2106 commit message template when using an editor to prepare the commit
2107 message. Defaults to true.
2108 </p>
2109 </dd>
2111 commit.template
2112 </dt>
2113 <dd>
2114 <p>
2115 Specify a file to use as the template for new commit messages.
2117 specified user’s home directory.
2118 </p>
2119 </dd>
2121 diff.autorefreshindex
2122 </dt>
2123 <dd>
2124 <p>
2126 files, do not consider stat-only change as changed.
2128 update the cached stat information for paths whose
2129 contents in the work tree match the contents in the
2130 index. This option defaults to true. Note that this
2133 </p>
2134 </dd>
2136 diff.dirstat
2137 </dt>
2138 <dd>
2139 <p>
2142 and friends. The defaults can be overridden on the command line
2145 The following parameters are available:
2146 </p>
2150 </dt>
2151 <dd>
2152 <p>
2153 Compute the dirstat numbers by counting the lines that have been
2154 removed from the source, or added to the destination. This ignores
2155 the amount of pure code movements within a file. In other words,
2156 rearranging lines in a file is not counted as much as other changes.
2157 This is the default behavior when no parameter is given.
2158 </p>
2159 </dd>
2162 </dt>
2163 <dd>
2164 <p>
2165 Compute the dirstat numbers by doing the regular line-based diff
2166 analysis, and summing the removed/added line counts. (For binary
2167 files, count 64-byte chunks instead, since binary files have no
2170 lines within a file as much as other changes. The resulting output
2172 </p>
2173 </dd>
2176 </dt>
2177 <dd>
2178 <p>
2179 Compute the dirstat numbers by counting the number of files changed.
2180 Each changed file counts equally in the dirstat analysis. This is
2182 not have to look at the file contents at all.
2183 </p>
2184 </dd>
2187 </dt>
2188 <dd>
2189 <p>
2190 Count changes in a child directory for the parent directory as well.
2192 reported may exceed 100%. The default (non-cumulative) behavior can
2194 </p>
2195 </dd>
2198 </dt>
2199 <dd>
2200 <p>
2201 An integer parameter specifies a cut-off percent (3% by default).
2202 Directories contributing less than this percentage of the changes
2203 are not shown in the output.
2204 </p>
2205 </dd>
2206 </dl></div>
2208 directories with less than 10% of the total amount of changed files,
2209 and accumulating child directory counts in the parent directories:
2211 </dd>
2213 diff.external
2214 </dt>
2215 <dd>
2216 <p>
2217 If this config variable is set, diff generation is not
2218 performed using the internal diff machinery, but using the
2220 environment variable. The command is called with parameters
2222 you want to use an external diff program only on a subset of
2224 </p>
2225 </dd>
2227 diff.ignoreSubmodules
2228 </dt>
2229 <dd>
2230 <p>
2231 Sets the default value of --ignore-submodules. Note that this
2234 this setting when reporting uncommitted changes.
2235 </p>
2236 </dd>
2238 diff.mnemonicprefix
2239 </dt>
2240 <dd>
2241 <p>
2244 this configuration is in effect, reverse diff output also swaps
2245 the order of the prefixes:
2246 </p>
2250 </dt>
2251 <dd>
2252 <p>
2253 compares the (i)ndex and the (w)ork tree;
2254 </p>
2255 </dd>
2258 </dt>
2259 <dd>
2260 <p>
2261 compares a (c)ommit and the (w)ork tree;
2262 </p>
2263 </dd>
2266 </dt>
2267 <dd>
2268 <p>
2269 compares a (c)ommit and the (i)ndex;
2270 </p>
2271 </dd>
2274 </dt>
2275 <dd>
2276 <p>
2277 compares an (o)bject and a (w)ork tree entity;
2278 </p>
2279 </dd>
2282 </dt>
2283 <dd>
2284 <p>
2286 </p>
2287 </dd>
2288 </dl></div>
2289 </dd>
2291 diff.noprefix
2292 </dt>
2293 <dd>
2294 <p>
2296 </p>
2297 </dd>
2299 diff.renameLimit
2300 </dt>
2301 <dd>
2302 <p>
2303 The number of files to consider when performing the copy/rename
2305 </p>
2306 </dd>
2308 diff.renames
2309 </dt>
2310 <dd>
2311 <p>
2312 Tells git to detect renames. If set to any boolean value, it
2313 will enable basic rename detection. If set to "copies" or
2314 "copy", it will detect copies, as well.
2315 </p>
2316 </dd>
2318 diff.suppressBlankEmpty
2319 </dt>
2320 <dd>
2321 <p>
2322 A boolean to inhibit the standard behavior of printing a space
2323 before each empty output line. Defaults to false.
2324 </p>
2325 </dd>
2328 </dt>
2329 <dd>
2330 <p>
2332 for details.
2333 </p>
2334 </dd>
2337 </dt>
2338 <dd>
2339 <p>
2340 The regular expression that the diff driver should use to
2341 recognize the hunk header. A built-in pattern may also be used.
2343 </p>
2344 </dd>
2347 </dt>
2348 <dd>
2349 <p>
2350 Set this option to true to make the diff driver treat files as
2352 </p>
2353 </dd>
2356 </dt>
2357 <dd>
2358 <p>
2359 The command that the diff driver should call to generate the
2360 text-converted version of a file. The result of the
2361 conversion is used to generate a human-readable diff. See
2363 </p>
2364 </dd>
2367 </dt>
2368 <dd>
2369 <p>
2370 The regular expression that the diff driver should use to
2372 details.
2373 </p>
2374 </dd>
2377 </dt>
2378 <dd>
2379 <p>
2380 Set this option to true to make the diff driver cache the text
2382 </p>
2383 </dd>
2385 diff.tool
2386 </dt>
2387 <dd>
2388 <p>
2392 "kompare". Any other value is treated as a custom diff tool,
2394 option.
2395 </p>
2396 </dd>
2399 </dt>
2400 <dd>
2401 <p>
2402 Override the path for the given tool. This is useful in case
2403 your tool is not in the PATH.
2404 </p>
2405 </dd>
2408 </dt>
2409 <dd>
2410 <p>
2411 Specify the command to invoke the specified diff tool.
2412 The specified command is evaluated in shell with the following
2415 is set to the name of the temporary file containing the contents
2416 of the diff post-image.
2417 </p>
2418 </dd>
2420 difftool.prompt
2421 </dt>
2422 <dd>
2423 <p>
2424 Prompt before each invocation of the diff tool.
2425 </p>
2426 </dd>
2428 diff.wordRegex
2429 </dt>
2430 <dd>
2431 <p>
2432 A POSIX Extended Regular Expression used to determine what is a "word"
2433 when performing word-by-word difference calculations. Character
2434 sequences that match the regular expression are "words", all other
2436 </p>
2437 </dd>
2439 fetch.recurseSubmodules
2440 </dt>
2441 <dd>
2442 <p>
2444 Setting it to a boolean changes the behavior of fetch and pull to
2445 unconditionally recurse into submodules when set to true or to not
2447 value), fetch and pull will only recurse into a populated submodule
2448 when its superproject retrieves a commit that updates the submodule’s
2449 reference.
2450 </p>
2451 </dd>
2453 fetch.unpackLimit
2454 </dt>
2455 <dd>
2456 <p>
2457 If the number of objects fetched over the git native
2458 transfer is below this
2459 limit, then the objects will be unpacked into loose object
2460 files. However if the number of received objects equals or
2461 exceeds this limit then the received pack will be stored as
2462 a pack, after adding any missing delta bases. Storing the
2463 pack from a push can make the push operation complete faster,
2464 especially on slow filesystems. If not set, the value of
2466 </p>
2467 </dd>
2469 format.attach
2470 </dt>
2471 <dd>
2472 <p>
2473 Enable multipart/mixed attachments as the default for
2475 which will enable attachments as the default and set the
2476 value as the boundary. See the --attach option in
2478 </p>
2479 </dd>
2481 format.numbered
2482 </dt>
2483 <dd>
2484 <p>
2485 A boolean which can enable or disable sequence numbers in patch
2486 subjects. It defaults to "auto" which enables it only if there
2487 is more than one patch. It can be enabled or disabled for all
2490 </p>
2491 </dd>
2493 format.headers
2494 </dt>
2495 <dd>
2496 <p>
2497 Additional email headers to include in a patch to be submitted
2499 </p>
2500 </dd>
2502 format.to
2503 </dt>
2505 format.cc
2506 </dt>
2507 <dd>
2508 <p>
2509 Additional recipients to include in a patch to be submitted
2510 by mail. See the --to and --cc options in
2512 </p>
2513 </dd>
2515 format.subjectprefix
2516 </dt>
2517 <dd>
2518 <p>
2520 subject prefix. Use this variable to change that prefix.
2521 </p>
2522 </dd>
2524 format.signature
2525 </dt>
2526 <dd>
2527 <p>
2528 The default for format-patch is to output a signature containing
2529 the git version number. Use this variable to change that default.
2530 Set this variable to the empty string ("") to suppress
2531 signature generation.
2532 </p>
2533 </dd>
2535 format.suffix
2536 </dt>
2537 <dd>
2538 <p>
2539 The default for format-patch is to output files with the suffix
2541 include the dot if you want it).
2542 </p>
2543 </dd>
2545 format.pretty
2546 </dt>
2547 <dd>
2548 <p>
2549 The default pretty format for log/show/whatchanged command,
2552 </p>
2553 </dd>
2555 format.thread
2556 </dt>
2557 <dd>
2558 <p>
2561 makes every mail a reply to the head of the series,
2562 where the head is chosen from the cover letter, the
2566 value disables threading.
2567 </p>
2568 </dd>
2570 format.signoff
2571 </dt>
2572 <dd>
2573 <p>
2576 patch should be a conscious act and means that you certify you have
2577 the rights to submit this work under the same open source license.
2579 </p>
2580 </dd>
2583 </dt>
2584 <dd>
2585 <p>
2586 The command which is used to convert the content of a worktree
2588 details.
2589 </p>
2590 </dd>
2593 </dt>
2594 <dd>
2595 <p>
2596 The command which is used to convert the content of a blob
2597 object to a worktree file upon checkout. See
2599 </p>
2600 </dd>
2602 gc.aggressiveWindow
2603 </dt>
2604 <dd>
2605 <p>
2606 The window size parameter used in the delta compression
2608 to 250.
2609 </p>
2610 </dd>
2612 gc.auto
2613 </dt>
2614 <dd>
2615 <p>
2616 When there are approximately more than this many loose
2618 Some Porcelain commands use this command to perform a
2619 light-weight garbage collection from time to time. The
2621 </p>
2622 </dd>
2624 gc.autopacklimit
2625 </dt>
2626 <dd>
2627 <p>
2628 When there are more than this many packs that are not
2630 --auto</tt> consolidates them into one larger pack. The
2632 </p>
2633 </dd>
2635 gc.packrefs
2636 </dt>
2637 <dd>
2638 <p>
2640 unclonable by Git versions prior to 1.5.1.2 over dumb
2641 transports such as HTTP. This variable determines whether
2643 to enable it within all non-bare repos or it can be set to a
2645 </p>
2646 </dd>
2648 gc.pruneexpire
2649 </dt>
2650 <dd>
2651 <p>
2653 Override the grace period with this config variable. The value
2654 "now" may be used to disable this grace period and always prune
2655 unreachable objects immediately.
2656 </p>
2657 </dd>
2659 gc.reflogexpire
2660 </dt>
2663 </dt>
2664 <dd>
2665 <p>
2668 "refs/stash") in the middle the setting applies only to
2670 </p>
2671 </dd>
2673 gc.reflogexpireunreachable
2674 </dt>
2677 </dt>
2678 <dd>
2679 <p>
2681 this time and are not reachable from the current tip;
2683 in the middle, the setting applies only to the refs that
2685 </p>
2686 </dd>
2688 gc.rerereresolved
2689 </dt>
2690 <dd>
2691 <p>
2692 Records of conflicted merge you resolved earlier are
2695 </p>
2696 </dd>
2698 gc.rerereunresolved
2699 </dt>
2700 <dd>
2701 <p>
2702 Records of conflicted merge you have not resolved are
2705 </p>
2706 </dd>
2708 gitcvs.commitmsgannotation
2709 </dt>
2710 <dd>
2711 <p>
2712 Append this string to each commit message. Set to empty string
2713 to disable this feature. Defaults to "via git-CVS emulator".
2714 </p>
2715 </dd>
2717 gitcvs.enabled
2718 </dt>
2719 <dd>
2720 <p>
2721 Whether the CVS server interface is enabled for this repository.
2723 </p>
2724 </dd>
2726 gitcvs.logfile
2727 </dt>
2728 <dd>
2729 <p>
2730 Path to a log file where the CVS server interface well… logs
2732 </p>
2733 </dd>
2735 gitcvs.usecrlfattr
2736 </dt>
2737 <dd>
2738 <p>
2739 If true, the server will look up the end-of-line conversion
2741 the attributes force git to treat a file as text,
2743 treat it as text. If they suppress text conversion, the file
2745 the client might otherwise do. If the attributes do not allow
2748 </p>
2749 </dd>
2751 gitcvs.allbinary
2752 </dt>
2753 <dd>
2754 <p>
2757 unresolved files are sent to the client in
2759 as binary files, which suppresses any newline munging it
2760 otherwise might do. Alternatively, if it is set to "guess",
2761 then the contents of the file are examined to decide if
2763 </p>
2764 </dd>
2766 gitcvs.dbname
2767 </dt>
2768 <dd>
2769 <p>
2770 Database used by git-cvsserver to cache revision information
2771 derived from the git repository. The exact meaning depends on the
2772 used database driver, for SQLite (which is the default driver) this
2773 is a filename. Supports variable substitution (see
2774 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<tt>;</tt>).
2776 </p>
2777 </dd>
2779 gitcvs.dbdriver
2780 </dt>
2781 <dd>
2782 <p>
2783 Used Perl DBI driver. You can specify any available driver
2784 for this here, but it might not work. git-cvsserver is tested
2789 </p>
2790 </dd>
2792 gitcvs.dbuser, gitcvs.dbpass
2793 </dt>
2794 <dd>
2795 <p>
2797 since SQLite has no concept of database users and/or passwords.
2800 </p>
2801 </dd>
2803 gitcvs.dbTableNamePrefix
2804 </dt>
2805 <dd>
2806 <p>
2807 Database table name prefix. Prepended to the names of any
2808 database tables used, allowing a single database to be used
2809 for several repositories. Supports variable substitution (see
2811 characters will be replaced with underscores.
2812 </p>
2813 </dd>
2814 </dl></div>
2819 access method.</p></div>
2822 grep.lineNumber
2823 </dt>
2824 <dd>
2825 <p>
2827 </p>
2828 </dd>
2830 grep.extendedRegexp
2831 </dt>
2832 <dd>
2833 <p>
2835 </p>
2836 </dd>
2838 gui.commitmsgwidth
2839 </dt>
2840 <dd>
2841 <p>
2842 Defines how wide the commit message window is in the
2844 </p>
2845 </dd>
2847 gui.diffcontext
2848 </dt>
2849 <dd>
2850 <p>
2851 Specifies how many context lines should be used in calls to diff
2853 </p>
2854 </dd>
2856 gui.encoding
2857 </dt>
2858 <dd>
2859 <p>
2860 Specifies the default encoding to use for displaying of
2864 If this option is not set, the tools default to the
2865 locale encoding.
2866 </p>
2867 </dd>
2869 gui.matchtrackingbranch
2870 </dt>
2871 <dd>
2872 <p>
2874 default to tracking remote branches with matching names or
2875 not. Default: "false".
2876 </p>
2877 </dd>
2879 gui.newbranchtemplate
2880 </dt>
2881 <dd>
2882 <p>
2883 Is used as suggested name when creating new branches using the
2885 </p>
2886 </dd>
2888 gui.pruneduringfetch
2889 </dt>
2890 <dd>
2891 <p>
2893 performing a fetch. The default value is "false".
2894 </p>
2895 </dd>
2897 gui.trustmtime
2898 </dt>
2899 <dd>
2900 <p>
2902 timestamp or not. By default the timestamps are not trusted.
2903 </p>
2904 </dd>
2906 gui.spellingdictionary
2907 </dt>
2908 <dd>
2909 <p>
2910 Specifies the dictionary used for spell checking commit messages in
2912 off.
2913 </p>
2914 </dd>
2916 gui.fastcopyblame
2917 </dt>
2918 <dd>
2919 <p>
2921 location detection. It makes blame significantly faster on huge
2922 repositories at the expense of less thorough copy detection.
2923 </p>
2924 </dd>
2926 gui.copyblamethreshold
2927 </dt>
2928 <dd>
2929 <p>
2931 detection, measured in alphanumeric characters. See the
2933 </p>
2934 </dd>
2936 gui.blamehistoryctx
2937 </dt>
2938 <dd>
2939 <p>
2940 Specifies the radius of history context in days to show in
2943 variable is set to zero, the whole history is shown.
2944 </p>
2945 </dd>
2948 </dt>
2949 <dd>
2950 <p>
2951 Specifies the shell command line to execute when the corresponding item
2953 mandatory for every tool. The command is executed from the root of
2954 the working directory, and in the environment it receives the name of
2958 </p>
2959 </dd>
2962 </dt>
2963 <dd>
2964 <p>
2965 Run the tool only if a diff is selected in the GUI. It guarantees
2967 </p>
2968 </dd>
2971 </dt>
2972 <dd>
2973 <p>
2974 Run the command silently, without creating a window to display its
2975 output.
2976 </p>
2977 </dd>
2980 </dt>
2981 <dd>
2982 <p>
2983 Don’t rescan the working directory for changes after the tool
2984 finishes execution.
2985 </p>
2986 </dd>
2989 </dt>
2990 <dd>
2991 <p>
2992 Show a confirmation dialog before actually running the tool.
2993 </p>
2994 </dd>
2997 </dt>
2998 <dd>
2999 <p>
3000 Request a string argument from the user, and pass it to the tool
3004 the dialog uses a built-in generic prompt; otherwise the exact
3005 value of the variable is used.
3006 </p>
3007 </dd>
3010 </dt>
3011 <dd>
3012 <p>
3013 Request a single valid revision from the user, and set the
3016 </p>
3017 </dd>
3020 </dt>
3021 <dd>
3022 <p>
3024 This is useful for tools similar to merge or rebase, but not
3025 for things like checkout or reset.
3026 </p>
3027 </dd>
3030 </dt>
3031 <dd>
3032 <p>
3033 Specifies the title to use for the prompt dialog. The default
3034 is the tool name.
3035 </p>
3036 </dd>
3039 </dt>
3040 <dd>
3041 <p>
3042 Specifies the general prompt string to display at the top of
3044 The default value includes the actual command.
3045 </p>
3046 </dd>
3048 help.browser
3049 </dt>
3050 <dd>
3051 <p>
3052 Specify the browser that will be used to display help in the
3054 </p>
3055 </dd>
3057 help.format
3058 </dt>
3059 <dd>
3060 <p>
3062 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
3064 </p>
3065 </dd>
3067 help.autocorrect
3068 </dt>
3069 <dd>
3070 <p>
3071 Automatically correct and execute mistyped commands after
3072 waiting for the given number of deciseconds (0.1 sec). If more
3073 than one command can be deduced from the entered text, nothing
3074 will be executed. If the value of this option is negative,
3075 the corrected command will be executed immediately. If the
3076 value is 0 - the command will be just shown but not executed.
3077 This is the default.
3078 </p>
3079 </dd>
3081 http.proxy
3082 </dt>
3083 <dd>
3084 <p>
3088 </p>
3089 </dd>
3091 http.cookiefile
3092 </dt>
3093 <dd>
3094 <p>
3095 File containing previously stored cookie lines which should be used
3096 in the git http session, if they match the server. The file format
3097 of the file to read cookies from should be plain HTTP headers or
3099 NOTE that the file specified with http.cookiefile is only used as
3100 input. No cookies will be stored in the file.
3101 </p>
3102 </dd>
3104 http.sslVerify
3105 </dt>
3106 <dd>
3107 <p>
3108 Whether to verify the SSL certificate when fetching or pushing
3110 variable.
3111 </p>
3112 </dd>
3114 http.sslCert
3115 </dt>
3116 <dd>
3117 <p>
3118 File containing the SSL certificate when fetching or pushing
3120 variable.
3121 </p>
3122 </dd>
3124 http.sslKey
3125 </dt>
3126 <dd>
3127 <p>
3128 File containing the SSL private key when fetching or pushing
3130 variable.
3131 </p>
3132 </dd>
3134 http.sslCertPasswordProtected
3135 </dt>
3136 <dd>
3137 <p>
3138 Enable git’s password prompt for the SSL certificate. Otherwise
3139 OpenSSL will prompt the user, possibly many times, if the
3140 certificate or private key is encrypted. Can be overridden by the
3142 </p>
3143 </dd>
3145 http.sslCAInfo
3146 </dt>
3147 <dd>
3148 <p>
3149 File containing the certificates to verify the peer with when
3150 fetching or pushing over HTTPS. Can be overridden by the
3152 </p>
3153 </dd>
3155 http.sslCAPath
3156 </dt>
3157 <dd>
3158 <p>
3159 Path containing files with the CA certificates to verify the peer
3160 with when fetching or pushing over HTTPS. Can be overridden
3162 </p>
3163 </dd>
3165 http.maxRequests
3166 </dt>
3167 <dd>
3168 <p>
3169 How many HTTP requests to launch in parallel. Can be overridden
3171 </p>
3172 </dd>
3174 http.minSessions
3175 </dt>
3176 <dd>
3177 <p>
3178 The number of curl sessions (counted across slots) to be kept across
3179 requests. They will not be ended with curl_easy_cleanup() until
3180 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
3182 </p>
3183 </dd>
3185 http.postBuffer
3186 </dt>
3187 <dd>
3188 <p>
3189 Maximum size in bytes of the buffer used by smart HTTP
3190 transports when POSTing data to the remote system.
3191 For requests larger than this buffer size, HTTP/1.1 and
3192 Transfer-Encoding: chunked is used to avoid creating a
3193 massive pack file locally. Default is 1 MiB, which is
3194 sufficient for most requests.
3195 </p>
3196 </dd>
3198 http.lowSpeedLimit, http.lowSpeedTime
3199 </dt>
3200 <dd>
3201 <p>
3206 </p>
3207 </dd>
3209 http.noEPSV
3210 </dt>
3211 <dd>
3212 <p>
3213 A boolean which disables using of EPSV ftp command by curl.
3216 environment variable. Default is false (curl will use EPSV).
3217 </p>
3218 </dd>
3220 http.useragent
3221 </dt>
3222 <dd>
3223 <p>
3224 The HTTP USER_AGENT string presented to an HTTP server. The default
3225 value represents the version of the client git such as git/1.7.1.
3226 This option allows you to override this value to a more common value
3227 such as Mozilla/4.0. This may be necessary, for instance, if
3228 connecting through a firewall that restricts HTTP connections to a set
3229 of common USER_AGENT strings (but not including those like git/1.7.1).
3231 </p>
3232 </dd>
3234 i18n.commitEncoding
3235 </dt>
3236 <dd>
3237 <p>
3238 Character encoding the commit messages are stored in; git itself
3239 does not care per se, but this information is necessary e.g. when
3240 importing commits from emails or in the gitk graphical history
3241 browser (and possibly at other places in the future or in other
3242 porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
3243 </p>
3244 </dd>
3246 i18n.logOutputEncoding
3247 </dt>
3248 <dd>
3249 <p>
3250 Character encoding the commit messages are converted to when
3252 </p>
3253 </dd>
3255 imap
3256 </dt>
3257 <dd>
3258 <p>
3261 </p>
3262 </dd>
3264 init.templatedir
3265 </dt>
3266 <dd>
3267 <p>
3268 Specify the directory from which templates will be copied.
3270 </p>
3271 </dd>
3273 instaweb.browser
3274 </dt>
3275 <dd>
3276 <p>
3277 Specify the program that will be used to browse your working
3279 </p>
3280 </dd>
3282 instaweb.httpd
3283 </dt>
3284 <dd>
3285 <p>
3286 The HTTP daemon command-line to start gitweb on your working
3288 </p>
3289 </dd>
3291 instaweb.local
3292 </dt>
3293 <dd>
3294 <p>
3296 be bound to the local IP (127.0.0.1).
3297 </p>
3298 </dd>
3300 instaweb.modulepath
3301 </dt>
3302 <dd>
3303 <p>
3305 instead of /usr/lib/apache2/modules. Only used if httpd
3306 is Apache.
3307 </p>
3308 </dd>
3310 instaweb.port
3311 </dt>
3312 <dd>
3313 <p>
3314 The port number to bind the gitweb httpd to. See
3316 </p>
3317 </dd>
3319 interactive.singlekey
3320 </dt>
3321 <dd>
3322 <p>
3323 In interactive commands, allow the user to provide one-letter
3324 input with a single key (i.e., without hitting enter).
3326 <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>,
3327 <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>. Note that this
3328 setting is silently ignored if portable keystroke input
3329 is not available.
3330 </p>
3331 </dd>
3333 log.abbrevCommit
3334 </dt>
3335 <dd>
3336 <p>
3337 If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
3340 </p>
3341 </dd>
3343 log.date
3344 </dt>
3345 <dd>
3346 <p>
3350 <tt>default</tt>, <tt>iso</tt>, <tt>rfc</tt>, and <tt>short</tt>; see <a href="git-log.html">git-log(1)</a>
3351 for details.
3352 </p>
3353 </dd>
3355 log.decorate
3356 </dt>
3357 <dd>
3358 <p>
3359 Print out the ref names of any commits that are shown by the log
3362 specified, the full ref name (including prefix) will be printed.
3364 </p>
3365 </dd>
3367 log.showroot
3368 </dt>
3369 <dd>
3370 <p>
3371 If true, the initial commit will be shown as a big creation event.
3372 This is equivalent to a diff against an empty tree.
3373 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
3374 normally hide the root commit will now show it. True by default.
3375 </p>
3376 </dd>
3378 mailmap.file
3379 </dt>
3380 <dd>
3381 <p>
3382 The location of an augmenting mailmap file. The default
3383 mailmap, located in the root of the repository, is loaded
3384 first, then the mailmap file pointed to by this variable.
3385 The location of the mailmap file may be in a repository
3386 subdirectory, or somewhere outside of the repository itself.
3387 See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.
3388 </p>
3389 </dd>
3391 man.viewer
3392 </dt>
3393 <dd>
3394 <p>
3395 Specify the programs that may be used to display help in the
3397 </p>
3398 </dd>
3401 </dt>
3402 <dd>
3403 <p>
3404 Specify the command to invoke the specified man viewer. The
3405 specified command is evaluated in shell with the man page
3407 </p>
3408 </dd>
3411 </dt>
3412 <dd>
3413 <p>
3414 Override the path for the given tool that may be used to
3416 </p>
3417 </dd>
3419 merge.conflictstyle
3420 </dt>
3421 <dd>
3422 <p>
3423 Specify the style in which conflicted hunks are written out to
3424 working tree files upon merge. The default is "merge", which
3427 a <tt>>>>>>>></tt> marker. An alternate style, "diff3", adds a <tt>|||||||</tt>
3429 </p>
3430 </dd>
3432 merge.defaultToUpstream
3433 </dt>
3434 <dd>
3435 <p>
3436 If merge is called without any commit argument, merge the upstream
3437 branches configured for the current branch by using their last
3438 observed values stored in their remote tracking branches.
3442 to their corresponding remote tracking branches, and the tips of
3443 these tracking branches are merged.
3444 </p>
3445 </dd>
3447 merge.ff
3448 </dt>
3449 <dd>
3450 <p>
3451 By default, git does not create an extra merge commit when merging
3452 a commit that is a descendant of the current commit. Instead, the
3454 this variable tells git to create an extra merge commit in such
3458 command line).
3459 </p>
3460 </dd>
3462 merge.log
3463 </dt>
3464 <dd>
3465 <p>
3466 In addition to branch names, populate the log message with at
3467 most the specified number of one-line descriptions from the
3468 actual commits that are being merged. Defaults to false, and
3469 true is a synonym for 20.
3470 </p>
3471 </dd>
3473 merge.renameLimit
3474 </dt>
3475 <dd>
3476 <p>
3477 The number of files to consider when performing rename detection
3478 during a merge; if not specified, defaults to the value of
3479 diff.renameLimit.
3480 </p>
3481 </dd>
3483 merge.renormalize
3484 </dt>
3485 <dd>
3486 <p>
3487 Tell git that canonical representation of files in the
3488 repository has changed over time (e.g. earlier commits record
3489 text files with CRLF line endings, but recent ones use LF line
3490 endings). In such a repository, git can convert the data
3491 recorded in commits to a canonical form before performing a
3492 merge to reduce unnecessary conflicts. For more information,
3493 see section "Merging branches with differing checkin/checkout
3495 </p>
3496 </dd>
3498 merge.stat
3499 </dt>
3500 <dd>
3501 <p>
3502 Whether to print the diffstat between ORIG_HEAD and the merge result
3503 at the end of the merge. True by default.
3504 </p>
3505 </dd>
3507 merge.tool
3508 </dt>
3509 <dd>
3510 <p>
3511 Controls which merge resolution program is used by
3515 and "xxdiff". Any other value is treated is custom merge tool
3517 </p>
3518 </dd>
3520 merge.verbosity
3521 </dt>
3522 <dd>
3523 <p>
3524 Controls the amount of output shown by the recursive merge
3525 strategy. Level 0 outputs nothing except a final error
3526 message if conflicts were detected. Level 1 outputs only
3528 above outputs debugging information. The default is level 2.
3530 </p>
3531 </dd>
3534 </dt>
3535 <dd>
3536 <p>
3537 Defines a human-readable name for a custom low-level
3539 </p>
3540 </dd>
3543 </dt>
3544 <dd>
3545 <p>
3546 Defines the command that implements a custom low-level
3548 </p>
3549 </dd>
3552 </dt>
3553 <dd>
3554 <p>
3555 Names a low-level merge driver to be used when
3556 performing an internal merge between common ancestors.
3558 </p>
3559 </dd>
3562 </dt>
3563 <dd>
3564 <p>
3565 Override the path for the given tool. This is useful in case
3566 your tool is not in the PATH.
3567 </p>
3568 </dd>
3571 </dt>
3572 <dd>
3573 <p>
3574 Specify the command to invoke the specified merge tool. The
3575 specified command is evaluated in shell with the following
3577 containing the common base of the files to be merged, if available;
3580 file containing the contents of the file from the branch being
3582 tool should write the results of a successful merge.
3583 </p>
3584 </dd>
3587 </dt>
3588 <dd>
3589 <p>
3590 For a custom merge command, specify whether the exit code of
3591 the merge command can be used to determine whether the merge was
3592 successful. If this is not set to true then the merge target file
3593 timestamp is checked and the merge assumed to have been successful
3594 if the file has been updated, otherwise the user is prompted to
3595 indicate the success of the merge.
3596 </p>
3597 </dd>
3599 mergetool.keepBackup
3600 </dt>
3601 <dd>
3602 <p>
3603 After performing a merge, the original file with conflict markers
3607 </p>
3608 </dd>
3610 mergetool.keepTemporaries
3611 </dt>
3612 <dd>
3613 <p>
3614 When invoking a custom merge tool, git uses a set of temporary
3615 files to pass to the tool. If the tool returns an error and this
3617 preserved, otherwise they will be removed after the tool has
3619 </p>
3620 </dd>
3622 mergetool.prompt
3623 </dt>
3624 <dd>
3625 <p>
3626 Prompt before each invocation of the merge resolution program.
3627 </p>
3628 </dd>
3630 notes.displayRef
3631 </dt>
3632 <dd>
3633 <p>
3634 The (fully qualified) refname from which to show notes when
3635 showing commit messages. The value of this variable can be set
3636 to a glob, in which case notes from all matching refs will be
3637 shown. You may also specify this configuration variable
3638 several times. A warning will be issued for refs that do not
3639 exist, but a glob that does not match any refs is silently
3640 ignored.
3641 </p>
3642 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_DISPLAY_REF</tt>
3643 environment variable, which must be a colon separated list of refs or
3644 globs.</p></div>
3646 GIT_NOTES_REF) is also implicitly added to the list of refs to be
3647 displayed.</p></div>
3648 </dd>
3651 </dt>
3652 <dd>
3653 <p>
3656 automatically copies your notes from the original to the
3658 "notes.rewriteRef" below.
3659 </p>
3660 </dd>
3662 notes.rewriteMode
3663 </dt>
3664 <dd>
3665 <p>
3666 When copying notes during a rewrite (see the
3667 "notes.rewrite.<command>" option), determines what to do if
3668 the target commit already has a note. Must be one of
3671 </p>
3672 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_MODE</tt>
3673 environment variable.</p></div>
3674 </dd>
3676 notes.rewriteRef
3677 </dt>
3678 <dd>
3679 <p>
3680 When copying notes during a rewrite, specifies the (fully
3681 qualified) ref whose notes should be copied. The ref may be a
3682 glob, in which case notes in all matching refs will be copied.
3683 You may also specify this configuration several times.
3684 </p>
3686 enable note rewriting.</p></div>
3687 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_REF</tt>
3688 environment variable, which must be a colon separated list of refs or
3689 globs.</p></div>
3690 </dd>
3692 pack.window
3693 </dt>
3694 <dd>
3695 <p>
3697 window size is given on the command line. Defaults to 10.
3698 </p>
3699 </dd>
3701 pack.depth
3702 </dt>
3703 <dd>
3704 <p>
3705 The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
3706 maximum depth is given on the command line. Defaults to 50.
3707 </p>
3708 </dd>
3710 pack.windowMemory
3711 </dt>
3712 <dd>
3713 <p>
3715 when no limit is given on the command line. The value can be
3717 limit.
3718 </p>
3719 </dd>
3721 pack.compression
3722 </dt>
3723 <dd>
3724 <p>
3728 slowest. If not set, defaults to core.compression. If that is
3730 compromise between speed and compression (currently equivalent
3731 to level 6)."
3732 </p>
3733 <div class="paragraph"><p>Note that changing the compression level will not automatically recompress
3734 all existing objects. You can force recompression by passing the -F option
3736 </dd>
3738 pack.deltaCacheSize
3739 </dt>
3740 <dd>
3741 <p>
3742 The maximum memory in bytes used for caching deltas in
3744 This cache is used to speed up the writing object phase by not
3745 having to recompute the final delta result once the best match
3746 for all objects is found. Repacking large repositories on machines
3747 which are tight with memory might be badly impacted by this though,
3748 especially if this cache pushes the system into swapping.
3750 used to virtually disable this cache. Defaults to 256 MiB.
3751 </p>
3752 </dd>
3754 pack.deltaCacheLimit
3755 </dt>
3756 <dd>
3757 <p>
3758 The maximum size of a delta, that is cached in
3760 writing object phase by not having to recompute the final delta
3761 result once the best match for all objects is found. Defaults to 1000.
3762 </p>
3763 </dd>
3765 pack.threads
3766 </dt>
3767 <dd>
3768 <p>
3769 Specifies the number of threads to spawn when searching for best
3771 be compiled with pthreads otherwise this option is ignored with a
3772 warning. This is meant to reduce packing time on multiprocessor
3773 machines. The required amount of memory for the delta search window
3774 is however multiplied by the number of threads.
3776 and set the number of threads accordingly.
3777 </p>
3778 </dd>
3780 pack.indexVersion
3781 </dt>
3782 <dd>
3783 <p>
3784 Specify the default pack index version. Valid values are 1 for
3786 the new pack index with capabilities for packs larger than 4 GB
3787 as well as proper protection against the repacking of corrupted
3789 and this config option ignored whenever the corresponding pack is
3790 larger than 2 GB.
3791 </p>
3792 <div class="paragraph"><p>If you have an old git that does not understand the version 2 <tt>*.idx</tt> file,
3794 that will copy both <tt>*.pack</tt> file and corresponding <tt>*.idx</tt> file from the
3795 other side may give you a repository that cannot be accessed with your
3797 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
3799 </dd>
3801 pack.packSizeLimit
3802 </dt>
3803 <dd>
3804 <p>
3805 The maximum size of a pack. This setting only affects
3806 packing to a file when repacking, i.e. the git:// protocol
3809 limited to 1 MiB. The default is unlimited.
3811 supported.
3812 </p>
3813 </dd>
3816 </dt>
3817 <dd>
3818 <p>
3819 If the value is boolean, turns on or off pagination of the
3820 output of a particular git subcommand when writing to a tty.
3821 Otherwise, turns on pagination for the subcommand using the
3824 precedence over this option. To disable pagination for all
3826 </p>
3827 </dd>
3830 </dt>
3831 <dd>
3832 <p>
3833 Alias for a --pretty= format string, as specified in
3835 as the built-in pretty formats could. For example,
3839 Note that an alias with the same name as a built-in format
3840 will be silently ignored.
3841 </p>
3842 </dd>
3844 pull.octopus
3845 </dt>
3846 <dd>
3847 <p>
3848 The default merge strategy to use when pulling multiple branches
3849 at once.
3850 </p>
3851 </dd>
3853 pull.twohead
3854 </dt>
3855 <dd>
3856 <p>
3857 The default merge strategy to use when pulling a single branch.
3858 </p>
3859 </dd>
3861 push.default
3862 </dt>
3863 <dd>
3864 <p>
3865 Defines the action git push should take if no refspec is given
3866 on the command line, no refspec is configured in the remote, and
3867 no refspec is implied by any of the options given on the command
3868 line. Possible values are:
3869 </p>
3871 <li>
3872 <p>
3874 </p>
3875 </li>
3876 <li>
3877 <p>
3879 All branches having the same name in both ends are considered to be
3880 matching. This is the default.
3881 </p>
3882 </li>
3883 <li>
3884 <p>
3886 </p>
3887 </li>
3888 <li>
3889 <p>
3891 </p>
3892 </li>
3893 <li>
3894 <p>
3896 </p>
3897 </li>
3898 </ul></div>
3899 </dd>
3901 rebase.stat
3902 </dt>
3903 <dd>
3904 <p>
3905 Whether to show a diffstat of what changed upstream since the last
3906 rebase. False by default.
3907 </p>
3908 </dd>
3910 rebase.autosquash
3911 </dt>
3912 <dd>
3913 <p>
3915 </p>
3916 </dd>
3918 receive.autogc
3919 </dt>
3920 <dd>
3921 <p>
3922 By default, git-receive-pack will run "git-gc --auto" after
3923 receiving data from git-push and updating refs. You can stop
3924 it by setting this variable to false.
3925 </p>
3926 </dd>
3928 receive.fsckObjects
3929 </dt>
3930 <dd>
3931 <p>
3932 If it is set to true, git-receive-pack will check all received
3933 objects. It will abort in the case of a malformed object or a
3934 broken link. The result of an abort are only dangling objects.
3935 Defaults to false.
3936 </p>
3937 </dd>
3939 receive.unpackLimit
3940 </dt>
3941 <dd>
3942 <p>
3943 If the number of objects received in a push is below this
3944 limit then the objects will be unpacked into loose object
3945 files. However if the number of received objects equals or
3946 exceeds this limit then the received pack will be stored as
3947 a pack, after adding any missing delta bases. Storing the
3948 pack from a push can make the push operation complete faster,
3949 especially on slow filesystems. If not set, the value of
3951 </p>
3952 </dd>
3954 receive.denyDeletes
3955 </dt>
3956 <dd>
3957 <p>
3958 If set to true, git-receive-pack will deny a ref update that deletes
3959 the ref. Use this to prevent such a ref deletion via a push.
3960 </p>
3961 </dd>
3963 receive.denyDeleteCurrent
3964 </dt>
3965 <dd>
3966 <p>
3967 If set to true, git-receive-pack will deny a ref update that
3968 deletes the currently checked out branch of a non-bare repository.
3969 </p>
3970 </dd>
3972 receive.denyCurrentBranch
3973 </dt>
3974 <dd>
3975 <p>
3976 If set to true or "refuse", git-receive-pack will deny a ref update
3977 to the currently checked out branch of a non-bare repository.
3978 Such a push is potentially dangerous because it brings the HEAD
3979 out of sync with the index and working tree. If set to "warn",
3980 print a warning of such a push to stderr, but allow the push to
3981 proceed. If set to false or "ignore", allow such pushes with no
3982 message. Defaults to "refuse".
3983 </p>
3984 </dd>
3986 receive.denyNonFastForwards
3987 </dt>
3988 <dd>
3989 <p>
3990 If set to true, git-receive-pack will deny a ref update which is
3991 not a fast-forward. Use this to prevent such an update via a push,
3992 even if that push is forced. This configuration variable is
3993 set when initializing a shared repository.
3994 </p>
3995 </dd>
3997 receive.updateserverinfo
3998 </dt>
3999 <dd>
4000 <p>
4001 If set to true, git-receive-pack will run git-update-server-info
4002 after receiving data from git-push and updating refs.
4003 </p>
4004 </dd>
4007 </dt>
4008 <dd>
4009 <p>
4012 </p>
4013 </dd>
4016 </dt>
4017 <dd>
4018 <p>
4020 </p>
4021 </dd>
4024 </dt>
4025 <dd>
4026 <p>
4027 For remotes that require curl (http, https and ftp), the URL to
4028 the proxy to use for that remote. Set to the empty string to
4029 disable proxying for that remote.
4030 </p>
4031 </dd>
4034 </dt>
4035 <dd>
4036 <p>
4039 </p>
4040 </dd>
4043 </dt>
4044 <dd>
4045 <p>
4048 </p>
4049 </dd>
4052 </dt>
4053 <dd>
4054 <p>
4055 If true, pushing to this remote will automatically behave
4057 </p>
4058 </dd>
4061 </dt>
4062 <dd>
4063 <p>
4064 If true, this remote will be skipped by default when updating
4067 </p>
4068 </dd>
4071 </dt>
4072 <dd>
4073 <p>
4074 If true, this remote will be skipped by default when updating
4077 </p>
4078 </dd>
4081 </dt>
4082 <dd>
4083 <p>
4084 The default program to execute on the remote side when pushing. See
4086 </p>
4087 </dd>
4090 </dt>
4091 <dd>
4092 <p>
4093 The default program to execute on the remote side when fetching. See
4095 </p>
4096 </dd>
4099 </dt>
4100 <dd>
4101 <p>
4102 Setting this value to --no-tags disables automatic tag following when
4106 override this setting. See options --tags and --no-tags of
4108 </p>
4109 </dd>
4112 </dt>
4113 <dd>
4114 <p>
4117 </p>
4118 </dd>
4121 </dt>
4122 <dd>
4123 <p>
4124 The list of remotes which are fetched by "git remote update
4126 </p>
4127 </dd>
4129 repack.usedeltabaseoffset
4130 </dt>
4131 <dd>
4132 <p>
4134 delta-base offset. If you need to share your repository with
4135 git older than version 1.4.4, either directly or via a dumb
4136 protocol such as http, then you need to set this option to
4137 "false" and repack. Access from old git versions over the
4138 native protocol are unaffected by this option.
4139 </p>
4140 </dd>
4142 rerere.autoupdate
4143 </dt>
4144 <dd>
4145 <p>
4147 resulting contents after it cleanly resolves conflicts using
4148 previously recorded resolution. Defaults to false.
4149 </p>
4150 </dd>
4152 rerere.enabled
4153 </dt>
4154 <dd>
4155 <p>
4156 Activate recording of resolved conflicts, so that identical
4157 conflict hunks can be resolved automatically, should they
4161 </p>
4162 </dd>
4164 sendemail.identity
4165 </dt>
4166 <dd>
4167 <p>
4168 A configuration identity. When given, causes values in the
4172 </p>
4173 </dd>
4175 sendemail.smtpencryption
4176 </dt>
4177 <dd>
4178 <p>
4181 </p>
4182 </dd>
4184 sendemail.smtpssl
4185 </dt>
4186 <dd>
4187 <p>
4189 </p>
4190 </dd>
4193 </dt>
4194 <dd>
4195 <p>
4197 found below, taking precedence over those when the this
4198 identity is selected, through command-line or
4200 </p>
4201 </dd>
4203 sendemail.aliasesfile
4204 </dt>
4206 sendemail.aliasfiletype
4207 </dt>
4209 sendemail.bcc
4210 </dt>
4212 sendemail.cc
4213 </dt>
4215 sendemail.cccmd
4216 </dt>
4218 sendemail.chainreplyto
4219 </dt>
4221 sendemail.confirm
4222 </dt>
4224 sendemail.envelopesender
4225 </dt>
4227 sendemail.from
4228 </dt>
4230 sendemail.multiedit
4231 </dt>
4233 sendemail.signedoffbycc
4234 </dt>
4236 sendemail.smtppass
4237 </dt>
4239 sendemail.suppresscc
4240 </dt>
4242 sendemail.suppressfrom
4243 </dt>
4245 sendemail.to
4246 </dt>
4248 sendemail.smtpdomain
4249 </dt>
4251 sendemail.smtpserver
4252 </dt>
4254 sendemail.smtpserverport
4255 </dt>
4257 sendemail.smtpserveroption
4258 </dt>
4260 sendemail.smtpuser
4261 </dt>
4263 sendemail.thread
4264 </dt>
4266 sendemail.validate
4267 </dt>
4268 <dd>
4269 <p>
4271 </p>
4272 </dd>
4274 sendemail.signedoffcc
4275 </dt>
4276 <dd>
4277 <p>
4279 </p>
4280 </dd>
4282 showbranch.default
4283 </dt>
4284 <dd>
4285 <p>
4288 </p>
4289 </dd>
4291 status.relativePaths
4292 </dt>
4293 <dd>
4294 <p>
4297 relative to the repository root (this was the default for git
4298 prior to v1.5.4).
4299 </p>
4300 </dd>
4302 status.showUntrackedFiles
4303 </dt>
4304 <dd>
4305 <p>
4306 By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
4307 files which are not currently tracked by Git. Directories which
4308 contain only untracked files, are shown with the directory name
4309 only. Showing untracked files means that Git needs to lstat() all
4310 all the files in the whole repository, which might be slow on some
4311 systems. So, this variable controls how the commands displays
4312 the untracked files. Possible values are:
4313 </p>
4315 <li>
4316 <p>
4318 </p>
4319 </li>
4320 <li>
4321 <p>
4323 </p>
4324 </li>
4325 <li>
4326 <p>
4328 </p>
4329 </li>
4330 </ul></div>
4332 This variable can be overridden with the -u|--untracked-files option
4333 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div>
4334 </dd>
4336 status.submodulesummary
4337 </dt>
4338 <dd>
4339 <p>
4340 Defaults to false.
4341 If this is set to a non zero number or true (identical to -1 or an
4342 unlimited number), the submodule summary will be enabled and a
4343 summary of commits for modified submodules will be shown (see
4345 </p>
4346 </dd>
4349 </dt>
4352 </dt>
4355 </dt>
4356 <dd>
4357 <p>
4358 The path within this project, URL, and the updating strategy
4359 for a submodule. These variables are initially populated
4362 <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.
4363 </p>
4364 </dd>
4367 </dt>
4368 <dd>
4369 <p>
4370 This option can be used to control recursive fetching of this
4371 submodule. It can be overridden by using the --[no-]recurse-submodules
4374 file.
4375 </p>
4376 </dd>
4379 </dt>
4380 <dd>
4381 <p>
4382 Defines under what circumstances "git status" and the diff family show
4383 a submodule as modified. When set to "all", it will never be considered
4384 modified, "dirty" will ignore all changes to the submodules work tree and
4385 takes only differences between the HEAD of the submodule and the commit
4386 recorded in the superproject into account. "untracked" will additionally
4387 let submodules with modified tracked files in their work tree show up.
4388 Using "none" (the default when this option is not set) also shows
4389 submodules that have untracked files in their work tree as changed.
4390 This setting overrides any setting made in .gitmodules for this submodule,
4391 both settings can be overridden on the command line by using the
4392 "--ignore-submodules" option.
4393 </p>
4394 </dd>
4396 tar.umask
4397 </dt>
4398 <dd>
4399 <p>
4400 This variable can be used to restrict the permission bits of
4401 tar archive entries. The default is 0002, which turns off the
4402 world write bit. The special value "user" indicates that the
4405 </p>
4406 </dd>
4408 transfer.unpackLimit
4409 </dt>
4410 <dd>
4411 <p>
4413 not set, the value of this variable is used instead.
4414 The default value is 100.
4415 </p>
4416 </dd>
4419 </dt>
4420 <dd>
4421 <p>
4422 Any URL that starts with this value will be rewritten to
4424 large number of repositories, and serves them with multiple
4425 access methods, and some users need to use different access
4426 methods, this feature allows people to specify any of the
4427 equivalent URLs and have git automatically rewrite the URL to
4428 the best alternative for the particular user, even for a
4429 never-before-seen repository on the site. When more than one
4430 insteadOf strings match a given URL, the longest match is used.
4431 </p>
4432 </dd>
4435 </dt>
4436 <dd>
4437 <p>
4438 Any URL that starts with this value will not be pushed to;
4440 resulting URL will be pushed to. In cases where some site serves
4441 a large number of repositories, and serves them with multiple
4442 access methods, some of which do not allow push, this feature
4443 allows people to specify a pull-only URL and have git
4444 automatically use an appropriate URL to push, even for a
4445 never-before-seen repository on the site. When more than one
4446 pushInsteadOf strings match a given URL, the longest match is
4447 used. If a remote has an explicit pushurl, git will ignore this
4448 setting for that remote.
4449 </p>
4450 </dd>
4452 user.email
4453 </dt>
4454 <dd>
4455 <p>
4456 Your email address to be recorded in any newly created commits.
4458 <em>EMAIL</em> environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>.
4459 </p>
4460 </dd>
4462 user.name
4463 </dt>
4464 <dd>
4465 <p>
4466 Your full name to be recorded in any newly created commits.
4469 </p>
4470 </dd>
4472 user.signingkey
4473 </dt>
4474 <dd>
4475 <p>
4477 automatically when creating a signed tag, you can override the
4478 default selection with this variable. This option is passed
4479 unchanged to gpg’s --local-user parameter, so you may specify a key
4480 using any method that gpg supports.
4481 </p>
4482 </dd>
4484 web.browser
4485 </dt>
4486 <dd>
4487 <p>
4488 Specify a web browser that may be used by some commands.
4489 Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
4490 may use it.
4491 </p>
4492 </dd>
4493 </dl></div>
4494 </div>
4498 </div>
4502 </div>
4503 </div>
4504 </body>
4505 </html>