git-config.html

   1 <!DOCTYPE html>
   2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
   3 <head>
   4 <meta charset="UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
   7 <meta name="generator" content="Asciidoctor 2.0.20"/>
   8 <title>git-config(1)</title>
   9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
  10 <style>
  11 /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
  12 /* Uncomment the following line when using as a custom stylesheet */
  13 /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
  14 html{font-family:sans-serif;-webkit-text-size-adjust:100%}
  15 a{background:none}
  16 a:focus{outline:thin dotted}
  17 a:active,a:hover{outline:0}
  18 h1{font-size:2em;margin:.67em 0}
  19 b,strong{font-weight:bold}
  20 abbr{font-size:.9em}
  21 abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
  22 dfn{font-style:italic}
  23 hr{height:0}
  24 mark{background:#ff0;color:#000}
  25 code,kbd,pre,samp{font-family:monospace;font-size:1em}
  26 pre{white-space:pre-wrap}
  27 q{quotes:"\201C" "\201D" "\2018" "\2019"}
  28 small{font-size:80%}
  29 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  30 sup{top:-.5em}
  31 sub{bottom:-.25em}
  32 img{border:0}
  33 svg:not(:root){overflow:hidden}
  34 figure{margin:0}
  35 audio,video{display:inline-block}
  36 audio:not([controls]){display:none;height:0}
  37 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  38 legend{border:0;padding:0}
  39 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  40 button,input{line-height:normal}
  41 button,select{text-transform:none}
  42 button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
  43 button[disabled],html input[disabled]{cursor:default}
  44 input[type=checkbox],input[type=radio]{padding:0}
  45 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  46 textarea{overflow:auto;vertical-align:top}
  47 table{border-collapse:collapse;border-spacing:0}
  48 *,::before,::after{box-sizing:border-box}
  49 html,body{font-size:100%}
  50 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  51 a:hover{cursor:pointer}
  52 img,object,embed{max-width:100%;height:auto}
  53 object,embed{height:100%}
  54 img{-ms-interpolation-mode:bicubic}
  55 .left{float:left!important}
  56 .right{float:right!important}
  57 .text-left{text-align:left!important}
  58 .text-right{text-align:right!important}
  59 .text-center{text-align:center!important}
  60 .text-justify{text-align:justify!important}
  61 .hide{display:none}
  62 img,object,svg{display:inline-block;vertical-align:middle}
  63 textarea{height:auto;min-height:50px}
  64 select{width:100%}
  65 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  66 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
  67 a{color:#2156a5;text-decoration:underline;line-height:inherit}
  68 a:hover,a:focus{color:#1d4b8f}
  69 a img{border:0}
  70 p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  71 p aside{font-size:.875em;line-height:1.35;font-style:italic}
  72 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  73 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  74 h1{font-size:2.125em}
  75 h2{font-size:1.6875em}
  76 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  77 h4,h5{font-size:1.125em}
  78 h6{font-size:1em}
  79 hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
  80 em,i{font-style:italic;line-height:inherit}
  81 strong,b{font-weight:bold;line-height:inherit}
  82 small{font-size:60%;line-height:inherit}
  83 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  84 ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  85 ul,ol{margin-left:1.5em}
  86 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
  87 ul.circle{list-style-type:circle}
  88 ul.disc{list-style-type:disc}
  89 ul.square{list-style-type:square}
  90 ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
  91 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  92 dl dt{margin-bottom:.3125em;font-weight:bold}
  93 dl dd{margin-bottom:1.25em}
  94 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
  95 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
  96 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
  97 h1{font-size:2.75em}
  98 h2{font-size:2.3125em}
  99 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
 100 h4{font-size:1.4375em}}
 101 table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
 102 table thead,table tfoot{background:#f7f8f7}
 103 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
 104 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
 105 table tr.even,table tr.alt{background:#f8f8f7}
 106 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
 107 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
 108 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
 109 .center{margin-left:auto;margin-right:auto}
 110 .stretch{width:100%}
 111 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
 112 .clearfix::after,.float-group::after{clear:both}
 113 :not(pre).nobreak{word-wrap:normal}
 114 :not(pre).nowrap{white-space:nowrap}
 115 :not(pre).pre-wrap{white-space:pre-wrap}
 116 :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
 117 pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
 118 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
 119 pre>code{display:block}
 120 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
 121 em em{font-style:normal}
 122 strong strong{font-weight:400}
 123 .keyseq{color:rgba(51,51,51,.8)}
 124 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
 125 .keyseq kbd:first-child{margin-left:0}
 126 .keyseq kbd:last-child{margin-right:0}
 127 .menuseq,.menuref{color:#000}
 128 .menuseq b:not(.caret),.menuref{font-weight:inherit}
 129 .menuseq{word-spacing:-.02em}
 130 .menuseq b.caret{font-size:1.25em;line-height:.8}
 131 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
 132 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
 133 b.button::before{content:"[";padding:0 3px 0 2px}
 134 b.button::after{content:"]";padding:0 2px 0 3px}
 135 p a>code:hover{color:rgba(0,0,0,.9)}
 136 #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
 137 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
 138 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
 139 #content{margin-top:1.25em}
 140 #content::before{content:none}
 141 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
 142 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
 143 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
 144 #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
 145 #header .details span:first-child{margin-left:-.125em}
 146 #header .details span.email a{color:rgba(0,0,0,.85)}
 147 #header .details br{display:none}
 148 #header .details br+span::before{content:"\00a0\2013\00a0"}
 149 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
 150 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
 151 #header #revnumber{text-transform:capitalize}
 152 #header #revnumber::after{content:"\00a0"}
 153 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
 154 #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
 155 #toc>ul{margin-left:.125em}
 156 #toc ul.sectlevel0>li>a{font-style:italic}
 157 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
 158 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
 159 #toc li{line-height:1.3334;margin-top:.3334em}
 160 #toc a{text-decoration:none}
 161 #toc a:active{text-decoration:underline}
 162 #toctitle{color:#7a2518;font-size:1.2em}
 163 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
 164 body.toc2{padding-left:15em;padding-right:0}
 165 #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
 166 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 167 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
 168 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
 169 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
 170 body.toc2.toc-right{padding-left:0;padding-right:15em}
 171 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
 172 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
 173 #toc.toc2{width:20em}
 174 #toc.toc2 #toctitle{font-size:1.375em}
 175 #toc.toc2>ul{font-size:.95em}
 176 #toc.toc2 ul ul{padding-left:1.25em}
 177 body.toc2.toc-right{padding-left:0;padding-right:20em}}
 178 #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
 179 #content #toc>:first-child{margin-top:0}
 180 #content #toc>:last-child{margin-bottom:0}
 181 #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
 182 #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
 183 #content{margin-bottom:.625em}
 184 .sect1{padding-bottom:.625em}
 185 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
 186 .sect1{padding-bottom:1.25em}}
 187 .sect1:last-child{padding-bottom:0}
 188 .sect1+.sect1{border-top:1px solid #e7e7e9}
 189 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
 190 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
 191 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
 192 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
 193 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
 194 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
 195 details{margin-left:1.25rem}
 196 details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
 197 details>summary::-webkit-details-marker{display:none}
 198 details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
 199 details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
 200 details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
 201 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
 202 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
 203 .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
 204 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
 205 .admonitionblock>table td.icon{text-align:center;width:80px}
 206 .admonitionblock>table td.icon img{max-width:none}
 207 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
 208 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
 209 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
 210 .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
 211 .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
 212 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
 213 .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
 214 .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
 215 .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
 216 @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
 217 @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
 218 .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
 219 .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
 220 .listingblock>.content{position:relative}
 221 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
 222 .listingblock:hover code[data-lang]::before{display:block}
 223 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
 224 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
 225 .listingblock pre.highlightjs{padding:0}
 226 .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
 227 .listingblock pre.prettyprint{border-width:0}
 228 .prettyprint{background:#f7f7f8}
 229 pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
 230 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
 231 pre.prettyprint li code[data-lang]::before{opacity:1}
 232 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
 233 table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
 234 table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
 235 table.linenotable td.code{padding-left:.75em}
 236 table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
 237 pre.pygments span.linenos{display:inline-block;margin-right:.75em}
 238 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
 239 .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
 240 .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
 241 .quoteblock blockquote{margin:0;padding:0;border:0}
 242 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
 243 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
 244 .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
 245 .verseblock{margin:0 1em 1.25em}
 246 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
 247 .verseblock pre strong{font-weight:400}
 248 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
 249 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
 250 .quoteblock .attribution br,.verseblock .attribution br{display:none}
 251 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
 252 .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
 253 .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
 254 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
 255 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
 256 .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
 257 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
 258 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
 259 .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
 260 p.tableblock:last-child{margin-bottom:0}
 261 td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
 262 td.tableblock>.content>:last-child{margin-bottom:-1.25em}
 263 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
 264 table.grid-all>*>tr>*{border-width:1px}
 265 table.grid-cols>*>tr>*{border-width:0 1px}
 266 table.grid-rows>*>tr>*{border-width:1px 0}
 267 table.frame-all{border-width:1px}
 268 table.frame-ends{border-width:1px 0}
 269 table.frame-sides{border-width:0 1px}
 270 table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
 271 table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
 272 table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
 273 table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
 274 table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
 275 th.halign-left,td.halign-left{text-align:left}
 276 th.halign-right,td.halign-right{text-align:right}
 277 th.halign-center,td.halign-center{text-align:center}
 278 th.valign-top,td.valign-top{vertical-align:top}
 279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
 280 th.valign-middle,td.valign-middle{vertical-align:middle}
 281 table thead th,table tfoot th{font-weight:bold}
 282 tbody tr th{background:#f7f8f7}
 283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
 284 p.tableblock>code:only-child{background:none;padding:0}
 285 p.tableblock{font-size:1em}
 286 ol{margin-left:1.75em}
 287 ul li ol{margin-left:1.5em}
 288 dl dd{margin-left:1.125em}
 289 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
 290 li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
 291 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
 292 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
 293 ul.unstyled,ol.unstyled{margin-left:0}
 294 li>p:empty:only-child::before{content:"";display:inline-block}
 295 ul.checklist>li>p:first-child{margin-left:-1em}
 296 ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
 297 ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
 298 ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
 299 ul.inline>li{margin-left:1.25em}
 300 .unstyled dl dt{font-weight:400;font-style:normal}
 301 ol.arabic{list-style-type:decimal}
 302 ol.decimal{list-style-type:decimal-leading-zero}
 303 ol.loweralpha{list-style-type:lower-alpha}
 304 ol.upperalpha{list-style-type:upper-alpha}
 305 ol.lowerroman{list-style-type:lower-roman}
 306 ol.upperroman{list-style-type:upper-roman}
 307 ol.lowergreek{list-style-type:lower-greek}
 308 .hdlist>table,.colist>table{border:0;background:none}
 309 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
 310 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
 311 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
 312 td.hdlist2{word-wrap:anywhere}
 313 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
 314 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
 315 .colist td:not([class]):first-child img{max-width:none}
 316 .colist td:not([class]):last-child{padding:.25em 0}
 317 .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
 318 .imageblock.left{margin:.25em .625em 1.25em 0}
 319 .imageblock.right{margin:.25em 0 1.25em .625em}
 320 .imageblock>.title{margin-bottom:0}
 321 .imageblock.thumb,.imageblock.th{border-width:6px}
 322 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
 323 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
 324 .image.left{margin-right:.625em}
 325 .image.right{margin-left:.625em}
 326 a.image{text-decoration:none;display:inline-block}
 327 a.image object{pointer-events:none}
 328 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 329 sup.footnote a,sup.footnoteref a{text-decoration:none}
 330 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
 331 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 332 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
 333 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
 334 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
 335 #footnotes .footnote:last-of-type{margin-bottom:0}
 336 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
 337 div.unbreakable{page-break-inside:avoid}
 338 .big{font-size:larger}
 339 .small{font-size:smaller}
 340 .underline{text-decoration:underline}
 341 .overline{text-decoration:overline}
 342 .line-through{text-decoration:line-through}
 343 .aqua{color:#00bfbf}
 344 .aqua-background{background:#00fafa}
 345 .black{color:#000}
 346 .black-background{background:#000}
 347 .blue{color:#0000bf}
 348 .blue-background{background:#0000fa}
 349 .fuchsia{color:#bf00bf}
 350 .fuchsia-background{background:#fa00fa}
 351 .gray{color:#606060}
 352 .gray-background{background:#7d7d7d}
 353 .green{color:#006000}
 354 .green-background{background:#007d00}
 355 .lime{color:#00bf00}
 356 .lime-background{background:#00fa00}
 357 .maroon{color:#600000}
 358 .maroon-background{background:#7d0000}
 359 .navy{color:#000060}
 360 .navy-background{background:#00007d}
 361 .olive{color:#606000}
 362 .olive-background{background:#7d7d00}
 363 .purple{color:#600060}
 364 .purple-background{background:#7d007d}
 365 .red{color:#bf0000}
 366 .red-background{background:#fa0000}
 367 .silver{color:#909090}
 368 .silver-background{background:#bcbcbc}
 369 .teal{color:#006060}
 370 .teal-background{background:#007d7d}
 371 .white{color:#bfbfbf}
 372 .white-background{background:#fafafa}
 373 .yellow{color:#bfbf00}
 374 .yellow-background{background:#fafa00}
 375 span.icon>.fa{cursor:default}
 376 a span.icon>.fa{cursor:inherit}
 377 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
 378 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
 379 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
 380 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
 381 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
 382 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
 383 .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
 384 .conum[data-value] *{color:#fff!important}
 385 .conum[data-value]+b{display:none}
 386 .conum[data-value]::after{content:attr(data-value)}
 387 pre .conum[data-value]{position:relative;top:-.125em}
 388 b.conum *{color:inherit!important}
 389 .conum:not([data-value]):empty{display:none}
 390 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
 391 h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
 392 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
 393 p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
 394 p{margin-bottom:1.25rem}
 395 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
 396 .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
 397 .print-only{display:none!important}
 398 @page{margin:1.25cm .75cm}
 399 @media print{*{box-shadow:none!important;text-shadow:none!important}
 400 html{font-size:80%}
 401 a{color:inherit!important;text-decoration:underline!important}
 402 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
 403 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
 404 abbr[title]{border-bottom:1px dotted}
 405 abbr[title]::after{content:" (" attr(title) ")"}
 406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
 407 thead{display:table-header-group}
 408 svg{max-width:100%}
 409 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
 410 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
 411 #header,#content,#footnotes,#footer{max-width:none}
 412 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
 413 #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
 414 body.book #header{text-align:center}
 415 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
 416 body.book #header .details{border:0!important;display:block;padding:0!important}
 417 body.book #header .details span:first-child{margin-left:0!important}
 418 body.book #header .details br{display:block}
 419 body.book #header .details br+span::before{content:none!important}
 420 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
 421 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
 422 .listingblock code[data-lang]::before{display:block}
 423 #footer{padding:0 .9375em}
 424 .hide-on-print{display:none!important}
 425 .print-only{display:block!important}
 426 .hide-for-print{display:none!important}
 427 .show-for-print{display:inherit!important}}
 428 @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
 429 .sect1{padding:0!important}
 430 .sect1+.sect1{border:0}
 431 #footer{background:none}
 432 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
 433 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
 434 </style>
 435 <style>
 436 pre>code {
 437    display: inline;
 438 }
 439 </style>
 440 </head>
 441 <body class="manpage">
 442 <div id="header">
 443 <h1>git-config(1) Manual Page</h1>
 444 <h2 id="_name">NAME</h2>
 445 <div class="sectionbody">
 446 <p>git-config - Get and set repository or global options</p>
 447 </div>
 448 </div>
 449 <div id="content">
 450 <div class="sect1">
 451 <h2 id="_synopsis">SYNOPSIS</h2>
 452 <div class="sectionbody">
 453 <div class="verseblock">
 454 <pre class="content"><em>git config list</em> [&lt;file-option&gt;] [&lt;display-option&gt;] [--includes]
 455 <em>git config get</em> [&lt;file-option&gt;] [&lt;display-option&gt;] [--includes] [--all] [--regexp] [--value=&lt;value&gt;] [--fixed-value] [--default=&lt;default&gt;] &lt;name&gt;
 456 <em>git config set</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--all] [--value=&lt;value&gt;] [--fixed-value] &lt;name&gt; &lt;value&gt;
 457 <em>git config unset</em> [&lt;file-option&gt;] [--all] [--value=&lt;value&gt;] [--fixed-value] &lt;name&gt; &lt;value&gt;
 458 <em>git config rename-section</em> [&lt;file-option&gt;] &lt;old-name&gt; &lt;new-name&gt;
 459 <em>git config remove-section</em> [&lt;file-option&gt;] &lt;name&gt;
 460 <em>git config edit</em> [&lt;file-option&gt;]
 461 <em>git config</em> [&lt;file-option&gt;] --get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]</pre>
 462 </div>
 463 </div>
 464 </div>
 465 <div class="sect1">
 466 <h2 id="_description">DESCRIPTION</h2>
 467 <div class="sectionbody">
 468 <div class="paragraph">
 469 <p>You can query/set/replace/unset options with this command. The name is
 470 actually the section and the key separated by a dot, and the value will be
 471 escaped.</p>
 472 </div>
 473 <div class="paragraph">
 474 <p>Multiple lines can be added to an option by using the <code>--append</code> option.
 475 If you want to update or unset an option which can occur on multiple
 476 lines, a <code>value-pattern</code> (which is an extended regular expression,
 477 unless the <code>--fixed-value</code> option is given) needs to be given.  Only the
 478 existing values that match the pattern are updated or unset.  If
 479 you want to handle the lines that do <strong>not</strong> match the pattern, just
 480 prepend a single exclamation mark in front (see also <a href="#EXAMPLES">EXAMPLES</a>),
 481 but note that this only works when the <code>--fixed-value</code> option is not
 482 in use.</p>
 483 </div>
 484 <div class="paragraph">
 485 <p>The <code>--type=&lt;type&gt;</code> option instructs <em>git config</em> to ensure that incoming and
 486 outgoing values are canonicalize-able under the given &lt;type&gt;.  If no
 487 <code>--type=&lt;type&gt;</code> is given, no canonicalization will be performed. Callers may
 488 unset an existing <code>--type</code> specifier with <code>--no-type</code>.</p>
 489 </div>
 490 <div class="paragraph">
 491 <p>When reading, the values are read from the system, global and
 492 repository local configuration files by default, and options
 493 <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code> and
 494 <code>--file &lt;filename&gt;</code> can be used to tell the command to read from only
 495 that location (see <a href="#FILES">FILES</a>).</p>
 496 </div>
 497 <div class="paragraph">
 498 <p>When writing, the new value is written to the repository local
 499 configuration file by default, and options <code>--system</code>, <code>--global</code>,
 500 <code>--worktree</code>, <code>--file &lt;filename&gt;</code> can be used to tell the command to
 501 write to that location (you can say <code>--local</code> but that is the
 502 default).</p>
 503 </div>
 504 <div class="paragraph">
 505 <p>This command will fail with non-zero status upon error.  Some exit
 506 codes are:</p>
 507 </div>
 508 <div class="ulist">
 509 <ul>
 510 <li>
 511 <p>The section or key is invalid (ret=1),</p>
 512 </li>
 513 <li>
 514 <p>no section or name was provided (ret=2),</p>
 515 </li>
 516 <li>
 517 <p>the config file is invalid (ret=3),</p>
 518 </li>
 519 <li>
 520 <p>the config file cannot be written (ret=4),</p>
 521 </li>
 522 <li>
 523 <p>you try to unset an option which does not exist (ret=5),</p>
 524 </li>
 525 <li>
 526 <p>you try to unset/set an option for which multiple lines match (ret=5), or</p>
 527 </li>
 528 <li>
 529 <p>you try to use an invalid regexp (ret=6).</p>
 530 </li>
 531 </ul>
 532 </div>
 533 <div class="paragraph">
 534 <p>On success, the command returns the exit code 0.</p>
 535 </div>
 536 <div class="paragraph">
 537 <p>A list of all available configuration variables can be obtained using the
 538 <code>git help --config</code> command.</p>
 539 </div>
 540 </div>
 541 </div>
 542 <div class="sect1">
 543 <h2 id="_commands">COMMANDS</h2>
 544 <div class="sectionbody">
 545 <div class="dlist">
 546 <dl>
 547 <dt class="hdlist1">list</dt>
 548 <dd>
 549 <p>List all variables set in config file, along with their values.</p>
 550 </dd>
 551 <dt class="hdlist1">get</dt>
 552 <dd>
 553 <p>Emits the value of the specified key. If key is present multiple times
 554 in the configuration, emits the last value. If <code>--all</code> is specified,
 555 emits all values associated with key. Returns error code 1 if key is
 556 not present.</p>
 557 </dd>
 558 <dt class="hdlist1">set</dt>
 559 <dd>
 560 <p>Set value for one or more config options. By default, this command
 561 refuses to write multi-valued config options. Passing <code>--all</code> will
 562 replace all multi-valued config options with the new value, whereas
 563 <code>--value=</code> will replace all config options whose values match the given
 564 pattern.</p>
 565 </dd>
 566 <dt class="hdlist1">unset</dt>
 567 <dd>
 568 <p>Unset value for one or more config options. By default, this command
 569 refuses to unset multi-valued keys. Passing <code>--all</code> will unset all
 570 multi-valued config options, whereas <code>--value</code> will unset all config
 571 options whose values match the given pattern.</p>
 572 </dd>
 573 <dt class="hdlist1">rename-section</dt>
 574 <dd>
 575 <p>Rename the given section to a new name.</p>
 576 </dd>
 577 <dt class="hdlist1">remove-section</dt>
 578 <dd>
 579 <p>Remove the given section from the configuration file.</p>
 580 </dd>
 581 <dt class="hdlist1">edit</dt>
 582 <dd>
 583 <p>Opens an editor to modify the specified config file; either
 584 <code>--system</code>, <code>--global</code>, <code>--local</code> (default), <code>--worktree</code>, or
 585 <code>--file &lt;config-file&gt;</code>.</p>
 586 </dd>
 587 </dl>
 588 </div>
 589 </div>
 590 </div>
 591 <div class="sect1">
 592 <h2 id="OPTIONS">OPTIONS</h2>
 593 <div class="sectionbody">
 594 <div class="dlist">
 595 <dl>
 596 <dt class="hdlist1">--replace-all</dt>
 597 <dd>
 598 <p>Default behavior is to replace at most one line. This replaces
 599 all lines matching the key (and optionally the <code>value-pattern</code>).</p>
 600 </dd>
 601 <dt class="hdlist1">--append</dt>
 602 <dd>
 603 <p>Adds a new line to the option without altering any existing
 604 values. This is the same as providing <em>--value=^$</em> in <code>set</code>.</p>
 605 </dd>
 606 <dt class="hdlist1">--comment &lt;message&gt;</dt>
 607 <dd>
 608 <p>Append a comment at the end of new or modified lines.</p>
 609 <div class="literalblock">
 610 <div class="content">
 611 <pre>If _&lt;message&gt;_ begins with one or more whitespaces followed
 612 by "#", it is used as-is.  If it begins with "#", a space is
 613 prepended before it is used.  Otherwise, a string " # " (a
 614 space followed by a hash followed by a space) is prepended
 615 to it.  And the resulting string is placed immediately after
 616 the value defined for the variable.  The _&lt;message&gt;_ must
 617 not contain linefeed characters (no multi-line comments are
 618 permitted).</pre>
 619 </div>
 620 </div>
 621 </dd>
 622 <dt class="hdlist1">--all</dt>
 623 <dd>
 624 <p>With <code>get</code>, return all values for a multi-valued key.</p>
 625 </dd>
 626 <dt class="hdlist1">--regexp</dt>
 627 <dd>
 628 <p>With <code>get</code>, interpret the name as a regular expression. Regular
 629 expression matching is currently case-sensitive and done against a
 630 canonicalized version of the key in which section and variable names
 631 are lowercased, but subsection names are not.</p>
 632 </dd>
 633 <dt class="hdlist1">--url=&lt;URL&gt;</dt>
 634 <dd>
 635 <p>When given a two-part &lt;name&gt; as &lt;section&gt;.&lt;key&gt;, the value for
 636 &lt;section&gt;.&lt;URL&gt;.&lt;key&gt; whose &lt;URL&gt; part matches the best to the
 637 given URL is returned (if no such key exists, the value for
 638 &lt;section&gt;.&lt;key&gt; is used as a fallback).  When given just the
 639 &lt;section&gt; as name, do so for all the keys in the section and
 640 list them.  Returns error code 1 if no value is found.</p>
 641 </dd>
 642 <dt class="hdlist1">--global</dt>
 643 <dd>
 644 <p>For writing options: write to global <code>~/.gitconfig</code> file
 645 rather than the repository <code>.git/config</code>, write to
 646 <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the
 647 <code>~/.gitconfig</code> file doesn&#8217;t.</p>
 648 <div class="paragraph">
 649 <p>For reading options: read only from global <code>~/.gitconfig</code> and from
 650 <code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p>
 651 </div>
 652 <div class="paragraph">
 653 <p>See also <a href="#FILES">FILES</a>.</p>
 654 </div>
 655 </dd>
 656 <dt class="hdlist1">--system</dt>
 657 <dd>
 658 <p>For writing options: write to system-wide
 659 <code>$(prefix)/etc/gitconfig</code> rather than the repository
 660 <code>.git/config</code>.</p>
 661 <div class="paragraph">
 662 <p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code>
 663 rather than from all available files.</p>
 664 </div>
 665 <div class="paragraph">
 666 <p>See also <a href="#FILES">FILES</a>.</p>
 667 </div>
 668 </dd>
 669 <dt class="hdlist1">--local</dt>
 670 <dd>
 671 <p>For writing options: write to the repository <code>.git/config</code> file.
 672 This is the default behavior.</p>
 673 <div class="paragraph">
 674 <p>For reading options: read only from the repository <code>.git/config</code> rather than
 675 from all available files.</p>
 676 </div>
 677 <div class="paragraph">
 678 <p>See also <a href="#FILES">FILES</a>.</p>
 679 </div>
 680 </dd>
 681 <dt class="hdlist1">--worktree</dt>
 682 <dd>
 683 <p>Similar to <code>--local</code> except that <code>$GIT_DIR/config.worktree</code> is
 684 read from or written to if <code>extensions.worktreeConfig</code> is
 685 enabled. If not it&#8217;s the same as <code>--local</code>. Note that <code>$GIT_DIR</code>
 686 is equal to <code>$GIT_COMMON_DIR</code> for the main working tree, but is of
 687 the form <code>$GIT_DIR/worktrees/&lt;id&gt;/</code> for other working trees. See
 688 <a href="git-worktree.html">git-worktree(1)</a> to learn how to enable
 689 <code>extensions.worktreeConfig</code>.</p>
 690 </dd>
 691 <dt class="hdlist1">-f &lt;config-file&gt;</dt>
 692 <dt class="hdlist1">--file &lt;config-file&gt;</dt>
 693 <dd>
 694 <p>For writing options: write to the specified file rather than the
 695 repository <code>.git/config</code>.</p>
 696 <div class="paragraph">
 697 <p>For reading options: read only from the specified file rather than from all
 698 available files.</p>
 699 </div>
 700 <div class="paragraph">
 701 <p>See also <a href="#FILES">FILES</a>.</p>
 702 </div>
 703 </dd>
 704 <dt class="hdlist1">--blob &lt;blob&gt;</dt>
 705 <dd>
 706 <p>Similar to <code>--file</code> but use the given blob instead of a file. E.g.
 707 you can use <em>master:.gitmodules</em> to read values from the file
 708 <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS"
 709 section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of
 710 ways to spell blob names.</p>
 711 </dd>
 712 <dt class="hdlist1">--fixed-value</dt>
 713 <dd>
 714 <p>When used with the <code>value-pattern</code> argument, treat <code>value-pattern</code> as
 715 an exact string instead of a regular expression. This will restrict
 716 the name/value pairs that are matched to only those where the value
 717 is exactly equal to the <code>value-pattern</code>.</p>
 718 </dd>
 719 <dt class="hdlist1">--type &lt;type&gt;</dt>
 720 <dd>
 721 <p><em>git config</em> will ensure that any input or output is valid under the given
 722 type constraint(s), and will canonicalize outgoing values in <code>&lt;type&gt;</code>'s
 723 canonical form.</p>
 724 <div class="paragraph">
 725 <p>Valid <code>&lt;type&gt;</code>'s include:</p>
 726 </div>
 727 <div class="ulist">
 728 <ul>
 729 <li>
 730 <p><em>bool</em>: canonicalize values as either "true" or "false".</p>
 731 </li>
 732 <li>
 733 <p><em>int</em>: canonicalize values as simple decimal numbers. An optional suffix of
 734 <em>k</em>, <em>m</em>, or <em>g</em> will cause the value to be multiplied by 1024, 1048576, or
 735 1073741824 upon input.</p>
 736 </li>
 737 <li>
 738 <p><em>bool-or-int</em>: canonicalize according to either <em>bool</em> or <em>int</em>, as described
 739 above.</p>
 740 </li>
 741 <li>
 742 <p><em>path</em>: canonicalize by expanding a leading <code>~</code> to the value of <code>$HOME</code> and
 743 <code>~user</code> to the home directory for the specified user. This specifier has no
 744 effect when setting the value (but you can use <code>git config section.variable
 745 ~/</code> from the command line to let your shell do the expansion.)</p>
 746 </li>
 747 <li>
 748 <p><em>expiry-date</em>: canonicalize by converting from a fixed or relative date-string
 749 to a timestamp. This specifier has no effect when setting the value.</p>
 750 </li>
 751 <li>
 752 <p><em>color</em>: When getting a value, canonicalize by converting to an ANSI color
 753 escape sequence. When setting a value, a sanity-check is performed to ensure
 754 that the given value is canonicalize-able as an ANSI color, but it is written
 755 as-is.</p>
 756 </li>
 757 </ul>
 758 </div>
 759 </dd>
 760 <dt class="hdlist1">--bool</dt>
 761 <dt class="hdlist1">--int</dt>
 762 <dt class="hdlist1">--bool-or-int</dt>
 763 <dt class="hdlist1">--path</dt>
 764 <dt class="hdlist1">--expiry-date</dt>
 765 <dd>
 766 <p>Historical options for selecting a type specifier. Prefer instead <code>--type</code>
 767 (see above).</p>
 768 </dd>
 769 <dt class="hdlist1">--no-type</dt>
 770 <dd>
 771 <p>Un-sets the previously set type specifier (if one was previously set). This
 772 option requests that <em>git config</em> not canonicalize the retrieved variable.
 773 <code>--no-type</code> has no effect without <code>--type=&lt;type&gt;</code> or <code>--&lt;type&gt;</code>.</p>
 774 </dd>
 775 <dt class="hdlist1">-z</dt>
 776 <dt class="hdlist1">--null</dt>
 777 <dd>
 778 <p>For all options that output values and/or keys, always
 779 end values with the null character (instead of a
 780 newline). Use newline instead as a delimiter between
 781 key and value. This allows for secure parsing of the
 782 output without getting confused e.g. by values that
 783 contain line breaks.</p>
 784 </dd>
 785 <dt class="hdlist1">--name-only</dt>
 786 <dd>
 787 <p>Output only the names of config variables for <code>list</code> or
 788 <code>get</code>.</p>
 789 </dd>
 790 <dt class="hdlist1">--show-origin</dt>
 791 <dd>
 792 <p>Augment the output of all queried config options with the
 793 origin type (file, standard input, blob, command line) and
 794 the actual origin (config file path, ref, or blob id if
 795 applicable).</p>
 796 </dd>
 797 <dt class="hdlist1">--show-scope</dt>
 798 <dd>
 799 <p>Similar to <code>--show-origin</code> in that it augments the output of
 800 all queried config options with the scope of that value
 801 (worktree, local, global, system, command).</p>
 802 </dd>
 803 <dt class="hdlist1">--get-colorbool &lt;name&gt; [&lt;stdout-is-tty&gt;]</dt>
 804 <dd>
 805 <p>Find the color setting for <code>&lt;name&gt;</code> (e.g. <code>color.diff</code>) and output
 806 "true" or "false".  <code>&lt;stdout-is-tty&gt;</code> should be either "true" or
 807 "false", and is taken into account when configuration says
 808 "auto".  If <code>&lt;stdout-is-tty&gt;</code> is missing, then checks the standard
 809 output of the command itself, and exits with status 0 if color
 810 is to be used, or exits with status 1 otherwise.
 811 When the color setting for <code>name</code> is undefined, the command uses
 812 <code>color.ui</code> as fallback.</p>
 813 </dd>
 814 <dt class="hdlist1">--[no-]includes</dt>
 815 <dd>
 816 <p>Respect <code>include.*</code> directives in config files when looking up
 817 values. Defaults to <code>off</code> when a specific file is given (e.g.,
 818 using <code>--file</code>, <code>--global</code>, etc) and <code>on</code> when searching all
 819 config files.</p>
 820 </dd>
 821 <dt class="hdlist1">--default &lt;value&gt;</dt>
 822 <dd>
 823 <p>When using <code>get</code>, and the requested variable is not found, behave as if
 824 &lt;value&gt; were the value assigned to that variable.</p>
 825 </dd>
 826 </dl>
 827 </div>
 828 </div>
 829 </div>
 830 <div class="sect1">
 831 <h2 id="_deprecated_modes">DEPRECATED MODES</h2>
 832 <div class="sectionbody">
 833 <div class="paragraph">
 834 <p>The following modes have been deprecated in favor of subcommands. It is
 835 recommended to migrate to the new syntax.</p>
 836 </div>
 837 <div class="dlist">
 838 <dl>
 839 <dt class="hdlist1"><em>git config &lt;name&gt;</em></dt>
 840 <dd>
 841 <p>Replaced by <code>git config get &lt;name&gt;</code>.</p>
 842 </dd>
 843 <dt class="hdlist1"><em>git config &lt;name&gt; &lt;value&gt; [&lt;value-pattern&gt;]</em></dt>
 844 <dd>
 845 <p>Replaced by <code>git config set [--value=&lt;pattern&gt;] &lt;name&gt; &lt;value&gt;</code>.</p>
 846 </dd>
 847 <dt class="hdlist1">-l</dt>
 848 <dt class="hdlist1">--list</dt>
 849 <dd>
 850 <p>Replaced by <code>git config list</code>.</p>
 851 </dd>
 852 <dt class="hdlist1">--get &lt;name&gt; [&lt;value-pattern&gt;]</dt>
 853 <dd>
 854 <p>Replaced by <code>git config get [--value=&lt;pattern&gt;] &lt;name&gt;</code>.</p>
 855 </dd>
 856 <dt class="hdlist1">--get-all &lt;name&gt; [&lt;value-pattern&gt;]</dt>
 857 <dd>
 858 <p>Replaced by <code>git config get [--value=&lt;pattern&gt;] --all &lt;name&gt;</code>.</p>
 859 </dd>
 860 <dt class="hdlist1">--get-regexp &lt;name-regexp&gt;</dt>
 861 <dd>
 862 <p>Replaced by <code>git config get --all --show-names --regexp &lt;name-regexp&gt;</code>.</p>
 863 </dd>
 864 <dt class="hdlist1">--get-urlmatch &lt;name&gt; &lt;URL&gt;</dt>
 865 <dd>
 866 <p>Replaced by <code>git config get --all --show-names --url=&lt;URL&gt; &lt;name&gt;</code>.</p>
 867 </dd>
 868 <dt class="hdlist1">--get-color &lt;name&gt; [&lt;default&gt;]</dt>
 869 <dd>
 870 <p>Replaced by <code>git config get --type=color [--default=&lt;default&gt;] &lt;name&gt;</code>.</p>
 871 </dd>
 872 <dt class="hdlist1">--add &lt;name&gt; &lt;value&gt;</dt>
 873 <dd>
 874 <p>Replaced by <code>git config set --append &lt;name&gt; &lt;value&gt;</code>.</p>
 875 </dd>
 876 <dt class="hdlist1">--unset &lt;name&gt; [&lt;value-pattern&gt;]</dt>
 877 <dd>
 878 <p>Replaced by <code>git config unset [--value=&lt;pattern&gt;] &lt;name&gt;</code>.</p>
 879 </dd>
 880 <dt class="hdlist1">--unset-all &lt;name&gt; [&lt;value-pattern&gt;]</dt>
 881 <dd>
 882 <p>Replaced by <code>git config unset [--value=&lt;pattern&gt;] --all &lt;name&gt;</code>.</p>
 883 </dd>
 884 <dt class="hdlist1">--rename-section &lt;old-name&gt; &lt;new-name&gt;</dt>
 885 <dd>
 886 <p>Replaced by <code>git config rename-section &lt;old-name&gt; &lt;new-name&gt;</code>.</p>
 887 </dd>
 888 <dt class="hdlist1">--remove-section &lt;name&gt;</dt>
 889 <dd>
 890 <p>Replaced by <code>git config remove-section &lt;name&gt;</code>.</p>
 891 </dd>
 892 <dt class="hdlist1">-e</dt>
 893 <dt class="hdlist1">--edit</dt>
 894 <dd>
 895 <p>Replaced by <code>git config edit</code>.</p>
 896 </dd>
 897 </dl>
 898 </div>
 899 </div>
 900 </div>
 901 <div class="sect1">
 902 <h2 id="_configuration">CONFIGURATION</h2>
 903 <div class="sectionbody">
 904 <div class="paragraph">
 905 <p><code>pager.config</code> is only respected when listing configuration, i.e., when
 906 using <code>list</code> or <code>get</code> which may return multiple results. The default is to use
 907 a pager.</p>
 908 </div>
 909 </div>
 910 </div>
 911 <div class="sect1">
 912 <h2 id="FILES">FILES</h2>
 913 <div class="sectionbody">
 914 <div class="paragraph">
 915 <p>By default, <em>git config</em> will read configuration options from multiple
 916 files:</p>
 917 </div>
 918 <div class="dlist">
 919 <dl>
 920 <dt class="hdlist1">$(prefix)/etc/gitconfig</dt>
 921 <dd>
 922 <p>System-wide configuration file.</p>
 923 </dd>
 924 <dt class="hdlist1">$XDG_CONFIG_HOME/git/config</dt>
 925 <dt class="hdlist1">~/.gitconfig</dt>
 926 <dd>
 927 <p>User-specific configuration files. When the XDG_CONFIG_HOME environment
 928 variable is not set or empty, $HOME/.config/ is used as
 929 $XDG_CONFIG_HOME.</p>
 930 <div class="paragraph">
 931 <p>These are also called "global" configuration files. If both files exist, both
 932 files are read in the order given above.</p>
 933 </div>
 934 </dd>
 935 <dt class="hdlist1">$GIT_DIR/config</dt>
 936 <dd>
 937 <p>Repository specific configuration file.</p>
 938 </dd>
 939 <dt class="hdlist1">$GIT_DIR/config.worktree</dt>
 940 <dd>
 941 <p>This is optional and is only searched when
 942 <code>extensions.worktreeConfig</code> is present in $GIT_DIR/config.</p>
 943 </dd>
 944 </dl>
 945 </div>
 946 <div class="paragraph">
 947 <p>You may also provide additional configuration parameters when running any
 948 git command by using the <code>-c</code> option. See <a href="git.html">git(1)</a> for details.</p>
 949 </div>
 950 <div class="paragraph">
 951 <p>Options will be read from all of these files that are available. If the
 952 global or the system-wide configuration files are missing or unreadable they
 953 will be ignored. If the repository configuration file is missing or unreadable,
 954 <em>git config</em> will exit with a non-zero error code. An error message is produced
 955 if the file is unreadable, but not if it is missing.</p>
 956 </div>
 957 <div class="paragraph">
 958 <p>The files are read in the order given above, with last value found taking
 959 precedence over values read earlier.  When multiple values are taken then all
 960 values of a key from all files will be used.</p>
 961 </div>
 962 <div class="paragraph">
 963 <p>By default, options are only written to the repository specific
 964 configuration file. Note that this also affects options like <code>set</code>
 965 and <code>unset</code>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p>
 966 </div>
 967 <div class="paragraph">
 968 <p>You can limit which configuration sources are read from or written to by
 969 specifying the path of a file with the <code>--file</code> option, or by specifying a
 970 configuration scope with <code>--system</code>, <code>--global</code>, <code>--local</code>, or <code>--worktree</code>.
 971 For more, see <a href="#OPTIONS">OPTIONS</a> above.</p>
 972 </div>
 973 </div>
 974 </div>
 975 <div class="sect1">
 976 <h2 id="SCOPES">SCOPES</h2>
 977 <div class="sectionbody">
 978 <div class="paragraph">
 979 <p>Each configuration source falls within a configuration scope. The scopes
 980 are:</p>
 981 </div>
 982 <div class="dlist">
 983 <dl>
 984 <dt class="hdlist1">system</dt>
 985 <dd>
 986 <p>$(prefix)/etc/gitconfig</p>
 987 </dd>
 988 <dt class="hdlist1">global</dt>
 989 <dd>
 990 <p>$XDG_CONFIG_HOME/git/config</p>
 991 <div class="paragraph">
 992 <p>~/.gitconfig</p>
 993 </div>
 994 </dd>
 995 <dt class="hdlist1">local</dt>
 996 <dd>
 997 <p>$GIT_DIR/config</p>
 998 </dd>
 999 <dt class="hdlist1">worktree</dt>
1000 <dd>
1001 <p>$GIT_DIR/config.worktree</p>
1002 </dd>
1003 <dt class="hdlist1">command</dt>
1004 <dd>
1005 <p>GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see <a href="#ENVIRONMENT">ENVIRONMENT</a>
1006 below)</p>
1007 <div class="paragraph">
1008 <p>the <code>-c</code> option</p>
1009 </div>
1010 </dd>
1011 </dl>
1012 </div>
1013 <div class="paragraph">
1014 <p>With the exception of <em>command</em>, each scope corresponds to a command line
1015 option: <code>--system</code>, <code>--global</code>, <code>--local</code>, <code>--worktree</code>.</p>
1016 </div>
1017 <div class="paragraph">
1018 <p>When reading options, specifying a scope will only read options from the
1019 files within that scope. When writing options, specifying a scope will write
1020 to the files within that scope (instead of the repository specific
1021 configuration file). See <a href="#OPTIONS">OPTIONS</a> above for a complete description.</p>
1022 </div>
1023 <div class="paragraph">
1024 <p>Most configuration options are respected regardless of the scope it is
1025 defined in, but some options are only respected in certain scopes. See the
1026 respective option&#8217;s documentation for the full details.</p>
1027 </div>
1028 <div class="sect2">
1029 <h3 id="_protected_configuration">Protected configuration</h3>
1030 <div class="paragraph">
1031 <p>Protected configuration refers to the <em>system</em>, <em>global</em>, and <em>command</em> scopes.
1032 For security reasons, certain options are only respected when they are
1033 specified in protected configuration, and ignored otherwise.</p>
1034 </div>
1035 <div class="paragraph">
1036 <p>Git treats these scopes as if they are controlled by the user or a trusted
1037 administrator. This is because an attacker who controls these scopes can do
1038 substantial harm without using Git, so it is assumed that the user&#8217;s environment
1039 protects these scopes against attackers.</p>
1040 </div>
1041 </div>
1042 </div>
1043 </div>
1044 <div class="sect1">
1045 <h2 id="ENVIRONMENT">ENVIRONMENT</h2>
1046 <div class="sectionbody">
1047 <div class="dlist">
1048 <dl>
1049 <dt class="hdlist1">GIT_CONFIG_GLOBAL</dt>
1050 <dt class="hdlist1">GIT_CONFIG_SYSTEM</dt>
1051 <dd>
1052 <p>Take the configuration from the given files instead from global or
1053 system-level configuration. See <a href="git.html">git(1)</a> for details.</p>
1054 </dd>
1055 <dt class="hdlist1">GIT_CONFIG_NOSYSTEM</dt>
1056 <dd>
1057 <p>Whether to skip reading settings from the system-wide
1058 $(prefix)/etc/gitconfig file. See <a href="git.html">git(1)</a> for details.</p>
1059 </dd>
1060 </dl>
1061 </div>
1062 <div class="paragraph">
1063 <p>See also <a href="#FILES">FILES</a>.</p>
1064 </div>
1065 <div class="dlist">
1066 <dl>
1067 <dt class="hdlist1">GIT_CONFIG_COUNT</dt>
1068 <dt class="hdlist1">GIT_CONFIG_KEY_&lt;n&gt;</dt>
1069 <dt class="hdlist1">GIT_CONFIG_VALUE_&lt;n&gt;</dt>
1070 <dd>
1071 <p>If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
1072 GIT_CONFIG_KEY_&lt;n&gt; and GIT_CONFIG_VALUE_&lt;n&gt; up to that number will be
1073 added to the process&#8217;s runtime configuration. The config pairs are
1074 zero-indexed. Any missing key or value is treated as an error. An empty
1075 GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
1076 pairs are processed. These environment variables will override values
1077 in configuration files, but will be overridden by any explicit options
1078 passed via <code>git -c</code>.</p>
1079 <div class="paragraph">
1080 <p>This is useful for cases where you want to spawn multiple git commands
1081 with a common configuration but cannot depend on a configuration file,
1082 for example when writing scripts.</p>
1083 </div>
1084 </dd>
1085 <dt class="hdlist1">GIT_CONFIG</dt>
1086 <dd>
1087 <p>If no <code>--file</code> option is provided to <code>git config</code>, use the file
1088 given by <code>GIT_CONFIG</code> as if it were provided via <code>--file</code>. This
1089 variable has no effect on other Git commands, and is mostly for
1090 historical compatibility; there is generally no reason to use it
1091 instead of the <code>--file</code> option.</p>
1092 </dd>
1093 </dl>
1094 </div>
1095 </div>
1096 </div>
1097 <div class="sect1">
1098 <h2 id="EXAMPLES">EXAMPLES</h2>
1099 <div class="sectionbody">
1100 <div class="paragraph">
1101 <p>Given a .git/config like this:</p>
1102 </div>
1103 <div class="listingblock">
1104 <div class="content">
1105 <pre>#
1106 # This is the config file, and
1107 # a '#' or ';' character indicates
1108 # a comment
1109 #
1110
1111 ; core variables
1112 [core]
1113         ; Don't trust file modes
1114         filemode = false
1115
1116 ; Our diff algorithm
1117 [diff]
1118         external = /usr/local/bin/diff-wrapper
1119         renames = true
1120
1121 ; Proxy settings
1122 [core]
1123         gitproxy=proxy-command for kernel.org
1124         gitproxy=default-proxy ; for all the rest
1125
1126 ; HTTP
1127 [http]
1128         sslVerify
1129 [http "https://weak.example.com"]
1130         sslVerify = false
1131         cookieFile = /tmp/cookie.txt</pre>
1132 </div>
1133 </div>
1134 <div class="paragraph">
1135 <p>you can set the filemode to true with</p>
1136 </div>
1137 <div class="listingblock">
1138 <div class="content">
1139 <pre>% git config set core.filemode true</pre>
1140 </div>
1141 </div>
1142 <div class="paragraph">
1143 <p>The hypothetical proxy command entries actually have a postfix to discern
1144 what URL they apply to. Here is how to change the entry for kernel.org
1145 to "ssh".</p>
1146 </div>
1147 <div class="listingblock">
1148 <div class="content">
1149 <pre>% git config set --value='for kernel.org$' core.gitproxy '"ssh" for kernel.org'</pre>
1150 </div>
1151 </div>
1152 <div class="paragraph">
1153 <p>This makes sure that only the key/value pair for kernel.org is replaced.</p>
1154 </div>
1155 <div class="paragraph">
1156 <p>To delete the entry for renames, do</p>
1157 </div>
1158 <div class="listingblock">
1159 <div class="content">
1160 <pre>% git config unset diff.renames</pre>
1161 </div>
1162 </div>
1163 <div class="paragraph">
1164 <p>If you want to delete an entry for a multivar (like core.gitproxy above),
1165 you have to provide a regex matching the value of exactly one line.</p>
1166 </div>
1167 <div class="paragraph">
1168 <p>To query the value for a given key, do</p>
1169 </div>
1170 <div class="listingblock">
1171 <div class="content">
1172 <pre>% git config get core.filemode</pre>
1173 </div>
1174 </div>
1175 <div class="paragraph">
1176 <p>or, to query a multivar:</p>
1177 </div>
1178 <div class="listingblock">
1179 <div class="content">
1180 <pre>% git config get --value="for kernel.org$" core.gitproxy</pre>
1181 </div>
1182 </div>
1183 <div class="paragraph">
1184 <p>If you want to know all the values for a multivar, do:</p>
1185 </div>
1186 <div class="listingblock">
1187 <div class="content">
1188 <pre>% git config get --all --show-names core.gitproxy</pre>
1189 </div>
1190 </div>
1191 <div class="paragraph">
1192 <p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a
1193 new one with</p>
1194 </div>
1195 <div class="listingblock">
1196 <div class="content">
1197 <pre>% git config set --all core.gitproxy ssh</pre>
1198 </div>
1199 </div>
1200 <div class="paragraph">
1201 <p>However, if you really only want to replace the line for the default proxy,
1202 i.e. the one without a "for &#8230;&#8203;" postfix, do something like this:</p>
1203 </div>
1204 <div class="listingblock">
1205 <div class="content">
1206 <pre>% git config set --value='! for ' core.gitproxy ssh</pre>
1207 </div>
1208 </div>
1209 <div class="paragraph">
1210 <p>To actually match only values with an exclamation mark, you have to</p>
1211 </div>
1212 <div class="listingblock">
1213 <div class="content">
1214 <pre>% git config set --value='[!]' section.key value</pre>
1215 </div>
1216 </div>
1217 <div class="paragraph">
1218 <p>To add a new proxy, without altering any of the existing ones, use</p>
1219 </div>
1220 <div class="listingblock">
1221 <div class="content">
1222 <pre>% git config set --append core.gitproxy '"proxy-command" for example.com'</pre>
1223 </div>
1224 </div>
1225 <div class="paragraph">
1226 <p>An example to use customized color from the configuration in your
1227 script:</p>
1228 </div>
1229 <div class="listingblock">
1230 <div class="content">
1231 <pre>#!/bin/sh
1232 WS=$(git config get --type=color --default="blue reverse" color.diff.whitespace)
1233 RESET=$(git config get --type=color --default="reset" "")
1234 echo "${WS}your whitespace color or blue reverse${RESET}"</pre>
1235 </div>
1236 </div>
1237 <div class="paragraph">
1238 <p>For URLs in <code>https://weak.example.com</code>, <code>http.sslVerify</code> is set to
1239 false, while it is set to <code>true</code> for all others:</p>
1240 </div>
1241 <div class="listingblock">
1242 <div class="content">
1243 <pre>% git config get --type=bool --url=https://good.example.com http.sslverify
1244 true
1245 % git config get --type=bool --url=https://weak.example.com http.sslverify
1246 false
1247 % git config get --url=https://weak.example.com http
1248 http.cookieFile /tmp/cookie.txt
1249 http.sslverify false</pre>
1250 </div>
1251 </div>
1252 </div>
1253 </div>
1254 <div class="sect1">
1255 <h2 id="_configuration_file">CONFIGURATION FILE</h2>
1256 <div class="sectionbody">
1257 <div class="paragraph">
1258 <p>The Git configuration file contains a number of variables that affect
1259 the Git commands' behavior. The files <code>.git/config</code> and optionally
1260 <code>config.worktree</code> (see the "CONFIGURATION FILE" section of
1261 <a href="git-worktree.html">git-worktree(1)</a>) in each repository are used to store the
1262 configuration for that repository, and <code>$HOME/.gitconfig</code> is used to
1263 store a per-user configuration as fallback values for the <code>.git/config</code>
1264 file. The file <code>/etc/gitconfig</code> can be used to store a system-wide
1265 default configuration.</p>
1266 </div>
1267 <div class="paragraph">
1268 <p>The configuration variables are used by both the Git plumbing
1269 and the porcelain commands. The variables are divided into sections, wherein
1270 the fully qualified variable name of the variable itself is the last
1271 dot-separated segment and the section name is everything before the last
1272 dot. The variable names are case-insensitive, allow only alphanumeric
1273 characters and <code>-</code>, and must start with an alphabetic character.  Some
1274 variables may appear multiple times; we say then that the variable is
1275 multivalued.</p>
1276 </div>
1277 <div class="sect2">
1278 <h3 id="_syntax">Syntax</h3>
1279 <div class="paragraph">
1280 <p>The syntax is fairly flexible and permissive.  Whitespace characters,
1281 which in this context are the space character (SP) and the horizontal
1282 tabulation (HT), are mostly ignored.  The <em>#</em> and <em>;</em> characters begin
1283 comments to the end of line.  Blank lines are ignored.</p>
1284 </div>
1285 <div class="paragraph">
1286 <p>The file consists of sections and variables.  A section begins with
1287 the name of the section in square brackets and continues until the next
1288 section begins.  Section names are case-insensitive.  Only alphanumeric
1289 characters, <code>-</code> and <code>.</code> are allowed in section names.  Each variable
1290 must belong to some section, which means that there must be a section
1291 header before the first setting of a variable.</p>
1292 </div>
1293 <div class="paragraph">
1294 <p>Sections can be further divided into subsections.  To begin a subsection
1295 put its name in double quotes, separated by space from the section name,
1296 in the section header, like in the example below:</p>
1297 </div>
1298 <div class="listingblock">
1299 <div class="content">
1300 <pre>        [section "subsection"]</pre>
1301 </div>
1302 </div>
1303 <div class="paragraph">
1304 <p>Subsection names are case sensitive and can contain any characters except
1305 newline and the null byte. Doublequote <code>"</code> and backslash can be included
1306 by escaping them as <code>\"</code> and <code>\\</code>, respectively. Backslashes preceding
1307 other characters are dropped when reading; for example, <code>\t</code> is read as
1308 <code>t</code> and <code>\0</code> is read as <code>0</code>. Section headers cannot span multiple lines.
1309 Variables may belong directly to a section or to a given subsection. You
1310 can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you don&#8217;t
1311 need to.</p>
1312 </div>
1313 <div class="paragraph">
1314 <p>There is also a deprecated <code>[section.subsection]</code> syntax. With this
1315 syntax, the subsection name is converted to lower-case and is also
1316 compared case sensitively. These subsection names follow the same
1317 restrictions as section names.</p>
1318 </div>
1319 <div class="paragraph">
1320 <p>All the other lines (and the remainder of the line after the section
1321 header) are recognized as setting variables, in the form
1322 <em>name = value</em> (or just <em>name</em>, which is a short-hand to say that
1323 the variable is the boolean "true").
1324 The variable names are case-insensitive, allow only alphanumeric characters
1325 and <code>-</code>, and must start with an alphabetic character.</p>
1326 </div>
1327 <div class="paragraph">
1328 <p>Whitespace characters surrounding <code>name</code>, <code>=</code> and <code>value</code> are discarded.
1329 Internal whitespace characters within <em>value</em> are retained verbatim.
1330 Comments starting with either <code>#</code> or <code>;</code> and extending to the end of line
1331 are discarded.  A line that defines a value can be continued to the next
1332 line by ending it with a backslash (<code>\</code>);  the backslash and the end-of-line
1333 characters are discarded.</p>
1334 </div>
1335 <div class="paragraph">
1336 <p>If <code>value</code> needs to contain leading or trailing whitespace characters,
1337 it must be enclosed in double quotation marks (<code>"</code>).  Inside double quotation
1338 marks, double quote (<code>"</code>) and backslash (<code>\</code>) characters must be escaped:
1339 use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p>
1340 </div>
1341 <div class="paragraph">
1342 <p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized:
1343 <code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB)
1344 and <code>\b</code> for backspace (BS).  Other char escape sequences (including octal
1345 escape sequences) are invalid.</p>
1346 </div>
1347 </div>
1348 <div class="sect2">
1349 <h3 id="_includes">Includes</h3>
1350 <div class="paragraph">
1351 <p>The <code>include</code> and <code>includeIf</code> sections allow you to include config
1352 directives from another source. These sections behave identically to
1353 each other with the exception that <code>includeIf</code> sections may be ignored
1354 if their condition does not evaluate to true; see "Conditional includes"
1355 below.</p>
1356 </div>
1357 <div class="paragraph">
1358 <p>You can include a config file from another by setting the special
1359 <code>include.path</code> (or <code>includeIf.*.path</code>) variable to the name of the file
1360 to be included. The variable takes a pathname as its value, and is
1361 subject to tilde expansion. These variables can be given multiple times.</p>
1362 </div>
1363 <div class="paragraph">
1364 <p>The contents of the included file are inserted immediately, as if they
1365 had been found at the location of the include directive. If the value of the
1366 variable is a relative path, the path is considered to
1367 be relative to the configuration file in which the include directive
1368 was found.  See below for examples.</p>
1369 </div>
1370 </div>
1371 <div class="sect2">
1372 <h3 id="_conditional_includes">Conditional includes</h3>
1373 <div class="paragraph">
1374 <p>You can conditionally include a config file from another by setting an
1375 <code>includeIf.&lt;condition&gt;.path</code> variable to the name of the file to be
1376 included.</p>
1377 </div>
1378 <div class="paragraph">
1379 <p>The condition starts with a keyword followed by a colon and some data
1380 whose format and meaning depends on the keyword. Supported keywords
1381 are:</p>
1382 </div>
1383 <div class="dlist">
1384 <dl>
1385 <dt class="hdlist1"><code>gitdir</code></dt>
1386 <dd>
1387 <p>The data that follows the keyword <code>gitdir:</code> is used as a glob
1388 pattern. If the location of the .git directory matches the
1389 pattern, the include condition is met.</p>
1390 <div class="paragraph">
1391 <p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1392 environment variable. If the repository is auto-discovered via a .git
1393 file (e.g. from submodules, or a linked worktree), the .git location
1394 would be the final location where the .git directory is, not where the
1395 .git file is.</p>
1396 </div>
1397 <div class="paragraph">
1398 <p>The pattern can contain standard globbing wildcards and two additional
1399 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1400 refer to <a href="gitignore.html">gitignore(5)</a> for details. For convenience:</p>
1401 </div>
1402 <div class="ulist">
1403 <ul>
1404 <li>
1405 <p>If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1406 content of the environment variable <code>HOME</code>.</p>
1407 </li>
1408 <li>
1409 <p>If the pattern starts with <code>./</code>, it is replaced with the directory
1410 containing the current config file.</p>
1411 </li>
1412 <li>
1413 <p>If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1414 will be automatically prepended. For example, the pattern <code>foo/bar</code>
1415 becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.</p>
1416 </li>
1417 <li>
1418 <p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1419 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1420 matches "foo" and everything inside, recursively.</p>
1421 </li>
1422 </ul>
1423 </div>
1424 </dd>
1425 <dt class="hdlist1"><code>gitdir/i</code></dt>
1426 <dd>
1427 <p>This is the same as <code>gitdir</code> except that matching is done
1428 case-insensitively (e.g. on case-insensitive file systems)</p>
1429 </dd>
1430 <dt class="hdlist1"><code>onbranch</code></dt>
1431 <dd>
1432 <p>The data that follows the keyword <code>onbranch:</code> is taken to be a
1433 pattern with standard globbing wildcards and two additional
1434 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components.
1435 If we are in a worktree where the name of the branch that is
1436 currently checked out matches the pattern, the include condition
1437 is met.</p>
1438 <div class="paragraph">
1439 <p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1440 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it matches
1441 all branches that begin with <code>foo/</code>. This is useful if your branches are
1442 organized hierarchically and you would like to apply a configuration to
1443 all the branches in that hierarchy.</p>
1444 </div>
1445 </dd>
1446 <dt class="hdlist1"><code>hasconfig:remote.*.url:</code></dt>
1447 <dd>
1448 <p>The data that follows this keyword is taken to
1449 be a pattern with standard globbing wildcards and two
1450 additional ones, <code>**/</code> and <code>/**</code>, that can match multiple
1451 components. The first time this keyword is seen, the rest of
1452 the config files will be scanned for remote URLs (without
1453 applying any values). If there exists at least one remote URL
1454 that matches this pattern, the include condition is met.</p>
1455 <div class="paragraph">
1456 <p>Files included by this option (directly or indirectly) are not allowed
1457 to contain remote URLs.</p>
1458 </div>
1459 <div class="paragraph">
1460 <p>Note that unlike other includeIf conditions, resolving this condition
1461 relies on information that is not yet known at the point of reading the
1462 condition. A typical use case is this option being present as a
1463 system-level or global-level config, and the remote URL being in a
1464 local-level config; hence the need to scan ahead when resolving this
1465 condition. In order to avoid the chicken-and-egg problem in which
1466 potentially-included files can affect whether such files are potentially
1467 included, Git breaks the cycle by prohibiting these files from affecting
1468 the resolution of these conditions (thus, prohibiting them from
1469 declaring remote URLs).</p>
1470 </div>
1471 <div class="paragraph">
1472 <p>As for the naming of this keyword, it is for forwards compatibility with
1473 a naming scheme that supports more variable-based include conditions,
1474 but currently Git only supports the exact keyword described above.</p>
1475 </div>
1476 </dd>
1477 </dl>
1478 </div>
1479 <div class="paragraph">
1480 <p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p>
1481 </div>
1482 <div class="ulist">
1483 <ul>
1484 <li>
1485 <p>Symlinks in <code>$GIT_DIR</code> are not resolved before matching.</p>
1486 </li>
1487 <li>
1488 <p>Both the symlink &amp; realpath versions of paths will be matched
1489 outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1490 /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1491 will match.</p>
1492 <div class="paragraph">
1493 <p>This was not the case in the initial release of this feature in
1494 v2.13.0, which only matched the realpath version. Configuration that
1495 wants to be compatible with the initial release of this feature needs
1496 to either specify only the realpath version, or both versions.</p>
1497 </div>
1498 </li>
1499 <li>
1500 <p>Note that "../" is not special and will match literally, which is
1501 unlikely what you want.</p>
1502 </li>
1503 </ul>
1504 </div>
1505 </div>
1506 <div class="sect2">
1507 <h3 id="_example">Example</h3>
1508 <div class="listingblock">
1509 <div class="content">
1510 <pre># Core variables
1511 [core]
1512         ; Don't trust file modes
1513         filemode = false
1514
1515 # Our diff algorithm
1516 [diff]
1517         external = /usr/local/bin/diff-wrapper
1518         renames = true
1519
1520 [branch "devel"]
1521         remote = origin
1522         merge = refs/heads/devel
1523
1524 # Proxy settings
1525 [core]
1526         gitProxy="ssh" for "kernel.org"
1527         gitProxy=default-proxy ; for the rest
1528
1529 [include]
1530         path = /path/to/foo.inc ; include by absolute path
1531         path = foo.inc ; find "foo.inc" relative to the current file
1532         path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
1533
1534 ; include if $GIT_DIR is /path/to/foo/.git
1535 [includeIf "gitdir:/path/to/foo/.git"]
1536         path = /path/to/foo.inc
1537
1538 ; include for all repositories inside /path/to/group
1539 [includeIf "gitdir:/path/to/group/"]
1540         path = /path/to/foo.inc
1541
1542 ; include for all repositories inside $HOME/to/group
1543 [includeIf "gitdir:~/to/group/"]
1544         path = /path/to/foo.inc
1545
1546 ; relative paths are always relative to the including
1547 ; file (if the condition is true); their location is not
1548 ; affected by the condition
1549 [includeIf "gitdir:/path/to/group/"]
1550         path = foo.inc
1551
1552 ; include only if we are in a worktree where foo-branch is
1553 ; currently checked out
1554 [includeIf "onbranch:foo-branch"]
1555         path = foo.inc
1556
1557 ; include only if a remote with the given URL exists (note
1558 ; that such a URL may be provided later in a file or in a
1559 ; file read after this file is read, as seen in this example)
1560 [includeIf "hasconfig:remote.*.url:https://example.com/**"]
1561         path = foo.inc
1562 [remote "origin"]
1563         url = https://example.com/git</pre>
1564 </div>
1565 </div>
1566 </div>
1567 <div class="sect2">
1568 <h3 id="_values">Values</h3>
1569 <div class="paragraph">
1570 <p>Values of many variables are treated as a simple string, but there
1571 are variables that take values of specific types and there are rules
1572 as to how to spell them.</p>
1573 </div>
1574 <div class="dlist">
1575 <dl>
1576 <dt class="hdlist1">boolean</dt>
1577 <dd>
1578 <p>When a variable is said to take a boolean value, many
1579 synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1580 case-insensitive.</p>
1581 <div class="dlist">
1582 <dl>
1583 <dt class="hdlist1">true</dt>
1584 <dd>
1585 <p>Boolean true literals are <code>yes</code>, <code>on</code>, <code>true</code>,
1586 and <code>1</code>.  Also, a variable defined without <code>= &lt;value&gt;</code>
1587 is taken as true.</p>
1588 </dd>
1589 <dt class="hdlist1">false</dt>
1590 <dd>
1591 <p>Boolean false literals are <code>no</code>, <code>off</code>, <code>false</code>,
1592 <code>0</code> and the empty string.</p>
1593 <div class="paragraph">
1594 <p>When converting a value to its canonical form using the <code>--type=bool</code> type
1595 specifier, <em>git config</em> will ensure that the output is "true" or
1596 "false" (spelled in lowercase).</p>
1597 </div>
1598 </dd>
1599 </dl>
1600 </div>
1601 </dd>
1602 <dt class="hdlist1">integer</dt>
1603 <dd>
1604 <p>The value for many variables that specify various sizes can
1605 be suffixed with <code>k</code>, <code>M</code>,&#8230;&#8203; to mean "scale the number by
1606 1024", "by 1024x1024", etc.</p>
1607 </dd>
1608 <dt class="hdlist1">color</dt>
1609 <dd>
1610 <p>The value for a variable that takes a color is a list of
1611 colors (at most two, one for foreground and one for background)
1612 and attributes (as many as you want), separated by spaces.</p>
1613 <div class="paragraph">
1614 <p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>,
1615 <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code> and <code>default</code>.  The first
1616 color given is the foreground; the second is the background.  All the
1617 basic colors except <code>normal</code> and <code>default</code> have a bright variant that can
1618 be specified by prefixing the color with <code>bright</code>, like <code>brightred</code>.</p>
1619 </div>
1620 <div class="paragraph">
1621 <p>The color <code>normal</code> makes no change to the color. It is the same as an
1622 empty string, but can be used as the foreground color when specifying a
1623 background color alone (for example, "normal red").</p>
1624 </div>
1625 <div class="paragraph">
1626 <p>The color <code>default</code> explicitly resets the color to the terminal default,
1627 for example to specify a cleared background. Although it varies between
1628 terminals, this is usually not the same as setting to "white black".</p>
1629 </div>
1630 <div class="paragraph">
1631 <p>Colors may also be given as numbers between 0 and 255; these use ANSI
1632 256-color mode (but note that not all terminals may support this).  If
1633 your terminal supports it, you may also specify 24-bit RGB values as
1634 hex, like <code>#ff0ab3</code>, or 12-bit RGB values like <code>#f1b</code>, which is
1635 equivalent to the 24-bit color <code>#ff11bb</code>.</p>
1636 </div>
1637 <div class="paragraph">
1638 <p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
1639 <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
1640 The position of any attributes with respect to the colors
1641 (before, after, or in between), doesn&#8217;t matter. Specific attributes may
1642 be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
1643 <code>no-ul</code>, etc).</p>
1644 </div>
1645 <div class="paragraph">
1646 <p>The pseudo-attribute <code>reset</code> resets all colors and attributes before
1647 applying the specified coloring. For example, <code>reset green</code> will result
1648 in a green foreground and default background without any active
1649 attributes.</p>
1650 </div>
1651 <div class="paragraph">
1652 <p>An empty color string produces no color effect at all. This can be used
1653 to avoid coloring specific elements without disabling color entirely.</p>
1654 </div>
1655 <div class="paragraph">
1656 <p>For git&#8217;s pre-defined color slots, the attributes are meant to be reset
1657 at the beginning of each item in the colored output. So setting
1658 <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
1659 plain <code>black</code>, even if the previous thing on the same output line (e.g.
1660 opening parenthesis before the list of branch names in <code>log --decorate</code>
1661 output) is set to be painted with <code>bold</code> or some other attribute.
1662 However, custom log formats may do more complicated and layered
1663 coloring, and the negated forms may be useful there.</p>
1664 </div>
1665 </dd>
1666 <dt class="hdlist1">pathname</dt>
1667 <dd>
1668 <p>A variable that takes a pathname value can be given a
1669 string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual
1670 tilde expansion happens to such a string: <code>~/</code>
1671 is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
1672 specified user&#8217;s home directory.</p>
1673 <div class="paragraph">
1674 <p>If a path starts with <code>%(prefix)/</code>, the remainder is interpreted as a
1675 path relative to Git&#8217;s "runtime prefix", i.e. relative to the location
1676 where Git itself was installed. For example, <code>%(prefix)/bin/</code> refers to
1677 the directory in which the Git executable itself lives. If Git was
1678 compiled without runtime prefix support, the compiled-in prefix will be
1679 substituted instead. In the unlikely event that a literal path needs to
1680 be specified that should <em>not</em> be expanded, it needs to be prefixed by
1681 <code>./</code>, like so: <code>./%(prefix)/bin</code>.</p>
1682 </div>
1683 </dd>
1684 </dl>
1685 </div>
1686 </div>
1687 <div class="sect2">
1688 <h3 id="_variables">Variables</h3>
1689 <div class="paragraph">
1690 <p>Note that this list is non-comprehensive and not necessarily complete.
1691 For command-specific variables, you will find a more detailed description
1692 in the appropriate manual page.</p>
1693 </div>
1694 <div class="paragraph">
1695 <p>Other git-related tools may and do use their own variables.  When
1696 inventing new variables for use in your own tool, make sure their
1697 names do not conflict with those that are used by Git itself and
1698 other popular tools, and describe them in your documentation.</p>
1699 </div>
1700 <div class="dlist">
1701 <dl>
1702 <dt class="hdlist1">add.ignoreErrors</dt>
1703 <dt class="hdlist1">add.ignore-errors (deprecated)</dt>
1704 <dd>
1705 <p>Tells <em>git add</em> to continue adding files when some files cannot be
1706 added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
1707 option of <a href="git-add.html">git-add(1)</a>.  <code>add.ignore-errors</code> is deprecated,
1708 as it does not follow the usual naming convention for configuration
1709 variables.</p>
1710 </dd>
1711 <dt class="hdlist1">advice.*</dt>
1712 <dd>
1713 <p>These variables control various optional help messages designed to
1714 aid new users.  When left unconfigured, Git will give the message
1715 alongside instructions on how to squelch it.  You can tell Git
1716 that you do not need the help message by setting these to <code>false</code>:</p>
1717 <div class="openblock">
1718 <div class="content">
1719 <div class="dlist">
1720 <dl>
1721 <dt class="hdlist1">addEmbeddedRepo</dt>
1722 <dd>
1723 <p>Shown when the user accidentally adds one
1724 git repo inside of another.</p>
1725 </dd>
1726 <dt class="hdlist1">addEmptyPathspec</dt>
1727 <dd>
1728 <p>Shown when the user runs <code>git add</code> without providing
1729 the pathspec parameter.</p>
1730 </dd>
1731 <dt class="hdlist1">addIgnoredFile</dt>
1732 <dd>
1733 <p>Shown when the user attempts to add an ignored file to
1734 the index.</p>
1735 </dd>
1736 <dt class="hdlist1">amWorkDir</dt>
1737 <dd>
1738 <p>Shown when <a href="git-am.html">git-am(1)</a> fails to apply a patch
1739 file, to tell the user the location of the file.</p>
1740 </dd>
1741 <dt class="hdlist1">ambiguousFetchRefspec</dt>
1742 <dd>
1743 <p>Shown when a fetch refspec for multiple remotes maps to
1744 the same remote-tracking branch namespace and causes branch
1745 tracking set-up to fail.</p>
1746 </dd>
1747 <dt class="hdlist1">checkoutAmbiguousRemoteBranchName</dt>
1748 <dd>
1749 <p>Shown when the argument to
1750 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
1751 ambiguously resolves to a
1752 remote tracking branch on more than one remote in
1753 situations where an unambiguous argument would have
1754 otherwise caused a remote-tracking branch to be
1755 checked out. See the <code>checkout.defaultRemote</code>
1756 configuration variable for how to set a given remote
1757 to be used by default in some situations where this
1758 advice would be printed.</p>
1759 </dd>
1760 <dt class="hdlist1">commitBeforeMerge</dt>
1761 <dd>
1762 <p>Shown when <a href="git-merge.html">git-merge(1)</a> refuses to
1763 merge to avoid overwriting local changes.</p>
1764 </dd>
1765 <dt class="hdlist1">detachedHead</dt>
1766 <dd>
1767 <p>Shown when the user uses
1768 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
1769 to move to the detached HEAD state, to tell the user how
1770 to create a local branch after the fact.</p>
1771 </dd>
1772 <dt class="hdlist1">diverging</dt>
1773 <dd>
1774 <p>Shown when a fast-forward is not possible.</p>
1775 </dd>
1776 <dt class="hdlist1">fetchShowForcedUpdates</dt>
1777 <dd>
1778 <p>Shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
1779 to calculate forced updates after ref updates, or to warn
1780 that the check is disabled.</p>
1781 </dd>
1782 <dt class="hdlist1">forceDeleteBranch</dt>
1783 <dd>
1784 <p>Shown when the user tries to delete a not fully merged
1785 branch without the force option set.</p>
1786 </dd>
1787 <dt class="hdlist1">ignoredHook</dt>
1788 <dd>
1789 <p>Shown when a hook is ignored because the hook is not
1790 set as executable.</p>
1791 </dd>
1792 <dt class="hdlist1">implicitIdentity</dt>
1793 <dd>
1794 <p>Shown when the user&#8217;s information is guessed from the
1795 system username and domain name, to tell the user how to
1796 set their identity configuration.</p>
1797 </dd>
1798 <dt class="hdlist1">mergeConflict</dt>
1799 <dd>
1800 <p>Shown when various commands stop because of conflicts.</p>
1801 </dd>
1802 <dt class="hdlist1">nestedTag</dt>
1803 <dd>
1804 <p>Shown when a user attempts to recursively tag a tag object.</p>
1805 </dd>
1806 <dt class="hdlist1">pushAlreadyExists</dt>
1807 <dd>
1808 <p>Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
1809 does not qualify for fast-forwarding (e.g., a tag.)</p>
1810 </dd>
1811 <dt class="hdlist1">pushFetchFirst</dt>
1812 <dd>
1813 <p>Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
1814 tries to overwrite a remote ref that points at an
1815 object we do not have.</p>
1816 </dd>
1817 <dt class="hdlist1">pushNeedsForce</dt>
1818 <dd>
1819 <p>Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
1820 tries to overwrite a remote ref that points at an
1821 object that is not a commit-ish, or make the remote
1822 ref point at an object that is not a commit-ish.</p>
1823 </dd>
1824 <dt class="hdlist1">pushNonFFCurrent</dt>
1825 <dd>
1826 <p>Shown when <a href="git-push.html">git-push(1)</a> fails due to a
1827 non-fast-forward update to the current branch.</p>
1828 </dd>
1829 <dt class="hdlist1">pushNonFFMatching</dt>
1830 <dd>
1831 <p>Shown when the user ran <a href="git-push.html">git-push(1)</a> and pushed
1832 "matching refs" explicitly (i.e. used <code>:</code>, or
1833 specified a refspec that isn&#8217;t the current branch) and
1834 it resulted in a non-fast-forward error.</p>
1835 </dd>
1836 <dt class="hdlist1">pushRefNeedsUpdate</dt>
1837 <dd>
1838 <p>Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
1839 a branch when its remote-tracking ref has updates that we
1840 do not have locally.</p>
1841 </dd>
1842 <dt class="hdlist1">pushUnqualifiedRefname</dt>
1843 <dd>
1844 <p>Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
1845 guess based on the source and destination refs what
1846 remote ref namespace the source belongs in, but where
1847 we can still suggest that the user push to either
1848 <code>refs/heads/*</code> or <code>refs/tags/*</code> based on the type of the
1849 source object.</p>
1850 </dd>
1851 <dt class="hdlist1">pushUpdateRejected</dt>
1852 <dd>
1853 <p>Set this variable to <code>false</code> if you want to disable
1854 <code>pushNonFFCurrent</code>, <code>pushNonFFMatching</code>, <code>pushAlreadyExists</code>,
1855 <code>pushFetchFirst</code>, <code>pushNeedsForce</code>, and <code>pushRefNeedsUpdate</code>
1856 simultaneously.</p>
1857 </dd>
1858 <dt class="hdlist1">rebaseTodoError</dt>
1859 <dd>
1860 <p>Shown when there is an error after editing the rebase todo list.</p>
1861 </dd>
1862 <dt class="hdlist1">refSyntax</dt>
1863 <dd>
1864 <p>Shown when the user provides an illegal ref name, to
1865 tell the user about the ref syntax documentation.</p>
1866 </dd>
1867 <dt class="hdlist1">resetNoRefresh</dt>
1868 <dd>
1869 <p>Shown when <a href="git-reset.html">git-reset(1)</a> takes more than 2
1870 seconds to refresh the index after reset, to tell the user
1871 that they can use the <code>--no-refresh</code> option.</p>
1872 </dd>
1873 <dt class="hdlist1">resolveConflict</dt>
1874 <dd>
1875 <p>Shown by various commands when conflicts
1876 prevent the operation from being performed.</p>
1877 </dd>
1878 <dt class="hdlist1">rmHints</dt>
1879 <dd>
1880 <p>Shown on failure in the output of <a href="git-rm.html">git-rm(1)</a>, to
1881 give directions on how to proceed from the current state.</p>
1882 </dd>
1883 <dt class="hdlist1">sequencerInUse</dt>
1884 <dd>
1885 <p>Shown when a sequencer command is already in progress.</p>
1886 </dd>
1887 <dt class="hdlist1">skippedCherryPicks</dt>
1888 <dd>
1889 <p>Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
1890 been cherry-picked onto the upstream branch.</p>
1891 </dd>
1892 <dt class="hdlist1">sparseIndexExpanded</dt>
1893 <dd>
1894 <p>Shown when a sparse index is expanded to a full index, which is likely
1895 due to an unexpected set of files existing outside of the
1896 sparse-checkout.</p>
1897 </dd>
1898 <dt class="hdlist1">statusAheadBehind</dt>
1899 <dd>
1900 <p>Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
1901 counts for a local ref compared to its remote tracking ref,
1902 and that calculation takes longer than expected. Will not
1903 appear if <code>status.aheadBehind</code> is false or the option
1904 <code>--no-ahead-behind</code> is given.</p>
1905 </dd>
1906 <dt class="hdlist1">statusHints</dt>
1907 <dd>
1908 <p>Show directions on how to proceed from the current
1909 state in the output of <a href="git-status.html">git-status(1)</a>, in
1910 the template shown when writing commit messages in
1911 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
1912 by <a href="git-switch.html">git-switch(1)</a> or
1913 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.</p>
1914 </dd>
1915 <dt class="hdlist1">statusUoption</dt>
1916 <dd>
1917 <p>Shown when <a href="git-status.html">git-status(1)</a> takes more than 2
1918 seconds to enumerate untracked files, to tell the user that
1919 they can use the <code>-u</code> option.</p>
1920 </dd>
1921 <dt class="hdlist1">submoduleAlternateErrorStrategyDie</dt>
1922 <dd>
1923 <p>Shown when a submodule.alternateErrorStrategy option
1924 configured to "die" causes a fatal error.</p>
1925 </dd>
1926 <dt class="hdlist1">submoduleMergeConflict</dt>
1927 <dd>
1928 <p>Advice shown when a non-trivial submodule merge conflict is
1929 encountered.</p>
1930 </dd>
1931 <dt class="hdlist1">submodulesNotUpdated</dt>
1932 <dd>
1933 <p>Shown when a user runs a submodule command that fails
1934 because <code>git submodule update --init</code> was not run.</p>
1935 </dd>
1936 <dt class="hdlist1">suggestDetachingHead</dt>
1937 <dd>
1938 <p>Shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
1939 without the explicit <code>--detach</code> option.</p>
1940 </dd>
1941 <dt class="hdlist1">updateSparsePath</dt>
1942 <dd>
1943 <p>Shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
1944 is asked to update index entries outside the current sparse
1945 checkout.</p>
1946 </dd>
1947 <dt class="hdlist1">waitingForEditor</dt>
1948 <dd>
1949 <p>Shown when Git is waiting for editor input. Relevant
1950 when e.g. the editor is not launched inside the terminal.</p>
1951 </dd>
1952 <dt class="hdlist1">worktreeAddOrphan</dt>
1953 <dd>
1954 <p>Shown when the user tries to create a worktree from an
1955 invalid reference, to tell the user how to create a new unborn
1956 branch instead.</p>
1957 </dd>
1958 </dl>
1959 </div>
1960 </div>
1961 </div>
1962 </dd>
1963 <dt class="hdlist1">alias.*</dt>
1964 <dd>
1965 <p>Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
1966 after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
1967 <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
1968 confusion and troubles with script usage, aliases that
1969 hide existing Git commands are ignored. Arguments are split by
1970 spaces, the usual shell quoting and escaping are supported.
1971 A quote pair or a backslash can be used to quote them.</p>
1972 <div class="paragraph">
1973 <p>Note that the first word of an alias does not necessarily have to be a
1974 command. It can be a command-line option that will be passed into the
1975 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
1976 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
1977 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
1978 running <code>git loud-rebase</code> would be equivalent to
1979 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
1980 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
1981 where the original command does not.</p>
1982 </div>
1983 <div class="paragraph">
1984 <p>If the alias expansion is prefixed with an exclamation point,
1985 it will be treated as a shell command.  For example, defining
1986 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
1987 <code>git new</code> is equivalent to running the shell command
1988 <code>gitk --all --not ORIG_HEAD</code>.  Note:</p>
1989 </div>
1990 <div class="ulist">
1991 <ul>
1992 <li>
1993 <p>Shell commands will be executed from the top-level directory of a
1994 repository, which may not necessarily be the current directory.</p>
1995 </li>
1996 <li>
1997 <p><code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
1998 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p>
1999 </li>
2000 <li>
2001 <p>Shell command aliases always receive any extra arguments provided to
2002 the Git command-line as positional arguments.</p>
2003 <div class="ulist">
2004 <ul>
2005 <li>
2006 <p>Care should be taken if your shell alias is a "one-liner" script
2007 with multiple commands (e.g. in a pipeline), references multiple
2008 arguments, or is otherwise not able to handle positional arguments
2009 added at the end.  For example: <code>alias.cmd = "!echo $1 | grep $2"</code>
2010 called as <code>git cmd 1 2</code> will be executed as <em>echo $1 | grep $2
2011 1 2</em>, which is not what you want.</p>
2012 </li>
2013 <li>
2014 <p>A convenient way to deal with this is to write your script
2015 operations in an inline function that is then called with any
2016 arguments from the command-line.  For example `alias.cmd = "!c() {
2017 echo $1 | grep $2 ; }; c" will correctly execute the prior example.</p>
2018 </li>
2019 <li>
2020 <p>Setting <code>GIT_TRACE=1</code> can help you debug the command being run for
2021 your alias.</p>
2022 </li>
2023 </ul>
2024 </div>
2025 </li>
2026 </ul>
2027 </div>
2028 </dd>
2029 <dt class="hdlist1">am.keepcr</dt>
2030 <dd>
2031 <p>If true, git-am will call git-mailsplit for patches in mbox format
2032 with parameter <code>--keep-cr</code>. In this case git-mailsplit will
2033 not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
2034 by giving <code>--no-keep-cr</code> from the command line.
2035 See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.</p>
2036 </dd>
2037 <dt class="hdlist1">am.threeWay</dt>
2038 <dd>
2039 <p>By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2040 set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2041 the patch records the identity of blobs it is supposed to apply to and
2042 we have those blobs available locally (equivalent to giving the <code>--3way</code>
2043 option from the command line). Defaults to <code>false</code>.
2044 See <a href="git-am.html">git-am(1)</a>.</p>
2045 </dd>
2046 <dt class="hdlist1">apply.ignoreWhitespace</dt>
2047 <dd>
2048 <p>When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
2049 whitespace, in the same way as the <code>--ignore-space-change</code>
2050 option.
2051 When set to one of: no, none, never, false, it tells <em>git apply</em> to
2052 respect all whitespace differences.
2053 See <a href="git-apply.html">git-apply(1)</a>.</p>
2054 </dd>
2055 <dt class="hdlist1">apply.whitespace</dt>
2056 <dd>
2057 <p>Tells <em>git apply</em> how to handle whitespace, in the same way
2058 as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.</p>
2059 </dd>
2060 <dt class="hdlist1">attr.tree</dt>
2061 <dd>
2062 <p>A reference to a tree in the repository from which to read attributes,
2063 instead of the <code>.gitattributes</code> file in the working tree. If the value
2064 does not resolve to a valid tree object, an empty tree is used instead.
2065 When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2066 command line option are used, this configuration variable has no effect.</p>
2067 </dd>
2068 </dl>
2069 </div>
2070 <div class="admonitionblock note">
2071 <table>
2072 <tr>
2073 <td class="icon">
2074 <div class="title">Note</div>
2075 </td>
2076 <td class="content">
2077 The configuration options in <code>bitmapPseudoMerge.*</code> are considered
2078 EXPERIMENTAL and may be subject to change or be removed entirely in the
2079 future. For more information about the pseudo-merge bitmap feature, see
2080 the "Pseudo-merge bitmaps" section of <a href="gitpacking.html">gitpacking(7)</a>.
2081 </td>
2082 </tr>
2083 </table>
2084 </div>
2085 <div class="dlist">
2086 <dl>
2087 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.pattern</dt>
2088 <dd>
2089 <p>Regular expression used to match reference names. Commits
2090 pointed to by references matching this pattern (and meeting
2091 the below criteria, like <code>bitmapPseudoMerge.&lt;name&gt;.sampleRate</code>
2092 and <code>bitmapPseudoMerge.&lt;name&gt;.threshold</code>) will be considered
2093 for inclusion in a pseudo-merge bitmap.</p>
2094 <div class="paragraph">
2095 <p>Commits are grouped into pseudo-merge groups based on whether or not
2096 any reference(s) that point at a given commit match the pattern, which
2097 is an extended regular expression.</p>
2098 </div>
2099 <div class="paragraph">
2100 <p>Within a pseudo-merge group, commits may be further grouped into
2101 sub-groups based on the capture groups in the pattern. These
2102 sub-groupings are formed from the regular expressions by concatenating
2103 any capture groups from the regular expression, with a <em>-</em> dash in
2104 between.</p>
2105 </div>
2106 <div class="paragraph">
2107 <p>For example, if the pattern is <code>refs/tags/</code>, then all tags (provided
2108 they meet the below criteria) will be considered candidates for the
2109 same pseudo-merge group. However, if the pattern is instead
2110 <code>refs/remotes/([0-9])+/tags/</code>, then tags from different remotes will
2111 be grouped into separate pseudo-merge groups, based on the remote
2112 number.</p>
2113 </div>
2114 </dd>
2115 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.decay</dt>
2116 <dd>
2117 <p>Determines the rate at which consecutive pseudo-merge bitmap
2118 groups decrease in size. Must be non-negative. This parameter
2119 can be thought of as <code>k</code> in the function <code>f(n) = C * n^-k</code>,
2120 where <code>f(n)</code> is the size of the `n`th group.</p>
2121 <div class="paragraph">
2122 <p>Setting the decay rate equal to <code>0</code> will cause all groups to be the
2123 same size. Setting the decay rate equal to <code>1</code> will cause the <code>n`th
2124 group to be `1/n</code> the size of the initial group.  Higher values of the
2125 decay rate cause consecutive groups to shrink at an increasing rate.
2126 The default is <code>1</code>.</p>
2127 </div>
2128 <div class="paragraph">
2129 <p>If all groups are the same size, it is possible that groups containing
2130 newer commits will be able to be used less often than earlier groups,
2131 since it is more likely that the references pointing at newer commits
2132 will be updated more often than a reference pointing at an old commit.</p>
2133 </div>
2134 </dd>
2135 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.sampleRate</dt>
2136 <dd>
2137 <p>Determines the proportion of non-bitmapped commits (among
2138 reference tips) which are selected for inclusion in an
2139 unstable pseudo-merge bitmap. Must be between <code>0</code> and <code>1</code>
2140 (inclusive). The default is <code>1</code>.</p>
2141 </dd>
2142 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.threshold</dt>
2143 <dd>
2144 <p>Determines the minimum age of non-bitmapped commits (among
2145 reference tips, as above) which are candidates for inclusion
2146 in an unstable pseudo-merge bitmap. The default is
2147 <code>1.week.ago</code>.</p>
2148 </dd>
2149 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.maxMerges</dt>
2150 <dd>
2151 <p>Determines the maximum number of pseudo-merge commits among
2152 which commits may be distributed.</p>
2153 <div class="paragraph">
2154 <p>For pseudo-merge groups whose pattern does not contain any capture
2155 groups, this setting is applied for all commits matching the regular
2156 expression. For patterns that have one or more capture groups, this
2157 setting is applied for each distinct capture group.</p>
2158 </div>
2159 <div class="paragraph">
2160 <p>For example, if your capture group is <code>refs/tags/</code>, then this setting
2161 will distribute all tags into a maximum of <code>maxMerges</code> pseudo-merge
2162 commits. However, if your capture group is, say,
2163 <code>refs/remotes/([0-9]+)/tags/</code>, then this setting will be applied to
2164 each remote&#8217;s set of tags individually.</p>
2165 </div>
2166 <div class="paragraph">
2167 <p>Must be non-negative. The default value is 64.</p>
2168 </div>
2169 </dd>
2170 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.stableThreshold</dt>
2171 <dd>
2172 <p>Determines the minimum age of commits (among reference tips,
2173 as above, however stable commits are still considered
2174 candidates even when they have been covered by a bitmap) which
2175 are candidates for a stable a pseudo-merge bitmap. The default
2176 is <code>1.month.ago</code>.</p>
2177 <div class="paragraph">
2178 <p>Setting this threshold to a smaller value (e.g., 1.week.ago) will cause
2179 more stable groups to be generated (which impose a one-time generation
2180 cost) but those groups will likely become stale over time. Using a
2181 larger value incurs the opposite penalty (fewer stable groups which are
2182 more useful).</p>
2183 </div>
2184 </dd>
2185 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.stableSize</dt>
2186 <dd>
2187 <p>Determines the size (in number of commits) of a stable
2188 psuedo-merge bitmap. The default is <code>512</code>.</p>
2189 </dd>
2190 <dt class="hdlist1">blame.blankBoundary</dt>
2191 <dd>
2192 <p>Show blank commit object name for boundary commits in
2193 <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.</p>
2194 </dd>
2195 <dt class="hdlist1">blame.coloring</dt>
2196 <dd>
2197 <p>This determines the coloring scheme to be applied to blame
2198 output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
2199 or <em>none</em> which is the default.</p>
2200 </dd>
2201 <dt class="hdlist1">blame.date</dt>
2202 <dd>
2203 <p>Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
2204 If unset the iso format is used. For supported values,
2205 see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.</p>
2206 </dd>
2207 <dt class="hdlist1">blame.showEmail</dt>
2208 <dd>
2209 <p>Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
2210 This option defaults to false.</p>
2211 </dd>
2212 <dt class="hdlist1">blame.showRoot</dt>
2213 <dd>
2214 <p>Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
2215 This option defaults to false.</p>
2216 </dd>
2217 <dt class="hdlist1">blame.ignoreRevsFile</dt>
2218 <dd>
2219 <p>Ignore revisions listed in the file, one unabbreviated object name per
2220 line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
2221 <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
2222 file names will reset the list of ignored revisions.  This option will
2223 be handled before the command line option <code>--ignore-revs-file</code>.</p>
2224 </dd>
2225 <dt class="hdlist1">blame.markUnblamableLines</dt>
2226 <dd>
2227 <p>Mark lines that were changed by an ignored revision that we could not
2228 attribute to another commit with a <em>*</em> in the output of
2229 <a href="git-blame.html">git-blame(1)</a>.</p>
2230 </dd>
2231 <dt class="hdlist1">blame.markIgnoredLines</dt>
2232 <dd>
2233 <p>Mark lines that were changed by an ignored revision that we attributed to
2234 another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.</p>
2235 </dd>
2236 <dt class="hdlist1">branch.autoSetupMerge</dt>
2237 <dd>
2238 <p>Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
2239 so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
2240 starting point branch. Note that even if this option is not set,
2241 this behavior can be chosen per-branch using the <code>--track</code>
2242 and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
2243 automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
2244 starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;automatic setup is done when the starting point is either a
2245 local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
2246 has a tracking configuration, it is copied to the new
2247 branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
2248 is a remote-tracking branch and the new branch has the same name as the
2249 remote branch. This option defaults to true.</p>
2250 </dd>
2251 <dt class="hdlist1">branch.autoSetupRebase</dt>
2252 <dd>
2253 <p>When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
2254 that tracks another branch, this variable tells Git to set
2255 up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
2256 When <code>never</code>, rebase is never automatically set to true.
2257 When <code>local</code>, rebase is set to true for tracked branches of
2258 other local branches.
2259 When <code>remote</code>, rebase is set to true for tracked branches of
2260 remote-tracking branches.
2261 When <code>always</code>, rebase will be set to true for all tracking
2262 branches.
2263 See "branch.autoSetupMerge" for details on how to set up a
2264 branch to track another branch.
2265 This option defaults to never.</p>
2266 </dd>
2267 <dt class="hdlist1">branch.sort</dt>
2268 <dd>
2269 <p>This variable controls the sort ordering of branches when displayed by
2270 <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
2271 value of this variable will be used as the default.
2272 See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.</p>
2273 </dd>
2274 <dt class="hdlist1">branch.&lt;name&gt;.remote</dt>
2275 <dd>
2276 <p>When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
2277 which remote to fetch from or push to.  The remote to push to
2278 may be overridden with <code>remote.pushDefault</code> (for all branches).
2279 The remote to push to, for the current branch, may be further
2280 overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
2281 configured, or if you are not on any branch and there is more than
2282 one remote defined in the repository, it defaults to <code>origin</code> for
2283 fetching and <code>remote.pushDefault</code> for pushing.
2284 Additionally, <code>.</code> (a period) is the current local repository
2285 (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.</p>
2286 </dd>
2287 <dt class="hdlist1">branch.&lt;name&gt;.pushRemote</dt>
2288 <dd>
2289 <p>When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
2290 pushing.  It also overrides <code>remote.pushDefault</code> for pushing
2291 from branch &lt;name&gt;.  When you pull from one place (e.g. your
2292 upstream) and push to another place (e.g. your own publishing
2293 repository), you would want to set <code>remote.pushDefault</code> to
2294 specify the remote to push to for all branches, and use this
2295 option to override it for a specific branch.</p>
2296 </dd>
2297 <dt class="hdlist1">branch.&lt;name&gt;.merge</dt>
2298 <dd>
2299 <p>Defines, together with branch.&lt;name&gt;.remote, the upstream branch
2300 for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
2301 branch to merge and can also affect <em>git push</em> (see push.default).
2302 When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
2303 refspec to be marked for merging in FETCH_HEAD. The value is
2304 handled like the remote part of a refspec, and must match a
2305 ref which is fetched from the remote given by
2306 "branch.&lt;name&gt;.remote".
2307 The merge information is used by <em>git pull</em> (which first calls
2308 <em>git fetch</em>) to lookup the default branch for merging. Without
2309 this option, <em>git pull</em> defaults to merge the first refspec fetched.
2310 Specify multiple values to get an octopus merge.
2311 If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
2312 another branch in the local repository, you can point
2313 branch.&lt;name&gt;.merge to the desired branch, and use the relative path
2314 setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.</p>
2315 </dd>
2316 <dt class="hdlist1">branch.&lt;name&gt;.mergeOptions</dt>
2317 <dd>
2318 <p>Sets default options for merging into branch &lt;name&gt;. The syntax and
2319 supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
2320 option values containing whitespace characters are currently not
2321 supported.</p>
2322 </dd>
2323 <dt class="hdlist1">branch.&lt;name&gt;.rebase</dt>
2324 <dd>
2325 <p>When true, rebase the branch &lt;name&gt; on top of the fetched branch,
2326 instead of merging the default branch from the default remote when
2327 "git pull" is run. See "pull.rebase" for doing this in a non
2328 branch-specific manner.</p>
2329 <div class="paragraph">
2330 <p>When <code>merges</code> (or just <em>m</em>), pass the <code>--rebase-merges</code> option to <em>git rebase</em>
2331 so that the local merge commits are included in the rebase (see
2332 <a href="git-rebase.html">git-rebase(1)</a> for details).</p>
2333 </div>
2334 <div class="paragraph">
2335 <p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
2336 mode.</p>
2337 </div>
2338 <div class="paragraph">
2339 <p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
2340 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
2341 for details).</p>
2342 </div>
2343 </dd>
2344 <dt class="hdlist1">branch.&lt;name&gt;.description</dt>
2345 <dd>
2346 <p>Branch description, can be edited with
2347 <code>git branch --edit-description</code>. Branch description is
2348 automatically added to the format-patch cover letter or
2349 request-pull summary.</p>
2350 </dd>
2351 <dt class="hdlist1">browser.&lt;tool&gt;.cmd</dt>
2352 <dd>
2353 <p>Specify the command to invoke the specified browser. The
2354 specified command is evaluated in shell with the URLs passed
2355 as arguments. (See <a href="git-web&#x2d;&#x2d;browse.html">git-web&#x2d;&#x2d;browse(1)</a>.)</p>
2356 </dd>
2357 <dt class="hdlist1">browser.&lt;tool&gt;.path</dt>
2358 <dd>
2359 <p>Override the path for the given tool that may be used to
2360 browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
2361 working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).</p>
2362 </dd>
2363 <dt class="hdlist1">bundle.*</dt>
2364 <dd>
2365 <p>The <code>bundle.*</code> keys may appear in a bundle list file found via the
2366 <code>git clone --bundle-uri</code> option. These keys currently have no effect
2367 if placed in a repository config file, though this will change in the
2368 future. See <a href="technical/bundle-uri.html">the bundle URI design
2369 document</a> for more details.</p>
2370 </dd>
2371 <dt class="hdlist1">bundle.version</dt>
2372 <dd>
2373 <p>This integer value advertises the version of the bundle list format
2374 used by the bundle list. Currently, the only accepted value is <code>1</code>.</p>
2375 </dd>
2376 <dt class="hdlist1">bundle.mode</dt>
2377 <dd>
2378 <p>This string value should be either <code>all</code> or <code>any</code>. This value describes
2379 whether all of the advertised bundles are required to unbundle a
2380 complete understanding of the bundled information (<code>all</code>) or if any one
2381 of the listed bundle URIs is sufficient (<code>any</code>).</p>
2382 </dd>
2383 <dt class="hdlist1">bundle.heuristic</dt>
2384 <dd>
2385 <p>If this string-valued key exists, then the bundle list is designed to
2386 work well with incremental <code>git fetch</code> commands. The heuristic signals
2387 that there are additional keys available for each bundle that help
2388 determine which subset of bundles the client should download. The
2389 only value currently understood is <code>creationToken</code>.</p>
2390 </dd>
2391 <dt class="hdlist1">bundle.&lt;id&gt;.*</dt>
2392 <dd>
2393 <p>The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
2394 bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.</p>
2395 </dd>
2396 <dt class="hdlist1">bundle.&lt;id&gt;.uri</dt>
2397 <dd>
2398 <p>This string value defines the URI by which Git can reach the contents
2399 of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.</p>
2400 </dd>
2401 <dt class="hdlist1">checkout.defaultRemote</dt>
2402 <dd>
2403 <p>When you run <code>git checkout &lt;something&gt;</code>
2404 or <code>git switch &lt;something&gt;</code> and only have one
2405 remote, it may implicitly fall back on checking out and
2406 tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
2407 as you have more than one remote with a <code>&lt;something&gt;</code>
2408 reference. This setting allows for setting the name of a
2409 preferred remote that should always win when it comes to
2410 disambiguation. The typical use-case is to set this to
2411 <code>origin</code>.</p>
2412 <div class="paragraph">
2413 <p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
2414 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
2415 or <code>git switch &lt;something&gt;</code>
2416 will checkout the <code>&lt;something&gt;</code> branch on another remote,
2417 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
2418 remote branch. This setting might be used for other checkout-like
2419 commands or functionality in the future.</p>
2420 </div>
2421 </dd>
2422 <dt class="hdlist1">checkout.guess</dt>
2423 <dd>
2424 <p>Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
2425 option in <code>git checkout</code> and <code>git switch</code>. See
2426 <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.</p>
2427 </dd>
2428 <dt class="hdlist1">checkout.workers</dt>
2429 <dd>
2430 <p>The number of parallel workers to use when updating the working tree.
2431 The default is one, i.e. sequential execution. If set to a value less
2432 than one, Git will use as many workers as the number of logical cores
2433 available. This setting and <code>checkout.thresholdForParallelism</code> affect
2434 all commands that perform checkout. E.g. checkout, clone, reset,
2435 sparse-checkout, etc.</p>
2436 <div class="paragraph">
2437 <p>Note: Parallel checkout usually delivers better performance for repositories
2438 located on SSDs or over NFS. For repositories on spinning disks and/or machines
2439 with a small number of cores, the default sequential checkout often performs
2440 better. The size and compression level of a repository might also influence how
2441 well the parallel version performs.</p>
2442 </div>
2443 </dd>
2444 <dt class="hdlist1">checkout.thresholdForParallelism</dt>
2445 <dd>
2446 <p>When running parallel checkout with a small number of files, the cost
2447 of subprocess spawning and inter-process communication might outweigh
2448 the parallelization gains. This setting allows you to define the minimum
2449 number of files for which parallel checkout should be attempted. The
2450 default is 100.</p>
2451 </dd>
2452 <dt class="hdlist1">clean.requireForce</dt>
2453 <dd>
2454 <p>A boolean to make git-clean refuse to delete files unless -f
2455 is given. Defaults to true.</p>
2456 </dd>
2457 <dt class="hdlist1"><code>clone.defaultRemoteName</code></dt>
2458 <dd>
2459 <p>The name of the remote to create when cloning a repository.  Defaults to
2460 <code>origin</code>.
2461 It can be overridden by passing the <code>--origin</code> command-line
2462 option to <a href="git-clone.html">git-clone(1)</a>.</p>
2463 </dd>
2464 <dt class="hdlist1"><code>clone.rejectShallow</code></dt>
2465 <dd>
2466 <p>Reject cloning a repository if it is a shallow one; this can be overridden by
2467 passing the <code>--reject-shallow</code> option on the command line.
2468 See <a href="git-clone.html">git-clone(1)</a>.</p>
2469 </dd>
2470 <dt class="hdlist1"><code>clone.filterSubmodules</code></dt>
2471 <dd>
2472 <p>If a partial clone filter is provided (see <code>--filter</code> in
2473 <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
2474 the filter to submodules.</p>
2475 </dd>
2476 <dt class="hdlist1">color.advice</dt>
2477 <dd>
2478 <p>A boolean to enable/disable color in hints (e.g. when a push
2479 failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
2480 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
2481 are used only when the error output goes to a terminal. If
2482 unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2483 </dd>
2484 <dt class="hdlist1">color.advice.hint</dt>
2485 <dd>
2486 <p>Use customized color for hints.</p>
2487 </dd>
2488 <dt class="hdlist1">color.blame.highlightRecent</dt>
2489 <dd>
2490 <p>Specify the line annotation color for <code>git blame --color-by-age</code>
2491 depending upon the age of the line.</p>
2492 <div class="paragraph">
2493 <p>This setting should be set to a comma-separated list of color and
2494 date settings, starting and ending with a color, the dates should be
2495 set from oldest to newest. The metadata will be colored with the
2496 specified colors if the line was introduced before the given
2497 timestamp, overwriting older timestamped colors.</p>
2498 </div>
2499 <div class="paragraph">
2500 <p>Instead of an absolute timestamp relative timestamps work as well,
2501 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p>
2502 </div>
2503 <div class="paragraph">
2504 <p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
2505 colors everything older than one year blue, recent changes between
2506 one month and one year old are kept white, and lines introduced
2507 within the last month are colored red.</p>
2508 </div>
2509 </dd>
2510 <dt class="hdlist1">color.blame.repeatedLines</dt>
2511 <dd>
2512 <p>Use the specified color to colorize line annotations for
2513 <code>git blame --color-lines</code>, if they come from the same commit as the
2514 preceding line. Defaults to cyan.</p>
2515 </dd>
2516 <dt class="hdlist1">color.branch</dt>
2517 <dd>
2518 <p>A boolean to enable/disable color in the output of
2519 <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
2520 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
2521 only when the output is to a terminal. If unset, then the
2522 value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2523 </dd>
2524 <dt class="hdlist1">color.branch.&lt;slot&gt;</dt>
2525 <dd>
2526 <p>Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
2527 <code>current</code> (the current branch), <code>local</code> (a local branch),
2528 <code>remote</code> (a remote-tracking branch in refs/remotes/),
2529 <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
2530 refs).</p>
2531 </dd>
2532 <dt class="hdlist1">color.diff</dt>
2533 <dd>
2534 <p>Whether to use ANSI escape sequences to add color to patches.
2535 If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
2536 <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
2537 for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
2538 commands will only use color when output is to the terminal.
2539 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
2540 default).</p>
2541 <div class="paragraph">
2542 <p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
2543 <em>git-diff-*</em> plumbing commands.  Can be overridden on the
2544 command line with the <code>--color[=&lt;when&gt;]</code> option.</p>
2545 </div>
2546 </dd>
2547 <dt class="hdlist1">color.diff.&lt;slot&gt;</dt>
2548 <dd>
2549 <p>Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
2550 which part of the patch to use the specified color, and is one
2551 of <code>context</code> (context text - <code>plain</code> is a historical synonym),
2552 <code>meta</code> (metainformation), <code>frag</code>
2553 (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
2554 <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
2555 (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
2556 <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
2557 <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
2558 <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
2559 setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
2560 <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
2561 <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).</p>
2562 </dd>
2563 <dt class="hdlist1">color.decorate.&lt;slot&gt;</dt>
2564 <dd>
2565 <p>Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
2566 of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
2567 branches, remote-tracking branches, tags, stash and HEAD, respectively
2568 and <code>grafted</code> for grafted commits.</p>
2569 </dd>
2570 <dt class="hdlist1">color.grep</dt>
2571 <dd>
2572 <p>When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
2573 <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
2574 when the output is written to the terminal.  If unset, then the
2575 value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2576 </dd>
2577 <dt class="hdlist1">color.grep.&lt;slot&gt;</dt>
2578 <dd>
2579 <p>Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
2580 part of the line to use the specified color, and is one of</p>
2581 <div class="openblock">
2582 <div class="content">
2583 <div class="dlist">
2584 <dl>
2585 <dt class="hdlist1"><code>context</code></dt>
2586 <dd>
2587 <p>non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)</p>
2588 </dd>
2589 <dt class="hdlist1"><code>filename</code></dt>
2590 <dd>
2591 <p>filename prefix (when not using <code>-h</code>)</p>
2592 </dd>
2593 <dt class="hdlist1"><code>function</code></dt>
2594 <dd>
2595 <p>function name lines (when using <code>-p</code>)</p>
2596 </dd>
2597 <dt class="hdlist1"><code>lineNumber</code></dt>
2598 <dd>
2599 <p>line number prefix (when using <code>-n</code>)</p>
2600 </dd>
2601 <dt class="hdlist1"><code>column</code></dt>
2602 <dd>
2603 <p>column number prefix (when using <code>--column</code>)</p>
2604 </dd>
2605 <dt class="hdlist1"><code>match</code></dt>
2606 <dd>
2607 <p>matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)</p>
2608 </dd>
2609 <dt class="hdlist1"><code>matchContext</code></dt>
2610 <dd>
2611 <p>matching text in context lines</p>
2612 </dd>
2613 <dt class="hdlist1"><code>matchSelected</code></dt>
2614 <dd>
2615 <p>matching text in selected lines. Also, used to customize the following
2616 <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.</p>
2617 </dd>
2618 <dt class="hdlist1"><code>selected</code></dt>
2619 <dd>
2620 <p>non-matching text in selected lines. Also, used to customize the
2621 following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
2622 <code>--committer</code>.</p>
2623 </dd>
2624 <dt class="hdlist1"><code>separator</code></dt>
2625 <dd>
2626 <p>separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
2627 and between hunks (<code>--</code>)</p>
2628 </dd>
2629 </dl>
2630 </div>
2631 </div>
2632 </div>
2633 </dd>
2634 <dt class="hdlist1">color.interactive</dt>
2635 <dd>
2636 <p>When set to <code>always</code>, always use colors for interactive prompts
2637 and displays (such as those used by "git-add --interactive" and
2638 "git-clean --interactive"). When false (or <code>never</code>), never.
2639 When set to <code>true</code> or <code>auto</code>, use colors only when the output is
2640 to the terminal. If unset, then the value of <code>color.ui</code> is
2641 used (<code>auto</code> by default).</p>
2642 </dd>
2643 <dt class="hdlist1">color.interactive.&lt;slot&gt;</dt>
2644 <dd>
2645 <p>Use customized color for <em>git add --interactive</em> and <em>git clean
2646 --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
2647 or <code>error</code>, for four distinct types of normal output from
2648 interactive commands.</p>
2649 </dd>
2650 <dt class="hdlist1">color.pager</dt>
2651 <dd>
2652 <p>A boolean to specify whether <code>auto</code> color modes should colorize
2653 output going to the pager. Defaults to true; set this to false
2654 if your pager does not understand ANSI color codes.</p>
2655 </dd>
2656 <dt class="hdlist1">color.push</dt>
2657 <dd>
2658 <p>A boolean to enable/disable color in push errors. May be set to
2659 <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
2660 case colors are used only when the error output goes to a terminal.
2661 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2662 </dd>
2663 <dt class="hdlist1">color.push.error</dt>
2664 <dd>
2665 <p>Use customized color for push errors.</p>
2666 </dd>
2667 <dt class="hdlist1">color.remote</dt>
2668 <dd>
2669 <p>If set, keywords at the start of the line are highlighted. The
2670 keywords are "error", "warning", "hint" and "success", and are
2671 matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
2672 <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
2673 <code>color.ui</code> is used (<code>auto</code> by default).</p>
2674 </dd>
2675 <dt class="hdlist1">color.remote.&lt;slot&gt;</dt>
2676 <dd>
2677 <p>Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
2678 <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
2679 corresponding keyword.</p>
2680 </dd>
2681 <dt class="hdlist1">color.showBranch</dt>
2682 <dd>
2683 <p>A boolean to enable/disable color in the output of
2684 <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
2685 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
2686 only when the output is to a terminal. If unset, then the
2687 value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2688 </dd>
2689 <dt class="hdlist1">color.status</dt>
2690 <dd>
2691 <p>A boolean to enable/disable color in the output of
2692 <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
2693 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
2694 only when the output is to a terminal. If unset, then the
2695 value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2696 </dd>
2697 <dt class="hdlist1">color.status.&lt;slot&gt;</dt>
2698 <dd>
2699 <p>Use customized color for status colorization. <code>&lt;slot&gt;</code> is
2700 one of <code>header</code> (the header text of the status message),
2701 <code>added</code> or <code>updated</code> (files which are added but not committed),
2702 <code>changed</code> (files which are changed but not added in the index),
2703 <code>untracked</code> (files which are not tracked by Git),
2704 <code>branch</code> (the current branch),
2705 <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
2706 to red),
2707 <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
2708 respectively, when branch and tracking information is displayed in the
2709 status short-format), or
2710 <code>unmerged</code> (files which have unmerged changes).</p>
2711 </dd>
2712 <dt class="hdlist1">color.transport</dt>
2713 <dd>
2714 <p>A boolean to enable/disable color when pushes are rejected. May be
2715 set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
2716 case colors are used only when the error output goes to a terminal.
2717 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2718 </dd>
2719 <dt class="hdlist1">color.transport.rejected</dt>
2720 <dd>
2721 <p>Use customized color when a push was rejected.</p>
2722 </dd>
2723 <dt class="hdlist1">color.ui</dt>
2724 <dd>
2725 <p>This variable determines the default value for variables such
2726 as <code>color.diff</code> and <code>color.grep</code> that control the use of color
2727 per command family. Its scope will expand as more commands learn
2728 configuration to set a default for the <code>--color</code> option.  Set it
2729 to <code>false</code> or <code>never</code> if you prefer Git commands not to use
2730 color unless enabled explicitly with some other configuration
2731 or the <code>--color</code> option. Set it to <code>always</code> if you want all
2732 output not intended for machine consumption to use color, to
2733 <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
2734 want such output to use color when written to the terminal.</p>
2735 </dd>
2736 <dt class="hdlist1">column.ui</dt>
2737 <dd>
2738 <p>Specify whether supported commands should output in columns.
2739 This variable consists of a list of tokens separated by spaces
2740 or commas:</p>
2741 <div class="paragraph">
2742 <p>These options control when the feature should be enabled
2743 (defaults to <em>never</em>):</p>
2744 </div>
2745 <div class="openblock">
2746 <div class="content">
2747 <div class="dlist">
2748 <dl>
2749 <dt class="hdlist1"><code>always</code></dt>
2750 <dd>
2751 <p>always show in columns</p>
2752 </dd>
2753 <dt class="hdlist1"><code>never</code></dt>
2754 <dd>
2755 <p>never show in columns</p>
2756 </dd>
2757 <dt class="hdlist1"><code>auto</code></dt>
2758 <dd>
2759 <p>show in columns if the output is to the terminal</p>
2760 </dd>
2761 </dl>
2762 </div>
2763 </div>
2764 </div>
2765 <div class="paragraph">
2766 <p>These options control layout (defaults to <em>column</em>).  Setting any
2767 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
2768 specified.</p>
2769 </div>
2770 <div class="openblock">
2771 <div class="content">
2772 <div class="dlist">
2773 <dl>
2774 <dt class="hdlist1"><code>column</code></dt>
2775 <dd>
2776 <p>fill columns before rows</p>
2777 </dd>
2778 <dt class="hdlist1"><code>row</code></dt>
2779 <dd>
2780 <p>fill rows before columns</p>
2781 </dd>
2782 <dt class="hdlist1"><code>plain</code></dt>
2783 <dd>
2784 <p>show in one column</p>
2785 </dd>
2786 </dl>
2787 </div>
2788 </div>
2789 </div>
2790 <div class="paragraph">
2791 <p>Finally, these options can be combined with a layout option (defaults
2792 to <em>nodense</em>):</p>
2793 </div>
2794 <div class="openblock">
2795 <div class="content">
2796 <div class="dlist">
2797 <dl>
2798 <dt class="hdlist1"><code>dense</code></dt>
2799 <dd>
2800 <p>make unequal size columns to utilize more space</p>
2801 </dd>
2802 <dt class="hdlist1"><code>nodense</code></dt>
2803 <dd>
2804 <p>make equal size columns</p>
2805 </dd>
2806 </dl>
2807 </div>
2808 </div>
2809 </div>
2810 </dd>
2811 <dt class="hdlist1">column.branch</dt>
2812 <dd>
2813 <p>Specify whether to output branch listing in <code>git branch</code> in columns.
2814 See <code>column.ui</code> for details.</p>
2815 </dd>
2816 <dt class="hdlist1">column.clean</dt>
2817 <dd>
2818 <p>Specify the layout when listing items in <code>git clean -i</code>, which always
2819 shows files and directories in columns. See <code>column.ui</code> for details.</p>
2820 </dd>
2821 <dt class="hdlist1">column.status</dt>
2822 <dd>
2823 <p>Specify whether to output untracked files in <code>git status</code> in columns.
2824 See <code>column.ui</code> for details.</p>
2825 </dd>
2826 <dt class="hdlist1">column.tag</dt>
2827 <dd>
2828 <p>Specify whether to output tag listings in <code>git tag</code> in columns.
2829 See <code>column.ui</code> for details.</p>
2830 </dd>
2831 <dt class="hdlist1">commit.cleanup</dt>
2832 <dd>
2833 <p>This setting overrides the default of the <code>--cleanup</code> option in
2834 <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
2835 default can be useful when you always want to keep lines that begin
2836 with the comment character <code>#</code> in your log message, in which case you
2837 would do <code>git config commit.cleanup whitespace</code> (note that you will
2838 have to remove the help lines that begin with <code>#</code> in the commit log
2839 template yourself, if you do this).</p>
2840 </dd>
2841 <dt class="hdlist1">commit.gpgSign</dt>
2842 <dd>
2843 <p>A boolean to specify whether all commits should be GPG signed.
2844 Use of this option when doing operations such as rebase can
2845 result in a large number of commits being signed. It may be
2846 convenient to use an agent to avoid typing your GPG passphrase
2847 several times.</p>
2848 </dd>
2849 <dt class="hdlist1">commit.status</dt>
2850 <dd>
2851 <p>A boolean to enable/disable inclusion of status information in the
2852 commit message template when using an editor to prepare the commit
2853 message.  Defaults to true.</p>
2854 </dd>
2855 <dt class="hdlist1">commit.template</dt>
2856 <dd>
2857 <p>Specify the pathname of a file to use as the template for
2858 new commit messages.</p>
2859 </dd>
2860 <dt class="hdlist1">commit.verbose</dt>
2861 <dd>
2862 <p>A boolean or int to specify the level of verbosity with <code>git commit</code>.
2863 See <a href="git-commit.html">git-commit(1)</a>.</p>
2864 </dd>
2865 <dt class="hdlist1">commitGraph.generationVersion</dt>
2866 <dd>
2867 <p>Specifies the type of generation number version to use when writing
2868 or reading the commit-graph file. If version 1 is specified, then
2869 the corrected commit dates will not be written or read. Defaults to
2870 2.</p>
2871 </dd>
2872 <dt class="hdlist1">commitGraph.maxNewFilters</dt>
2873 <dd>
2874 <p>Specifies the default value for the <code>--max-new-filters</code> option of <code>git
2875 commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).</p>
2876 </dd>
2877 <dt class="hdlist1">commitGraph.readChangedPaths</dt>
2878 <dd>
2879 <p>Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if true, and
2880 commitGraph.changedPathsVersion=0 if false. (If commitGraph.changedPathVersion
2881 is also set, commitGraph.changedPathsVersion takes precedence.)</p>
2882 </dd>
2883 <dt class="hdlist1">commitGraph.changedPathsVersion</dt>
2884 <dd>
2885 <p>Specifies the version of the changed-path Bloom filters that Git will read and
2886 write. May be -1, 0, 1, or 2. Note that values greater than 1 may be
2887 incompatible with older versions of Git which do not yet understand
2888 those versions. Use caution when operating in a mixed-version
2889 environment.</p>
2890 <div class="paragraph">
2891 <p>Defaults to -1.</p>
2892 </div>
2893 <div class="paragraph">
2894 <p>If -1, Git will use the version of the changed-path Bloom filters in the
2895 repository, defaulting to 1 if there are none.</p>
2896 </div>
2897 <div class="paragraph">
2898 <p>If 0, Git will not read any Bloom filters, and will write version 1 Bloom
2899 filters when instructed to write.</p>
2900 </div>
2901 <div class="paragraph">
2902 <p>If 1, Git will only read version 1 Bloom filters, and will write version 1
2903 Bloom filters.</p>
2904 </div>
2905 <div class="paragraph">
2906 <p>If 2, Git will only read version 2 Bloom filters, and will write version 2
2907 Bloom filters.</p>
2908 </div>
2909 <div class="paragraph">
2910 <p>See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.</p>
2911 </div>
2912 </dd>
2913 <dt class="hdlist1">completion.commands</dt>
2914 <dd>
2915 <p>This is only used by git-completion.bash to add or remove
2916 commands from the list of completed commands. Normally only
2917 porcelain commands and a few select others are completed. You
2918 can add more commands, separated by space, in this
2919 variable. Prefixing the command with <em>-</em> will remove it from
2920 the existing list.</p>
2921 </dd>
2922 <dt class="hdlist1">core.fileMode</dt>
2923 <dd>
2924 <p>Tells Git if the executable bit of files in the working tree
2925 is to be honored.</p>
2926 <div class="paragraph">
2927 <p>Some filesystems lose the executable bit when a file that is
2928 marked as executable is checked out, or checks out a
2929 non-executable file with executable bit on.
2930 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
2931 to see if it handles the executable bit correctly
2932 and this variable is automatically set as necessary.</p>
2933 </div>
2934 <div class="paragraph">
2935 <p>A repository, however, may be on a filesystem that handles
2936 the filemode correctly, and this variable is set to <em>true</em>
2937 when created, but later may be made accessible from another
2938 environment that loses the filemode (e.g. exporting ext4 via
2939 CIFS mount, visiting a Cygwin created repository with
2940 Git for Windows or Eclipse).
2941 In such a case it may be necessary to set this variable to <em>false</em>.
2942 See <a href="git-update-index.html">git-update-index(1)</a>.</p>
2943 </div>
2944 <div class="paragraph">
2945 <p>The default is true (when core.filemode is not specified in the config file).</p>
2946 </div>
2947 </dd>
2948 <dt class="hdlist1">core.hideDotFiles</dt>
2949 <dd>
2950 <p>(Windows-only) If true, mark newly-created directories and files whose
2951 name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
2952 directory is hidden, but no other files starting with a dot.  The
2953 default mode is <em>dotGitOnly</em>.</p>
2954 </dd>
2955 <dt class="hdlist1">core.ignoreCase</dt>
2956 <dd>
2957 <p>Internal variable which enables various workarounds to enable
2958 Git to work better on filesystems that are not case sensitive,
2959 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
2960 finds "makefile" when Git expects "Makefile", Git will assume
2961 it is really the same file, and continue to remember it as
2962 "Makefile".</p>
2963 <div class="paragraph">
2964 <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>
2965 will probe and set core.ignoreCase true if appropriate when the repository
2966 is created.</p>
2967 </div>
2968 <div class="paragraph">
2969 <p>Git relies on the proper configuration of this variable for your operating
2970 and file system. Modifying this value may result in unexpected behavior.</p>
2971 </div>
2972 </dd>
2973 <dt class="hdlist1">core.precomposeUnicode</dt>
2974 <dd>
2975 <p>This option is only used by Mac OS implementation of Git.
2976 When core.precomposeUnicode=true, Git reverts the unicode decomposition
2977 of filenames done by Mac OS. This is useful when sharing a repository
2978 between Mac OS and Linux or Windows.
2979 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
2980 When false, file names are handled fully transparent by Git,
2981 which is backward compatible with older versions of Git.</p>
2982 </dd>
2983 <dt class="hdlist1">core.protectHFS</dt>
2984 <dd>
2985 <p>If set to true, do not allow checkout of paths that would
2986 be considered equivalent to <code>.git</code> on an HFS+ filesystem.
2987 Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.</p>
2988 </dd>
2989 <dt class="hdlist1">core.protectNTFS</dt>
2990 <dd>
2991 <p>If set to true, do not allow checkout of paths that would
2992 cause problems with the NTFS filesystem, e.g. conflict with
2993 8.3 "short" names.
2994 Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.</p>
2995 </dd>
2996 <dt class="hdlist1">core.fsmonitor</dt>
2997 <dd>
2998 <p>If set to true, enable the built-in file system monitor
2999 daemon for this working directory (<a href="git-fsmonitor&#x2d;&#x2d;daemon.html">git-fsmonitor&#x2d;&#x2d;daemon(1)</a>).</p>
3000 <div class="paragraph">
3001 <p>Like hook-based file system monitors, the built-in file system monitor
3002 can speed up Git commands that need to refresh the Git index
3003 (e.g. <code>git status</code>) in a working directory with many files.  The
3004 built-in monitor eliminates the need to install and maintain an
3005 external third-party tool.</p>
3006 </div>
3007 <div class="paragraph">
3008 <p>The built-in file system monitor is currently available only on a
3009 limited set of supported platforms.  Currently, this includes Windows
3010 and MacOS.</p>
3011 </div>
3012 <div class="literalblock">
3013 <div class="content">
3014 <pre>Otherwise, this variable contains the pathname of the "fsmonitor"
3015 hook command.</pre>
3016 </div>
3017 </div>
3018 <div class="paragraph">
3019 <p>This hook command is used to identify all files that may have changed
3020 since the requested date/time. This information is used to speed up
3021 git by avoiding unnecessary scanning of files that have not changed.</p>
3022 </div>
3023 <div class="paragraph">
3024 <p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p>
3025 </div>
3026 <div class="paragraph">
3027 <p>Note that if you concurrently use multiple versions of Git, such
3028 as one version on the command line and another version in an IDE
3029 tool, that the definition of <code>core.fsmonitor</code> was extended to
3030 allow boolean values in addition to hook pathnames.  Git versions
3031 2.35.1 and prior will not understand the boolean values and will
3032 consider the "true" or "false" values as hook pathnames to be
3033 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
3034 V2 and will fall back to no fsmonitor (full scan).  Git versions
3035 prior to 2.26 default to hook protocol V1 and will silently
3036 assume there were no changes to report (no scan), so status
3037 commands may report incomplete results.  For this reason, it is
3038 best to upgrade all of your Git versions before using the built-in
3039 file system monitor.</p>
3040 </div>
3041 </dd>
3042 <dt class="hdlist1">core.fsmonitorHookVersion</dt>
3043 <dd>
3044 <p>Sets the protocol version to be used when invoking the
3045 "fsmonitor" hook.</p>
3046 <div class="paragraph">
3047 <p>There are currently versions 1 and 2. When this is not set,
3048 version 2 will be tried first and if it fails then version 1
3049 will be tried. Version 1 uses a timestamp as input to determine
3050 which files have changes since that time but some monitors
3051 like Watchman have race conditions when used with a timestamp.
3052 Version 2 uses an opaque string so that the monitor can return
3053 something that can be used to determine what files have changed
3054 without race conditions.</p>
3055 </div>
3056 </dd>
3057 <dt class="hdlist1">core.trustctime</dt>
3058 <dd>
3059 <p>If false, the ctime differences between the index and the
3060 working tree are ignored; useful when the inode change time
3061 is regularly modified by something outside Git (file system
3062 crawlers and some backup systems).
3063 See <a href="git-update-index.html">git-update-index(1)</a>. True by default.</p>
3064 </dd>
3065 <dt class="hdlist1">core.splitIndex</dt>
3066 <dd>
3067 <p>If true, the split-index feature of the index will be used.
3068 See <a href="git-update-index.html">git-update-index(1)</a>. False by default.</p>
3069 </dd>
3070 <dt class="hdlist1">core.untrackedCache</dt>
3071 <dd>
3072 <p>Determines what to do about the untracked cache feature of the
3073 index. It will be kept, if this variable is unset or set to
3074 <code>keep</code>. It will automatically be added if set to <code>true</code>. And
3075 it will automatically be removed, if set to <code>false</code>. Before
3076 setting it to <code>true</code>, you should check that mtime is working
3077 properly on your system.
3078 See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
3079 <code>feature.manyFiles</code> is enabled which sets this setting to
3080 <code>true</code> by default.</p>
3081 </dd>
3082 <dt class="hdlist1">core.checkStat</dt>
3083 <dd>
3084 <p>When missing or is set to <code>default</code>, many fields in the stat
3085 structure are checked to detect if a file has been modified
3086 since Git looked at it.  When this configuration variable is
3087 set to <code>minimal</code>, sub-second part of mtime and ctime, the
3088 uid and gid of the owner of the file, the inode number (and
3089 the device number, if Git was compiled to use it), are
3090 excluded from the check among these fields, leaving only the
3091 whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
3092 is set) and the filesize to be checked.</p>
3093 <div class="paragraph">
3094 <p>There are implementations of Git that do not leave usable values in
3095 some fields (e.g. JGit); by excluding these fields from the
3096 comparison, the <code>minimal</code> mode may help interoperability when the
3097 same repository is used by these other systems at the same time.</p>
3098 </div>
3099 </dd>
3100 <dt class="hdlist1">core.quotePath</dt>
3101 <dd>
3102 <p>Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
3103 quote "unusual" characters in the pathname by enclosing the
3104 pathname in double-quotes and escaping those characters with
3105 backslashes in the same way C escapes control characters (e.g.
3106 <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
3107 values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
3108 UTF-8).  If this variable is set to false, bytes higher than
3109 0x80 are not considered "unusual" any more. Double-quotes,
3110 backslash and control characters are always escaped regardless
3111 of the setting of this variable.  A simple space character is
3112 not considered "unusual".  Many commands can output pathnames
3113 completely verbatim using the <code>-z</code> option. The default value
3114 is true.</p>
3115 </dd>
3116 <dt class="hdlist1">core.eol</dt>
3117 <dd>
3118 <p>Sets the line ending type to use in the working directory for
3119 files that are marked as text (either by having the <code>text</code>
3120 attribute set, or by having <code>text=auto</code> and Git auto-detecting
3121 the contents as text).
3122 Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
3123 native line ending.  The default value is <code>native</code>.  See
3124 <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
3125 conversion. Note that this value is ignored if <code>core.autocrlf</code>
3126 is set to <code>true</code> or <code>input</code>.</p>
3127 </dd>
3128 <dt class="hdlist1">core.safecrlf</dt>
3129 <dd>
3130 <p>If true, makes Git check if converting <code>CRLF</code> is reversible when
3131 end-of-line conversion is active.  Git will verify if a command
3132 modifies a file in the work tree either directly or indirectly.
3133 For example, committing a file followed by checking out the
3134 same file should yield the original file in the work tree.  If
3135 this is not the case for the current setting of
3136 <code>core.autocrlf</code>, Git will reject the file.  The variable can
3137 be set to "warn", in which case Git will only warn about an
3138 irreversible conversion but continue the operation.</p>
3139 <div class="paragraph">
3140 <p>CRLF conversion bears a slight chance of corrupting data.
3141 When it is enabled, Git will convert CRLF to LF during commit and LF to
3142 CRLF during checkout.  A file that contains a mixture of LF and
3143 CRLF before the commit cannot be recreated by Git.  For text
3144 files this is the right thing to do: it corrects line endings
3145 such that we have only LF line endings in the repository.
3146 But for binary files that are accidentally classified as text the
3147 conversion can corrupt data.</p>
3148 </div>
3149 <div class="paragraph">
3150 <p>If you recognize such corruption early you can easily fix it by
3151 setting the conversion type explicitly in .gitattributes.  Right
3152 after committing you still have the original file in your work
3153 tree and this file is not yet corrupted.  You can explicitly tell
3154 Git that this file is binary and Git will handle the file
3155 appropriately.</p>
3156 </div>
3157 <div class="paragraph">
3158 <p>Unfortunately, the desired effect of cleaning up text files with
3159 mixed line endings and the undesired effect of corrupting binary
3160 files cannot be distinguished.  In both cases CRLFs are removed
3161 in an irreversible way.  For text files this is the right thing
3162 to do because CRLFs are line endings, while for binary files
3163 converting CRLFs corrupts data.</p>
3164 </div>
3165 <div class="paragraph">
3166 <p>Note, this safety check does not mean that a checkout will generate a
3167 file identical to the original file for a different setting of
3168 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
3169 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
3170 and could later be checked out with <code>core.eol=crlf</code>, in which case the
3171 resulting file would contain <code>CRLF</code>, although the original file
3172 contained <code>LF</code>.  However, in both work trees the line endings would be
3173 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
3174 file with mixed line endings would be reported by the <code>core.safecrlf</code>
3175 mechanism.</p>
3176 </div>
3177 </dd>
3178 <dt class="hdlist1">core.autocrlf</dt>
3179 <dd>
3180 <p>Setting this variable to "true" is the same as setting
3181 the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
3182 Set to true if you want to have <code>CRLF</code> line endings in your
3183 working directory and the repository has LF line endings.
3184 This variable can be set to <em>input</em>,
3185 in which case no output conversion is performed.</p>
3186 </dd>
3187 <dt class="hdlist1">core.checkRoundtripEncoding</dt>
3188 <dd>
3189 <p>A comma and/or whitespace separated list of encodings that Git
3190 performs UTF-8 round trip checks on if they are used in an
3191 <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
3192 The default value is <code>SHIFT-JIS</code>.</p>
3193 </dd>
3194 <dt class="hdlist1">core.symlinks</dt>
3195 <dd>
3196 <p>If false, symbolic links are checked out as small plain files that
3197 contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
3198 <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
3199 file. Useful on filesystems like FAT that do not support
3200 symbolic links.</p>
3201 <div class="paragraph">
3202 <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>
3203 will probe and set core.symlinks false if appropriate when the repository
3204 is created.</p>
3205 </div>
3206 </dd>
3207 <dt class="hdlist1">core.gitProxy</dt>
3208 <dd>
3209 <p>A "proxy command" to execute (as <em>command host port</em>) instead
3210 of establishing direct connection to the remote server when
3211 using the Git protocol for fetching. If the variable value is
3212 in the "COMMAND for DOMAIN" format, the command is applied only
3213 on hostnames ending with the specified domain string. This variable
3214 may be set multiple times and is matched in the given order;
3215 the first match wins.</p>
3216 <div class="paragraph">
3217 <p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
3218 (which always applies universally, without the special "for"
3219 handling).</p>
3220 </div>
3221 <div class="paragraph">
3222 <p>The special string <code>none</code> can be used as the proxy command to
3223 specify that no proxy be used for a given domain pattern.
3224 This is useful for excluding servers inside a firewall from
3225 proxy use, while defaulting to a common proxy for external domains.</p>
3226 </div>
3227 </dd>
3228 <dt class="hdlist1">core.sshCommand</dt>
3229 <dd>
3230 <p>If this variable is set, <code>git fetch</code> and <code>git push</code> will
3231 use the specified command instead of <code>ssh</code> when they need to
3232 connect to a remote system. The command is in the same form as
3233 the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
3234 when the environment variable is set.</p>
3235 </dd>
3236 <dt class="hdlist1">core.ignoreStat</dt>
3237 <dd>
3238 <p>If true, Git will avoid using lstat() calls to detect if files have
3239 changed by setting the "assume-unchanged" bit for those tracked files
3240 which it has updated identically in both the index and working tree.</p>
3241 <div class="paragraph">
3242 <p>When files are modified outside of Git, the user will need to stage
3243 the modified files explicitly (e.g. see <em>Examples</em> section in
3244 <a href="git-update-index.html">git-update-index(1)</a>).
3245 Git will not normally detect changes to those files.</p>
3246 </div>
3247 <div class="paragraph">
3248 <p>This is useful on systems where lstat() calls are very slow, such as
3249 CIFS/Microsoft Windows.</p>
3250 </div>
3251 <div class="paragraph">
3252 <p>False by default.</p>
3253 </div>
3254 </dd>
3255 <dt class="hdlist1">core.preferSymlinkRefs</dt>
3256 <dd>
3257 <p>Instead of the default "symref" format for HEAD
3258 and other symbolic reference files, use symbolic links.
3259 This is sometimes needed to work with old scripts that
3260 expect HEAD to be a symbolic link.</p>
3261 </dd>
3262 <dt class="hdlist1">core.alternateRefsCommand</dt>
3263 <dd>
3264 <p>When advertising tips of available history from an alternate, use the shell to
3265 execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
3266 first argument is the absolute path of the alternate. Output must contain one
3267 hex object id per line (i.e., the same as produced by <code>git for-each-ref
3268 --format='%(objectname)'</code>).</p>
3269 <div class="paragraph">
3270 <p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
3271 value, as it does not take a repository path as an argument (but you can wrap
3272 the command above in a shell script).</p>
3273 </div>
3274 </dd>
3275 <dt class="hdlist1">core.alternateRefsPrefixes</dt>
3276 <dd>
3277 <p>When listing references from an alternate, list only references that begin
3278 with the given prefix. Prefixes match as if they were given as arguments to
3279 <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
3280 whitespace. If <code>core.alternateRefsCommand</code> is set, setting
3281 <code>core.alternateRefsPrefixes</code> has no effect.</p>
3282 </dd>
3283 <dt class="hdlist1">core.bare</dt>
3284 <dd>
3285 <p>If true this repository is assumed to be <em>bare</em> and has no
3286 working directory associated with it.  If this is the case a
3287 number of commands that require a working directory will be
3288 disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.</p>
3289 <div class="paragraph">
3290 <p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
3291 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
3292 repository that ends in "/.git" is assumed to be not bare (bare =
3293 false), while all other repositories are assumed to be bare (bare
3294 = true).</p>
3295 </div>
3296 </dd>
3297 <dt class="hdlist1">core.worktree</dt>
3298 <dd>
3299 <p>Set the path to the root of the working tree.
3300 If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
3301 is ignored and not used for determining the root of working tree.
3302 This can be overridden by the <code>GIT_WORK_TREE</code> environment
3303 variable and the <code>--work-tree</code> command-line option.
3304 The value can be an absolute path or relative to the path to
3305 the .git directory, which is either specified by --git-dir
3306 or GIT_DIR, or automatically discovered.
3307 If --git-dir or GIT_DIR is specified but none of
3308 --work-tree, GIT_WORK_TREE and core.worktree is specified,
3309 the current working directory is regarded as the top level
3310 of your working tree.</p>
3311 <div class="paragraph">
3312 <p>Note that this variable is honored even when set in a configuration
3313 file in a ".git" subdirectory of a directory and its value differs
3314 from the latter directory (e.g. "/path/to/.git/config" has
3315 core.worktree set to "/different/path"), which is most likely a
3316 misconfiguration.  Running Git commands in the "/path/to" directory will
3317 still use "/different/path" as the root of the work tree and can cause
3318 confusion unless you know what you are doing (e.g. you are creating a
3319 read-only snapshot of the same index to a location different from the
3320 repository&#8217;s usual working tree).</p>
3321 </div>
3322 </dd>
3323 <dt class="hdlist1">core.logAllRefUpdates</dt>
3324 <dd>
3325 <p>Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
3326 "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
3327 SHA-1, the date/time and the reason of the update, but
3328 only when the file exists.  If this configuration
3329 variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
3330 file is automatically created for branch heads (i.e. under
3331 <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
3332 note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
3333 If it is set to <code>always</code>, then a missing reflog is automatically
3334 created for any ref under <code>refs/</code>.</p>
3335 <div class="paragraph">
3336 <p>This information can be used to determine what commit
3337 was the tip of a branch "2 days ago".</p>
3338 </div>
3339 <div class="paragraph">
3340 <p>This value is true by default in a repository that has
3341 a working directory associated with it, and false by
3342 default in a bare repository.</p>
3343 </div>
3344 </dd>
3345 <dt class="hdlist1">core.repositoryFormatVersion</dt>
3346 <dd>
3347 <p>Internal variable identifying the repository format and layout
3348 version.</p>
3349 </dd>
3350 <dt class="hdlist1">core.sharedRepository</dt>
3351 <dd>
3352 <p>When <em>group</em> (or <em>true</em>), the repository is made shareable between
3353 several users in a group (making sure all the files and objects are
3354 group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
3355 repository will be readable by all users, additionally to being
3356 group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
3357 reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
3358 files in the repository will have this mode value. <em>0xxx</em> will override
3359 user&#8217;s umask value (whereas the other options will only override
3360 requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
3361 the repo read/write-able for the owner and group, but inaccessible to
3362 others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
3363 repository that is group-readable but not group-writable.
3364 See <a href="git-init.html">git-init(1)</a>. False by default.</p>
3365 </dd>
3366 <dt class="hdlist1">core.warnAmbiguousRefs</dt>
3367 <dd>
3368 <p>If true, Git will warn you if the ref name you passed it is ambiguous
3369 and might match multiple refs in the repository. True by default.</p>
3370 </dd>
3371 <dt class="hdlist1">core.compression</dt>
3372 <dd>
3373 <p>An integer -1..9, indicating a default compression level.
3374 -1 is the zlib default. 0 means no compression,
3375 and 1..9 are various speed/size tradeoffs, 9 being slowest.
3376 If set, this provides a default to other compression variables,
3377 such as <code>core.looseCompression</code> and <code>pack.compression</code>.</p>
3378 </dd>
3379 <dt class="hdlist1">core.looseCompression</dt>
3380 <dd>
3381 <p>An integer -1..9, indicating the compression level for objects that
3382 are not in a pack file. -1 is the zlib default. 0 means no
3383 compression, and 1..9 are various speed/size tradeoffs, 9 being
3384 slowest.  If not set,  defaults to core.compression.  If that is
3385 not set,  defaults to 1 (best speed).</p>
3386 </dd>
3387 <dt class="hdlist1">core.packedGitWindowSize</dt>
3388 <dd>
3389 <p>Number of bytes of a pack file to map into memory in a
3390 single mapping operation.  Larger window sizes may allow
3391 your system to process a smaller number of large pack files
3392 more quickly.  Smaller window sizes will negatively affect
3393 performance due to increased calls to the operating system&#8217;s
3394 memory manager, but may improve performance when accessing
3395 a large number of large pack files.</p>
3396 <div class="paragraph">
3397 <p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
3398 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
3399 be reasonable for all users/operating systems.  You probably do
3400 not need to adjust this value.</p>
3401 </div>
3402 <div class="paragraph">
3403 <p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
3404 </div>
3405 </dd>
3406 <dt class="hdlist1">core.packedGitLimit</dt>
3407 <dd>
3408 <p>Maximum number of bytes to map simultaneously into memory
3409 from pack files.  If Git needs to access more than this many
3410 bytes at once to complete an operation it will unmap existing
3411 regions to reclaim virtual address space within the process.</p>
3412 <div class="paragraph">
3413 <p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
3414 unlimited) on 64 bit platforms.
3415 This should be reasonable for all users/operating systems, except on
3416 the largest projects.  You probably do not need to adjust this value.</p>
3417 </div>
3418 <div class="paragraph">
3419 <p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
3420 </div>
3421 </dd>
3422 <dt class="hdlist1">core.deltaBaseCacheLimit</dt>
3423 <dd>
3424 <p>Maximum number of bytes per thread to reserve for caching base objects
3425 that may be referenced by multiple deltified objects.  By storing the
3426 entire decompressed base objects in a cache Git is able
3427 to avoid unpacking and decompressing frequently used base
3428 objects multiple times.</p>
3429 <div class="paragraph">
3430 <p>Default is 96 MiB on all platforms.  This should be reasonable
3431 for all users/operating systems, except on the largest projects.
3432 You probably do not need to adjust this value.</p>
3433 </div>
3434 <div class="paragraph">
3435 <p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
3436 </div>
3437 </dd>
3438 <dt class="hdlist1">core.bigFileThreshold</dt>
3439 <dd>
3440 <p>The size of files considered "big", which as discussed below
3441 changes the behavior of numerous git commands, as well as how
3442 such files are stored within the repository. The default is
3443 512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
3444 supported.</p>
3445 <div class="paragraph">
3446 <p>Files above the configured limit will be:</p>
3447 </div>
3448 <div class="ulist">
3449 <ul>
3450 <li>
3451 <p>Stored deflated in packfiles, without attempting delta compression.</p>
3452 <div class="paragraph">
3453 <p>The default limit is primarily set with this use-case in mind. With it,
3454 most projects will have their source code and other text files delta
3455 compressed, but not larger binary media files.</p>
3456 </div>
3457 <div class="paragraph">
3458 <p>Storing large files without delta compression avoids excessive memory
3459 usage, at the slight expense of increased disk usage.</p>
3460 </div>
3461 </li>
3462 <li>
3463 <p>Will be treated as if they were labeled "binary" (see
3464 <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
3465 <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.</p>
3466 </li>
3467 <li>
3468 <p>Will generally be streamed when written, which avoids excessive
3469 memory usage, at the cost of some fixed overhead. Commands that make
3470 use of this include <a href="git-archive.html">git-archive(1)</a>,
3471 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
3472 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.</p>
3473 </li>
3474 </ul>
3475 </div>
3476 </dd>
3477 <dt class="hdlist1">core.excludesFile</dt>
3478 <dd>
3479 <p>Specifies the pathname to the file that contains patterns to
3480 describe paths that are not meant to be tracked, in addition
3481 to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
3482 Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
3483 If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
3484 is used instead. See <a href="gitignore.html">gitignore(5)</a>.</p>
3485 </dd>
3486 <dt class="hdlist1">core.askPass</dt>
3487 <dd>
3488 <p>Some commands (e.g. svn and http interfaces) that interactively
3489 ask for a password can be told to use an external program given
3490 via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
3491 environment variable. If not set, fall back to the value of the
3492 <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
3493 prompt. The external program shall be given a suitable prompt as
3494 command-line argument and write the password on its STDOUT.</p>
3495 </dd>
3496 <dt class="hdlist1">core.attributesFile</dt>
3497 <dd>
3498 <p>In addition to <code>.gitattributes</code> (per-directory) and
3499 <code>.git/info/attributes</code>, Git looks into this file for attributes
3500 (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
3501 way as for <code>core.excludesFile</code>. Its default value is
3502 <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
3503 set or empty, <code>$HOME/.config/git/attributes</code> is used instead.</p>
3504 </dd>
3505 <dt class="hdlist1">core.hooksPath</dt>
3506 <dd>
3507 <p>By default Git will look for your hooks in the
3508 <code>$GIT_DIR/hooks</code> directory. Set this to different path,
3509 e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
3510 that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
3511 in <code>$GIT_DIR/hooks/pre-receive</code>.</p>
3512 <div class="paragraph">
3513 <p>The path can be either absolute or relative. A relative path is
3514 taken as relative to the directory where the hooks are run (see
3515 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p>
3516 </div>
3517 <div class="paragraph">
3518 <p>This configuration variable is useful in cases where you&#8217;d like to
3519 centrally configure your Git hooks instead of configuring them on a
3520 per-repository basis, or as a more flexible and centralized
3521 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
3522 default hooks.</p>
3523 </div>
3524 </dd>
3525 <dt class="hdlist1">core.editor</dt>
3526 <dd>
3527 <p>Commands such as <code>commit</code> and <code>tag</code> that let you edit
3528 messages by launching an editor use the value of this
3529 variable when it is set, and the environment variable
3530 <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.</p>
3531 </dd>
3532 <dt class="hdlist1">core.commentChar</dt>
3533 <dt class="hdlist1">core.commentString</dt>
3534 <dd>
3535 <p>Commands such as <code>commit</code> and <code>tag</code> that let you edit
3536 messages consider a line that begins with this character
3537 commented, and removes them after the editor returns
3538 (default <em>#</em>).</p>
3539 <div class="paragraph">
3540 <p>If set to "auto", <code>git-commit</code> would select a character that is not
3541 the beginning character of any line in existing commit messages.</p>
3542 </div>
3543 <div class="paragraph">
3544 <p>Note that these two variables are aliases of each other, and in modern
3545 versions of Git you are free to use a string (e.g., <code>//</code> or <code>⁑⁕⁑</code>) with
3546 <code>commentChar</code>. Versions of Git prior to v2.45.0 will ignore
3547 <code>commentString</code> but will reject a value of <code>commentChar</code> that consists
3548 of more than a single ASCII byte. If you plan to use your config with
3549 older and newer versions of Git, you may want to specify both:</p>
3550 </div>
3551 <div class="literalblock">
3552 <div class="content">
3553 <pre>[core]
3554 # single character for older versions
3555 commentChar = "#"
3556 # string for newer versions (which will override commentChar
3557 # because it comes later in the file)
3558 commentString = "//"</pre>
3559 </div>
3560 </div>
3561 </dd>
3562 <dt class="hdlist1">core.filesRefLockTimeout</dt>
3563 <dd>
3564 <p>The length of time, in milliseconds, to retry when trying to
3565 lock an individual reference. Value 0 means not to retry at
3566 all; -1 means to try indefinitely. Default is 100 (i.e.,
3567 retry for 100ms).</p>
3568 </dd>
3569 <dt class="hdlist1">core.packedRefsTimeout</dt>
3570 <dd>
3571 <p>The length of time, in milliseconds, to retry when trying to
3572 lock the <code>packed-refs</code> file. Value 0 means not to retry at
3573 all; -1 means to try indefinitely. Default is 1000 (i.e.,
3574 retry for 1 second).</p>
3575 </dd>
3576 <dt class="hdlist1">core.pager</dt>
3577 <dd>
3578 <p>Text viewer for use by Git commands (e.g., <em>less</em>).  The value
3579 is meant to be interpreted by the shell.  The order of preference
3580 is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
3581 configuration, then <code>$PAGER</code>, and then the default chosen at
3582 compile time (usually <em>less</em>).</p>
3583 <div class="paragraph">
3584 <p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
3585 (if <code>LESS</code> environment variable is set, Git does not change it at
3586 all).  If you want to selectively override Git&#8217;s default setting
3587 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
3588 be passed to the shell by Git, which will translate the final
3589 command to <code>LESS=FRX less -S</code>. The environment does not set the
3590 <code>S</code> option but the command line does, instructing less to truncate
3591 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
3592 deactivate the <code>F</code> option specified by the environment from the
3593 command-line, deactivating the "quit if one screen" behavior of
3594 <code>less</code>.  One can specifically activate some flags for particular
3595 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
3596 line truncation only for <code>git blame</code>.</p>
3597 </div>
3598 <div class="paragraph">
3599 <p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
3600 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
3601 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p>
3602 </div>
3603 </dd>
3604 <dt class="hdlist1">core.whitespace</dt>
3605 <dd>
3606 <p>A comma separated list of common whitespace problems to
3607 notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
3608 highlight them, and <em>git apply --whitespace=error</em> will
3609 consider them as errors.  You can prefix <code>-</code> to disable
3610 any of them (e.g. <code>-trailing-space</code>):</p>
3611 <div class="ulist">
3612 <ul>
3613 <li>
3614 <p><code>blank-at-eol</code> treats trailing whitespaces at the end of the line
3615 as an error (enabled by default).</p>
3616 </li>
3617 <li>
3618 <p><code>space-before-tab</code> treats a space character that appears immediately
3619 before a tab character in the initial indent part of the line as an
3620 error (enabled by default).</p>
3621 </li>
3622 <li>
3623 <p><code>indent-with-non-tab</code> treats a line that is indented with space
3624 characters instead of the equivalent tabs as an error (not enabled by
3625 default).</p>
3626 </li>
3627 <li>
3628 <p><code>tab-in-indent</code> treats a tab character in the initial indent part of
3629 the line as an error (not enabled by default).</p>
3630 </li>
3631 <li>
3632 <p><code>blank-at-eof</code> treats blank lines added at the end of file as an error
3633 (enabled by default).</p>
3634 </li>
3635 <li>
3636 <p><code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
3637 <code>blank-at-eof</code>.</p>
3638 </li>
3639 <li>
3640 <p><code>cr-at-eol</code> treats a carriage-return at the end of line as
3641 part of the line terminator, i.e. with it, <code>trailing-space</code>
3642 does not trigger if the character before such a carriage-return
3643 is not a whitespace (not enabled by default).</p>
3644 </li>
3645 <li>
3646 <p><code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
3647 is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
3648 errors. The default tab width is 8. Allowed values are 1 to 63.</p>
3649 </li>
3650 </ul>
3651 </div>
3652 </dd>
3653 <dt class="hdlist1">core.fsync</dt>
3654 <dd>
3655 <p>A comma-separated list of components of the repository that
3656 should be hardened via the core.fsyncMethod when created or
3657 modified.  You can disable hardening of any component by
3658 prefixing it with a <em>-</em>.  Items that are not hardened may be
3659 lost in the event of an unclean system shutdown. Unless you
3660 have special requirements, it is recommended that you leave
3661 this option empty or pick one of <code>committed</code>, <code>added</code>,
3662 or <code>all</code>.</p>
3663 <div class="paragraph">
3664 <p>When this configuration is encountered, the set of components starts with
3665 the platform default value, disabled components are removed, and additional
3666 components are added. <code>none</code> resets the state so that the platform default
3667 is ignored.</p>
3668 </div>
3669 <div class="paragraph">
3670 <p>The empty string resets the fsync configuration to the platform
3671 default. The default on most platforms is equivalent to
3672 <code>core.fsync=committed,-loose-object</code>, which has good performance,
3673 but risks losing recent work in the event of an unclean system shutdown.</p>
3674 </div>
3675 <div class="ulist">
3676 <ul>
3677 <li>
3678 <p><code>none</code> clears the set of fsynced components.</p>
3679 </li>
3680 <li>
3681 <p><code>loose-object</code> hardens objects added to the repo in loose-object form.</p>
3682 </li>
3683 <li>
3684 <p><code>pack</code> hardens objects added to the repo in packfile form.</p>
3685 </li>
3686 <li>
3687 <p><code>pack-metadata</code> hardens packfile bitmaps and indexes.</p>
3688 </li>
3689 <li>
3690 <p><code>commit-graph</code> hardens the commit-graph file.</p>
3691 </li>
3692 <li>
3693 <p><code>index</code> hardens the index when it is modified.</p>
3694 </li>
3695 <li>
3696 <p><code>objects</code> is an aggregate option that is equivalent to
3697 <code>loose-object,pack</code>.</p>
3698 </li>
3699 <li>
3700 <p><code>reference</code> hardens references modified in the repo.</p>
3701 </li>
3702 <li>
3703 <p><code>derived-metadata</code> is an aggregate option that is equivalent to
3704 <code>pack-metadata,commit-graph</code>.</p>
3705 </li>
3706 <li>
3707 <p><code>committed</code> is an aggregate option that is currently equivalent to
3708 <code>objects</code>. This mode sacrifices some performance to ensure that work
3709 that is committed to the repository with <code>git commit</code> or similar commands
3710 is hardened.</p>
3711 </li>
3712 <li>
3713 <p><code>added</code> is an aggregate option that is currently equivalent to
3714 <code>committed,index</code>. This mode sacrifices additional performance to
3715 ensure that the results of commands like <code>git add</code> and similar operations
3716 are hardened.</p>
3717 </li>
3718 <li>
3719 <p><code>all</code> is an aggregate option that syncs all individual components above.</p>
3720 </li>
3721 </ul>
3722 </div>
3723 </dd>
3724 <dt class="hdlist1">core.fsyncMethod</dt>
3725 <dd>
3726 <p>A value indicating the strategy Git will use to harden repository data
3727 using fsync and related primitives.</p>
3728 <div class="ulist">
3729 <ul>
3730 <li>
3731 <p><code>fsync</code> uses the fsync() system call or platform equivalents.</p>
3732 </li>
3733 <li>
3734 <p><code>writeout-only</code> issues pagecache writeback requests, but depending on the
3735 filesystem and storage hardware, data added to the repository may not be
3736 durable in the event of a system crash. This is the default mode on macOS.</p>
3737 </li>
3738 <li>
3739 <p><code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
3740 updates in the disk writeback cache and then does a single full fsync of
3741 a dummy file to trigger the disk cache flush at the end of the operation.</p>
3742 <div class="paragraph">
3743 <p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
3744 data is made durable as if <code>fsync</code> was specified. This mode is expected to
3745 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
3746 and on Windows for repos stored on NTFS or ReFS filesystems.</p>
3747 </div>
3748 </li>
3749 </ul>
3750 </div>
3751 </dd>
3752 <dt class="hdlist1">core.fsyncObjectFiles</dt>
3753 <dd>
3754 <p>This boolean will enable <em>fsync()</em> when writing object files.
3755 This setting is deprecated. Use core.fsync instead.</p>
3756 <div class="paragraph">
3757 <p>This setting affects data added to the Git repository in loose-object
3758 form. When set to true, Git will issue an fsync or similar system call
3759 to flush caches so that loose-objects remain consistent in the face
3760 of a unclean system shutdown.</p>
3761 </div>
3762 </dd>
3763 <dt class="hdlist1">core.preloadIndex</dt>
3764 <dd>
3765 <p>Enable parallel index preload for operations like <em>git diff</em></p>
3766 <div class="paragraph">
3767 <p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
3768 on filesystems like NFS that have weak caching semantics and thus
3769 relatively high IO latencies.  When enabled, Git will do the
3770 index comparison to the filesystem data in parallel, allowing
3771 overlapping IO&#8217;s.  Defaults to true.</p>
3772 </div>
3773 </dd>
3774 <dt class="hdlist1">core.unsetenvvars</dt>
3775 <dd>
3776 <p>Windows-only: comma-separated list of environment variables'
3777 names that need to be unset before spawning any other process.
3778 Defaults to <code>PERL5LIB</code> to account for the fact that Git for
3779 Windows insists on using its own Perl interpreter.</p>
3780 </dd>
3781 <dt class="hdlist1">core.restrictinheritedhandles</dt>
3782 <dd>
3783 <p>Windows-only: override whether spawned processes inherit only standard
3784 file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
3785 <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
3786 Windows 7 and later, and <code>false</code> on older Windows versions.</p>
3787 </dd>
3788 <dt class="hdlist1">core.createObject</dt>
3789 <dd>
3790 <p>You can set this to <em>link</em>, in which case a hardlink followed by
3791 a delete of the source are used to make sure that object creation
3792 will not overwrite existing objects.</p>
3793 <div class="paragraph">
3794 <p>On some file system/operating system combinations, this is unreliable.
3795 Set this config setting to <em>rename</em> there; however, this will remove the
3796 check that makes sure that existing object files will not get overwritten.</p>
3797 </div>
3798 </dd>
3799 <dt class="hdlist1">core.notesRef</dt>
3800 <dd>
3801 <p>When showing commit messages, also show notes which are stored in
3802 the given ref.  The ref must be fully qualified.  If the given
3803 ref does not exist, it is not an error but means that no
3804 notes should be printed.</p>
3805 <div class="paragraph">
3806 <p>This setting defaults to "refs/notes/commits", and it can be overridden by
3807 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p>
3808 </div>
3809 </dd>
3810 <dt class="hdlist1">core.commitGraph</dt>
3811 <dd>
3812 <p>If true, then git will read the commit-graph file (if it exists)
3813 to parse the graph structure of commits. Defaults to true. See
3814 <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.</p>
3815 </dd>
3816 <dt class="hdlist1">core.useReplaceRefs</dt>
3817 <dd>
3818 <p>If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
3819 option was given on the command line. See <a href="git.html">git(1)</a> and
3820 <a href="git-replace.html">git-replace(1)</a> for more information.</p>
3821 </dd>
3822 <dt class="hdlist1">core.multiPackIndex</dt>
3823 <dd>
3824 <p>Use the multi-pack-index file to track multiple packfiles using a
3825 single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
3826 information. Defaults to true.</p>
3827 </dd>
3828 <dt class="hdlist1">core.sparseCheckout</dt>
3829 <dd>
3830 <p>Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
3831 for more information.</p>
3832 </dd>
3833 <dt class="hdlist1">core.sparseCheckoutCone</dt>
3834 <dd>
3835 <p>Enables the "cone mode" of the sparse checkout feature. When the
3836 sparse-checkout file contains a limited set of patterns, this
3837 mode provides significant performance advantages. The "non-cone
3838 mode" can be requested to allow specifying more flexible
3839 patterns by setting this variable to <em>false</em>. See
3840 <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.</p>
3841 </dd>
3842 <dt class="hdlist1">core.abbrev</dt>
3843 <dd>
3844 <p>Set the length object names are abbreviated to.  If
3845 unspecified or set to "auto", an appropriate value is
3846 computed based on the approximate number of packed objects
3847 in your repository, which hopefully is enough for
3848 abbreviated object names to stay unique for some time.
3849 If set to "no", no abbreviation is made and the object names
3850 are shown in their full length.
3851 The minimum length is 4.</p>
3852 </dd>
3853 <dt class="hdlist1">core.maxTreeDepth</dt>
3854 <dd>
3855 <p>The maximum depth Git is willing to recurse while traversing a
3856 tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
3857 to allow Git to abort cleanly, and should not generally need to
3858 be adjusted. When Git is compiled with MSVC, the default is 512.
3859 Otherwise, the default is 2048.</p>
3860 </dd>
3861 <dt class="hdlist1">credential.helper</dt>
3862 <dd>
3863 <p>Specify an external helper to be called when a username or
3864 password credential is needed; the helper may consult external
3865 storage to avoid prompting the user for the credentials. This is
3866 normally the name of a credential helper with possible
3867 arguments, but may also be an absolute path with arguments or, if
3868 preceded by <code>!</code>, shell commands.</p>
3869 <div class="paragraph">
3870 <p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
3871 for details and examples.</p>
3872 </div>
3873 </dd>
3874 <dt class="hdlist1">credential.useHttpPath</dt>
3875 <dd>
3876 <p>When acquiring credentials, consider the "path" component of an http
3877 or https URL to be important. Defaults to false. See
3878 <a href="gitcredentials.html">gitcredentials(7)</a> for more information.</p>
3879 </dd>
3880 <dt class="hdlist1">credential.username</dt>
3881 <dd>
3882 <p>If no username is set for a network authentication, use this username
3883 by default. See credential.&lt;context&gt;.* below, and
3884 <a href="gitcredentials.html">gitcredentials(7)</a>.</p>
3885 </dd>
3886 <dt class="hdlist1">credential.&lt;url&gt;.*</dt>
3887 <dd>
3888 <p>Any of the credential.* options above can be applied selectively to
3889 some credentials. For example, "credential.https://example.com.username"
3890 would set the default username only for https connections to
3891 example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
3892 matched.</p>
3893 </dd>
3894 <dt class="hdlist1">credentialCache.ignoreSIGHUP</dt>
3895 <dd>
3896 <p>Tell git-credential-cache&#8212;&#8203;daemon to ignore SIGHUP, instead of quitting.</p>
3897 </dd>
3898 <dt class="hdlist1">credentialStore.lockTimeoutMS</dt>
3899 <dd>
3900 <p>The length of time, in milliseconds, for git-credential-store to retry
3901 when trying to lock the credentials file. A value of 0 means not to retry at
3902 all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
3903 1s).</p>
3904 </dd>
3905 <dt class="hdlist1">diff.autoRefreshIndex</dt>
3906 <dd>
3907 <p>When using <em>git diff</em> to compare with work tree
3908 files, do not consider stat-only changes as changed.
3909 Instead, silently run <code>git update-index --refresh</code> to
3910 update the cached stat information for paths whose
3911 contents in the work tree match the contents in the
3912 index.  This option defaults to true.  Note that this
3913 affects only <em>git diff</em> Porcelain, and not lower level
3914 <em>diff</em> commands such as <em>git diff-files</em>.</p>
3915 </dd>
3916 <dt class="hdlist1">diff.dirstat</dt>
3917 <dd>
3918 <p>A comma separated list of <code>--dirstat</code> parameters specifying the
3919 default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
3920 and friends. The defaults can be overridden on the command line
3921 (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
3922 (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
3923 The following parameters are available:</p>
3924 <div class="openblock">
3925 <div class="content">
3926 <div class="dlist">
3927 <dl>
3928 <dt class="hdlist1"><code>changes</code></dt>
3929 <dd>
3930 <p>Compute the dirstat numbers by counting the lines that have been
3931 removed from the source, or added to the destination. This ignores
3932 the amount of pure code movements within a file.  In other words,
3933 rearranging lines in a file is not counted as much as other changes.
3934 This is the default behavior when no parameter is given.</p>
3935 </dd>
3936 <dt class="hdlist1"><code>lines</code></dt>
3937 <dd>
3938 <p>Compute the dirstat numbers by doing the regular line-based diff
3939 analysis, and summing the removed/added line counts. (For binary
3940 files, count 64-byte chunks instead, since binary files have no
3941 natural concept of lines). This is a more expensive <code>--dirstat</code>
3942 behavior than the <code>changes</code> behavior, but it does count rearranged
3943 lines within a file as much as other changes. The resulting output
3944 is consistent with what you get from the other <code>--*stat</code> options.</p>
3945 </dd>
3946 <dt class="hdlist1"><code>files</code></dt>
3947 <dd>
3948 <p>Compute the dirstat numbers by counting the number of files changed.
3949 Each changed file counts equally in the dirstat analysis. This is
3950 the computationally cheapest <code>--dirstat</code> behavior, since it does
3951 not have to look at the file contents at all.</p>
3952 </dd>
3953 <dt class="hdlist1"><code>cumulative</code></dt>
3954 <dd>
3955 <p>Count changes in a child directory for the parent directory as well.
3956 Note that when using <code>cumulative</code>, the sum of the percentages
3957 reported may exceed 100%. The default (non-cumulative) behavior can
3958 be specified with the <code>noncumulative</code> parameter.</p>
3959 </dd>
3960 <dt class="hdlist1">&lt;limit&gt;</dt>
3961 <dd>
3962 <p>An integer parameter specifies a cut-off percent (3% by default).
3963 Directories contributing less than this percentage of the changes
3964 are not shown in the output.</p>
3965 </dd>
3966 </dl>
3967 </div>
3968 </div>
3969 </div>
3970 <div class="paragraph">
3971 <p>Example: The following will count changed files, while ignoring
3972 directories with less than 10% of the total amount of changed files,
3973 and accumulating child directory counts in the parent directories:
3974 <code>files,10,cumulative</code>.</p>
3975 </div>
3976 </dd>
3977 <dt class="hdlist1">diff.statNameWidth</dt>
3978 <dd>
3979 <p>Limit the width of the filename part in --stat output. If set, applies
3980 to all commands generating --stat output except format-patch.</p>
3981 </dd>
3982 <dt class="hdlist1">diff.statGraphWidth</dt>
3983 <dd>
3984 <p>Limit the width of the graph part in --stat output. If set, applies
3985 to all commands generating --stat output except format-patch.</p>
3986 </dd>
3987 <dt class="hdlist1">diff.context</dt>
3988 <dd>
3989 <p>Generate diffs with &lt;n&gt; lines of context instead of the default
3990 of 3. This value is overridden by the -U option.</p>
3991 </dd>
3992 <dt class="hdlist1">diff.interHunkContext</dt>
3993 <dd>
3994 <p>Show the context between diff hunks, up to the specified number
3995 of lines, thereby fusing the hunks that are close to each other.
3996 This value serves as the default for the <code>--inter-hunk-context</code>
3997 command line option.</p>
3998 </dd>
3999 <dt class="hdlist1">diff.external</dt>
4000 <dd>
4001 <p>If this config variable is set, diff generation is not
4002 performed using the internal diff machinery, but using the
4003 given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
4004 environment variable.  The command is called with parameters
4005 as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
4006 you want to use an external diff program only on a subset of
4007 your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.</p>
4008 </dd>
4009 <dt class="hdlist1">diff.trustExitCode</dt>
4010 <dd>
4011 <p>If this boolean value is set to true then the
4012 <code>diff.external</code> command is expected to return exit code
4013 0 if it considers the input files to be equal or 1 if it
4014 considers them to be different, like <code>diff(1)</code>.
4015 If it is set to false, which is the default, then the command
4016 is expected to return exit code 0 regardless of equality.
4017 Any other exit code causes Git to report a fatal error.</p>
4018 </dd>
4019 <dt class="hdlist1">diff.ignoreSubmodules</dt>
4020 <dd>
4021 <p>Sets the default value of --ignore-submodules. Note that this
4022 affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4023 commands such as <em>git diff-files</em>. <em>git checkout</em>
4024 and <em>git switch</em> also honor
4025 this setting when reporting uncommitted changes. Setting it to
4026 <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
4027 and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
4028 overridden by using the --ignore-submodules command-line option.
4029 The <em>git submodule</em> commands are not affected by this setting.
4030 By default this is set to untracked so that any untracked
4031 submodules are ignored.</p>
4032 </dd>
4033 <dt class="hdlist1">diff.mnemonicPrefix</dt>
4034 <dd>
4035 <p>If set, <em>git diff</em> uses a prefix pair that is different from the
4036 standard "a/" and "b/" depending on what is being compared.  When
4037 this configuration is in effect, reverse diff output also swaps
4038 the order of the prefixes:</p>
4039 <div class="dlist">
4040 <dl>
4041 <dt class="hdlist1"><code>git diff</code></dt>
4042 <dd>
4043 <p>compares the (i)ndex and the (w)ork tree;</p>
4044 </dd>
4045 <dt class="hdlist1"><code>git diff HEAD</code></dt>
4046 <dd>
4047 <p>compares a (c)ommit and the (w)ork tree;</p>
4048 </dd>
4049 <dt class="hdlist1"><code>git diff --cached</code></dt>
4050 <dd>
4051 <p>compares a (c)ommit and the (i)ndex;</p>
4052 </dd>
4053 <dt class="hdlist1"><code>git diff HEAD:file1 file2</code></dt>
4054 <dd>
4055 <p>compares an (o)bject and a (w)ork tree entity;</p>
4056 </dd>
4057 <dt class="hdlist1"><code>git diff --no-index a b</code></dt>
4058 <dd>
4059 <p>compares two non-git things (1) and (2).</p>
4060 </dd>
4061 </dl>
4062 </div>
4063 </dd>
4064 <dt class="hdlist1">diff.noPrefix</dt>
4065 <dd>
4066 <p>If set, <em>git diff</em> does not show any source or destination prefix.</p>
4067 </dd>
4068 <dt class="hdlist1">diff.srcPrefix</dt>
4069 <dd>
4070 <p>If set, <em>git diff</em> uses this source prefix. Defaults to "a/".</p>
4071 </dd>
4072 <dt class="hdlist1">diff.dstPrefix</dt>
4073 <dd>
4074 <p>If set, <em>git diff</em> uses this destination prefix. Defaults to "b/".</p>
4075 </dd>
4076 <dt class="hdlist1">diff.relative</dt>
4077 <dd>
4078 <p>If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
4079 and show pathnames relative to the current directory.</p>
4080 </dd>
4081 <dt class="hdlist1">diff.orderFile</dt>
4082 <dd>
4083 <p>File indicating how to order files within a diff.
4084 See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
4085 If <code>diff.orderFile</code> is a relative pathname, it is treated as
4086 relative to the top of the working tree.</p>
4087 </dd>
4088 <dt class="hdlist1">diff.renameLimit</dt>
4089 <dd>
4090 <p>The number of files to consider in the exhaustive portion of
4091 copy/rename detection; equivalent to the <em>git diff</em> option
4092 <code>-l</code>.  If not set, the default value is currently 1000.  This
4093 setting has no effect if rename detection is turned off.</p>
4094 </dd>
4095 <dt class="hdlist1">diff.renames</dt>
4096 <dd>
4097 <p>Whether and how Git detects renames.  If set to "false",
4098 rename detection is disabled. If set to "true", basic rename
4099 detection is enabled.  If set to "copies" or "copy", Git will
4100 detect copies, as well.  Defaults to true.  Note that this
4101 affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
4102 <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
4103 <a href="git-diff-files.html">git-diff-files(1)</a>.</p>
4104 </dd>
4105 <dt class="hdlist1">diff.suppressBlankEmpty</dt>
4106 <dd>
4107 <p>A boolean to inhibit the standard behavior of printing a space
4108 before each empty output line. Defaults to false.</p>
4109 </dd>
4110 <dt class="hdlist1">diff.submodule</dt>
4111 <dd>
4112 <p>Specify the format in which differences in submodules are
4113 shown.  The "short" format just shows the names of the commits
4114 at the beginning and end of the range. The "log" format lists
4115 the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
4116 does. The "diff" format shows an inline diff of the changed
4117 contents of the submodule. Defaults to "short".</p>
4118 </dd>
4119 <dt class="hdlist1">diff.wordRegex</dt>
4120 <dd>
4121 <p>A POSIX Extended Regular Expression used to determine what is a "word"
4122 when performing word-by-word difference calculations.  Character
4123 sequences that match the regular expression are "words", all other
4124 characters are <strong>ignorable</strong> whitespace.</p>
4125 </dd>
4126 <dt class="hdlist1">diff.&lt;driver&gt;.command</dt>
4127 <dd>
4128 <p>The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
4129 for details.</p>
4130 </dd>
4131 <dt class="hdlist1">diff.&lt;driver&gt;.trustExitCode</dt>
4132 <dd>
4133 <p>If this boolean value is set to true then the
4134 <code>diff.&lt;driver&gt;.command</code> command is expected to return exit code
4135 0 if it considers the input files to be equal or 1 if it
4136 considers them to be different, like <code>diff(1)</code>.
4137 If it is set to false, which is the default, then the command
4138 is expected to return exit code 0 regardless of equality.
4139 Any other exit code causes Git to report a fatal error.</p>
4140 </dd>
4141 <dt class="hdlist1">diff.&lt;driver&gt;.xfuncname</dt>
4142 <dd>
4143 <p>The regular expression that the diff driver should use to
4144 recognize the hunk header.  A built-in pattern may also be used.
4145 See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4146 </dd>
4147 <dt class="hdlist1">diff.&lt;driver&gt;.binary</dt>
4148 <dd>
4149 <p>Set this option to true to make the diff driver treat files as
4150 binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4151 </dd>
4152 <dt class="hdlist1">diff.&lt;driver&gt;.textconv</dt>
4153 <dd>
4154 <p>The command that the diff driver should call to generate the
4155 text-converted version of a file.  The result of the
4156 conversion is used to generate a human-readable diff.  See
4157 <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4158 </dd>
4159 <dt class="hdlist1">diff.&lt;driver&gt;.wordRegex</dt>
4160 <dd>
4161 <p>The regular expression that the diff driver should use to
4162 split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
4163 details.</p>
4164 </dd>
4165 <dt class="hdlist1">diff.&lt;driver&gt;.cachetextconv</dt>
4166 <dd>
4167 <p>Set this option to true to make the diff driver cache the text
4168 conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4169 <div class="dlist">
4170 <dl>
4171 <dt class="hdlist1"><code>araxis</code></dt>
4172 <dd>
4173 <p>Use Araxis Merge (requires a graphical session)</p>
4174 </dd>
4175 <dt class="hdlist1"><code>bc</code></dt>
4176 <dd>
4177 <p>Use Beyond Compare (requires a graphical session)</p>
4178 </dd>
4179 <dt class="hdlist1"><code>bc3</code></dt>
4180 <dd>
4181 <p>Use Beyond Compare (requires a graphical session)</p>
4182 </dd>
4183 <dt class="hdlist1"><code>bc4</code></dt>
4184 <dd>
4185 <p>Use Beyond Compare (requires a graphical session)</p>
4186 </dd>
4187 <dt class="hdlist1"><code>codecompare</code></dt>
4188 <dd>
4189 <p>Use Code Compare (requires a graphical session)</p>
4190 </dd>
4191 <dt class="hdlist1"><code>deltawalker</code></dt>
4192 <dd>
4193 <p>Use DeltaWalker (requires a graphical session)</p>
4194 </dd>
4195 <dt class="hdlist1"><code>diffmerge</code></dt>
4196 <dd>
4197 <p>Use DiffMerge (requires a graphical session)</p>
4198 </dd>
4199 <dt class="hdlist1"><code>diffuse</code></dt>
4200 <dd>
4201 <p>Use Diffuse (requires a graphical session)</p>
4202 </dd>
4203 <dt class="hdlist1"><code>ecmerge</code></dt>
4204 <dd>
4205 <p>Use ECMerge (requires a graphical session)</p>
4206 </dd>
4207 <dt class="hdlist1"><code>emerge</code></dt>
4208 <dd>
4209 <p>Use Emacs' Emerge</p>
4210 </dd>
4211 <dt class="hdlist1"><code>examdiff</code></dt>
4212 <dd>
4213 <p>Use ExamDiff Pro (requires a graphical session)</p>
4214 </dd>
4215 <dt class="hdlist1"><code>guiffy</code></dt>
4216 <dd>
4217 <p>Use Guiffy&#8217;s Diff Tool (requires a graphical session)</p>
4218 </dd>
4219 <dt class="hdlist1"><code>gvimdiff</code></dt>
4220 <dd>
4221 <p>Use gVim (requires a graphical session)</p>
4222 </dd>
4223 <dt class="hdlist1"><code>kdiff3</code></dt>
4224 <dd>
4225 <p>Use KDiff3 (requires a graphical session)</p>
4226 </dd>
4227 <dt class="hdlist1"><code>kompare</code></dt>
4228 <dd>
4229 <p>Use Kompare (requires a graphical session)</p>
4230 </dd>
4231 <dt class="hdlist1"><code>meld</code></dt>
4232 <dd>
4233 <p>Use Meld (requires a graphical session)</p>
4234 </dd>
4235 <dt class="hdlist1"><code>nvimdiff</code></dt>
4236 <dd>
4237 <p>Use Neovim</p>
4238 </dd>
4239 <dt class="hdlist1"><code>opendiff</code></dt>
4240 <dd>
4241 <p>Use FileMerge (requires a graphical session)</p>
4242 </dd>
4243 <dt class="hdlist1"><code>p4merge</code></dt>
4244 <dd>
4245 <p>Use HelixCore P4Merge (requires a graphical session)</p>
4246 </dd>
4247 <dt class="hdlist1"><code>smerge</code></dt>
4248 <dd>
4249 <p>Use Sublime Merge (requires a graphical session)</p>
4250 </dd>
4251 <dt class="hdlist1"><code>tkdiff</code></dt>
4252 <dd>
4253 <p>Use TkDiff (requires a graphical session)</p>
4254 </dd>
4255 <dt class="hdlist1"><code>vimdiff</code></dt>
4256 <dd>
4257 <p>Use Vim</p>
4258 </dd>
4259 <dt class="hdlist1"><code>vscode</code></dt>
4260 <dd>
4261 <p>Use Visual Studio Code (requires a graphical session)</p>
4262 </dd>
4263 <dt class="hdlist1"><code>winmerge</code></dt>
4264 <dd>
4265 <p>Use WinMerge (requires a graphical session)</p>
4266 </dd>
4267 <dt class="hdlist1"><code>xxdiff</code></dt>
4268 <dd>
4269 <p>Use xxdiff (requires a graphical session)</p>
4270 </dd>
4271 </dl>
4272 </div>
4273 </dd>
4274 <dt class="hdlist1">diff.indentHeuristic</dt>
4275 <dd>
4276 <p>Set this option to <code>false</code> to disable the default heuristics
4277 that shift diff hunk boundaries to make patches easier to read.</p>
4278 </dd>
4279 <dt class="hdlist1">diff.algorithm</dt>
4280 <dd>
4281 <p>Choose a diff algorithm.  The variants are as follows:</p>
4282 <div class="openblock">
4283 <div class="content">
4284 <div class="dlist">
4285 <dl>
4286 <dt class="hdlist1"><code>default</code>, <code>myers</code></dt>
4287 <dd>
4288 <p>The basic greedy diff algorithm. Currently, this is the default.</p>
4289 </dd>
4290 <dt class="hdlist1"><code>minimal</code></dt>
4291 <dd>
4292 <p>Spend extra time to make sure the smallest possible diff is
4293 produced.</p>
4294 </dd>
4295 <dt class="hdlist1"><code>patience</code></dt>
4296 <dd>
4297 <p>Use "patience diff" algorithm when generating patches.</p>
4298 </dd>
4299 <dt class="hdlist1"><code>histogram</code></dt>
4300 <dd>
4301 <p>This algorithm extends the patience algorithm to "support
4302 low-occurrence common elements".</p>
4303 </dd>
4304 </dl>
4305 </div>
4306 </div>
4307 </div>
4308 </dd>
4309 <dt class="hdlist1">diff.wsErrorHighlight</dt>
4310 <dd>
4311 <p>Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
4312 lines of the diff.  Multiple values are separated by comma,
4313 <code>none</code> resets previous values, <code>default</code> reset the list to
4314 <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
4315 whitespace errors are colored with <code>color.diff.whitespace</code>.
4316 The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
4317 overrides this setting.</p>
4318 </dd>
4319 <dt class="hdlist1">diff.colorMoved</dt>
4320 <dd>
4321 <p>If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
4322 in a diff are colored differently, for details of valid modes
4323 see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
4324 true the default color mode will be used. When set to false,
4325 moved lines are not colored.</p>
4326 </dd>
4327 <dt class="hdlist1">diff.colorMovedWS</dt>
4328 <dd>
4329 <p>When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
4330 this option controls the <code>&lt;mode&gt;</code> how spaces are treated.
4331 For details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.</p>
4332 </dd>
4333 <dt class="hdlist1">diff.tool</dt>
4334 <dd>
4335 <p>Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
4336 This variable overrides the value configured in <code>merge.tool</code>.
4337 The list below shows the valid built-in values.
4338 Any other value is treated as a custom diff tool and requires
4339 that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.</p>
4340 </dd>
4341 <dt class="hdlist1">diff.guitool</dt>
4342 <dd>
4343 <p>Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
4344 the -g/--gui flag is specified. This variable overrides the value
4345 configured in <code>merge.guitool</code>. The list below shows the valid
4346 built-in values. Any other value is treated as a custom diff tool
4347 and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
4348 is defined.</p>
4349 </dd>
4350 <dt class="hdlist1">difftool.&lt;tool&gt;.cmd</dt>
4351 <dd>
4352 <p>Specify the command to invoke the specified diff tool.
4353 The specified command is evaluated in shell with the following
4354 variables available:  <em>LOCAL</em> is set to the name of the temporary
4355 file containing the contents of the diff pre-image and <em>REMOTE</em>
4356 is set to the name of the temporary file containing the contents
4357 of the diff post-image.</p>
4358 <div class="paragraph">
4359 <p>See the <code>--tool=&lt;tool&gt;</code> option in <a href="git-difftool.html">git-difftool(1)</a> for more details.</p>
4360 </div>
4361 </dd>
4362 <dt class="hdlist1">difftool.&lt;tool&gt;.path</dt>
4363 <dd>
4364 <p>Override the path for the given tool.  This is useful in case
4365 your tool is not in the PATH.</p>
4366 </dd>
4367 <dt class="hdlist1">difftool.trustExitCode</dt>
4368 <dd>
4369 <p>Exit difftool if the invoked diff tool returns a non-zero exit status.</p>
4370 <div class="paragraph">
4371 <p>See the <code>--trust-exit-code</code> option in <a href="git-difftool.html">git-difftool(1)</a> for more details.</p>
4372 </div>
4373 </dd>
4374 <dt class="hdlist1">difftool.prompt</dt>
4375 <dd>
4376 <p>Prompt before each invocation of the diff tool.</p>
4377 </dd>
4378 <dt class="hdlist1">difftool.guiDefault</dt>
4379 <dd>
4380 <p>Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
4381 the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
4382 depending on the presence of a <code>DISPLAY</code> environment variable value. The
4383 default is <code>false</code>, where the <code>--gui</code> argument must be provided
4384 explicitly for the <code>diff.guitool</code> to be used.</p>
4385 </dd>
4386 <dt class="hdlist1">extensions.objectFormat</dt>
4387 <dd>
4388 <p>Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
4389 <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
4390 this key unless <code>core.repositoryFormatVersion</code> is 1.</p>
4391 <div class="paragraph">
4392 <p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
4393 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
4394 work and will produce hard-to-diagnose issues.</p>
4395 </div>
4396 </dd>
4397 <dt class="hdlist1">extensions.compatObjectFormat</dt>
4398 <dd>
4399 <p>Specify a compatitbility hash algorithm to use.  The acceptable values
4400 are <code>sha1</code> and <code>sha256</code>.  The value specified must be different from the
4401 value of extensions.objectFormat.  This allows client level
4402 interoperability between git repositories whose objectFormat matches
4403 this compatObjectFormat.  In particular when fully implemented the
4404 pushes and pulls from a repository in whose objectFormat matches
4405 compatObjectFormat.  As well as being able to use oids encoded in
4406 compatObjectFormat in addition to oids encoded with objectFormat to
4407 locally specify objects.</p>
4408 </dd>
4409 <dt class="hdlist1">extensions.refStorage</dt>
4410 <dd>
4411 <p>Specify the ref storage format to use. The acceptable values are:</p>
4412 <div class="ulist">
4413 <ul>
4414 <li>
4415 <p><code>files</code> for loose files with packed-refs. This is the default.</p>
4416 </li>
4417 <li>
4418 <p><code>reftable</code> for the reftable format. This format is experimental and its
4419 internals are subject to change.</p>
4420 <div class="paragraph">
4421 <p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p>
4422 </div>
4423 <div class="paragraph">
4424 <p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
4425 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
4426 work and will produce hard-to-diagnose issues.</p>
4427 </div>
4428 </li>
4429 </ul>
4430 </div>
4431 </dd>
4432 <dt class="hdlist1">extensions.worktreeConfig</dt>
4433 <dd>
4434 <p>If enabled, then worktrees will load config settings from the
4435 <code>$GIT_DIR/config.worktree</code> file in addition to the
4436 <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
4437 <code>$GIT_DIR</code> are the same for the main working tree, while other
4438 working trees have <code>$GIT_DIR</code> equal to
4439 <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
4440 <code>config.worktree</code> file will override settings from any other
4441 config files.</p>
4442 <div class="paragraph">
4443 <p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
4444 certain values from the common config file to the main working tree&#8217;s
4445 <code>config.worktree</code> file, if present:</p>
4446 </div>
4447 <div class="ulist">
4448 <ul>
4449 <li>
4450 <p><code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
4451 <code>$GIT_COMMON_DIR/config.worktree</code>.</p>
4452 </li>
4453 <li>
4454 <p>If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
4455 to <code>$GIT_COMMON_DIR/config.worktree</code>.</p>
4456 <div class="paragraph">
4457 <p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
4458 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
4459 sparse-checkout settings for each worktree. By default, the <code>git
4460 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
4461 these config values on a per-worktree basis, and uses the
4462 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
4463 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
4464 details.</p>
4465 </div>
4466 <div class="paragraph">
4467 <p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
4468 regardless of the <code>core.repositoryFormatVersion</code> setting.</p>
4469 </div>
4470 </li>
4471 </ul>
4472 </div>
4473 </dd>
4474 <dt class="hdlist1">fastimport.unpackLimit</dt>
4475 <dd>
4476 <p>If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
4477 is below this limit, then the objects will be unpacked into
4478 loose object files.  However, if the number of imported objects
4479 equals or exceeds this limit, then the pack will be stored as a
4480 pack.  Storing the pack from a fast-import can make the import
4481 operation complete faster, especially on slow filesystems.  If
4482 not set, the value of <code>transfer.unpackLimit</code> is used instead.</p>
4483 </dd>
4484 <dt class="hdlist1">feature.*</dt>
4485 <dd>
4486 <p>The config settings that start with <code>feature.</code> modify the defaults of
4487 a group of other config settings. These groups are created by the Git
4488 developer community as recommended defaults and are subject to change.
4489 In particular, new config options may be added with different defaults.</p>
4490 </dd>
4491 <dt class="hdlist1">feature.experimental</dt>
4492 <dd>
4493 <p>Enable config options that are new to Git, and are being considered for
4494 future defaults. Config settings included here may be added or removed
4495 with each release, including minor version updates. These settings may
4496 have unintended interactions since they are so new. Please enable this
4497 setting if you are interested in providing feedback on experimental
4498 features. The new default values are:</p>
4499 <div class="ulist">
4500 <ul>
4501 <li>
4502 <p><code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
4503 skipping more commits at a time, reducing the number of round trips.</p>
4504 </li>
4505 <li>
4506 <p><code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
4507 walking fewer objects.</p>
4508 </li>
4509 <li>
4510 <p><code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
4511 reusing objects from multiple packs instead of just one.</p>
4512 </li>
4513 </ul>
4514 </div>
4515 </dd>
4516 <dt class="hdlist1">feature.manyFiles</dt>
4517 <dd>
4518 <p>Enable config options that optimize for repos with many files in the
4519 working directory. With many files, commands such as <code>git status</code> and
4520 <code>git checkout</code> may be slow and these new defaults improve performance:</p>
4521 <div class="ulist">
4522 <ul>
4523 <li>
4524 <p><code>index.skipHash=true</code> speeds up index writes by not computing a trailing
4525 checksum. Note that this will cause Git versions earlier than 2.13.0 to
4526 refuse to parse the index and Git versions earlier than 2.40.0 will report
4527 a corrupted index during <code>git fsck</code>.</p>
4528 </li>
4529 <li>
4530 <p><code>index.version=4</code> enables path-prefix compression in the index.</p>
4531 </li>
4532 <li>
4533 <p><code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
4534 that mtime is working on your machine.</p>
4535 </li>
4536 </ul>
4537 </div>
4538 </dd>
4539 <dt class="hdlist1">fetch.recurseSubmodules</dt>
4540 <dd>
4541 <p>This option controls whether <code>git fetch</code> (and the underlying fetch
4542 in <code>git pull</code>) will recursively fetch into populated submodules.
4543 This option can be set either to a boolean value or to <em>on-demand</em>.
4544 Setting it to a boolean changes the behavior of fetch and pull to
4545 recurse unconditionally into submodules when set to true or to not
4546 recurse at all when set to false. When set to <em>on-demand</em>, fetch and
4547 pull will only recurse into a populated submodule when its
4548 superproject retrieves a commit that updates the submodule&#8217;s
4549 reference.
4550 Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.</p>
4551 </dd>
4552 <dt class="hdlist1">fetch.fsckObjects</dt>
4553 <dd>
4554 <p>If it is set to true, git-fetch-pack will check all fetched
4555 objects. See <code>transfer.fsckObjects</code> for what&#8217;s
4556 checked. Defaults to false. If not set, the value of
4557 <code>transfer.fsckObjects</code> is used instead.</p>
4558 </dd>
4559 <dt class="hdlist1">fetch.fsck.&lt;msg-id&gt;</dt>
4560 <dd>
4561 <p>Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
4562 <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
4563 the <code>fsck.&lt;msg-id&gt;</code> documentation for details.</p>
4564 </dd>
4565 <dt class="hdlist1">fetch.fsck.skipList</dt>
4566 <dd>
4567 <p>Acts like <code>fsck.skipList</code>, but is used by
4568 <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
4569 the <code>fsck.skipList</code> documentation for details.</p>
4570 </dd>
4571 <dt class="hdlist1">fetch.unpackLimit</dt>
4572 <dd>
4573 <p>If the number of objects fetched over the Git native
4574 transfer is below this
4575 limit, then the objects will be unpacked into loose object
4576 files. However if the number of received objects equals or
4577 exceeds this limit then the received pack will be stored as
4578 a pack, after adding any missing delta bases.  Storing the
4579 pack from a push can make the push operation complete faster,
4580 especially on slow filesystems.  If not set, the value of
4581 <code>transfer.unpackLimit</code> is used instead.</p>
4582 </dd>
4583 <dt class="hdlist1">fetch.prune</dt>
4584 <dd>
4585 <p>If true, fetch will automatically behave as if the <code>--prune</code>
4586 option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
4587 and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.</p>
4588 </dd>
4589 <dt class="hdlist1">fetch.pruneTags</dt>
4590 <dd>
4591 <p>If true, fetch will automatically behave as if the
4592 <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
4593 if not set already. This allows for setting both this option
4594 and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
4595 refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
4596 section of <a href="git-fetch.html">git-fetch(1)</a>.</p>
4597 </dd>
4598 <dt class="hdlist1">fetch.all</dt>
4599 <dd>
4600 <p>If true, fetch will attempt to update all available remotes.
4601 This behavior can be overridden by passing <code>--no-all</code> or by
4602 explicitly specifying one or more remote(s) to fetch from.
4603 Defaults to false.</p>
4604 </dd>
4605 <dt class="hdlist1">fetch.output</dt>
4606 <dd>
4607 <p>Control how ref update status is printed. Valid values are
4608 <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
4609 OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.</p>
4610 </dd>
4611 <dt class="hdlist1">fetch.negotiationAlgorithm</dt>
4612 <dd>
4613 <p>Control how information about the commits in the local repository
4614 is sent when negotiating the contents of the packfile to be sent by
4615 the server.  Set to "consecutive" to use an algorithm that walks
4616 over consecutive commits checking each one.  Set to "skipping" to
4617 use an algorithm that skips commits in an effort to converge
4618 faster, but may result in a larger-than-necessary packfile; or set
4619 to "noop" to not send any information at all, which will almost
4620 certainly result in a larger-than-necessary packfile, but will skip
4621 the negotiation step.  Set to "default" to override settings made
4622 previously and use the default behaviour.  The default is normally
4623 "consecutive", but if <code>feature.experimental</code> is true, then the
4624 default is "skipping".  Unknown values will cause <em>git fetch</em> to
4625 error out.</p>
4626 <div class="paragraph">
4627 <p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
4628 <a href="git-fetch.html">git-fetch(1)</a>.</p>
4629 </div>
4630 </dd>
4631 <dt class="hdlist1">fetch.showForcedUpdates</dt>
4632 <dd>
4633 <p>Set to false to enable <code>--no-show-forced-updates</code> in
4634 <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
4635 Defaults to true.</p>
4636 </dd>
4637 <dt class="hdlist1">fetch.parallel</dt>
4638 <dd>
4639 <p>Specifies the maximal number of fetch operations to be run in parallel
4640 at a time (submodules, or remotes when the <code>--multiple</code> option of
4641 <a href="git-fetch.html">git-fetch(1)</a> is in effect).</p>
4642 <div class="paragraph">
4643 <p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p>
4644 </div>
4645 <div class="paragraph">
4646 <p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
4647 config setting.</p>
4648 </div>
4649 </dd>
4650 <dt class="hdlist1">fetch.writeCommitGraph</dt>
4651 <dd>
4652 <p>Set to true to write a commit-graph after every <code>git fetch</code> command
4653 that downloads a pack-file from a remote. Using the <code>--split</code> option,
4654 most executions will create a very small commit-graph file on top of
4655 the existing commit-graph file(s). Occasionally, these files will
4656 merge and the write may take longer. Having an updated commit-graph
4657 file helps performance of many Git commands, including <code>git merge-base</code>,
4658 <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.</p>
4659 </dd>
4660 <dt class="hdlist1">fetch.bundleURI</dt>
4661 <dd>
4662 <p>This value stores a URI for downloading Git object data from a bundle
4663 URI before performing an incremental fetch from the origin Git server.
4664 This is similar to how the <code>--bundle-uri</code> option behaves in
4665 <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
4666 <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
4667 list that is organized for incremental fetches.</p>
4668 <div class="paragraph">
4669 <p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
4670 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
4671 the new bundle URI.</p>
4672 </div>
4673 </dd>
4674 <dt class="hdlist1">fetch.bundleCreationToken</dt>
4675 <dd>
4676 <p>When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
4677 list that uses the "creationToken" heuristic, this config value
4678 stores the maximum <code>creationToken</code> value of the downloaded bundles.
4679 This value is used to prevent downloading bundles in the future
4680 if the advertised <code>creationToken</code> is not strictly larger than this
4681 value.</p>
4682 <div class="paragraph">
4683 <p>The creation token values are chosen by the provider serving the specific
4684 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
4685 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p>
4686 </div>
4687 </dd>
4688 <dt class="hdlist1">filter.&lt;driver&gt;.clean</dt>
4689 <dd>
4690 <p>The command which is used to convert the content of a worktree
4691 file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
4692 details.</p>
4693 </dd>
4694 <dt class="hdlist1">filter.&lt;driver&gt;.smudge</dt>
4695 <dd>
4696 <p>The command which is used to convert the content of a blob
4697 object to a worktree file upon checkout.  See
4698 <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4699 </dd>
4700 <dt class="hdlist1">format.attach</dt>
4701 <dd>
4702 <p>Enable multipart/mixed attachments as the default for
4703 <em>format-patch</em>.  The value can also be a double quoted string
4704 which will enable attachments as the default and set the
4705 value as the boundary.  See the --attach option in
4706 <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
4707 value, set it to an empty string.</p>
4708 </dd>
4709 <dt class="hdlist1">format.from</dt>
4710 <dd>
4711 <p>Provides the default value for the <code>--from</code> option to format-patch.
4712 Accepts a boolean value, or a name and email address.  If false,
4713 format-patch defaults to <code>--no-from</code>, using commit authors directly in
4714 the "From:" field of patch mails.  If true, format-patch defaults to
4715 <code>--from</code>, using your committer identity in the "From:" field of patch
4716 mails and including a "From:" field in the body of the patch mail if
4717 different.  If set to a non-boolean value, format-patch uses that
4718 value instead of your committer identity.  Defaults to false.</p>
4719 </dd>
4720 <dt class="hdlist1">format.forceInBodyFrom</dt>
4721 <dd>
4722 <p>Provides the default value for the <code>--[no-]force-in-body-from</code>
4723 option to format-patch.  Defaults to false.</p>
4724 </dd>
4725 <dt class="hdlist1">format.numbered</dt>
4726 <dd>
4727 <p>A boolean which can enable or disable sequence numbers in patch
4728 subjects.  It defaults to "auto" which enables it only if there
4729 is more than one patch.  It can be enabled or disabled for all
4730 messages by setting it to "true" or "false".  See --numbered
4731 option in <a href="git-format-patch.html">git-format-patch(1)</a>.</p>
4732 </dd>
4733 <dt class="hdlist1">format.headers</dt>
4734 <dd>
4735 <p>Additional email headers to include in a patch to be submitted
4736 by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.</p>
4737 </dd>
4738 <dt class="hdlist1">format.to</dt>
4739 <dt class="hdlist1">format.cc</dt>
4740 <dd>
4741 <p>Additional recipients to include in a patch to be submitted
4742 by mail.  See the --to and --cc options in
4743 <a href="git-format-patch.html">git-format-patch(1)</a>.</p>
4744 </dd>
4745 <dt class="hdlist1">format.subjectPrefix</dt>
4746 <dd>
4747 <p>The default for format-patch is to output files with the <em>[PATCH]</em>
4748 subject prefix. Use this variable to change that prefix.</p>
4749 </dd>
4750 <dt class="hdlist1">format.coverFromDescription</dt>
4751 <dd>
4752 <p>The default mode for format-patch to determine which parts of
4753 the cover letter will be populated using the branch&#8217;s
4754 description. See the <code>--cover-from-description</code> option in
4755 <a href="git-format-patch.html">git-format-patch(1)</a>.</p>
4756 </dd>
4757 <dt class="hdlist1">format.signature</dt>
4758 <dd>
4759 <p>The default for format-patch is to output a signature containing
4760 the Git version number. Use this variable to change that default.
4761 Set this variable to the empty string ("") to suppress
4762 signature generation.</p>
4763 </dd>
4764 <dt class="hdlist1">format.signatureFile</dt>
4765 <dd>
4766 <p>Works just like format.signature except the contents of the
4767 file specified by this variable will be used as the signature.</p>
4768 </dd>
4769 <dt class="hdlist1">format.suffix</dt>
4770 <dd>
4771 <p>The default for format-patch is to output files with the suffix
4772 <code>.patch</code>. Use this variable to change that suffix (make sure to
4773 include the dot if you want it).</p>
4774 </dd>
4775 <dt class="hdlist1">format.encodeEmailHeaders</dt>
4776 <dd>
4777 <p>Encode email headers that have non-ASCII characters with
4778 "Q-encoding" (described in RFC 2047) for email transmission.
4779 Defaults to true.</p>
4780 </dd>
4781 <dt class="hdlist1">format.pretty</dt>
4782 <dd>
4783 <p>The default pretty format for log/show/whatchanged command.
4784 See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
4785 <a href="git-whatchanged.html">git-whatchanged(1)</a>.</p>
4786 </dd>
4787 <dt class="hdlist1">format.thread</dt>
4788 <dd>
4789 <p>The default threading style for <em>git format-patch</em>.  Can be
4790 a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
4791 makes every mail a reply to the head of the series,
4792 where the head is chosen from the cover letter, the
4793 <code>--in-reply-to</code>, and the first patch mail, in this order.
4794 <code>deep</code> threading makes every mail a reply to the previous one.
4795 A true boolean value is the same as <code>shallow</code>, and a false
4796 value disables threading.</p>
4797 </dd>
4798 <dt class="hdlist1">format.signOff</dt>
4799 <dd>
4800 <p>A boolean value which lets you enable the <code>-s/--signoff</code> option of
4801 format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
4802 patch should be a conscious act and means that you certify you have
4803 the rights to submit this work under the same open source license.
4804 Please see the <em>SubmittingPatches</em> document for further discussion.</p>
4805 </dd>
4806 <dt class="hdlist1">format.coverLetter</dt>
4807 <dd>
4808 <p>A boolean that controls whether to generate a cover-letter when
4809 format-patch is invoked, but in addition can be set to "auto", to
4810 generate a cover-letter only when there&#8217;s more than one patch.
4811 Default is false.</p>
4812 </dd>
4813 <dt class="hdlist1">format.outputDirectory</dt>
4814 <dd>
4815 <p>Set a custom directory to store the resulting files instead of the
4816 current working directory. All directory components will be created.</p>
4817 </dd>
4818 <dt class="hdlist1">format.filenameMaxLength</dt>
4819 <dd>
4820 <p>The maximum length of the output filenames generated by the
4821 <code>format-patch</code> command; defaults to 64.  Can be overridden
4822 by the <code>--filename-max-length=&lt;n&gt;</code> command line option.</p>
4823 </dd>
4824 <dt class="hdlist1">format.useAutoBase</dt>
4825 <dd>
4826 <p>A boolean value which lets you enable the <code>--base=auto</code> option of
4827 format-patch by default. Can also be set to "whenAble" to allow
4828 enabling <code>--base=auto</code> if a suitable base is available, but to skip
4829 adding base info otherwise without the format dying.</p>
4830 </dd>
4831 <dt class="hdlist1">format.notes</dt>
4832 <dd>
4833 <p>Provides the default value for the <code>--notes</code> option to
4834 format-patch. Accepts a boolean value, or a ref which specifies
4835 where to get notes. If false, format-patch defaults to
4836 <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
4837 set to a non-boolean value, format-patch defaults to
4838 <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
4839 to false.</p>
4840 <div class="paragraph">
4841 <p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
4842 instead.</p>
4843 </div>
4844 <div class="paragraph">
4845 <p>This configuration can be specified multiple times in order to allow
4846 multiple notes refs to be included. In that case, it will behave
4847 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
4848 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
4849 also show notes from that notes ref and a value of <code>false</code> will negate
4850 previous configurations and not show notes.</p>
4851 </div>
4852 <div class="paragraph">
4853 <p>For example,</p>
4854 </div>
4855 <div class="listingblock">
4856 <div class="content">
4857 <pre>[format]
4858         notes = true
4859         notes = foo
4860         notes = false
4861         notes = bar</pre>
4862 </div>
4863 </div>
4864 <div class="paragraph">
4865 <p>will only show notes from <code>refs/notes/bar</code>.</p>
4866 </div>
4867 </dd>
4868 <dt class="hdlist1">format.mboxrd</dt>
4869 <dd>
4870 <p>A boolean value which enables the robust "mboxrd" format when
4871 <code>--stdout</code> is in use to escape "^&gt;+From " lines.</p>
4872 </dd>
4873 <dt class="hdlist1">format.noprefix</dt>
4874 <dd>
4875 <p>If set, do not show any source or destination prefix in patches.
4876 This is equivalent to the <code>diff.noprefix</code> option used by <code>git
4877 diff</code> (but which is not respected by <code>format-patch</code>). Note that
4878 by setting this, the receiver of any patches you generate will
4879 have to apply them using the <code>-p0</code> option.</p>
4880 </dd>
4881 <dt class="hdlist1">fsck.&lt;msg-id&gt;</dt>
4882 <dd>
4883 <p>During fsck git may find issues with legacy data which
4884 wouldn&#8217;t be generated by current versions of git, and which
4885 wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
4886 set. This feature is intended to support working with legacy
4887 repositories containing such data.</p>
4888 <div class="paragraph">
4889 <p>Setting <code>fsck.&lt;msg-id&gt;</code> will be picked up by <a href="git-fsck.html">git-fsck(1)</a>, but
4890 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
4891 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p>
4892 </div>
4893 <div class="paragraph">
4894 <p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
4895 same applies for the corresponding <code>receive.fsck.*</code> and
4896 <code>fetch.fsck.*</code>. variables.</p>
4897 </div>
4898 <div class="paragraph">
4899 <p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
4900 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
4901 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
4902 uniformly configure the same fsck settings in different circumstances,
4903 all three of them must be set to the same values.</p>
4904 </div>
4905 <div class="paragraph">
4906 <p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
4907 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
4908 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
4909 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
4910 with the message ID, e.g. "missingEmail: invalid author/committer
4911 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
4912 will hide that issue.</p>
4913 </div>
4914 <div class="paragraph">
4915 <p>In general, it is better to enumerate existing objects with problems
4916 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
4917 problematic objects share to be ignored, as doing the latter will
4918 allow new instances of the same breakages go unnoticed.</p>
4919 </div>
4920 <div class="paragraph">
4921 <p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
4922 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
4923 will only cause git to warn.</p>
4924 </div>
4925 <div class="paragraph">
4926 <p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
4927 values of <code>&lt;msg-id&gt;</code>.</p>
4928 </div>
4929 </dd>
4930 <dt class="hdlist1">fsck.skipList</dt>
4931 <dd>
4932 <p>The path to a list of object names (i.e. one unabbreviated SHA-1 per
4933 line) that are known to be broken in a non-fatal way and should
4934 be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
4935 lines, and any leading and trailing whitespace are ignored. Everything
4936 but a SHA-1 per line will error out on older versions.</p>
4937 <div class="paragraph">
4938 <p>This feature is useful when an established project should be accepted
4939 despite early commits containing errors that can be safely ignored,
4940 such as invalid committer email addresses.  Note: corrupt objects
4941 cannot be skipped with this setting.</p>
4942 </div>
4943 <div class="paragraph">
4944 <p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
4945 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p>
4946 </div>
4947 <div class="paragraph">
4948 <p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
4949 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
4950 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
4951 uniformly configure the same fsck settings in different circumstances,
4952 all three of them must be set to the same values.</p>
4953 </div>
4954 <div class="paragraph">
4955 <p>Older versions of Git (before 2.20) documented that the object names
4956 list should be sorted. This was never a requirement; the object names
4957 could appear in any order, but when reading the list we tracked whether
4958 the list was sorted for the purposes of an internal binary search
4959 implementation, which could save itself some work with an already sorted
4960 list. Unless you had a humongous list there was no reason to go out of
4961 your way to pre-sort the list. After Git version 2.20 a hash implementation
4962 is used instead, so there&#8217;s now no reason to pre-sort the list.</p>
4963 </div>
4964 </dd>
4965 <dt class="hdlist1">fsmonitor.allowRemote</dt>
4966 <dd>
4967 <p>By default, the fsmonitor daemon refuses to work with network-mounted
4968 repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
4969 behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.</p>
4970 </dd>
4971 <dt class="hdlist1">fsmonitor.socketDir</dt>
4972 <dd>
4973 <p>This Mac OS-specific option, if set, specifies the directory in
4974 which to create the Unix domain socket used for communication
4975 between the fsmonitor daemon and various Git commands. The directory must
4976 reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
4977 is set to <code>true</code>.</p>
4978 </dd>
4979 <dt class="hdlist1">gc.aggressiveDepth</dt>
4980 <dd>
4981 <p>The depth parameter used in the delta compression
4982 algorithm used by <em>git gc --aggressive</em>.  This defaults
4983 to 50, which is the default for the <code>--depth</code> option when
4984 <code>--aggressive</code> isn&#8217;t in use.</p>
4985 <div class="paragraph">
4986 <p>See the documentation for the <code>--depth</code> option in
4987 <a href="git-repack.html">git-repack(1)</a> for more details.</p>
4988 </div>
4989 </dd>
4990 <dt class="hdlist1">gc.aggressiveWindow</dt>
4991 <dd>
4992 <p>The window size parameter used in the delta compression
4993 algorithm used by <em>git gc --aggressive</em>.  This defaults
4994 to 250, which is a much more aggressive window size than
4995 the default <code>--window</code> of 10.</p>
4996 <div class="paragraph">
4997 <p>See the documentation for the <code>--window</code> option in
4998 <a href="git-repack.html">git-repack(1)</a> for more details.</p>
4999 </div>
5000 </dd>
5001 <dt class="hdlist1">gc.auto</dt>
5002 <dd>
5003 <p>When there are approximately more than this many loose
5004 objects in the repository, <code>git gc --auto</code> will pack them.
5005 Some Porcelain commands use this command to perform a
5006 light-weight garbage collection from time to time.  The
5007 default value is 6700.</p>
5008 <div class="paragraph">
5009 <p>Setting this to 0 disables not only automatic packing based on the
5010 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
5011 otherwise use to determine if there&#8217;s work to do, such as
5012 <code>gc.autoPackLimit</code>.</p>
5013 </div>
5014 </dd>
5015 <dt class="hdlist1">gc.autoPackLimit</dt>
5016 <dd>
5017 <p>When there are more than this many packs that are not
5018 marked with <code>*.keep</code> file in the repository, <code>git gc
5019 --auto</code> consolidates them into one larger pack.  The
5020 default value is 50.  Setting this to 0 disables it.
5021 Setting <code>gc.auto</code> to 0 will also disable this.</p>
5022 <div class="paragraph">
5023 <p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
5024 use, it&#8217;ll affect how the auto pack limit works.</p>
5025 </div>
5026 </dd>
5027 <dt class="hdlist1">gc.autoDetach</dt>
5028 <dd>
5029 <p>Make <code>git gc --auto</code> return immediately and run in the background
5030 if the system supports it. Default is true. This config variable acts
5031 as a fallback in case <code>maintenance.autoDetach</code> is not set.</p>
5032 </dd>
5033 <dt class="hdlist1">gc.bigPackThreshold</dt>
5034 <dd>
5035 <p>If non-zero, all non-cruft packs larger than this limit are kept
5036 when <code>git gc</code> is run. This is very similar to
5037 <code>--keep-largest-pack</code> except that all non-cruft packs that meet
5038 the threshold are kept, not just the largest pack. Defaults to
5039 zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
5040 <div class="paragraph">
5041 <p>Note that if the number of kept packs is more than gc.autoPackLimit,
5042 this configuration variable is ignored, all packs except the base pack
5043 will be repacked. After this the number of packs should go below
5044 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p>
5045 </div>
5046 <div class="paragraph">
5047 <p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
5048 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
5049 will also be excluded (this is the equivalent of running <code>git gc</code> with
5050 <code>--keep-largest-pack</code>).</p>
5051 </div>
5052 </dd>
5053 <dt class="hdlist1">gc.writeCommitGraph</dt>
5054 <dd>
5055 <p>If true, then gc will rewrite the commit-graph file when
5056 <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
5057 the commit-graph will be updated if housekeeping is
5058 required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
5059 for details.</p>
5060 </dd>
5061 <dt class="hdlist1">gc.logExpiry</dt>
5062 <dd>
5063 <p>If the file gc.log exists, then <code>git gc --auto</code> will print
5064 its content and exit with status zero instead of running
5065 unless that file is more than <em>gc.logExpiry</em> old.  Default is
5066 "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
5067 value.</p>
5068 </dd>
5069 <dt class="hdlist1">gc.packRefs</dt>
5070 <dd>
5071 <p>Running <code>git pack-refs</code> in a repository renders it
5072 unclonable by Git versions prior to 1.5.1.2 over dumb
5073 transports such as HTTP.  This variable determines whether
5074 <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
5075 to enable it within all non-bare repos or it can be set to a
5076 boolean value.  The default is <code>true</code>.</p>
5077 </dd>
5078 <dt class="hdlist1">gc.cruftPacks</dt>
5079 <dd>
5080 <p>Store unreachable objects in a cruft pack (see
5081 <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
5082 is <code>true</code>.</p>
5083 </dd>
5084 <dt class="hdlist1">gc.maxCruftSize</dt>
5085 <dd>
5086 <p>Limit the size of new cruft packs when repacking. When
5087 specified in addition to <code>--max-cruft-size</code>, the command line
5088 option takes priority. See the <code>--max-cruft-size</code> option of
5089 <a href="git-repack.html">git-repack(1)</a>.</p>
5090 </dd>
5091 <dt class="hdlist1">gc.pruneExpire</dt>
5092 <dd>
5093 <p>When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
5094 (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
5095 cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
5096 grace period with this config variable.  The value "now" may be
5097 used to disable this grace period and always prune unreachable
5098 objects immediately, or "never" may be used to suppress pruning.
5099 This feature helps prevent corruption when <em>git gc</em> runs
5100 concurrently with another process writing to the repository; see
5101 the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.</p>
5102 </dd>
5103 <dt class="hdlist1">gc.worktreePruneExpire</dt>
5104 <dd>
5105 <p>When <em>git gc</em> is run, it calls
5106 <em>git worktree prune --expire 3.months.ago</em>.
5107 This config variable can be used to set a different grace
5108 period. The value "now" may be used to disable the grace
5109 period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
5110 may be used to suppress pruning.</p>
5111 </dd>
5112 <dt class="hdlist1">gc.reflogExpire</dt>
5113 <dt class="hdlist1">gc.&lt;pattern&gt;.reflogExpire</dt>
5114 <dd>
5115 <p><em>git reflog expire</em> removes reflog entries older than
5116 this time; defaults to 90 days. The value "now" expires all
5117 entries immediately, and "never" suppresses expiration
5118 altogether. With "&lt;pattern&gt;" (e.g.
5119 "refs/stash") in the middle the setting applies only to
5120 the refs that match the &lt;pattern&gt;.</p>
5121 </dd>
5122 <dt class="hdlist1">gc.reflogExpireUnreachable</dt>
5123 <dt class="hdlist1">gc.&lt;pattern&gt;.reflogExpireUnreachable</dt>
5124 <dd>
5125 <p><em>git reflog expire</em> removes reflog entries older than
5126 this time and are not reachable from the current tip;
5127 defaults to 30 days. The value "now" expires all entries
5128 immediately, and "never" suppresses expiration altogether.
5129 With "&lt;pattern&gt;" (e.g. "refs/stash")
5130 in the middle, the setting applies only to the refs that
5131 match the &lt;pattern&gt;.</p>
5132 <div class="paragraph">
5133 <p>These types of entries are generally created as a result of using <code>git
5134 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
5135 or rebase occurring.  Since these changes are not part of the current
5136 project most users will want to expire them sooner, which is why the
5137 default is more aggressive than <code>gc.reflogExpire</code>.</p>
5138 </div>
5139 </dd>
5140 <dt class="hdlist1">gc.recentObjectsHook</dt>
5141 <dd>
5142 <p>When considering whether or not to remove an object (either when
5143 generating a cruft pack or storing unreachable objects as
5144 loose), use the shell to execute the specified command(s).
5145 Interpret their output as object IDs which Git will consider as
5146 "recent", regardless of their age. By treating their mtimes as
5147 "now", any objects (and their descendants) mentioned in the
5148 output will be kept regardless of their true age.</p>
5149 <div class="paragraph">
5150 <p>Output must contain exactly one hex object ID per line, and nothing
5151 else. Objects which cannot be found in the repository are ignored.
5152 Multiple hooks are supported, but all must exit successfully, else the
5153 operation (either generating a cruft pack or unpacking unreachable
5154 objects) will be halted.</p>
5155 </div>
5156 </dd>
5157 <dt class="hdlist1">gc.repackFilter</dt>
5158 <dd>
5159 <p>When repacking, use the specified filter to move certain
5160 objects into a separate packfile.  See the
5161 <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.</p>
5162 </dd>
5163 <dt class="hdlist1">gc.repackFilterTo</dt>
5164 <dd>
5165 <p>When repacking and using a filter, see <code>gc.repackFilter</code>, the
5166 specified location will be used to create the packfile
5167 containing the filtered out objects. <strong>WARNING:</strong> The
5168 specified location should be accessible, using for example the
5169 Git alternates mechanism, otherwise the repo could be
5170 considered corrupt by Git as it migh not be able to access the
5171 objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
5172 of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
5173 section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.</p>
5174 </dd>
5175 <dt class="hdlist1">gc.rerereResolved</dt>
5176 <dd>
5177 <p>Records of conflicted merge you resolved earlier are
5178 kept for this many days when <em>git rerere gc</em> is run.
5179 You can also use more human-readable "1.month.ago", etc.
5180 The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.</p>
5181 </dd>
5182 <dt class="hdlist1">gc.rerereUnresolved</dt>
5183 <dd>
5184 <p>Records of conflicted merge you have not resolved are
5185 kept for this many days when <em>git rerere gc</em> is run.
5186 You can also use more human-readable "1.month.ago", etc.
5187 The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.</p>
5188 </dd>
5189 <dt class="hdlist1">gitcvs.commitMsgAnnotation</dt>
5190 <dd>
5191 <p>Append this string to each commit message. Set to empty string
5192 to disable this feature. Defaults to "via git-CVS emulator".</p>
5193 </dd>
5194 <dt class="hdlist1">gitcvs.enabled</dt>
5195 <dd>
5196 <p>Whether the CVS server interface is enabled for this repository.
5197 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.</p>
5198 </dd>
5199 <dt class="hdlist1">gitcvs.logFile</dt>
5200 <dd>
5201 <p>Path to a log file where the CVS server interface well&#8230;&#8203; logs
5202 various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.</p>
5203 </dd>
5204 <dt class="hdlist1">gitcvs.usecrlfattr</dt>
5205 <dd>
5206 <p>If true, the server will look up the end-of-line conversion
5207 attributes for files to determine the <code>-k</code> modes to use. If
5208 the attributes force Git to treat a file as text,
5209 the <code>-k</code> mode will be left blank so CVS clients will
5210 treat it as text. If they suppress text conversion, the file
5211 will be set with <em>-kb</em> mode, which suppresses any newline munging
5212 the client might otherwise do. If the attributes do not allow
5213 the file type to be determined, then <code>gitcvs.allBinary</code> is
5214 used. See <a href="gitattributes.html">gitattributes(5)</a>.</p>
5215 </dd>
5216 <dt class="hdlist1">gitcvs.allBinary</dt>
5217 <dd>
5218 <p>This is used if <code>gitcvs.usecrlfattr</code> does not resolve
5219 the correct <em>-kb</em> mode to use. If true, all
5220 unresolved files are sent to the client in
5221 mode <em>-kb</em>. This causes the client to treat them
5222 as binary files, which suppresses any newline munging it
5223 otherwise might do. Alternatively, if it is set to "guess",
5224 then the contents of the file are examined to decide if
5225 it is binary, similar to <code>core.autocrlf</code>.</p>
5226 </dd>
5227 <dt class="hdlist1">gitcvs.dbName</dt>
5228 <dd>
5229 <p>Database used by git-cvsserver to cache revision information
5230 derived from the Git repository. The exact meaning depends on the
5231 used database driver, for SQLite (which is the default driver) this
5232 is a filename. Supports variable substitution (see
5233 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
5234 Default: <em>%Ggitcvs.%m.sqlite</em></p>
5235 </dd>
5236 <dt class="hdlist1">gitcvs.dbDriver</dt>
5237 <dd>
5238 <p>Used Perl DBI driver. You can specify any available driver
5239 for this here, but it might not work. git-cvsserver is tested
5240 with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
5241 reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
5242 May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
5243 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.</p>
5244 </dd>
5245 <dt class="hdlist1">gitcvs.dbUser, gitcvs.dbPass</dt>
5246 <dd>
5247 <p>Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
5248 since SQLite has no concept of database users and/or passwords.
5249 <em>gitcvs.dbUser</em> supports variable substitution (see
5250 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).</p>
5251 </dd>
5252 <dt class="hdlist1">gitcvs.dbTableNamePrefix</dt>
5253 <dd>
5254 <p>Database table name prefix.  Prepended to the names of any
5255 database tables used, allowing a single database to be used
5256 for several repositories.  Supports variable substitution (see
5257 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
5258 characters will be replaced with underscores.</p>
5259 </dd>
5260 </dl>
5261 </div>
5262 <div class="paragraph">
5263 <p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
5264 <code>gitcvs.allBinary</code> can also be specified as
5265 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
5266 is one of "ext" and "pserver") to make them apply only for the given
5267 access method.</p>
5268 </div>
5269 <div class="dlist">
5270 <dl>
5271 <dt class="hdlist1">gitweb.category</dt>
5272 <dt class="hdlist1">gitweb.description</dt>
5273 <dt class="hdlist1">gitweb.owner</dt>
5274 <dt class="hdlist1">gitweb.url</dt>
5275 <dd>
5276 <p>See <a href="gitweb.html">gitweb(1)</a> for description.</p>
5277 </dd>
5278 <dt class="hdlist1">gitweb.avatar</dt>
5279 <dt class="hdlist1">gitweb.blame</dt>
5280 <dt class="hdlist1">gitweb.grep</dt>
5281 <dt class="hdlist1">gitweb.highlight</dt>
5282 <dt class="hdlist1">gitweb.patches</dt>
5283 <dt class="hdlist1">gitweb.pickaxe</dt>
5284 <dt class="hdlist1">gitweb.remote_heads</dt>
5285 <dt class="hdlist1">gitweb.showSizes</dt>
5286 <dt class="hdlist1">gitweb.snapshot</dt>
5287 <dd>
5288 <p>See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.</p>
5289 </dd>
5290 <dt class="hdlist1">gpg.program</dt>
5291 <dd>
5292 <p>Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
5293 making or verifying a PGP signature. The program must support the
5294 same command-line interface as GPG, namely, to verify a detached
5295 signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
5296 program is expected to signal a good signature by exiting with
5297 code 0.  To generate an ASCII-armored detached signature, the
5298 standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
5299 signed, and the program is expected to send the result to its
5300 standard output.</p>
5301 </dd>
5302 <dt class="hdlist1">gpg.format</dt>
5303 <dd>
5304 <p>Specifies which key format to use when signing with <code>--gpg-sign</code>.
5305 Default is "openpgp". Other possible values are "x509", "ssh".</p>
5306 <div class="paragraph">
5307 <p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
5308 based on the selected <code>gpg.format</code>.</p>
5309 </div>
5310 </dd>
5311 <dt class="hdlist1">gpg.&lt;format&gt;.program</dt>
5312 <dd>
5313 <p>Use this to customize the program used for the signing format you
5314 chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
5315 be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
5316 value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".</p>
5317 </dd>
5318 <dt class="hdlist1">gpg.minTrustLevel</dt>
5319 <dd>
5320 <p>Specifies a minimum trust level for signature verification.  If
5321 this option is unset, then signature verification for merge
5322 operations requires a key with at least <code>marginal</code> trust.  Other
5323 operations that perform signature verification require a key
5324 with at least <code>undefined</code> trust.  Setting this option overrides
5325 the required trust-level for all operations.  Supported values,
5326 in increasing order of significance:</p>
5327 <div class="ulist">
5328 <ul>
5329 <li>
5330 <p><code>undefined</code></p>
5331 </li>
5332 <li>
5333 <p><code>never</code></p>
5334 </li>
5335 <li>
5336 <p><code>marginal</code></p>
5337 </li>
5338 <li>
5339 <p><code>fully</code></p>
5340 </li>
5341 <li>
5342 <p><code>ultimate</code></p>
5343 </li>
5344 </ul>
5345 </div>
5346 </dd>
5347 <dt class="hdlist1">gpg.ssh.defaultKeyCommand</dt>
5348 <dd>
5349 <p>This command will be run when user.signingkey is not set and a ssh
5350 signature is requested. On successful exit a valid ssh public key
5351 prefixed with <code>key::</code> is expected in the first line of its output.
5352 This allows for a script doing a dynamic lookup of the correct public
5353 key when it is impractical to statically configure <code>user.signingKey</code>.
5354 For example when keys or SSH Certificates are rotated frequently or
5355 selection of the right key depends on external factors unknown to git.</p>
5356 </dd>
5357 <dt class="hdlist1">gpg.ssh.allowedSignersFile</dt>
5358 <dd>
5359 <p>A file containing ssh public keys which you are willing to trust.
5360 The file consists of one or more lines of principals followed by an ssh
5361 public key.
5362 e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
5363 See ssh-keygen(1) "ALLOWED SIGNERS" for details.
5364 The principal is only used to identify the key and is available when
5365 verifying a signature.</p>
5366 <div class="paragraph">
5367 <p>SSH has no concept of trust levels like gpg does. To be able to differentiate
5368 between valid signatures and trusted signatures the trust level of a signature
5369 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
5370 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p>
5371 </div>
5372 <div class="paragraph">
5373 <p>This file can be set to a location outside of the repository and every developer
5374 maintains their own trust store. A central repository server could generate this
5375 file automatically from ssh keys with push access to verify the code against.
5376 In a corporate setting this file is probably generated at a global location
5377 from automation that already handles developer ssh keys.</p>
5378 </div>
5379 <div class="paragraph">
5380 <p>A repository that only allows signed commits can store the file
5381 in the repository itself using a path relative to the top-level of the working tree.
5382 This way only committers with an already valid key can add or change keys in the keyring.</p>
5383 </div>
5384 <div class="paragraph">
5385 <p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
5386 valid-before options. Git will mark signatures as valid if the signing key was
5387 valid at the time of the signature&#8217;s creation. This allows users to change a
5388 signing key without invalidating all previously made signatures.</p>
5389 </div>
5390 <div class="paragraph">
5391 <p>Using a SSH CA key with the cert-authority option
5392 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p>
5393 </div>
5394 </dd>
5395 <dt class="hdlist1">gpg.ssh.revocationFile</dt>
5396 <dd>
5397 <p>Either a SSH KRL or a list of revoked public keys (without the principal prefix).
5398 See ssh-keygen(1) for details.
5399 If a public key is found in this file then it will always be treated
5400 as having trust level "never" and signatures will show as invalid.</p>
5401 </dd>
5402 <dt class="hdlist1">grep.lineNumber</dt>
5403 <dd>
5404 <p>If set to true, enable <code>-n</code> option by default.</p>
5405 </dd>
5406 <dt class="hdlist1">grep.column</dt>
5407 <dd>
5408 <p>If set to true, enable the <code>--column</code> option by default.</p>
5409 </dd>
5410 <dt class="hdlist1">grep.patternType</dt>
5411 <dd>
5412 <p>Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
5413 <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
5414 <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
5415 value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
5416 between <em>basic</em> and <em>extended</em>.</p>
5417 </dd>
5418 <dt class="hdlist1">grep.extendedRegexp</dt>
5419 <dd>
5420 <p>If set to true, enable <code>--extended-regexp</code> option by default. This
5421 option is ignored when the <code>grep.patternType</code> option is set to a value
5422 other than <em>default</em>.</p>
5423 </dd>
5424 <dt class="hdlist1">grep.threads</dt>
5425 <dd>
5426 <p>Number of grep worker threads to use. If unset (or set to 0), Git will
5427 use as many threads as the number of logical cores available.</p>
5428 </dd>
5429 <dt class="hdlist1">grep.fullName</dt>
5430 <dd>
5431 <p>If set to true, enable <code>--full-name</code> option by default.</p>
5432 </dd>
5433 <dt class="hdlist1">grep.fallbackToNoIndex</dt>
5434 <dd>
5435 <p>If set to true, fall back to <code>git grep --no-index</code> if <code>git grep</code>
5436 is executed outside of a git repository.  Defaults to false.</p>
5437 </dd>
5438 <dt class="hdlist1">gui.commitMsgWidth</dt>
5439 <dd>
5440 <p>Defines how wide the commit message window is in the
5441 <a href="git-gui.html">git-gui(1)</a>. "75" is the default.</p>
5442 </dd>
5443 <dt class="hdlist1">gui.diffContext</dt>
5444 <dd>
5445 <p>Specifies how many context lines should be used in calls to diff
5446 made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".</p>
5447 </dd>
5448 <dt class="hdlist1">gui.displayUntracked</dt>
5449 <dd>
5450 <p>Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
5451 in the file list. The default is "true".</p>
5452 </dd>
5453 <dt class="hdlist1">gui.encoding</dt>
5454 <dd>
5455 <p>Specifies the default character encoding to use for displaying of
5456 file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
5457 It can be overridden by setting the <em>encoding</em> attribute
5458 for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
5459 If this option is not set, the tools default to the
5460 locale encoding.</p>
5461 </dd>
5462 <dt class="hdlist1">gui.matchTrackingBranch</dt>
5463 <dd>
5464 <p>Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
5465 default to tracking remote branches with matching names or
5466 not. Default: "false".</p>
5467 </dd>
5468 <dt class="hdlist1">gui.newBranchTemplate</dt>
5469 <dd>
5470 <p>Is used as a suggested name when creating new branches using the
5471 <a href="git-gui.html">git-gui(1)</a>.</p>
5472 </dd>
5473 <dt class="hdlist1">gui.pruneDuringFetch</dt>
5474 <dd>
5475 <p>"true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
5476 performing a fetch. The default value is "false".</p>
5477 </dd>
5478 <dt class="hdlist1">gui.trustmtime</dt>
5479 <dd>
5480 <p>Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
5481 timestamp or not. By default the timestamps are not trusted.</p>
5482 </dd>
5483 <dt class="hdlist1">gui.spellingDictionary</dt>
5484 <dd>
5485 <p>Specifies the dictionary used for spell checking commit messages in
5486 the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
5487 off.</p>
5488 </dd>
5489 <dt class="hdlist1">gui.fastCopyBlame</dt>
5490 <dd>
5491 <p>If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
5492 location detection. It makes blame significantly faster on huge
5493 repositories at the expense of less thorough copy detection.</p>
5494 </dd>
5495 <dt class="hdlist1">gui.copyBlameThreshold</dt>
5496 <dd>
5497 <p>Specifies the threshold to use in <em>git gui blame</em> original location
5498 detection, measured in alphanumeric characters. See the
5499 <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.</p>
5500 </dd>
5501 <dt class="hdlist1">gui.blamehistoryctx</dt>
5502 <dd>
5503 <p>Specifies the radius of history context in days to show in
5504 <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
5505 Context</code> menu item is invoked from <em>git gui blame</em>. If this
5506 variable is set to zero, the whole history is shown.</p>
5507 </dd>
5508 <dt class="hdlist1">guitool.&lt;name&gt;.cmd</dt>
5509 <dd>
5510 <p>Specifies the shell command line to execute when the corresponding item
5511 of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
5512 mandatory for every tool. The command is executed from the root of
5513 the working directory, and in the environment it receives the name of
5514 the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
5515 <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
5516 the head is detached, <em>CUR_BRANCH</em> is empty).</p>
5517 </dd>
5518 <dt class="hdlist1">guitool.&lt;name&gt;.needsFile</dt>
5519 <dd>
5520 <p>Run the tool only if a diff is selected in the GUI. It guarantees
5521 that <em>FILENAME</em> is not empty.</p>
5522 </dd>
5523 <dt class="hdlist1">guitool.&lt;name&gt;.noConsole</dt>
5524 <dd>
5525 <p>Run the command silently, without creating a window to display its
5526 output.</p>
5527 </dd>
5528 <dt class="hdlist1">guitool.&lt;name&gt;.noRescan</dt>
5529 <dd>
5530 <p>Don&#8217;t rescan the working directory for changes after the tool
5531 finishes execution.</p>
5532 </dd>
5533 <dt class="hdlist1">guitool.&lt;name&gt;.confirm</dt>
5534 <dd>
5535 <p>Show a confirmation dialog before actually running the tool.</p>
5536 </dd>
5537 <dt class="hdlist1">guitool.&lt;name&gt;.argPrompt</dt>
5538 <dd>
5539 <p>Request a string argument from the user, and pass it to the tool
5540 through the <code>ARGS</code> environment variable. Since requesting an
5541 argument implies confirmation, the <em>confirm</em> option has no effect
5542 if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
5543 the dialog uses a built-in generic prompt; otherwise the exact
5544 value of the variable is used.</p>
5545 </dd>
5546 <dt class="hdlist1">guitool.&lt;name&gt;.revPrompt</dt>
5547 <dd>
5548 <p>Request a single valid revision from the user, and set the
5549 <code>REVISION</code> environment variable. In other aspects this option
5550 is similar to <em>argPrompt</em>, and can be used together with it.</p>
5551 </dd>
5552 <dt class="hdlist1">guitool.&lt;name&gt;.revUnmerged</dt>
5553 <dd>
5554 <p>Show only unmerged branches in the <em>revPrompt</em> subdialog.
5555 This is useful for tools similar to merge or rebase, but not
5556 for things like checkout or reset.</p>
5557 </dd>
5558 <dt class="hdlist1">guitool.&lt;name&gt;.title</dt>
5559 <dd>
5560 <p>Specifies the title to use for the prompt dialog. The default
5561 is the tool name.</p>
5562 </dd>
5563 <dt class="hdlist1">guitool.&lt;name&gt;.prompt</dt>
5564 <dd>
5565 <p>Specifies the general prompt string to display at the top of
5566 the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
5567 The default value includes the actual command.</p>
5568 </dd>
5569 <dt class="hdlist1">help.browser</dt>
5570 <dd>
5571 <p>Specify the browser that will be used to display help in the
5572 <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.</p>
5573 </dd>
5574 <dt class="hdlist1">help.format</dt>
5575 <dd>
5576 <p>Override the default help format used by <a href="git-help.html">git-help(1)</a>.
5577 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
5578 the default. <em>web</em> and <em>html</em> are the same.</p>
5579 </dd>
5580 <dt class="hdlist1">help.autoCorrect</dt>
5581 <dd>
5582 <p>If git detects typos and can identify exactly one valid command similar
5583 to the error, git will try to suggest the correct command or even
5584 run the suggestion automatically. Possible config values are:</p>
5585 <div class="ulist">
5586 <ul>
5587 <li>
5588 <p>0 (default): show the suggested command.</p>
5589 </li>
5590 <li>
5591 <p>positive number: run the suggested command after specified
5592 deciseconds (0.1 sec).</p>
5593 </li>
5594 <li>
5595 <p>"immediate": run the suggested command immediately.</p>
5596 </li>
5597 <li>
5598 <p>"prompt": show the suggestion and prompt for confirmation to run
5599 the command.</p>
5600 </li>
5601 <li>
5602 <p>"never": don&#8217;t run or show any suggested command.</p>
5603 </li>
5604 </ul>
5605 </div>
5606 </dd>
5607 <dt class="hdlist1">help.htmlPath</dt>
5608 <dd>
5609 <p>Specify the path where the HTML documentation resides. File system paths
5610 and URLs are supported. HTML pages will be prefixed with this path when
5611 help is displayed in the <em>web</em> format. This defaults to the documentation
5612 path of your Git installation.</p>
5613 </dd>
5614 <dt class="hdlist1">http.proxy</dt>
5615 <dd>
5616 <p>Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
5617 <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
5618 addition to the syntax understood by curl, it is possible to specify a
5619 proxy string with a user name but no password, in which case git will
5620 attempt to acquire one in the same way it does for other credentials. See
5621 <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
5622 <em>[protocol://][user[:password]@]proxyhost[:port][/path]</em>. This can be
5623 overridden on a per-remote basis; see remote.&lt;name&gt;.proxy</p>
5624 <div class="paragraph">
5625 <p>Any proxy, however configured, must be completely transparent and must not
5626 modify, transform, or buffer the request or response in any way.  Proxies which
5627 are not completely transparent are known to cause various forms of breakage
5628 with Git.</p>
5629 </div>
5630 </dd>
5631 <dt class="hdlist1">http.proxyAuthMethod</dt>
5632 <dd>
5633 <p>Set the method with which to authenticate against the HTTP proxy. This
5634 only takes effect if the configured proxy string contains a user name part
5635 (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
5636 overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
5637 Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
5638 variable.  Possible values are:</p>
5639 <div class="openblock">
5640 <div class="content">
5641 <div class="ulist">
5642 <ul>
5643 <li>
5644 <p><code>anyauth</code> - Automatically pick a suitable authentication method. It is
5645 assumed that the proxy answers an unauthenticated request with a 407
5646 status code and one or more Proxy-authenticate headers with supported
5647 authentication methods. This is the default.</p>
5648 </li>
5649 <li>
5650 <p><code>basic</code> - HTTP Basic authentication</p>
5651 </li>
5652 <li>
5653 <p><code>digest</code> - HTTP Digest authentication; this prevents the password from being
5654 transmitted to the proxy in clear text</p>
5655 </li>
5656 <li>
5657 <p><code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
5658 of <code>curl(1)</code>)</p>
5659 </li>
5660 <li>
5661 <p><code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)</p>
5662 </li>
5663 </ul>
5664 </div>
5665 </div>
5666 </div>
5667 </dd>
5668 <dt class="hdlist1">http.proxySSLCert</dt>
5669 <dd>
5670 <p>The pathname of a file that stores a client certificate to use to authenticate
5671 with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
5672 variable.</p>
5673 </dd>
5674 <dt class="hdlist1">http.proxySSLKey</dt>
5675 <dd>
5676 <p>The pathname of a file that stores a private key to use to authenticate with
5677 an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
5678 variable.</p>
5679 </dd>
5680 <dt class="hdlist1">http.proxySSLCertPasswordProtected</dt>
5681 <dd>
5682 <p>Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
5683 will prompt the user, possibly many times, if the certificate or private key
5684 is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
5685 environment variable.</p>
5686 </dd>
5687 <dt class="hdlist1">http.proxySSLCAInfo</dt>
5688 <dd>
5689 <p>Pathname to the file containing the certificate bundle that should be used to
5690 verify the proxy with when using an HTTPS proxy. Can be overridden by the
5691 <code>GIT_PROXY_SSL_CAINFO</code> environment variable.</p>
5692 </dd>
5693 <dt class="hdlist1">http.emptyAuth</dt>
5694 <dd>
5695 <p>Attempt authentication without seeking a username or password.  This
5696 can be used to attempt GSS-Negotiate authentication without specifying
5697 a username in the URL, as libcurl normally requires a username for
5698 authentication.</p>
5699 </dd>
5700 <dt class="hdlist1">http.proactiveAuth</dt>
5701 <dd>
5702 <p>Attempt authentication without first making an unauthenticated attempt and
5703 receiving a 401 response. This can be used to ensure that all requests are
5704 authenticated. If <code>http.emptyAuth</code> is set to true, this value has no effect.</p>
5705 <div class="paragraph">
5706 <p>If the credential helper used specifies an authentication scheme (i.e., via the
5707 <code>authtype</code> field), that value will be used; if a username and password is
5708 provided without a scheme, then Basic authentication is used.  The value of the
5709 option determines the scheme requested from the helper. Possible values are:</p>
5710 </div>
5711 <div class="openblock">
5712 <div class="content">
5713 <div class="ulist">
5714 <ul>
5715 <li>
5716 <p><code>basic</code> - Request Basic authentication from the helper.</p>
5717 </li>
5718 <li>
5719 <p><code>auto</code> - Allow the helper to pick an appropriate scheme.</p>
5720 </li>
5721 <li>
5722 <p><code>none</code> - Disable proactive authentication.</p>
5723 </li>
5724 </ul>
5725 </div>
5726 </div>
5727 </div>
5728 <div class="paragraph">
5729 <p>Note that TLS should always be used with this configuration, since otherwise it
5730 is easy to accidentally expose plaintext credentials if Basic authentication
5731 is selected.</p>
5732 </div>
5733 </dd>
5734 <dt class="hdlist1">http.delegation</dt>
5735 <dd>
5736 <p>Control GSSAPI credential delegation. The delegation is disabled
5737 by default in libcurl since version 7.21.7. Set parameter to tell
5738 the server what it is allowed to delegate when it comes to user
5739 credentials. Used with GSS/kerberos. Possible values are:</p>
5740 <div class="openblock">
5741 <div class="content">
5742 <div class="ulist">
5743 <ul>
5744 <li>
5745 <p><code>none</code> - Don&#8217;t allow any delegation.</p>
5746 </li>
5747 <li>
5748 <p><code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
5749 Kerberos service ticket, which is a matter of realm policy.</p>
5750 </li>
5751 <li>
5752 <p><code>always</code> - Unconditionally allow the server to delegate.</p>
5753 </li>
5754 </ul>
5755 </div>
5756 </div>
5757 </div>
5758 </dd>
5759 <dt class="hdlist1">http.extraHeader</dt>
5760 <dd>
5761 <p>Pass an additional HTTP header when communicating with a server.  If
5762 more than one such entry exists, all of them are added as extra
5763 headers.  To allow overriding the settings inherited from the system
5764 config, an empty value will reset the extra headers to the empty list.</p>
5765 </dd>
5766 <dt class="hdlist1">http.cookieFile</dt>
5767 <dd>
5768 <p>The pathname of a file containing previously stored cookie lines,
5769 which should be used
5770 in the Git http session, if they match the server. The file format
5771 of the file to read cookies from should be plain HTTP headers or
5772 the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
5773 Set it to an empty string, to accept only new cookies from
5774 the server and send them back in successive requests within same
5775 connection.
5776 NOTE that the file specified with http.cookieFile is used only as
5777 input unless http.saveCookies is set.</p>
5778 </dd>
5779 <dt class="hdlist1">http.saveCookies</dt>
5780 <dd>
5781 <p>If set, store cookies received during requests to the file specified by
5782 http.cookieFile. Has no effect if http.cookieFile is unset, or set to
5783 an empty string.</p>
5784 </dd>
5785 <dt class="hdlist1">http.version</dt>
5786 <dd>
5787 <p>Use the specified HTTP protocol version when communicating with a server.
5788 If you want to force the default. The available and default version depend
5789 on libcurl. Currently the possible values of
5790 this option are:</p>
5791 <div class="ulist">
5792 <ul>
5793 <li>
5794 <p>HTTP/2</p>
5795 </li>
5796 <li>
5797 <p>HTTP/1.1</p>
5798 </li>
5799 </ul>
5800 </div>
5801 </dd>
5802 <dt class="hdlist1">http.curloptResolve</dt>
5803 <dd>
5804 <p>Hostname resolution information that will be used first by
5805 libcurl when sending HTTP requests.  This information should
5806 be in one of the following formats:</p>
5807 <div class="ulist">
5808 <ul>
5809 <li>
5810 <p>[+]HOST:PORT:ADDRESS[,ADDRESS]</p>
5811 </li>
5812 <li>
5813 <p>-HOST:PORT</p>
5814 </li>
5815 </ul>
5816 </div>
5817 <div class="paragraph">
5818 <p>The first format redirects all requests to the given <code>HOST:PORT</code>
5819 to the provided <code>ADDRESS</code>(s). The second format clears all
5820 previous config values for that <code>HOST:PORT</code> combination.  To
5821 allow easy overriding of all the settings inherited from the
5822 system config, an empty value will reset all resolution
5823 information to the empty list.</p>
5824 </div>
5825 </dd>
5826 <dt class="hdlist1">http.sslVersion</dt>
5827 <dd>
5828 <p>The SSL version to use when negotiating an SSL connection, if you
5829 want to force the default.  The available and default version
5830 depend on whether libcurl was built against NSS or OpenSSL and the
5831 particular configuration of the crypto library in use. Internally
5832 this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
5833 documentation for more details on the format of this option and
5834 for the ssl version supported. Currently the possible values of
5835 this option are:</p>
5836 <div class="ulist">
5837 <ul>
5838 <li>
5839 <p>sslv2</p>
5840 </li>
5841 <li>
5842 <p>sslv3</p>
5843 </li>
5844 <li>
5845 <p>tlsv1</p>
5846 </li>
5847 <li>
5848 <p>tlsv1.0</p>
5849 </li>
5850 <li>
5851 <p>tlsv1.1</p>
5852 </li>
5853 <li>
5854 <p>tlsv1.2</p>
5855 </li>
5856 <li>
5857 <p>tlsv1.3</p>
5858 </li>
5859 </ul>
5860 </div>
5861 <div class="paragraph">
5862 <p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
5863 To force git to use libcurl&#8217;s default ssl version and ignore any
5864 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
5865 empty string.</p>
5866 </div>
5867 </dd>
5868 <dt class="hdlist1">http.sslCipherList</dt>
5869 <dd>
5870 <p>A list of SSL ciphers to use when negotiating an SSL connection.
5871 The available ciphers depend on whether libcurl was built against
5872 NSS or OpenSSL and the particular configuration of the crypto
5873 library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
5874 option; see the libcurl documentation for more details on the format
5875 of this list.</p>
5876 <div class="paragraph">
5877 <p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
5878 To force git to use libcurl&#8217;s default cipher list and ignore any
5879 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
5880 empty string.</p>
5881 </div>
5882 </dd>
5883 <dt class="hdlist1">http.sslVerify</dt>
5884 <dd>
5885 <p>Whether to verify the SSL certificate when fetching or pushing
5886 over HTTPS. Defaults to true. Can be overridden by the
5887 <code>GIT_SSL_NO_VERIFY</code> environment variable.</p>
5888 </dd>
5889 <dt class="hdlist1">http.sslCert</dt>
5890 <dd>
5891 <p>File containing the SSL certificate when fetching or pushing
5892 over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
5893 variable.</p>
5894 </dd>
5895 <dt class="hdlist1">http.sslKey</dt>
5896 <dd>
5897 <p>File containing the SSL private key when fetching or pushing
5898 over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
5899 variable.</p>
5900 </dd>
5901 <dt class="hdlist1">http.sslCertPasswordProtected</dt>
5902 <dd>
5903 <p>Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
5904 OpenSSL will prompt the user, possibly many times, if the
5905 certificate or private key is encrypted.  Can be overridden by the
5906 <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.</p>
5907 </dd>
5908 <dt class="hdlist1">http.sslCAInfo</dt>
5909 <dd>
5910 <p>File containing the certificates to verify the peer with when
5911 fetching or pushing over HTTPS. Can be overridden by the
5912 <code>GIT_SSL_CAINFO</code> environment variable.</p>
5913 </dd>
5914 <dt class="hdlist1">http.sslCAPath</dt>
5915 <dd>
5916 <p>Path containing files with the CA certificates to verify the peer
5917 with when fetching or pushing over HTTPS. Can be overridden
5918 by the <code>GIT_SSL_CAPATH</code> environment variable.</p>
5919 </dd>
5920 <dt class="hdlist1">http.sslBackend</dt>
5921 <dd>
5922 <p>Name of the SSL backend to use (e.g. "openssl" or "schannel").
5923 This option is ignored if cURL lacks support for choosing the SSL
5924 backend at runtime.</p>
5925 </dd>
5926 <dt class="hdlist1">http.schannelCheckRevoke</dt>
5927 <dd>
5928 <p>Used to enforce or disable certificate revocation checks in cURL
5929 when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
5930 unset. Only necessary to disable this if Git consistently errors
5931 and the message is about checking the revocation status of a
5932 certificate. This option is ignored if cURL lacks support for
5933 setting the relevant SSL option at runtime.</p>
5934 </dd>
5935 <dt class="hdlist1">http.schannelUseSSLCAInfo</dt>
5936 <dd>
5937 <p>As of cURL v7.60.0, the Secure Channel backend can use the
5938 certificate bundle provided via <code>http.sslCAInfo</code>, but that would
5939 override the Windows Certificate Store. Since this is not desirable
5940 by default, Git will tell cURL not to use that bundle by default
5941 when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
5942 unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.</p>
5943 </dd>
5944 <dt class="hdlist1">http.pinnedPubkey</dt>
5945 <dd>
5946 <p>Public key of the https service. It may either be the filename of
5947 a PEM or DER encoded public key file or a string starting with
5948 <em>sha256//</em> followed by the base64 encoded sha256 hash of the
5949 public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
5950 exit with an error if this option is set but not supported by
5951 cURL.</p>
5952 </dd>
5953 <dt class="hdlist1">http.sslTry</dt>
5954 <dd>
5955 <p>Attempt to use AUTH SSL/TLS and encrypted data transfers
5956 when connecting via regular FTP protocol. This might be needed
5957 if the FTP server requires it for security reasons or you wish
5958 to connect securely whenever remote FTP server supports it.
5959 Default is false since it might trigger certificate verification
5960 errors on misconfigured servers.</p>
5961 </dd>
5962 <dt class="hdlist1">http.maxRequests</dt>
5963 <dd>
5964 <p>How many HTTP requests to launch in parallel. Can be overridden
5965 by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.</p>
5966 </dd>
5967 <dt class="hdlist1">http.minSessions</dt>
5968 <dd>
5969 <p>The number of curl sessions (counted across slots) to be kept across
5970 requests. They will not be ended with curl_easy_cleanup() until
5971 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
5972 value will be capped at 1. Defaults to 1.</p>
5973 </dd>
5974 <dt class="hdlist1">http.postBuffer</dt>
5975 <dd>
5976 <p>Maximum size in bytes of the buffer used by smart HTTP
5977 transports when POSTing data to the remote system.
5978 For requests larger than this buffer size, HTTP/1.1 and
5979 Transfer-Encoding: chunked is used to avoid creating a
5980 massive pack file locally.  Default is 1 MiB, which is
5981 sufficient for most requests.</p>
5982 <div class="paragraph">
5983 <p>Note that raising this limit is only effective for disabling chunked
5984 transfer encoding and therefore should be used only where the remote
5985 server or a proxy only supports HTTP/1.0 or is noncompliant with the
5986 HTTP standard.  Raising this is not, in general, an effective solution
5987 for most push problems, but can increase memory consumption
5988 significantly since the entire buffer is allocated even for small
5989 pushes.</p>
5990 </div>
5991 </dd>
5992 <dt class="hdlist1">http.lowSpeedLimit, http.lowSpeedTime</dt>
5993 <dd>
5994 <p>If the HTTP transfer speed, in bytes per second, is less than
5995 <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
5996 the transfer is aborted.
5997 Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
5998 <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.</p>
5999 </dd>
6000 <dt class="hdlist1">http.noEPSV</dt>
6001 <dd>
6002 <p>A boolean which disables using of EPSV ftp command by curl.
6003 This can be helpful with some "poor" ftp servers which don&#8217;t
6004 support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
6005 environment variable. Default is false (curl will use EPSV).</p>
6006 </dd>
6007 <dt class="hdlist1">http.userAgent</dt>
6008 <dd>
6009 <p>The HTTP USER_AGENT string presented to an HTTP server.  The default
6010 value represents the version of the Git client such as git/1.7.1.
6011 This option allows you to override this value to a more common value
6012 such as Mozilla/4.0.  This may be necessary, for instance, if
6013 connecting through a firewall that restricts HTTP connections to a set
6014 of common USER_AGENT strings (but not including those like git/1.7.1).
6015 Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.</p>
6016 </dd>
6017 <dt class="hdlist1">http.followRedirects</dt>
6018 <dd>
6019 <p>Whether git should follow HTTP redirects. If set to <code>true</code>, git
6020 will transparently follow any redirect issued by a server it
6021 encounters. If set to <code>false</code>, git will treat all redirects as
6022 errors. If set to <code>initial</code>, git will follow redirects only for
6023 the initial request to a remote, but not for subsequent
6024 follow-up HTTP requests. Since git uses the redirected URL as
6025 the base for the follow-up requests, this is generally
6026 sufficient. The default is <code>initial</code>.</p>
6027 </dd>
6028 <dt class="hdlist1">http.&lt;url&gt;.*</dt>
6029 <dd>
6030 <p>Any of the http.* options above can be applied selectively to some URLs.
6031 For a config key to match a URL, each element of the config key is
6032 compared to that of the URL, in the following order:</p>
6033 <div class="openblock">
6034 <div class="content">
6035 <div class="olist arabic">
6036 <ol class="arabic">
6037 <li>
6038 <p>Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
6039 must match exactly between the config key and the URL.</p>
6040 </li>
6041 <li>
6042 <p>Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
6043 This field must match between the config key and the URL. It is
6044 possible to specify a <code>*</code> as part of the host name to match all subdomains
6045 at this level. <code>https://*.example.com/</code> for example would match
6046 <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.</p>
6047 </li>
6048 <li>
6049 <p>Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
6050 This field must match exactly between the config key and the URL.
6051 Omitted port numbers are automatically converted to the correct
6052 default for the scheme before matching.</p>
6053 </li>
6054 <li>
6055 <p>Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
6056 path field of the config key must match the path field of the URL
6057 either exactly or as a prefix of slash-delimited path elements.  This means
6058 a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
6059 match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
6060 key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
6061 key with just path <code>foo/</code>).</p>
6062 </li>
6063 <li>
6064 <p>User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
6065 the config key has a user name it must match the user name in the
6066 URL exactly. If the config key does not have a user name, that
6067 config key will match a URL with any user name (including none),
6068 but at a lower precedence than a config key with a user name.</p>
6069 </li>
6070 </ol>
6071 </div>
6072 </div>
6073 </div>
6074 <div class="paragraph">
6075 <p>The list above is ordered by decreasing precedence; a URL that matches
6076 a config key&#8217;s path is preferred to one that matches its user name. For example,
6077 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
6078 <code>https://example.com/foo</code> will be preferred over a config key match of
6079 <code>https://user@example.com</code>.</p>
6080 </div>
6081 <div class="paragraph">
6082 <p>All URLs are normalized before attempting any matching (the password part,
6083 if embedded in the URL, is always ignored for matching purposes) so that
6084 equivalent URLs that are simply spelled differently will match properly.
6085 Environment variable settings always override any matches.  The URLs that are
6086 matched against are those given directly to Git commands.  This means any URLs
6087 visited as a result of a redirection do not participate in matching.</p>
6088 </div>
6089 </dd>
6090 <dt class="hdlist1">i18n.commitEncoding</dt>
6091 <dd>
6092 <p>Character encoding the commit messages are stored in; Git itself
6093 does not care per se, but this information is necessary e.g. when
6094 importing commits from emails or in the gitk graphical history
6095 browser (and possibly in other places in the future or in other
6096 porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.</p>
6097 </dd>
6098 <dt class="hdlist1">i18n.logOutputEncoding</dt>
6099 <dd>
6100 <p>Character encoding the commit messages are converted to when
6101 running <em>git log</em> and friends.</p>
6102 </dd>
6103 <dt class="hdlist1">imap.folder</dt>
6104 <dd>
6105 <p>The folder to drop the mails into, which is typically the Drafts
6106 folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
6107 "[Gmail]/Drafts". Required.</p>
6108 </dd>
6109 <dt class="hdlist1">imap.tunnel</dt>
6110 <dd>
6111 <p>Command used to set up a tunnel to the IMAP server through which
6112 commands will be piped instead of using a direct network connection
6113 to the server. Required when imap.host is not set.</p>
6114 </dd>
6115 <dt class="hdlist1">imap.host</dt>
6116 <dd>
6117 <p>A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
6118 connections and an <code>imaps://</code> prefix for secure connections.
6119 Ignored when imap.tunnel is set, but required otherwise.</p>
6120 </dd>
6121 <dt class="hdlist1">imap.user</dt>
6122 <dd>
6123 <p>The username to use when logging in to the server.</p>
6124 </dd>
6125 <dt class="hdlist1">imap.pass</dt>
6126 <dd>
6127 <p>The password to use when logging in to the server.</p>
6128 </dd>
6129 <dt class="hdlist1">imap.port</dt>
6130 <dd>
6131 <p>An integer port number to connect to on the server.
6132 Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
6133 Ignored when imap.tunnel is set.</p>
6134 </dd>
6135 <dt class="hdlist1">imap.sslverify</dt>
6136 <dd>
6137 <p>A boolean to enable/disable verification of the server certificate
6138 used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
6139 imap.tunnel is set.</p>
6140 </dd>
6141 <dt class="hdlist1">imap.preformattedHTML</dt>
6142 <dd>
6143 <p>A boolean to enable/disable the use of html encoding when sending
6144 a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
6145 and have a content type of text/html.  Ironically, enabling this
6146 option causes Thunderbird to send the patch as a plain/text,
6147 format=fixed email.  Default is <code>false</code>.</p>
6148 </dd>
6149 <dt class="hdlist1">imap.authMethod</dt>
6150 <dd>
6151 <p>Specify the authentication method for authenticating with the IMAP server.
6152 If Git was built with the NO_CURL option, or if your curl version is older
6153 than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
6154 option, the only supported method is <em>CRAM-MD5</em>. If this is not set
6155 then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.</p>
6156 </dd>
6157 <dt class="hdlist1">include.path</dt>
6158 <dt class="hdlist1">includeIf.&lt;condition&gt;.path</dt>
6159 <dd>
6160 <p>Special variables to include other configuration files. See
6161 the "CONFIGURATION FILE" section in the main
6162 <a href="git-config.html">git-config(1)</a> documentation,
6163 specifically the "Includes" and "Conditional Includes" subsections.</p>
6164 </dd>
6165 <dt class="hdlist1">index.recordEndOfIndexEntries</dt>
6166 <dd>
6167 <p>Specifies whether the index file should include an "End Of Index
6168 Entry" section. This reduces index load time on multiprocessor
6169 machines but produces a message "ignoring EOIE extension" when
6170 reading the index using Git versions before 2.20. Defaults to
6171 <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
6172 otherwise.</p>
6173 </dd>
6174 <dt class="hdlist1">index.recordOffsetTable</dt>
6175 <dd>
6176 <p>Specifies whether the index file should include an "Index Entry
6177 Offset Table" section. This reduces index load time on
6178 multiprocessor machines but produces a message "ignoring IEOT
6179 extension" when reading the index using Git versions before 2.20.
6180 Defaults to <em>true</em> if index.threads has been explicitly enabled,
6181 <em>false</em> otherwise.</p>
6182 </dd>
6183 <dt class="hdlist1">index.sparse</dt>
6184 <dd>
6185 <p>When enabled, write the index using sparse-directory entries. This
6186 has no effect unless <code>core.sparseCheckout</code> and
6187 <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.</p>
6188 </dd>
6189 <dt class="hdlist1">index.threads</dt>
6190 <dd>
6191 <p>Specifies the number of threads to spawn when loading the index.
6192 This is meant to reduce index load time on multiprocessor machines.
6193 Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
6194 CPUs and set the number of threads accordingly. Specifying 1 or
6195 <em>false</em> will disable multithreading. Defaults to <em>true</em>.</p>
6196 </dd>
6197 <dt class="hdlist1">index.version</dt>
6198 <dd>
6199 <p>Specify the version with which new index files should be
6200 initialized.  This does not affect existing repositories.
6201 If <code>feature.manyFiles</code> is enabled, then the default is 4.</p>
6202 </dd>
6203 <dt class="hdlist1">index.skipHash</dt>
6204 <dd>
6205 <p>When enabled, do not compute the trailing hash for the index file.
6206 This accelerates Git commands that manipulate the index, such as
6207 <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
6208 checksum, write a trailing set of bytes with value zero, indicating
6209 that the computation was skipped.</p>
6210 <div class="paragraph">
6211 <p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
6212 refuse to parse the index and Git clients older than 2.40.0 will report an
6213 error during <code>git fsck</code>.</p>
6214 </div>
6215 </dd>
6216 </dl>
6217 </div>
6218 <div class="dlist">
6219 <dl>
6220 <dt class="hdlist1"><code>init.templateDir</code></dt>
6221 <dd>
6222 <p>Specify the directory from which templates will be copied. (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.)</p>
6223 </dd>
6224 <dt class="hdlist1"><code>init.defaultBranch</code></dt>
6225 <dd>
6226 <p>Allows overriding the default branch name e.g. when initializing
6227 a new repository.</p>
6228 </dd>
6229 <dt class="hdlist1"><code>init.defaultObjectFormat</code></dt>
6230 <dd>
6231 <p>Allows overriding the default object format for new repositories. See
6232 <code>--object-format=</code> in <a href="git-init.html">git-init(1)</a>. Both the command line option
6233 and the <code>GIT_DEFAULT_HASH</code> environment variable take precedence over
6234 this config.</p>
6235 </dd>
6236 <dt class="hdlist1"><code>init.defaultRefFormat</code></dt>
6237 <dd>
6238 <p>Allows overriding the default ref storage format for new repositories.
6239 See <code>--ref-format=</code> in <a href="git-init.html">git-init(1)</a>. Both the command line
6240 option and the <code>GIT_DEFAULT_REF_FORMAT</code> environment variable take
6241 precedence over this config.</p>
6242 </dd>
6243 <dt class="hdlist1">instaweb.browser</dt>
6244 <dd>
6245 <p>Specify the program that will be used to browse your working
6246 repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.</p>
6247 </dd>
6248 <dt class="hdlist1">instaweb.httpd</dt>
6249 <dd>
6250 <p>The HTTP daemon command-line to start gitweb on your working
6251 repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.</p>
6252 </dd>
6253 <dt class="hdlist1">instaweb.local</dt>
6254 <dd>
6255 <p>If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
6256 be bound to the local IP (127.0.0.1).</p>
6257 </dd>
6258 <dt class="hdlist1">instaweb.modulePath</dt>
6259 <dd>
6260 <p>The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
6261 instead of /usr/lib/apache2/modules.  Only used if httpd
6262 is Apache.</p>
6263 </dd>
6264 <dt class="hdlist1">instaweb.port</dt>
6265 <dd>
6266 <p>The port number to bind the gitweb httpd to. See
6267 <a href="git-instaweb.html">git-instaweb(1)</a>.</p>
6268 </dd>
6269 <dt class="hdlist1">interactive.singleKey</dt>
6270 <dd>
6271 <p>When set to true, allow the user to provide one-letter input
6272 with a single key (i.e., without hitting the Enter key) in
6273 interactive commands.  This is currently used by the <code>--patch</code>
6274 mode of <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
6275 <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
6276 <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>.</p>
6277 </dd>
6278 <dt class="hdlist1">interactive.diffFilter</dt>
6279 <dd>
6280 <p>When an interactive command (such as <code>git add --patch</code>) shows
6281 a colorized diff, git will pipe the diff through the shell
6282 command defined by this configuration variable. The command may
6283 mark up the diff further for human consumption, provided that it
6284 retains a one-to-one correspondence with the lines in the
6285 original diff. Defaults to disabled (no filtering).</p>
6286 </dd>
6287 <dt class="hdlist1">log.abbrevCommit</dt>
6288 <dd>
6289 <p>If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
6290 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
6291 override this option with <code>--no-abbrev-commit</code>.</p>
6292 </dd>
6293 <dt class="hdlist1">log.date</dt>
6294 <dd>
6295 <p>Set the default date-time mode for the <em>log</em> command.
6296 Setting a value for log.date is similar to using <em>git log</em>'s
6297 <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.</p>
6298 <div class="paragraph">
6299 <p>If the format is set to "auto:foo" and the pager is in use, format
6300 "foo" will be used for the date format. Otherwise, "default" will
6301 be used.</p>
6302 </div>
6303 </dd>
6304 <dt class="hdlist1">log.decorate</dt>
6305 <dd>
6306 <p>Print out the ref names of any commits that are shown by the log
6307 command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
6308 <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
6309 specified, the full ref name (including prefix) will be printed.
6310 If <em>auto</em> is specified, then if the output is going to a terminal,
6311 the ref names are shown as if <em>short</em> were given, otherwise no ref
6312 names are shown. This is the same as the <code>--decorate</code> option
6313 of the <code>git log</code>.</p>
6314 </dd>
6315 <dt class="hdlist1">log.initialDecorationSet</dt>
6316 <dd>
6317 <p>By default, <code>git log</code> only shows decorations for certain known ref
6318 namespaces. If <em>all</em> is specified, then show all refs as
6319 decorations.</p>
6320 </dd>
6321 <dt class="hdlist1">log.excludeDecoration</dt>
6322 <dd>
6323 <p>Exclude the specified patterns from the log decorations. This is
6324 similar to the <code>--decorate-refs-exclude</code> command-line option, but
6325 the config option can be overridden by the <code>--decorate-refs</code>
6326 option.</p>
6327 </dd>
6328 <dt class="hdlist1">log.diffMerges</dt>
6329 <dd>
6330 <p>Set diff format to be used when <code>--diff-merges=on</code> is
6331 specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
6332 details. Defaults to <code>separate</code>.</p>
6333 </dd>
6334 <dt class="hdlist1">log.follow</dt>
6335 <dd>
6336 <p>If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
6337 a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
6338 i.e. it cannot be used to follow multiple files and does not work well
6339 on non-linear history.</p>
6340 </dd>
6341 <dt class="hdlist1">log.graphColors</dt>
6342 <dd>
6343 <p>A list of colors, separated by commas, that can be used to draw
6344 history lines in <code>git log --graph</code>.</p>
6345 </dd>
6346 <dt class="hdlist1">log.showRoot</dt>
6347 <dd>
6348 <p>If true, the initial commit will be shown as a big creation event.
6349 This is equivalent to a diff against an empty tree.
6350 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
6351 normally hide the root commit will now show it. True by default.</p>
6352 </dd>
6353 <dt class="hdlist1">log.showSignature</dt>
6354 <dd>
6355 <p>If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
6356 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.</p>
6357 </dd>
6358 <dt class="hdlist1">log.mailmap</dt>
6359 <dd>
6360 <p>If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
6361 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
6362 assume <code>--no-use-mailmap</code>. True by default.</p>
6363 </dd>
6364 <dt class="hdlist1">lsrefs.unborn</dt>
6365 <dd>
6366 <p>May be "advertise" (the default), "allow", or "ignore". If "advertise",
6367 the server will respond to the client sending "unborn" (as described in
6368 <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
6369 protocol v2 capability advertisement. "allow" is the same as
6370 "advertise" except that the server will not advertise support for this
6371 feature; this is useful for load-balanced servers that cannot be
6372 updated atomically (for example), since the administrator could
6373 configure "allow", then after a delay, configure "advertise".</p>
6374 </dd>
6375 <dt class="hdlist1">mailinfo.scissors</dt>
6376 <dd>
6377 <p>If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
6378 <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
6379 was provided on the command-line. When active, this feature
6380 removes everything from the message body before a scissors
6381 line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").</p>
6382 </dd>
6383 <dt class="hdlist1">mailmap.file</dt>
6384 <dd>
6385 <p>The location of an augmenting mailmap file. The default
6386 mailmap, located in the root of the repository, is loaded
6387 first, then the mailmap file pointed to by this variable.
6388 The location of the mailmap file may be in a repository
6389 subdirectory, or somewhere outside of the repository itself.
6390 See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.</p>
6391 </dd>
6392 <dt class="hdlist1">mailmap.blob</dt>
6393 <dd>
6394 <p>Like <code>mailmap.file</code>, but consider the value as a reference to a
6395 blob in the repository. If both <code>mailmap.file</code> and
6396 <code>mailmap.blob</code> are given, both are parsed, with entries from
6397 <code>mailmap.file</code> taking precedence. In a bare repository, this
6398 defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
6399 defaults to empty.</p>
6400 </dd>
6401 <dt class="hdlist1">maintenance.auto</dt>
6402 <dd>
6403 <p>This boolean config option controls whether some commands run
6404 <code>git maintenance run --auto</code> after doing their normal work. Defaults
6405 to true.</p>
6406 </dd>
6407 <dt class="hdlist1">maintenance.autoDetach</dt>
6408 <dd>
6409 <p>Many Git commands trigger automatic maintenance after they have
6410 written data into the repository. This boolean config option
6411 controls whether this automatic maintenance shall happen in the
6412 foreground or whether the maintenance process shall detach and
6413 continue to run in the background.</p>
6414 <div class="paragraph">
6415 <p>If unset, the value of <code>gc.autoDetach</code> is used as a fallback. Defaults
6416 to true if both are unset, meaning that the maintenance process will
6417 detach.</p>
6418 </div>
6419 </dd>
6420 <dt class="hdlist1">maintenance.strategy</dt>
6421 <dd>
6422 <p>This string config option provides a way to specify one of a few
6423 recommended schedules for background maintenance. This only affects
6424 which tasks are run during <code>git maintenance run --schedule=X</code>
6425 commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
6426 Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
6427 then that value is used instead of the one provided by
6428 <code>maintenance.strategy</code>. The possible strategy strings are:</p>
6429 <div class="ulist">
6430 <ul>
6431 <li>
6432 <p><code>none</code>: This default setting implies no tasks are run at any schedule.</p>
6433 </li>
6434 <li>
6435 <p><code>incremental</code>: This setting optimizes for performing small maintenance
6436 activities that do not delete any data. This does not schedule the <code>gc</code>
6437 task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
6438 <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
6439 task weekly.</p>
6440 </li>
6441 </ul>
6442 </div>
6443 </dd>
6444 <dt class="hdlist1">maintenance.&lt;task&gt;.enabled</dt>
6445 <dd>
6446 <p>This boolean config option controls whether the maintenance task
6447 with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
6448 <code>git maintenance run</code>. These config values are ignored if a
6449 <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
6450 is true.</p>
6451 </dd>
6452 <dt class="hdlist1">maintenance.&lt;task&gt;.schedule</dt>
6453 <dd>
6454 <p>This config option controls whether or not the given <code>&lt;task&gt;</code> runs
6455 during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
6456 value must be one of "hourly", "daily", or "weekly".</p>
6457 </dd>
6458 <dt class="hdlist1">maintenance.commit-graph.auto</dt>
6459 <dd>
6460 <p>This integer config option controls how often the <code>commit-graph</code> task
6461 should be run as part of <code>git maintenance run --auto</code>. If zero, then
6462 the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
6463 negative value will force the task to run every time. Otherwise, a
6464 positive value implies the command should run when the number of
6465 reachable commits that are not in the commit-graph file is at least
6466 the value of <code>maintenance.commit-graph.auto</code>. The default value is
6467 100.</p>
6468 </dd>
6469 <dt class="hdlist1">maintenance.loose-objects.auto</dt>
6470 <dd>
6471 <p>This integer config option controls how often the <code>loose-objects</code> task
6472 should be run as part of <code>git maintenance run --auto</code>. If zero, then
6473 the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
6474 negative value will force the task to run every time. Otherwise, a
6475 positive value implies the command should run when the number of
6476 loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
6477 The default value is 100.</p>
6478 </dd>
6479 <dt class="hdlist1">maintenance.incremental-repack.auto</dt>
6480 <dd>
6481 <p>This integer config option controls how often the <code>incremental-repack</code>
6482 task should be run as part of <code>git maintenance run --auto</code>. If zero,
6483 then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
6484 option. A negative value will force the task to run every time.
6485 Otherwise, a positive value implies the command should run when the
6486 number of pack-files not in the multi-pack-index is at least the value
6487 of <code>maintenance.incremental-repack.auto</code>. The default value is 10.</p>
6488 </dd>
6489 <dt class="hdlist1">man.viewer</dt>
6490 <dd>
6491 <p>Specify the programs that may be used to display help in the
6492 <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.</p>
6493 </dd>
6494 <dt class="hdlist1">man.&lt;tool&gt;.cmd</dt>
6495 <dd>
6496 <p>Specify the command to invoke the specified man viewer. The
6497 specified command is evaluated in shell with the man page
6498 passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)</p>
6499 </dd>
6500 <dt class="hdlist1">man.&lt;tool&gt;.path</dt>
6501 <dd>
6502 <p>Override the path for the given tool that may be used to
6503 display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.</p>
6504 </dd>
6505 <dt class="hdlist1">merge.conflictStyle</dt>
6506 <dd>
6507 <p>Specify the style in which conflicted hunks are written out to
6508 working tree files upon merge.  The default is "merge", which
6509 shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
6510 a <code>=======</code> marker, changes made by the other side, and then
6511 a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
6512 marker and the original text before the <code>=======</code> marker.  The
6513 "merge" style tends to produce smaller conflict regions than diff3,
6514 both because of the exclusion of the original text, and because
6515 when a subset of lines match on the two sides, they are just pulled
6516 out of the conflict region.  Another alternate style, "zdiff3", is
6517 similar to diff3 but removes matching lines on the two sides from
6518 the conflict region when those matching lines appear near either
6519 the beginning or end of a conflict region.</p>
6520 </dd>
6521 <dt class="hdlist1">merge.defaultToUpstream</dt>
6522 <dd>
6523 <p>If merge is called without any commit argument, merge the upstream
6524 branches configured for the current branch by using their last
6525 observed values stored in their remote-tracking branches.
6526 The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
6527 branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
6528 are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
6529 to their corresponding remote-tracking branches, and the tips of
6530 these tracking branches are merged. Defaults to true.</p>
6531 </dd>
6532 <dt class="hdlist1">merge.ff</dt>
6533 <dd>
6534 <p>By default, Git does not create an extra merge commit when merging
6535 a commit that is a descendant of the current commit. Instead, the
6536 tip of the current branch is fast-forwarded. When set to <code>false</code>,
6537 this variable tells Git to create an extra merge commit in such
6538 a case (equivalent to giving the <code>--no-ff</code> option from the command
6539 line). When set to <code>only</code>, only such fast-forward merges are
6540 allowed (equivalent to giving the <code>--ff-only</code> option from the
6541 command line).</p>
6542 </dd>
6543 <dt class="hdlist1">merge.verifySignatures</dt>
6544 <dd>
6545 <p>If true, this is equivalent to the --verify-signatures command
6546 line option. See <a href="git-merge.html">git-merge(1)</a> for details.</p>
6547 </dd>
6548 <dt class="hdlist1">merge.branchdesc</dt>
6549 <dd>
6550 <p>In addition to branch names, populate the log message with
6551 the branch description text associated with them.  Defaults
6552 to false.</p>
6553 </dd>
6554 <dt class="hdlist1">merge.log</dt>
6555 <dd>
6556 <p>In addition to branch names, populate the log message with at
6557 most the specified number of one-line descriptions from the
6558 actual commits that are being merged.  Defaults to false, and
6559 true is a synonym for 20.</p>
6560 </dd>
6561 <dt class="hdlist1">merge.suppressDest</dt>
6562 <dd>
6563 <p>By adding a glob that matches the names of integration
6564 branches to this multi-valued configuration variable, the
6565 default merge message computed for merges into these
6566 integration branches will omit "into &lt;branch name&gt;" from
6567 its title.</p>
6568 <div class="paragraph">
6569 <p>An element with an empty value can be used to clear the list
6570 of globs accumulated from previous configuration entries.
6571 When there is no <code>merge.suppressDest</code> variable defined, the
6572 default value of <code>master</code> is used for backward compatibility.</p>
6573 </div>
6574 </dd>
6575 <dt class="hdlist1">merge.renameLimit</dt>
6576 <dd>
6577 <p>The number of files to consider in the exhaustive portion of
6578 rename detection during a merge.  If not specified, defaults
6579 to the value of diff.renameLimit.  If neither
6580 merge.renameLimit nor diff.renameLimit are specified,
6581 currently defaults to 7000.  This setting has no effect if
6582 rename detection is turned off.</p>
6583 </dd>
6584 <dt class="hdlist1">merge.renames</dt>
6585 <dd>
6586 <p>Whether Git detects renames.  If set to "false", rename detection
6587 is disabled. If set to "true", basic rename detection is enabled.
6588 Defaults to the value of diff.renames.</p>
6589 </dd>
6590 <dt class="hdlist1">merge.directoryRenames</dt>
6591 <dd>
6592 <p>Whether Git detects directory renames, affecting what happens at
6593 merge time to new files added to a directory on one side of
6594 history when that directory was renamed on the other side of
6595 history.  If merge.directoryRenames is set to "false", directory
6596 rename detection is disabled, meaning that such new files will be
6597 left behind in the old directory.  If set to "true", directory
6598 rename detection is enabled, meaning that such new files will be
6599 moved into the new directory.  If set to "conflict", a conflict
6600 will be reported for such paths.  If merge.renames is false,
6601 merge.directoryRenames is ignored and treated as false.  Defaults
6602 to "conflict".</p>
6603 </dd>
6604 <dt class="hdlist1">merge.renormalize</dt>
6605 <dd>
6606 <p>Tell Git that canonical representation of files in the
6607 repository has changed over time (e.g. earlier commits record
6608 text files with CRLF line endings, but recent ones use LF line
6609 endings).  In such a repository, Git can convert the data
6610 recorded in commits to a canonical form before performing a
6611 merge to reduce unnecessary conflicts.  For more information,
6612 see section "Merging branches with differing checkin/checkout
6613 attributes" in <a href="gitattributes.html">gitattributes(5)</a>.</p>
6614 </dd>
6615 <dt class="hdlist1">merge.stat</dt>
6616 <dd>
6617 <p>Whether to print the diffstat between ORIG_HEAD and the merge result
6618 at the end of the merge.  True by default.</p>
6619 </dd>
6620 <dt class="hdlist1">merge.autoStash</dt>
6621 <dd>
6622 <p>When set to true, automatically create a temporary stash entry
6623 before the operation begins, and apply it after the operation
6624 ends.  This means that you can run merge on a dirty worktree.
6625 However, use with care: the final stash application after a
6626 successful merge might result in non-trivial conflicts.
6627 This option can be overridden by the <code>--no-autostash</code> and
6628 <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
6629 Defaults to false.</p>
6630 </dd>
6631 <dt class="hdlist1">merge.tool</dt>
6632 <dd>
6633 <p>Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
6634 The list below shows the valid built-in values.
6635 Any other value is treated as a custom merge tool and requires
6636 that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.</p>
6637 </dd>
6638 <dt class="hdlist1">merge.guitool</dt>
6639 <dd>
6640 <p>Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
6641 -g/--gui flag is specified. The list below shows the valid built-in values.
6642 Any other value is treated as a custom merge tool and requires that a
6643 corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.</p>
6644 <div class="dlist">
6645 <dl>
6646 <dt class="hdlist1"><code>araxis</code></dt>
6647 <dd>
6648 <p>Use Araxis Merge (requires a graphical session)</p>
6649 </dd>
6650 <dt class="hdlist1"><code>bc</code></dt>
6651 <dd>
6652 <p>Use Beyond Compare (requires a graphical session)</p>
6653 </dd>
6654 <dt class="hdlist1"><code>bc3</code></dt>
6655 <dd>
6656 <p>Use Beyond Compare (requires a graphical session)</p>
6657 </dd>
6658 <dt class="hdlist1"><code>bc4</code></dt>
6659 <dd>
6660 <p>Use Beyond Compare (requires a graphical session)</p>
6661 </dd>
6662 <dt class="hdlist1"><code>codecompare</code></dt>
6663 <dd>
6664 <p>Use Code Compare (requires a graphical session)</p>
6665 </dd>
6666 <dt class="hdlist1"><code>deltawalker</code></dt>
6667 <dd>
6668 <p>Use DeltaWalker (requires a graphical session)</p>
6669 </dd>
6670 <dt class="hdlist1"><code>diffmerge</code></dt>
6671 <dd>
6672 <p>Use DiffMerge (requires a graphical session)</p>
6673 </dd>
6674 <dt class="hdlist1"><code>diffuse</code></dt>
6675 <dd>
6676 <p>Use Diffuse (requires a graphical session)</p>
6677 </dd>
6678 <dt class="hdlist1"><code>ecmerge</code></dt>
6679 <dd>
6680 <p>Use ECMerge (requires a graphical session)</p>
6681 </dd>
6682 <dt class="hdlist1"><code>emerge</code></dt>
6683 <dd>
6684 <p>Use Emacs' Emerge</p>
6685 </dd>
6686 <dt class="hdlist1"><code>examdiff</code></dt>
6687 <dd>
6688 <p>Use ExamDiff Pro (requires a graphical session)</p>
6689 </dd>
6690 <dt class="hdlist1"><code>guiffy</code></dt>
6691 <dd>
6692 <p>Use Guiffy&#8217;s Diff Tool (requires a graphical session)</p>
6693 </dd>
6694 <dt class="hdlist1"><code>gvimdiff</code></dt>
6695 <dd>
6696 <p>Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)</p>
6697 </dd>
6698 <dt class="hdlist1"><code>gvimdiff1</code></dt>
6699 <dd>
6700 <p>Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)</p>
6701 </dd>
6702 <dt class="hdlist1"><code>gvimdiff2</code></dt>
6703 <dd>
6704 <p>Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)</p>
6705 </dd>
6706 <dt class="hdlist1"><code>gvimdiff3</code></dt>
6707 <dd>
6708 <p>Use gVim (requires a graphical session) where only the MERGED file is shown</p>
6709 </dd>
6710 <dt class="hdlist1"><code>kdiff3</code></dt>
6711 <dd>
6712 <p>Use KDiff3 (requires a graphical session)</p>
6713 </dd>
6714 <dt class="hdlist1"><code>meld</code></dt>
6715 <dd>
6716 <p>Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)</p>
6717 </dd>
6718 <dt class="hdlist1"><code>nvimdiff</code></dt>
6719 <dd>
6720 <p>Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)</p>
6721 </dd>
6722 <dt class="hdlist1"><code>nvimdiff1</code></dt>
6723 <dd>
6724 <p>Use Neovim with a 2 panes layout (LOCAL and REMOTE)</p>
6725 </dd>
6726 <dt class="hdlist1"><code>nvimdiff2</code></dt>
6727 <dd>
6728 <p>Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)</p>
6729 </dd>
6730 <dt class="hdlist1"><code>nvimdiff3</code></dt>
6731 <dd>
6732 <p>Use Neovim where only the MERGED file is shown</p>
6733 </dd>
6734 <dt class="hdlist1"><code>opendiff</code></dt>
6735 <dd>
6736 <p>Use FileMerge (requires a graphical session)</p>
6737 </dd>
6738 <dt class="hdlist1"><code>p4merge</code></dt>
6739 <dd>
6740 <p>Use HelixCore P4Merge (requires a graphical session)</p>
6741 </dd>
6742 <dt class="hdlist1"><code>smerge</code></dt>
6743 <dd>
6744 <p>Use Sublime Merge (requires a graphical session)</p>
6745 </dd>
6746 <dt class="hdlist1"><code>tkdiff</code></dt>
6747 <dd>
6748 <p>Use TkDiff (requires a graphical session)</p>
6749 </dd>
6750 <dt class="hdlist1"><code>tortoisemerge</code></dt>
6751 <dd>
6752 <p>Use TortoiseMerge (requires a graphical session)</p>
6753 </dd>
6754 <dt class="hdlist1"><code>vimdiff</code></dt>
6755 <dd>
6756 <p>Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)</p>
6757 </dd>
6758 <dt class="hdlist1"><code>vimdiff1</code></dt>
6759 <dd>
6760 <p>Use Vim with a 2 panes layout (LOCAL and REMOTE)</p>
6761 </dd>
6762 <dt class="hdlist1"><code>vimdiff2</code></dt>
6763 <dd>
6764 <p>Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)</p>
6765 </dd>
6766 <dt class="hdlist1"><code>vimdiff3</code></dt>
6767 <dd>
6768 <p>Use Vim where only the MERGED file is shown</p>
6769 </dd>
6770 <dt class="hdlist1"><code>vscode</code></dt>
6771 <dd>
6772 <p>Use Visual Studio Code (requires a graphical session)</p>
6773 </dd>
6774 <dt class="hdlist1"><code>winmerge</code></dt>
6775 <dd>
6776 <p>Use WinMerge (requires a graphical session)</p>
6777 </dd>
6778 <dt class="hdlist1"><code>xxdiff</code></dt>
6779 <dd>
6780 <p>Use xxdiff (requires a graphical session)</p>
6781 </dd>
6782 </dl>
6783 </div>
6784 </dd>
6785 <dt class="hdlist1">merge.verbosity</dt>
6786 <dd>
6787 <p>Controls the amount of output shown by the recursive merge
6788 strategy.  Level 0 outputs nothing except a final error
6789 message if conflicts were detected. Level 1 outputs only
6790 conflicts, 2 outputs conflicts and file changes.  Level 5 and
6791 above outputs debugging information.  The default is level 2.
6792 Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.</p>
6793 </dd>
6794 <dt class="hdlist1">merge.&lt;driver&gt;.name</dt>
6795 <dd>
6796 <p>Defines a human-readable name for a custom low-level
6797 merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
6798 </dd>
6799 <dt class="hdlist1">merge.&lt;driver&gt;.driver</dt>
6800 <dd>
6801 <p>Defines the command that implements a custom low-level
6802 merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
6803 </dd>
6804 <dt class="hdlist1">merge.&lt;driver&gt;.recursive</dt>
6805 <dd>
6806 <p>Names a low-level merge driver to be used when
6807 performing an internal merge between common ancestors.
6808 See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
6809 </dd>
6810 <dt class="hdlist1">mergetool.&lt;tool&gt;.path</dt>
6811 <dd>
6812 <p>Override the path for the given tool.  This is useful in case
6813 your tool is not in the PATH.</p>
6814 </dd>
6815 <dt class="hdlist1">mergetool.&lt;tool&gt;.cmd</dt>
6816 <dd>
6817 <p>Specify the command to invoke the specified merge tool.  The
6818 specified command is evaluated in shell with the following
6819 variables available: <em>BASE</em> is the name of a temporary file
6820 containing the common base of the files to be merged, if available;
6821 <em>LOCAL</em> is the name of a temporary file containing the contents of
6822 the file on the current branch; <em>REMOTE</em> is the name of a temporary
6823 file containing the contents of the file from the branch being
6824 merged; <em>MERGED</em> contains the name of the file to which the merge
6825 tool should write the results of a successful merge.</p>
6826 </dd>
6827 <dt class="hdlist1">mergetool.&lt;tool&gt;.hideResolved</dt>
6828 <dd>
6829 <p>Allows the user to override the global <code>mergetool.hideResolved</code> value
6830 for a specific tool. See <code>mergetool.hideResolved</code> for the full
6831 description.</p>
6832 </dd>
6833 <dt class="hdlist1">mergetool.&lt;tool&gt;.trustExitCode</dt>
6834 <dd>
6835 <p>For a custom merge command, specify whether the exit code of
6836 the merge command can be used to determine whether the merge was
6837 successful.  If this is not set to true then the merge target file
6838 timestamp is checked, and the merge is assumed to have been successful
6839 if the file has been updated; otherwise, the user is prompted to
6840 indicate the success of the merge.</p>
6841 </dd>
6842 <dt class="hdlist1">mergetool.meld.hasOutput</dt>
6843 <dd>
6844 <p>Older versions of <code>meld</code> do not support the <code>--output</code> option.
6845 Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
6846 by inspecting the output of <code>meld --help</code>.  Configuring
6847 <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
6848 use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
6849 to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
6850 and <code>false</code> avoids using <code>--output</code>.</p>
6851 </dd>
6852 <dt class="hdlist1">mergetool.meld.useAutoMerge</dt>
6853 <dd>
6854 <p>When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
6855 parts automatically, highlight the conflicting parts, and wait for
6856 user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
6857 Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
6858 Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
6859 is supported and will only use <code>--auto-merge</code> when available.  A
6860 value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
6861 default value.</p>
6862 </dd>
6863 <dt class="hdlist1">mergetool.&lt;vimdiff variant&gt;.layout</dt>
6864 <dd>
6865 <p>Configure the split window layout for vimdiff&#8217;s <code>&lt;variant&gt;</code>, which is any of <code>vimdiff</code>,
6866 <code>nvimdiff</code>, <code>gvimdiff</code>.
6867 Upon launching <code>git mergetool</code> with <code>--tool=&lt;variant&gt;</code> (or without <code>--tool</code>
6868 if <code>merge.tool</code> is configured as <code>&lt;variant&gt;</code>), Git will consult
6869 <code>mergetool.&lt;variant&gt;.layout</code> to determine the tool&#8217;s layout. If the
6870 variant-specific configuration is not available, <code>vimdiff</code>'s is used as
6871 fallback.  If that too is not available, a default layout with 4 windows
6872 will be used.  To configure the layout, see the <code>BACKEND SPECIFIC HINTS</code>
6873 section in <a href="git-mergetool.html">git-mergetool(1)</a>.</p>
6874 </dd>
6875 <dt class="hdlist1">mergetool.hideResolved</dt>
6876 <dd>
6877 <p>During a merge, Git will automatically resolve as many conflicts as
6878 possible and write the <em>MERGED</em> file containing conflict markers around
6879 any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
6880 represent the versions of the file from before Git&#8217;s conflict
6881 resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
6882 that only the unresolved conflicts are presented to the merge tool. Can
6883 be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
6884 configuration variable. Defaults to <code>false</code>.</p>
6885 </dd>
6886 <dt class="hdlist1">mergetool.keepBackup</dt>
6887 <dd>
6888 <p>After performing a merge, the original file with conflict markers
6889 can be saved as a file with a <code>.orig</code> extension.  If this variable
6890 is set to <code>false</code> then this file is not preserved.  Defaults to
6891 <code>true</code> (i.e. keep the backup files).</p>
6892 </dd>
6893 <dt class="hdlist1">mergetool.keepTemporaries</dt>
6894 <dd>
6895 <p>When invoking a custom merge tool, Git uses a set of temporary
6896 files to pass to the tool. If the tool returns an error and this
6897 variable is set to <code>true</code>, then these temporary files will be
6898 preserved; otherwise, they will be removed after the tool has
6899 exited. Defaults to <code>false</code>.</p>
6900 </dd>
6901 <dt class="hdlist1">mergetool.writeToTemp</dt>
6902 <dd>
6903 <p>Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
6904 conflicting files in the worktree by default.  Git will attempt
6905 to use a temporary directory for these files when set <code>true</code>.
6906 Defaults to <code>false</code>.</p>
6907 </dd>
6908 <dt class="hdlist1">mergetool.prompt</dt>
6909 <dd>
6910 <p>Prompt before each invocation of the merge resolution program.</p>
6911 </dd>
6912 <dt class="hdlist1">mergetool.guiDefault</dt>
6913 <dd>
6914 <p>Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
6915 specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
6916 or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
6917 variable value. The default is <code>false</code>, where the <code>--gui</code> argument
6918 must be provided explicitly for the <code>merge.guitool</code> to be used.</p>
6919 </dd>
6920 <dt class="hdlist1">notes.mergeStrategy</dt>
6921 <dd>
6922 <p>Which merge strategy to choose by default when resolving notes
6923 conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
6924 <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
6925 section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.</p>
6926 <div class="paragraph">
6927 <p>This setting can be overridden by passing the <code>--strategy</code> option to
6928 <a href="git-notes.html">git-notes(1)</a>.</p>
6929 </div>
6930 </dd>
6931 <dt class="hdlist1">notes.&lt;name&gt;.mergeStrategy</dt>
6932 <dd>
6933 <p>Which merge strategy to choose when doing a notes merge into
6934 refs/notes/&lt;name&gt;.  This overrides the more general
6935 "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
6936 <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.</p>
6937 </dd>
6938 <dt class="hdlist1">notes.displayRef</dt>
6939 <dd>
6940 <p>Which ref (or refs, if a glob or specified more than once), in
6941 addition to the default set by <code>core.notesRef</code> or
6942 <code>GIT_NOTES_REF</code>, to read notes from when showing commit
6943 messages with the <em>git log</em> family of commands.</p>
6944 <div class="paragraph">
6945 <p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
6946 environment variable, which must be a colon separated list of refs or
6947 globs.</p>
6948 </div>
6949 <div class="paragraph">
6950 <p>A warning will be issued for refs that do not exist,
6951 but a glob that does not match any refs is silently ignored.</p>
6952 </div>
6953 <div class="paragraph">
6954 <p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
6955 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
6956 those commands.</p>
6957 </div>
6958 <div class="paragraph">
6959 <p>The effective value of "core.notesRef" (possibly overridden by
6960 GIT_NOTES_REF) is also implicitly added to the list of refs to be
6961 displayed.</p>
6962 </div>
6963 </dd>
6964 <dt class="hdlist1">notes.rewrite.&lt;command&gt;</dt>
6965 <dd>
6966 <p>When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
6967 <code>rebase</code>), if this variable is <code>false</code>, git will not copy
6968 notes from the original to the rewritten commit.  Defaults to
6969 <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.</p>
6970 <div class="paragraph">
6971 <p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
6972 environment variable, which must be a colon separated list of refs or
6973 globs.</p>
6974 </div>
6975 </dd>
6976 <dt class="hdlist1">notes.rewriteMode</dt>
6977 <dd>
6978 <p>When copying notes during a rewrite (see the
6979 "notes.rewrite.&lt;command&gt;" option), determines what to do if
6980 the target commit already has a note.  Must be one of
6981 <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
6982 Defaults to <code>concatenate</code>.</p>
6983 <div class="paragraph">
6984 <p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
6985 environment variable.</p>
6986 </div>
6987 </dd>
6988 <dt class="hdlist1">notes.rewriteRef</dt>
6989 <dd>
6990 <p>When copying notes during a rewrite, specifies the (fully
6991 qualified) ref whose notes should be copied.  May be a glob,
6992 in which case notes in all matching refs will be copied.  You
6993 may also specify this configuration several times.</p>
6994 <div class="paragraph">
6995 <p>Does not have a default value; you must configure this variable to
6996 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
6997 rewriting for the default commit notes.</p>
6998 </div>
6999 <div class="paragraph">
7000 <p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
7001 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p>
7002 </div>
7003 </dd>
7004 <dt class="hdlist1">pack.window</dt>
7005 <dd>
7006 <p>The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
7007 window size is given on the command line. Defaults to 10.</p>
7008 </dd>
7009 <dt class="hdlist1">pack.depth</dt>
7010 <dd>
7011 <p>The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
7012 maximum depth is given on the command line. Defaults to 50.
7013 Maximum value is 4095.</p>
7014 </dd>
7015 <dt class="hdlist1">pack.windowMemory</dt>
7016 <dd>
7017 <p>The maximum size of memory that is consumed by each thread
7018 in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
7019 no limit is given on the command line.  The value can be
7020 suffixed with "k", "m", or "g".  When left unconfigured (or
7021 set explicitly to 0), there will be no limit.</p>
7022 </dd>
7023 <dt class="hdlist1">pack.compression</dt>
7024 <dd>
7025 <p>An integer -1..9, indicating the compression level for objects
7026 in a pack file. -1 is the zlib default. 0 means no
7027 compression, and 1..9 are various speed/size tradeoffs, 9 being
7028 slowest.  If not set,  defaults to core.compression.  If that is
7029 not set,  defaults to -1, the zlib default, which is "a default
7030 compromise between speed and compression (currently equivalent
7031 to level 6)."</p>
7032 <div class="paragraph">
7033 <p>Note that changing the compression level will not automatically recompress
7034 all existing objects. You can force recompression by passing the -F option
7035 to <a href="git-repack.html">git-repack(1)</a>.</p>
7036 </div>
7037 </dd>
7038 <dt class="hdlist1">pack.allowPackReuse</dt>
7039 <dd>
7040 <p>When true or "single", and when reachability bitmaps are
7041 enabled, pack-objects will try to send parts of the bitmapped
7042 packfile verbatim. When "multi", and when a multi-pack
7043 reachability bitmap is available, pack-objects will try to send
7044 parts of all packs in the MIDX.</p>
7045 <div class="paragraph">
7046 <p>If only a single pack bitmap is available, and <code>pack.allowPackReuse</code>
7047 is set to "multi", reuse parts of just the bitmapped packfile. This
7048 can reduce memory and CPU usage to serve fetches, but might result in
7049 sending a slightly larger pack. Defaults to true.</p>
7050 </div>
7051 </dd>
7052 <dt class="hdlist1">pack.island</dt>
7053 <dd>
7054 <p>An extended regular expression configuring a set of delta
7055 islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
7056 for details.</p>
7057 </dd>
7058 <dt class="hdlist1">pack.islandCore</dt>
7059 <dd>
7060 <p>Specify an island name which gets to have its objects be
7061 packed first. This creates a kind of pseudo-pack at the front
7062 of one pack, so that the objects from the specified island are
7063 hopefully faster to copy into any pack that should be served
7064 to a user requesting these objects. In practice this means
7065 that the island specified should likely correspond to what is
7066 the most commonly cloned in the repo. See also "DELTA ISLANDS"
7067 in <a href="git-pack-objects.html">git-pack-objects(1)</a>.</p>
7068 </dd>
7069 <dt class="hdlist1">pack.deltaCacheSize</dt>
7070 <dd>
7071 <p>The maximum memory in bytes used for caching deltas in
7072 <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
7073 This cache is used to speed up the writing object phase by not
7074 having to recompute the final delta result once the best match
7075 for all objects is found.  Repacking large repositories on machines
7076 which are tight with memory might be badly impacted by this though,
7077 especially if this cache pushes the system into swapping.
7078 A value of 0 means no limit. The smallest size of 1 byte may be
7079 used to virtually disable this cache. Defaults to 256 MiB.</p>
7080 </dd>
7081 <dt class="hdlist1">pack.deltaCacheLimit</dt>
7082 <dd>
7083 <p>The maximum size of a delta, that is cached in
7084 <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
7085 writing object phase by not having to recompute the final delta
7086 result once the best match for all objects is found.
7087 Defaults to 1000. Maximum value is 65535.</p>
7088 </dd>
7089 <dt class="hdlist1">pack.threads</dt>
7090 <dd>
7091 <p>Specifies the number of threads to spawn when searching for best
7092 delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
7093 be compiled with pthreads otherwise this option is ignored with a
7094 warning. This is meant to reduce packing time on multiprocessor
7095 machines. The required amount of memory for the delta search window
7096 is however multiplied by the number of threads.
7097 Specifying 0 will cause Git to auto-detect the number of CPUs
7098 and set the number of threads accordingly.</p>
7099 </dd>
7100 <dt class="hdlist1">pack.indexVersion</dt>
7101 <dd>
7102 <p>Specify the default pack index version.  Valid values are 1 for
7103 legacy pack index used by Git versions prior to 1.5.2, and 2 for
7104 the new pack index with capabilities for packs larger than 4 GB
7105 as well as proper protection against the repacking of corrupted
7106 packs.  Version 2 is the default.  Note that version 2 is enforced
7107 and this config option is ignored whenever the corresponding pack is
7108 larger than 2 GB.</p>
7109 <div class="paragraph">
7110 <p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
7111 cloning or fetching over a non-native protocol (e.g. "http")
7112 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
7113 other side may give you a repository that cannot be accessed with your
7114 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
7115 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
7116 the <code>*.idx</code> file.</p>
7117 </div>
7118 </dd>
7119 <dt class="hdlist1">pack.packSizeLimit</dt>
7120 <dd>
7121 <p>The maximum size of a pack.  This setting only affects
7122 packing to a file when repacking, i.e. the git:// protocol
7123 is unaffected.  It can be overridden by the <code>--max-pack-size</code>
7124 option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
7125 in the creation of multiple packfiles.</p>
7126 <div class="paragraph">
7127 <p>Note that this option is rarely useful, and may result in a larger total
7128 on-disk size (because Git will not store deltas between packs) and
7129 worse runtime performance (object lookup within multiple packs is
7130 slower than a single pack, and optimizations like reachability bitmaps
7131 cannot cope with multiple packs).</p>
7132 </div>
7133 <div class="paragraph">
7134 <p>If you need to actively run Git using smaller packfiles (e.g., because your
7135 filesystem does not support large files), this option may help. But if
7136 your goal is to transmit a packfile over a medium that supports limited
7137 sizes (e.g., removable media that cannot store the whole repository),
7138 you are likely better off creating a single large packfile and splitting
7139 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p>
7140 </div>
7141 <div class="paragraph">
7142 <p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
7143 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
7144 </div>
7145 </dd>
7146 <dt class="hdlist1">pack.useBitmaps</dt>
7147 <dd>
7148 <p>When true, git will use pack bitmaps (if available) when packing
7149 to stdout (e.g., during the server side of a fetch). Defaults to
7150 true. You should not generally need to turn this off unless
7151 you are debugging pack bitmaps.</p>
7152 </dd>
7153 <dt class="hdlist1">pack.useBitmapBoundaryTraversal</dt>
7154 <dd>
7155 <p>When true, Git will use an experimental algorithm for computing
7156 reachability queries with bitmaps. Instead of building up
7157 complete bitmaps for all of the negated tips and then OR-ing
7158 them together, consider negated tips with existing bitmaps as
7159 additive (i.e. OR-ing them into the result if they exist,
7160 ignoring them otherwise), and build up a bitmap at the boundary
7161 instead.</p>
7162 <div class="paragraph">
7163 <p>When using this algorithm, Git may include too many objects as a result
7164 of not opening up trees belonging to certain UNINTERESTING commits. This
7165 inexactness matches the non-bitmap traversal algorithm.</p>
7166 </div>
7167 <div class="paragraph">
7168 <p>In many cases, this can provide a speed-up over the exact algorithm,
7169 particularly when there is poor bitmap coverage of the negated side of
7170 the query.</p>
7171 </div>
7172 </dd>
7173 <dt class="hdlist1">pack.useSparse</dt>
7174 <dd>
7175 <p>When true, git will default to using the <em>--sparse</em> option in
7176 <em>git pack-objects</em> when the <em>--revs</em> option is present. This
7177 algorithm only walks trees that appear in paths that introduce new
7178 objects. This can have significant performance benefits when
7179 computing a pack to send a small change. However, it is possible
7180 that extra objects are added to the pack-file if the included
7181 commits contain certain types of direct renames. Default is
7182 <code>true</code>.</p>
7183 </dd>
7184 <dt class="hdlist1">pack.preferBitmapTips</dt>
7185 <dd>
7186 <p>When selecting which commits will receive bitmaps, prefer a
7187 commit at the tip of any reference that is a suffix of any value
7188 of this configuration over any other commits in the "selection
7189 window".</p>
7190 <div class="paragraph">
7191 <p>Note that setting this configuration to <code>refs/foo</code> does not mean that
7192 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
7193 necessarily be selected. This is because commits are selected for
7194 bitmaps from within a series of windows of variable length.</p>
7195 </div>
7196 <div class="paragraph">
7197 <p>If a commit at the tip of any reference which is a suffix of any value
7198 of this configuration is seen in a window, it is immediately given
7199 preference over any other commit in that window.</p>
7200 </div>
7201 </dd>
7202 <dt class="hdlist1">pack.writeBitmaps (deprecated)</dt>
7203 <dd>
7204 <p>This is a deprecated synonym for <code>repack.writeBitmaps</code>.</p>
7205 </dd>
7206 <dt class="hdlist1">pack.writeBitmapHashCache</dt>
7207 <dd>
7208 <p>When true, git will include a "hash cache" section in the bitmap
7209 index (if one is written). This cache can be used to feed git&#8217;s
7210 delta heuristics, potentially leading to better deltas between
7211 bitmapped and non-bitmapped objects (e.g., when serving a fetch
7212 between an older, bitmapped pack and objects that have been
7213 pushed since the last gc). The downside is that it consumes 4
7214 bytes per object of disk space. Defaults to true.</p>
7215 <div class="paragraph">
7216 <p>When writing a multi-pack reachability bitmap, no new namehashes are
7217 computed; instead, any namehashes stored in an existing bitmap are
7218 permuted into their appropriate location when writing a new bitmap.</p>
7219 </div>
7220 </dd>
7221 <dt class="hdlist1">pack.writeBitmapLookupTable</dt>
7222 <dd>
7223 <p>When true, Git will include a "lookup table" section in the
7224 bitmap index (if one is written). This table is used to defer
7225 loading individual bitmaps as late as possible. This can be
7226 beneficial in repositories that have relatively large bitmap
7227 indexes. Defaults to false.</p>
7228 </dd>
7229 <dt class="hdlist1">pack.readReverseIndex</dt>
7230 <dd>
7231 <p>When true, git will read any .rev file(s) that may be available
7232 (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
7233 will be generated from scratch and stored in memory. Defaults to
7234 true.</p>
7235 </dd>
7236 <dt class="hdlist1">pack.writeReverseIndex</dt>
7237 <dd>
7238 <p>When true, git will write a corresponding .rev file (see:
7239 <a href="gitformat-pack.html">gitformat-pack(5)</a>)
7240 for each new packfile that it writes in all places except for
7241 <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
7242 Defaults to true.</p>
7243 </dd>
7244 <dt class="hdlist1">pager.&lt;cmd&gt;</dt>
7245 <dd>
7246 <p>If the value is boolean, turns on or off pagination of the
7247 output of a particular Git subcommand when writing to a tty.
7248 Otherwise, turns on pagination for the subcommand using the
7249 pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
7250 or <code>--no-pager</code> is specified on the command line, it takes
7251 precedence over this option.  To disable pagination for all
7252 commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.</p>
7253 </dd>
7254 <dt class="hdlist1">pretty.&lt;name&gt;</dt>
7255 <dd>
7256 <p>Alias for a --pretty= format string, as specified in
7257 <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
7258 as the built-in pretty formats could. For example,
7259 running <code>git config pretty.changelog "format:* %H %s"</code>
7260 would cause the invocation <code>git log --pretty=changelog</code>
7261 to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
7262 Note that an alias with the same name as a built-in format
7263 will be silently ignored.</p>
7264 </dd>
7265 <dt class="hdlist1">promisor.quiet</dt>
7266 <dd>
7267 <p>If set to "true" assume <code>--quiet</code> when fetching additional
7268 objects for a partial clone.</p>
7269 </dd>
7270 <dt class="hdlist1">protocol.allow</dt>
7271 <dd>
7272 <p>If set, provide a user defined default policy for all protocols which
7273 don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
7274 if unset, known-safe protocols (http, https, git, ssh) have a
7275 default policy of <code>always</code>, known-dangerous protocols (ext) have a
7276 default policy of <code>never</code>, and all other protocols (including file)
7277 have a default policy of <code>user</code>.  Supported policies:</p>
7278 <div class="openblock">
7279 <div class="content">
7280 <div class="ulist">
7281 <ul>
7282 <li>
7283 <p><code>always</code> - protocol is always able to be used.</p>
7284 </li>
7285 <li>
7286 <p><code>never</code> - protocol is never able to be used.</p>
7287 </li>
7288 <li>
7289 <p><code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
7290 either unset or has a value of 1.  This policy should be used when you want a
7291 protocol to be directly usable by the user but don&#8217;t want it used by commands which
7292 execute clone/fetch/push commands without user input, e.g. recursive
7293 submodule initialization.</p>
7294 </li>
7295 </ul>
7296 </div>
7297 </div>
7298 </div>
7299 </dd>
7300 <dt class="hdlist1">protocol.&lt;name&gt;.allow</dt>
7301 <dd>
7302 <p>Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
7303 commands. See <code>protocol.allow</code> above for the available policies.</p>
7304 <div class="paragraph">
7305 <p>The protocol names currently used by git are:</p>
7306 </div>
7307 <div class="openblock">
7308 <div class="content">
7309 <div class="ulist">
7310 <ul>
7311 <li>
7312 <p><code>file</code>: any local file-based path (including <code>file://</code> URLs,
7313 or local paths)</p>
7314 </li>
7315 <li>
7316 <p><code>git</code>: the anonymous git protocol over a direct TCP
7317 connection (or proxy, if configured)</p>
7318 </li>
7319 <li>
7320 <p><code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
7321 <code>ssh://</code>, etc).</p>
7322 </li>
7323 <li>
7324 <p><code>http</code>: git over http, both "smart http" and "dumb http".
7325 Note that this does <em>not</em> include <code>https</code>; if you want to configure
7326 both, you must do so individually.</p>
7327 </li>
7328 <li>
7329 <p>any external helpers are named by their protocol (e.g., use
7330 <code>hg</code> to allow the <code>git-remote-hg</code> helper)</p>
7331 </li>
7332 </ul>
7333 </div>
7334 </div>
7335 </div>
7336 </dd>
7337 <dt class="hdlist1">protocol.version</dt>
7338 <dd>
7339 <p>If set, clients will attempt to communicate with a server
7340 using the specified protocol version.  If the server does
7341 not support it, communication falls back to version 0.
7342 If unset, the default is <code>2</code>.
7343 Supported versions:</p>
7344 <div class="openblock">
7345 <div class="content">
7346 <div class="ulist">
7347 <ul>
7348 <li>
7349 <p><code>0</code> - the original wire protocol.</p>
7350 </li>
7351 <li>
7352 <p><code>1</code> - the original wire protocol with the addition of a version string
7353 in the initial response from the server.</p>
7354 </li>
7355 <li>
7356 <p><code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.</p>
7357 </li>
7358 </ul>
7359 </div>
7360 </div>
7361 </div>
7362 </dd>
7363 <dt class="hdlist1">pull.ff</dt>
7364 <dd>
7365 <p>By default, Git does not create an extra merge commit when merging
7366 a commit that is a descendant of the current commit. Instead, the
7367 tip of the current branch is fast-forwarded. When set to <code>false</code>,
7368 this variable tells Git to create an extra merge commit in such
7369 a case (equivalent to giving the <code>--no-ff</code> option from the command
7370 line). When set to <code>only</code>, only such fast-forward merges are
7371 allowed (equivalent to giving the <code>--ff-only</code> option from the
7372 command line). This setting overrides <code>merge.ff</code> when pulling.</p>
7373 </dd>
7374 <dt class="hdlist1">pull.rebase</dt>
7375 <dd>
7376 <p>When true, rebase branches on top of the fetched branch, instead
7377 of merging the default branch from the default remote when "git
7378 pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
7379 per-branch basis.</p>
7380 <div class="paragraph">
7381 <p>When <code>merges</code> (or just <em>m</em>), pass the <code>--rebase-merges</code> option to <em>git rebase</em>
7382 so that the local merge commits are included in the rebase (see
7383 <a href="git-rebase.html">git-rebase(1)</a> for details).</p>
7384 </div>
7385 <div class="paragraph">
7386 <p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
7387 mode.</p>
7388 </div>
7389 <div class="paragraph">
7390 <p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
7391 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
7392 for details).</p>
7393 </div>
7394 </dd>
7395 <dt class="hdlist1">pull.octopus</dt>
7396 <dd>
7397 <p>The default merge strategy to use when pulling multiple branches
7398 at once.</p>
7399 </dd>
7400 <dt class="hdlist1">pull.twohead</dt>
7401 <dd>
7402 <p>The default merge strategy to use when pulling a single branch.</p>
7403 </dd>
7404 <dt class="hdlist1">push.autoSetupRemote</dt>
7405 <dd>
7406 <p>If set to "true" assume <code>--set-upstream</code> on default push when no
7407 upstream tracking exists for the current branch; this option
7408 takes effect with push.default options <em>simple</em>, <em>upstream</em>,
7409 and <em>current</em>. It is useful if by default you want new branches
7410 to be pushed to the default remote (like the behavior of
7411 <em>push.default=current</em>) and you also want the upstream tracking
7412 to be set. Workflows most likely to benefit from this option are
7413 <em>simple</em> central workflows where all branches are expected to
7414 have the same name on the remote.</p>
7415 </dd>
7416 <dt class="hdlist1">push.default</dt>
7417 <dd>
7418 <p>Defines the action <code>git push</code> should take if no refspec is
7419 given (whether from the command-line, config, or elsewhere).
7420 Different values are well-suited for
7421 specific workflows; for instance, in a purely central workflow
7422 (i.e. the fetch source is equal to the push destination),
7423 <code>upstream</code> is probably what you want.  Possible values are:</p>
7424 <div class="openblock">
7425 <div class="content">
7426 <div class="ulist">
7427 <ul>
7428 <li>
7429 <p><code>nothing</code> - do not push anything (error out) unless a refspec is
7430 given. This is primarily meant for people who want to
7431 avoid mistakes by always being explicit.</p>
7432 </li>
7433 <li>
7434 <p><code>current</code> - push the current branch to update a branch with the same
7435 name on the receiving end.  Works in both central and non-central
7436 workflows.</p>
7437 </li>
7438 <li>
7439 <p><code>upstream</code> - push the current branch back to the branch whose
7440 changes are usually integrated into the current branch (which is
7441 called <code>@{upstream}</code>).  This mode only makes sense if you are
7442 pushing to the same repository you would normally pull from
7443 (i.e. central workflow).</p>
7444 </li>
7445 <li>
7446 <p><code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.</p>
7447 </li>
7448 <li>
7449 <p><code>simple</code> - push the current branch with the same name on the remote.</p>
7450 <div class="paragraph">
7451 <p>If you are working on a centralized workflow (pushing to the same repository you
7452 pull from, which is typically <code>origin</code>), then you need to configure an upstream
7453 branch with the same name.</p>
7454 </div>
7455 <div class="paragraph">
7456 <p>This mode is the default since Git 2.0, and is the safest option suited for
7457 beginners.</p>
7458 </div>
7459 </li>
7460 <li>
7461 <p><code>matching</code> - push all branches having the same name on both ends.
7462 This makes the repository you are pushing to remember the set of
7463 branches that will be pushed out (e.g. if you always push <em>maint</em>
7464 and <em>master</em> there and no other branches, the repository you push
7465 to will have these two branches, and your local <em>maint</em> and
7466 <em>master</em> will be pushed there).</p>
7467 <div class="paragraph">
7468 <p>To use this mode effectively, you have to make sure <em>all</em> the
7469 branches you would push out are ready to be pushed out before
7470 running <em>git push</em>, as the whole point of this mode is to allow you
7471 to push all of the branches in one go.  If you usually finish work
7472 on only one branch and push out the result, while other branches are
7473 unfinished, this mode is not for you.  Also this mode is not
7474 suitable for pushing into a shared central repository, as other
7475 people may add new branches there, or update the tip of existing
7476 branches outside your control.</p>
7477 </div>
7478 <div class="paragraph">
7479 <p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
7480 new default).</p>
7481 </div>
7482 </li>
7483 </ul>
7484 </div>
7485 </div>
7486 </div>
7487 </dd>
7488 <dt class="hdlist1">push.followTags</dt>
7489 <dd>
7490 <p>If set to true, enable <code>--follow-tags</code> option by default.  You
7491 may override this configuration at time of push by specifying
7492 <code>--no-follow-tags</code>.</p>
7493 </dd>
7494 <dt class="hdlist1">push.gpgSign</dt>
7495 <dd>
7496 <p>May be set to a boolean value, or the string <em>if-asked</em>. A true
7497 value causes all pushes to be GPG signed, as if <code>--signed</code> is
7498 passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
7499 pushes to be signed if the server supports it, as if
7500 <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
7501 override a value from a lower-priority config file. An explicit
7502 command-line flag always overrides this config option.</p>
7503 </dd>
7504 <dt class="hdlist1">push.pushOption</dt>
7505 <dd>
7506 <p>When no <code>--push-option=&lt;option&gt;</code> argument is given from the
7507 command line, <code>git push</code> behaves as if each &lt;value&gt; of
7508 this variable is given as <code>--push-option=&lt;value&gt;</code>.</p>
7509 <div class="paragraph">
7510 <p>This is a multi-valued variable, and an empty value can be used in a
7511 higher priority configuration file (e.g. <code>.git/config</code> in a
7512 repository) to clear the values inherited from a lower priority
7513 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p>
7514 </div>
7515 <div class="listingblock">
7516 <div class="content">
7517 <pre>Example:
7518
7519 /etc/gitconfig
7520   push.pushoption = a
7521   push.pushoption = b
7522
7523 ~/.gitconfig
7524   push.pushoption = c
7525
7526 repo/.git/config
7527   push.pushoption =
7528   push.pushoption = b
7529
7530 This will result in only b (a and c are cleared).</pre>
7531 </div>
7532 </div>
7533 </dd>
7534 <dt class="hdlist1">push.recurseSubmodules</dt>
7535 <dd>
7536 <p>May be "check", "on-demand", "only", or "no", with the same behavior
7537 as that of "push --recurse-submodules".
7538 If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
7539 set (in which case a <em>true</em> value means <em>on-demand</em>).</p>
7540 </dd>
7541 <dt class="hdlist1">push.useForceIfIncludes</dt>
7542 <dd>
7543 <p>If set to "true", it is equivalent to specifying
7544 <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
7545 in the command line. Adding <code>--no-force-if-includes</code> at the
7546 time of push overrides this configuration setting.</p>
7547 </dd>
7548 <dt class="hdlist1">push.negotiate</dt>
7549 <dd>
7550 <p>If set to "true", attempt to reduce the size of the packfile
7551 sent by rounds of negotiation in which the client and the
7552 server attempt to find commits in common. If "false", Git will
7553 rely solely on the server&#8217;s ref advertisement to find commits
7554 in common.</p>
7555 </dd>
7556 <dt class="hdlist1">push.useBitmaps</dt>
7557 <dd>
7558 <p>If set to "false", disable use of bitmaps for "git push" even if
7559 <code>pack.useBitmaps</code> is "true", without preventing other git operations
7560 from using bitmaps. Default is true.</p>
7561 </dd>
7562 <dt class="hdlist1">rebase.backend</dt>
7563 <dd>
7564 <p>Default backend to use for rebasing.  Possible choices are
7565 <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
7566 all remaining capabilities of the apply backend, this setting
7567 may become unused.</p>
7568 </dd>
7569 <dt class="hdlist1">rebase.stat</dt>
7570 <dd>
7571 <p>Whether to show a diffstat of what changed upstream since the last
7572 rebase. False by default.</p>
7573 </dd>
7574 <dt class="hdlist1">rebase.autoSquash</dt>
7575 <dd>
7576 <p>If set to true, enable the <code>--autosquash</code> option of
7577 <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
7578 This can be overridden with the <code>--no-autosquash</code> option.</p>
7579 </dd>
7580 <dt class="hdlist1">rebase.autoStash</dt>
7581 <dd>
7582 <p>When set to true, automatically create a temporary stash entry
7583 before the operation begins, and apply it after the operation
7584 ends.  This means that you can run rebase on a dirty worktree.
7585 However, use with care: the final stash application after a
7586 successful rebase might result in non-trivial conflicts.
7587 This option can be overridden by the <code>--no-autostash</code> and
7588 <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
7589 Defaults to false.</p>
7590 </dd>
7591 <dt class="hdlist1">rebase.updateRefs</dt>
7592 <dd>
7593 <p>If set to true enable <code>--update-refs</code> option by default.</p>
7594 </dd>
7595 <dt class="hdlist1">rebase.missingCommitsCheck</dt>
7596 <dd>
7597 <p>If set to "warn", git rebase -i will print a warning if some
7598 commits are removed (e.g. a line was deleted), however the
7599 rebase will still proceed. If set to "error", it will print
7600 the previous warning and stop the rebase, <em>git rebase
7601 --edit-todo</em> can then be used to correct the error. If set to
7602 "ignore", no checking is done.
7603 To drop a commit without warning or error, use the <code>drop</code>
7604 command in the todo list.
7605 Defaults to "ignore".</p>
7606 </dd>
7607 <dt class="hdlist1">rebase.instructionFormat</dt>
7608 <dd>
7609 <p>A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
7610 todo list during an interactive rebase.  The format will
7611 automatically have the commit hash prepended to the format.</p>
7612 </dd>
7613 <dt class="hdlist1">rebase.abbreviateCommands</dt>
7614 <dd>
7615 <p>If set to true, <code>git rebase</code> will use abbreviated command names in the
7616 todo list resulting in something like this:</p>
7617 <div class="listingblock">
7618 <div class="content">
7619 <pre>        p deadbee The oneline of the commit
7620         p fa1afe1 The oneline of the next commit
7621         ...</pre>
7622 </div>
7623 </div>
7624 <div class="paragraph">
7625 <p>instead of:</p>
7626 </div>
7627 <div class="listingblock">
7628 <div class="content">
7629 <pre>        pick deadbee The oneline of the commit
7630         pick fa1afe1 The oneline of the next commit
7631         ...</pre>
7632 </div>
7633 </div>
7634 <div class="paragraph">
7635 <p>Defaults to false.</p>
7636 </div>
7637 </dd>
7638 <dt class="hdlist1">rebase.rescheduleFailedExec</dt>
7639 <dd>
7640 <p>Automatically reschedule <code>exec</code> commands that failed. This only makes
7641 sense in interactive mode (or when an <code>--exec</code> option was provided).
7642 This is the same as specifying the <code>--reschedule-failed-exec</code> option.</p>
7643 </dd>
7644 <dt class="hdlist1">rebase.forkPoint</dt>
7645 <dd>
7646 <p>If set to false set <code>--no-fork-point</code> option by default.</p>
7647 </dd>
7648 <dt class="hdlist1">rebase.rebaseMerges</dt>
7649 <dd>
7650 <p>Whether and how to set the <code>--rebase-merges</code> option by default. Can
7651 be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
7652 true or to <code>no-rebase-cousins</code> is equivalent to
7653 <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
7654 equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
7655 equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
7656 command line, with or without an argument, overrides any
7657 <code>rebase.rebaseMerges</code> configuration.</p>
7658 </dd>
7659 <dt class="hdlist1">rebase.maxLabelLength</dt>
7660 <dd>
7661 <p>When generating label names from commit subjects, truncate the names to
7662 this length. By default, the names are truncated to a little less than
7663 <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
7664 corresponding loose refs).</p>
7665 </dd>
7666 <dt class="hdlist1">receive.advertiseAtomic</dt>
7667 <dd>
7668 <p>By default, git-receive-pack will advertise the atomic push
7669 capability to its clients. If you don&#8217;t want to advertise this
7670 capability, set this variable to false.</p>
7671 </dd>
7672 <dt class="hdlist1">receive.advertisePushOptions</dt>
7673 <dd>
7674 <p>When set to true, git-receive-pack will advertise the push options
7675 capability to its clients. False by default.</p>
7676 </dd>
7677 <dt class="hdlist1">receive.autogc</dt>
7678 <dd>
7679 <p>By default, git-receive-pack will run "git maintenance run --auto" after
7680 receiving data from git-push and updating refs.  You can stop
7681 it by setting this variable to false.</p>
7682 </dd>
7683 <dt class="hdlist1">receive.certNonceSeed</dt>
7684 <dd>
7685 <p>By setting this variable to a string, <code>git receive-pack</code>
7686 will accept a <code>git push --signed</code> and verify it by using
7687 a "nonce" protected by HMAC using this string as a secret
7688 key.</p>
7689 </dd>
7690 <dt class="hdlist1">receive.certNonceSlop</dt>
7691 <dd>
7692 <p>When a <code>git push --signed</code> sends a push certificate with a
7693 "nonce" that was issued by a receive-pack serving the same
7694 repository within this many seconds, export the "nonce"
7695 found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
7696 hooks (instead of what the receive-pack asked the sending
7697 side to include).  This may allow writing checks in
7698 <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
7699 checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
7700 that records by how many seconds the nonce is stale to
7701 decide if they want to accept the certificate, they only
7702 can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.</p>
7703 </dd>
7704 <dt class="hdlist1">receive.fsckObjects</dt>
7705 <dd>
7706 <p>If it is set to true, git-receive-pack will check all received
7707 objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
7708 Defaults to false. If not set, the value of
7709 <code>transfer.fsckObjects</code> is used instead.</p>
7710 </dd>
7711 <dt class="hdlist1">receive.fsck.&lt;msg-id&gt;</dt>
7712 <dd>
7713 <p>Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
7714 <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
7715 <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
7716 details.</p>
7717 </dd>
7718 <dt class="hdlist1">receive.fsck.skipList</dt>
7719 <dd>
7720 <p>Acts like <code>fsck.skipList</code>, but is used by
7721 <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
7722 <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
7723 details.</p>
7724 </dd>
7725 <dt class="hdlist1">receive.keepAlive</dt>
7726 <dd>
7727 <p>After receiving the pack from the client, <code>receive-pack</code> may
7728 produce no output (if <code>--quiet</code> was specified) while processing
7729 the pack, causing some networks to drop the TCP connection.
7730 With this option set, if <code>receive-pack</code> does not transmit
7731 any data in this phase for <code>receive.keepAlive</code> seconds, it will
7732 send a short keepalive packet.  The default is 5 seconds; set
7733 to 0 to disable keepalives entirely.</p>
7734 </dd>
7735 <dt class="hdlist1">receive.unpackLimit</dt>
7736 <dd>
7737 <p>If the number of objects received in a push is below this
7738 limit then the objects will be unpacked into loose object
7739 files. However if the number of received objects equals or
7740 exceeds this limit then the received pack will be stored as
7741 a pack, after adding any missing delta bases.  Storing the
7742 pack from a push can make the push operation complete faster,
7743 especially on slow filesystems.  If not set, the value of
7744 <code>transfer.unpackLimit</code> is used instead.</p>
7745 </dd>
7746 <dt class="hdlist1">receive.maxInputSize</dt>
7747 <dd>
7748 <p>If the size of the incoming pack stream is larger than this
7749 limit, then git-receive-pack will error out, instead of
7750 accepting the pack file. If not set or set to 0, then the size
7751 is unlimited.</p>
7752 </dd>
7753 <dt class="hdlist1">receive.denyDeletes</dt>
7754 <dd>
7755 <p>If set to true, git-receive-pack will deny a ref update that deletes
7756 the ref. Use this to prevent such a ref deletion via a push.</p>
7757 </dd>
7758 <dt class="hdlist1">receive.denyDeleteCurrent</dt>
7759 <dd>
7760 <p>If set to true, git-receive-pack will deny a ref update that
7761 deletes the currently checked out branch of a non-bare repository.</p>
7762 </dd>
7763 <dt class="hdlist1">receive.denyCurrentBranch</dt>
7764 <dd>
7765 <p>If set to true or "refuse", git-receive-pack will deny a ref update
7766 to the currently checked out branch of a non-bare repository.
7767 Such a push is potentially dangerous because it brings the HEAD
7768 out of sync with the index and working tree. If set to "warn",
7769 print a warning of such a push to stderr, but allow the push to
7770 proceed. If set to false or "ignore", allow such pushes with no
7771 message. Defaults to "refuse".</p>
7772 <div class="paragraph">
7773 <p>Another option is "updateInstead" which will update the working
7774 tree if pushing into the current branch.  This option is
7775 intended for synchronizing working directories when one side is not easily
7776 accessible via interactive ssh (e.g. a live web site, hence the requirement
7777 that the working directory be clean). This mode also comes in handy when
7778 developing inside a VM to test and fix code on different Operating Systems.</p>
7779 </div>
7780 <div class="paragraph">
7781 <p>By default, "updateInstead" will refuse the push if the working tree or
7782 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
7783 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p>
7784 </div>
7785 </dd>
7786 <dt class="hdlist1">receive.denyNonFastForwards</dt>
7787 <dd>
7788 <p>If set to true, git-receive-pack will deny a ref update which is
7789 not a fast-forward. Use this to prevent such an update via a push,
7790 even if that push is forced. This configuration variable is
7791 set when initializing a shared repository.</p>
7792 </dd>
7793 <dt class="hdlist1">receive.hideRefs</dt>
7794 <dd>
7795 <p>This variable is the same as <code>transfer.hideRefs</code>, but applies
7796 only to <code>receive-pack</code> (and so affects pushes, but not fetches).
7797 An attempt to update or delete a hidden ref by <code>git push</code> is
7798 rejected.</p>
7799 </dd>
7800 <dt class="hdlist1">receive.procReceiveRefs</dt>
7801 <dd>
7802 <p>This is a multi-valued variable that defines reference prefixes
7803 to match the commands in <code>receive-pack</code>.  Commands matching the
7804 prefixes will be executed by an external hook "proc-receive",
7805 instead of the internal <code>execute_commands</code> function.  If this
7806 variable is not defined, the "proc-receive" hook will never be
7807 used, and all commands will be executed by the internal
7808 <code>execute_commands</code> function.</p>
7809 <div class="paragraph">
7810 <p>For example, if this variable is set to "refs/for", pushing to reference
7811 such as "refs/for/master" will not create or update a reference named
7812 "refs/for/master", but may create or update a pull request directly by
7813 running the hook "proc-receive".</p>
7814 </div>
7815 <div class="paragraph">
7816 <p>Optional modifiers can be provided in the beginning of the value to filter
7817 commands for specific actions: create (a), modify (m), delete (d).
7818 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
7819 E.g.:</p>
7820 </div>
7821 <div class="literalblock">
7822 <div class="content">
7823 <pre>git config --system --add receive.procReceiveRefs ad:refs/heads
7824 git config --system --add receive.procReceiveRefs !:refs/heads</pre>
7825 </div>
7826 </div>
7827 </dd>
7828 <dt class="hdlist1">receive.updateServerInfo</dt>
7829 <dd>
7830 <p>If set to true, git-receive-pack will run git-update-server-info
7831 after receiving data from git-push and updating refs.</p>
7832 </dd>
7833 <dt class="hdlist1">receive.shallowUpdate</dt>
7834 <dd>
7835 <p>If set to true, .git/shallow can be updated when new refs
7836 require new shallow roots. Otherwise those refs are rejected.</p>
7837 </dd>
7838 <dt class="hdlist1">reftable.blockSize</dt>
7839 <dd>
7840 <p>The size in bytes used by the reftable backend when writing blocks.
7841 The block size is determined by the writer, and does not have to be a
7842 power of 2. The block size must be larger than the longest reference
7843 name or log entry used in the repository, as references cannot span
7844 blocks.</p>
7845 <div class="paragraph">
7846 <p>Powers of two that are friendly to the virtual memory system or
7847 filesystem (such as 4kB or 8kB) are recommended. Larger sizes (64kB) can
7848 yield better compression, with a possible increased cost incurred by
7849 readers during access.</p>
7850 </div>
7851 <div class="paragraph">
7852 <p>The largest block size is <code>16777215</code> bytes (15.99 MiB). The default value is
7853 <code>4096</code> bytes (4kB). A value of <code>0</code> will use the default value.</p>
7854 </div>
7855 </dd>
7856 <dt class="hdlist1">reftable.restartInterval</dt>
7857 <dd>
7858 <p>The interval at which to create restart points. The reftable backend
7859 determines the restart points at file creation. Every 16 may be
7860 more suitable for smaller block sizes (4k or 8k), every 64 for larger
7861 block sizes (64k).</p>
7862 <div class="paragraph">
7863 <p>More frequent restart points reduces prefix compression and increases
7864 space consumed by the restart table, both of which increase file size.</p>
7865 </div>
7866 <div class="paragraph">
7867 <p>Less frequent restart points makes prefix compression more effective,
7868 decreasing overall file size, with increased penalties for readers
7869 walking through more records after the binary search step.</p>
7870 </div>
7871 <div class="paragraph">
7872 <p>A maximum of <code>65535</code> restart points per block is supported.</p>
7873 </div>
7874 <div class="paragraph">
7875 <p>The default value is to create restart points every 16 records. A value of <code>0</code>
7876 will use the default value.</p>
7877 </div>
7878 </dd>
7879 <dt class="hdlist1">reftable.indexObjects</dt>
7880 <dd>
7881 <p>Whether the reftable backend shall write object blocks. Object blocks
7882 are a reverse mapping of object ID to the references pointing to them.</p>
7883 <div class="paragraph">
7884 <p>The default value is <code>true</code>.</p>
7885 </div>
7886 </dd>
7887 <dt class="hdlist1">reftable.geometricFactor</dt>
7888 <dd>
7889 <p>Whenever the reftable backend appends a new table to the stack, it
7890 performs auto compaction to ensure that there is only a handful of
7891 tables. The backend does this by ensuring that tables form a geometric
7892 sequence regarding the respective sizes of each table.</p>
7893 <div class="paragraph">
7894 <p>By default, the geometric sequence uses a factor of 2, meaning that for any
7895 table, the next-biggest table must at least be twice as big. A maximum factor
7896 of 256 is supported.</p>
7897 </div>
7898 </dd>
7899 <dt class="hdlist1">remote.pushDefault</dt>
7900 <dd>
7901 <p>The remote to push to by default.  Overrides
7902 <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
7903 <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.</p>
7904 </dd>
7905 <dt class="hdlist1">remote.&lt;name&gt;.url</dt>
7906 <dd>
7907 <p>The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
7908 <a href="git-push.html">git-push(1)</a>. A configured remote can have multiple URLs;
7909 in this case the first is used for fetching, and all are used
7910 for pushing (assuming no <code>remote.&lt;name&gt;.pushurl</code> is defined).
7911 Setting this key to the empty string clears the list of urls,
7912 allowing you to override earlier config.</p>
7913 </dd>
7914 <dt class="hdlist1">remote.&lt;name&gt;.pushurl</dt>
7915 <dd>
7916 <p>The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
7917 If a <code>pushurl</code> option is present in a configured remote, it
7918 is used for pushing instead of <code>remote.&lt;name&gt;.url</code>. A configured
7919 remote can have multiple push URLs; in this case a push goes to
7920 all of them. Setting this key to the empty string clears the
7921 list of urls, allowing you to override earlier config.</p>
7922 </dd>
7923 <dt class="hdlist1">remote.&lt;name&gt;.proxy</dt>
7924 <dd>
7925 <p>For remotes that require curl (http, https and ftp), the URL to
7926 the proxy to use for that remote.  Set to the empty string to
7927 disable proxying for that remote.</p>
7928 </dd>
7929 <dt class="hdlist1">remote.&lt;name&gt;.proxyAuthMethod</dt>
7930 <dd>
7931 <p>For remotes that require curl (http, https and ftp), the method to use for
7932 authenticating against the proxy in use (probably set in
7933 <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.</p>
7934 </dd>
7935 <dt class="hdlist1">remote.&lt;name&gt;.fetch</dt>
7936 <dd>
7937 <p>The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
7938 <a href="git-fetch.html">git-fetch(1)</a>.</p>
7939 </dd>
7940 <dt class="hdlist1">remote.&lt;name&gt;.push</dt>
7941 <dd>
7942 <p>The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
7943 <a href="git-push.html">git-push(1)</a>.</p>
7944 </dd>
7945 <dt class="hdlist1">remote.&lt;name&gt;.mirror</dt>
7946 <dd>
7947 <p>If true, pushing to this remote will automatically behave
7948 as if the <code>--mirror</code> option was given on the command line.</p>
7949 </dd>
7950 <dt class="hdlist1">remote.&lt;name&gt;.skipDefaultUpdate</dt>
7951 <dd>
7952 <p>If true, this remote will be skipped by default when updating
7953 using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
7954 <a href="git-remote.html">git-remote(1)</a>.</p>
7955 </dd>
7956 <dt class="hdlist1">remote.&lt;name&gt;.skipFetchAll</dt>
7957 <dd>
7958 <p>If true, this remote will be skipped by default when updating
7959 using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of
7960 <a href="git-remote.html">git-remote(1)</a>.</p>
7961 </dd>
7962 <dt class="hdlist1">remote.&lt;name&gt;.receivepack</dt>
7963 <dd>
7964 <p>The default program to execute on the remote side when pushing.  See
7965 option --receive-pack of <a href="git-push.html">git-push(1)</a>.</p>
7966 </dd>
7967 <dt class="hdlist1">remote.&lt;name&gt;.uploadpack</dt>
7968 <dd>
7969 <p>The default program to execute on the remote side when fetching.  See
7970 option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.</p>
7971 </dd>
7972 <dt class="hdlist1">remote.&lt;name&gt;.tagOpt</dt>
7973 <dd>
7974 <p>Setting this value to --no-tags disables automatic tag following when
7975 fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
7976 tag from remote &lt;name&gt;, even if they are not reachable from remote
7977 branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
7978 override this setting. See options --tags and --no-tags of
7979 <a href="git-fetch.html">git-fetch(1)</a>.</p>
7980 </dd>
7981 <dt class="hdlist1">remote.&lt;name&gt;.vcs</dt>
7982 <dd>
7983 <p>Setting this to a value &lt;vcs&gt; will cause Git to interact with
7984 the remote with the git-remote-&lt;vcs&gt; helper.</p>
7985 </dd>
7986 <dt class="hdlist1">remote.&lt;name&gt;.prune</dt>
7987 <dd>
7988 <p>When set to true, fetching from this remote by default will also
7989 remove any remote-tracking references that no longer exist on the
7990 remote (as if the <code>--prune</code> option was given on the command line).
7991 Overrides <code>fetch.prune</code> settings, if any.</p>
7992 </dd>
7993 <dt class="hdlist1">remote.&lt;name&gt;.pruneTags</dt>
7994 <dd>
7995 <p>When set to true, fetching from this remote by default will also
7996 remove any local tags that no longer exist on the remote if pruning
7997 is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
7998 <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.</p>
7999 <div class="paragraph">
8000 <p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
8001 <a href="git-fetch.html">git-fetch(1)</a>.</p>
8002 </div>
8003 </dd>
8004 <dt class="hdlist1">remote.&lt;name&gt;.promisor</dt>
8005 <dd>
8006 <p>When set to true, this remote will be used to fetch promisor
8007 objects.</p>
8008 </dd>
8009 <dt class="hdlist1">remote.&lt;name&gt;.partialclonefilter</dt>
8010 <dd>
8011 <p>The filter that will be applied when fetching from this      promisor remote.
8012 Changing or clearing this value will only affect fetches for new commits.
8013 To fetch associated objects for commits already present in the local object
8014 database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.</p>
8015 </dd>
8016 <dt class="hdlist1">remotes.&lt;group&gt;</dt>
8017 <dd>
8018 <p>The list of remotes which are fetched by "git remote update
8019 &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.</p>
8020 </dd>
8021 <dt class="hdlist1">repack.useDeltaBaseOffset</dt>
8022 <dd>
8023 <p>By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
8024 delta-base offset. If you need to share your repository with
8025 Git older than version 1.4.4, either directly or via a dumb
8026 protocol such as http, then you need to set this option to
8027 "false" and repack. Access from old Git versions over the
8028 native protocol are unaffected by this option.</p>
8029 </dd>
8030 <dt class="hdlist1">repack.packKeptObjects</dt>
8031 <dd>
8032 <p>If set to true, makes <code>git repack</code> act as if
8033 <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
8034 details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
8035 index is being written (either via <code>--write-bitmap-index</code> or
8036 <code>repack.writeBitmaps</code>).</p>
8037 </dd>
8038 <dt class="hdlist1">repack.useDeltaIslands</dt>
8039 <dd>
8040 <p>If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
8041 was passed. Defaults to <code>false</code>.</p>
8042 </dd>
8043 <dt class="hdlist1">repack.writeBitmaps</dt>
8044 <dd>
8045 <p>When true, git will write a bitmap index when packing all
8046 objects to disk (e.g., when <code>git repack -a</code> is run).  This
8047 index can speed up the "counting objects" phase of subsequent
8048 packs created for clones and fetches, at the cost of some disk
8049 space and extra time spent on the initial repack.  This has
8050 no effect if multiple packfiles are created.
8051 Defaults to true on bare repos, false otherwise.</p>
8052 </dd>
8053 <dt class="hdlist1">repack.updateServerInfo</dt>
8054 <dd>
8055 <p>If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
8056 <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
8057 when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.</p>
8058 </dd>
8059 <dt class="hdlist1">repack.cruftWindow</dt>
8060 <dt class="hdlist1">repack.cruftWindowMemory</dt>
8061 <dt class="hdlist1">repack.cruftDepth</dt>
8062 <dt class="hdlist1">repack.cruftThreads</dt>
8063 <dd>
8064 <p>Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
8065 a cruft pack and the respective parameters are not given over
8066 the command line. See similarly named <code>pack.*</code> configuration
8067 variables for defaults and meaning.</p>
8068 </dd>
8069 <dt class="hdlist1">rerere.autoUpdate</dt>
8070 <dd>
8071 <p>When set to true, <code>git-rerere</code> updates the index with the
8072 resulting contents after it cleanly resolves conflicts using
8073 previously recorded resolutions.  Defaults to false.</p>
8074 </dd>
8075 <dt class="hdlist1">rerere.enabled</dt>
8076 <dd>
8077 <p>Activate recording of resolved conflicts, so that identical
8078 conflict hunks can be resolved automatically, should they be
8079 encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
8080 enabled if there is an <code>rr-cache</code> directory under the
8081 <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
8082 repository.</p>
8083 </dd>
8084 <dt class="hdlist1">revert.reference</dt>
8085 <dd>
8086 <p>Setting this variable to true makes <code>git revert</code> behave
8087 as if the <code>--reference</code> option is given.</p>
8088 </dd>
8089 <dt class="hdlist1">safe.bareRepository</dt>
8090 <dd>
8091 <p>Specifies which bare repositories Git will work with. The currently
8092 supported values are:</p>
8093 <div class="ulist">
8094 <ul>
8095 <li>
8096 <p><code>all</code>: Git works with all bare repositories. This is the default.</p>
8097 </li>
8098 <li>
8099 <p><code>explicit</code>: Git only works with bare repositories specified via
8100 the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
8101 environment variable (see <a href="git.html">git(1)</a>).</p>
8102 <div class="paragraph">
8103 <p>If you do not use bare repositories in your workflow, then it may be
8104 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
8105 config. This will protect you from attacks that involve cloning a
8106 repository that contains a bare repository and running a Git command
8107 within that directory.</p>
8108 </div>
8109 <div class="paragraph">
8110 <p>This config setting is only respected in protected configuration (see
8111 <a href="#SCOPES">SCOPES</a>). This prevents untrusted repositories from tampering with
8112 this value.</p>
8113 </div>
8114 </li>
8115 </ul>
8116 </div>
8117 </dd>
8118 <dt class="hdlist1">safe.directory</dt>
8119 <dd>
8120 <p>These config entries specify Git-tracked directories that are
8121 considered safe even if they are owned by someone other than the
8122 current user. By default, Git will refuse to even parse a Git
8123 config of a repository owned by someone else, let alone run its
8124 hooks, and this config setting allows users to specify exceptions,
8125 e.g. for intentionally shared repositories (see the <code>--shared</code>
8126 option in <a href="git-init.html">git-init(1)</a>).</p>
8127 <div class="paragraph">
8128 <p>This is a multi-valued setting, i.e. you can add more than one directory
8129 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
8130 override any such directories specified in the system config), add a
8131 <code>safe.directory</code> entry with an empty value.</p>
8132 </div>
8133 <div class="paragraph">
8134 <p>This config setting is only respected in protected configuration (see
8135 <a href="#SCOPES">SCOPES</a>). This prevents untrusted repositories from tampering with this
8136 value.</p>
8137 </div>
8138 <div class="paragraph">
8139 <p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
8140 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
8141 path relative to Git&#8217;s (runtime) prefix.</p>
8142 </div>
8143 <div class="paragraph">
8144 <p>To completely opt-out of this security check, set <code>safe.directory</code> to the
8145 string <code>*</code>. This will allow all repositories to be treated as if their
8146 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
8147 is set in system config and you want to re-enable this protection, then
8148 initialize your list with an empty value before listing the repositories
8149 that you deem safe.  Giving a directory with <code>/*</code> appended to it will
8150 allow access to all repositories under the named directory.</p>
8151 </div>
8152 <div class="paragraph">
8153 <p>As explained, Git only allows you to access repositories owned by
8154 yourself, i.e. the user who is running Git, by default.  When Git
8155 is running as <em>root</em> in a non Windows platform that provides sudo,
8156 however, git checks the SUDO_UID environment variable that sudo creates
8157 and will allow access to the uid recorded as its value in addition to
8158 the id from <em>root</em>.
8159 This is to make it easy to perform a common sequence during installation
8160 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
8161 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
8162 which id the original user has.
8163 If that is not what you would prefer and want git to only trust
8164 repositories that are owned by root instead, then you can remove
8165 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p>
8166 </div>
8167 </dd>
8168 <dt class="hdlist1">sendemail.identity</dt>
8169 <dd>
8170 <p>A configuration identity. When given, causes values in the
8171 <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
8172 values in the <em>sendemail</em> section. The default identity is
8173 the value of <code>sendemail.identity</code>.</p>
8174 </dd>
8175 <dt class="hdlist1">sendemail.smtpEncryption</dt>
8176 <dd>
8177 <p>See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
8178 setting is not subject to the <em>identity</em> mechanism.</p>
8179 </dd>
8180 <dt class="hdlist1">sendemail.smtpSSLCertPath</dt>
8181 <dd>
8182 <p>Path to ca-certificates (either a directory or a single file).
8183 Set it to an empty string to disable certificate verification.</p>
8184 </dd>
8185 <dt class="hdlist1">sendemail.&lt;identity&gt;.*</dt>
8186 <dd>
8187 <p>Identity-specific versions of the <em>sendemail.*</em> parameters
8188 found below, taking precedence over those when this
8189 identity is selected, through either the command-line or
8190 <code>sendemail.identity</code>.</p>
8191 </dd>
8192 <dt class="hdlist1">sendemail.multiEdit</dt>
8193 <dd>
8194 <p>If true (default), a single editor instance will be spawned to edit
8195 files you have to edit (patches when <code>--annotate</code> is used, and the
8196 summary when <code>--compose</code> is used). If false, files will be edited one
8197 after the other, spawning a new editor each time.</p>
8198 </dd>
8199 <dt class="hdlist1">sendemail.confirm</dt>
8200 <dd>
8201 <p>Sets the default for whether to confirm before sending. Must be
8202 one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
8203 in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
8204 values.</p>
8205 </dd>
8206 <dt class="hdlist1">sendemail.aliasesFile</dt>
8207 <dd>
8208 <p>To avoid typing long email addresses, point this to one or more
8209 email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.</p>
8210 </dd>
8211 <dt class="hdlist1">sendemail.aliasFileType</dt>
8212 <dd>
8213 <p>Format of the file(s) specified in sendemail.aliasesFile. Must be
8214 one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.</p>
8215 <div class="paragraph">
8216 <p>What an alias file in each format looks like can be found in
8217 the documentation of the email program of the same name. The
8218 differences and limitations from the standard formats are
8219 described below:</p>
8220 </div>
8221 <div class="openblock">
8222 <div class="content">
8223 <div class="dlist">
8224 <dl>
8225 <dt class="hdlist1">sendmail</dt>
8226 <dd>
8227 <div class="ulist">
8228 <ul>
8229 <li>
8230 <p>Quoted aliases and quoted addresses are not supported: lines that
8231 contain a <code>"</code> symbol are ignored.</p>
8232 </li>
8233 <li>
8234 <p>Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
8235 supported.</p>
8236 </li>
8237 <li>
8238 <p>File inclusion (<code>:include: /path/name</code>) is not supported.</p>
8239 </li>
8240 <li>
8241 <p>Warnings are printed on the standard error output for any
8242 explicitly unsupported constructs, and any other lines that are not
8243 recognized by the parser.</p>
8244 </li>
8245 </ul>
8246 </div>
8247 </dd>
8248 </dl>
8249 </div>
8250 </div>
8251 </div>
8252 </dd>
8253 <dt class="hdlist1">sendemail.annotate</dt>
8254 <dt class="hdlist1">sendemail.bcc</dt>
8255 <dt class="hdlist1">sendemail.cc</dt>
8256 <dt class="hdlist1">sendemail.ccCmd</dt>
8257 <dt class="hdlist1">sendemail.chainReplyTo</dt>
8258 <dt class="hdlist1">sendemail.envelopeSender</dt>
8259 <dt class="hdlist1">sendemail.from</dt>
8260 <dt class="hdlist1">sendemail.headerCmd</dt>
8261 <dt class="hdlist1">sendemail.signedOffByCc</dt>
8262 <dt class="hdlist1">sendemail.smtpPass</dt>
8263 <dt class="hdlist1">sendemail.suppressCc</dt>
8264 <dt class="hdlist1">sendemail.suppressFrom</dt>
8265 <dt class="hdlist1">sendemail.to</dt>
8266 <dt class="hdlist1">sendemail.toCmd</dt>
8267 <dt class="hdlist1">sendemail.smtpDomain</dt>
8268 <dt class="hdlist1">sendemail.smtpServer</dt>
8269 <dt class="hdlist1">sendemail.smtpServerPort</dt>
8270 <dt class="hdlist1">sendemail.smtpServerOption</dt>
8271 <dt class="hdlist1">sendemail.smtpUser</dt>
8272 <dt class="hdlist1">sendemail.thread</dt>
8273 <dt class="hdlist1">sendemail.transferEncoding</dt>
8274 <dt class="hdlist1">sendemail.validate</dt>
8275 <dt class="hdlist1">sendemail.xmailer</dt>
8276 <dd>
8277 <p>These configuration variables all provide a default for
8278 <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
8279 documentation for details.</p>
8280 </dd>
8281 <dt class="hdlist1">sendemail.signedOffCc (deprecated)</dt>
8282 <dd>
8283 <p>Deprecated alias for <code>sendemail.signedOffByCc</code>.</p>
8284 </dd>
8285 <dt class="hdlist1">sendemail.smtpBatchSize</dt>
8286 <dd>
8287 <p>Number of messages to be sent per connection, after that a relogin
8288 will happen.  If the value is 0 or undefined, send all messages in
8289 one connection.
8290 See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.</p>
8291 </dd>
8292 <dt class="hdlist1">sendemail.smtpReloginDelay</dt>
8293 <dd>
8294 <p>Seconds to wait before reconnecting to the smtp server.
8295 See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.</p>
8296 </dd>
8297 <dt class="hdlist1">sendemail.forbidSendmailVariables</dt>
8298 <dd>
8299 <p>To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
8300 will abort with a warning if any configuration options for "sendmail"
8301 exist. Set this variable to bypass the check.</p>
8302 </dd>
8303 <dt class="hdlist1">sequence.editor</dt>
8304 <dd>
8305 <p>Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
8306 The value is meant to be interpreted by the shell when it is used.
8307 It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
8308 When not configured, the default commit message editor is used instead.</p>
8309 </dd>
8310 <dt class="hdlist1">showBranch.default</dt>
8311 <dd>
8312 <p>The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
8313 See <a href="git-show-branch.html">git-show-branch(1)</a>.</p>
8314 </dd>
8315 <dt class="hdlist1">sparse.expectFilesOutsideOfPatterns</dt>
8316 <dd>
8317 <p>Typically with sparse checkouts, files not matching any
8318 sparsity patterns are marked with a SKIP_WORKTREE bit in the
8319 index and are missing from the working tree.  Accordingly, Git
8320 will ordinarily check whether files with the SKIP_WORKTREE bit
8321 are in fact present in the working tree contrary to
8322 expectations.  If Git finds any, it marks those paths as
8323 present by clearing the relevant SKIP_WORKTREE bits.  This
8324 option can be used to tell Git that such
8325 present-despite-skipped files are expected and to stop
8326 checking for them.</p>
8327 <div class="paragraph">
8328 <p>The default is <code>false</code>, which allows Git to automatically recover
8329 from the list of files in the index and working tree falling out of
8330 sync.</p>
8331 </div>
8332 <div class="paragraph">
8333 <p>Set this to <code>true</code> if you are in a setup where some external factor
8334 relieves Git of the responsibility for maintaining the consistency
8335 between the presence of working tree files and sparsity patterns.  For
8336 example, if you have a Git-aware virtual file system that has a robust
8337 mechanism for keeping the working tree and the sparsity patterns up to
8338 date based on access patterns.</p>
8339 </div>
8340 <div class="paragraph">
8341 <p>Regardless of this setting, Git does not check for
8342 present-despite-skipped files unless sparse checkout is enabled, so
8343 this config option has no effect unless <code>core.sparseCheckout</code> is
8344 <code>true</code>.</p>
8345 </div>
8346 </dd>
8347 <dt class="hdlist1">splitIndex.maxPercentChange</dt>
8348 <dd>
8349 <p>When the split index feature is used, this specifies the
8350 percent of entries the split index can contain compared to the
8351 total number of entries in both the split index and the shared
8352 index before a new shared index is written.
8353 The value should be between 0 and 100. If the value is 0, then
8354 a new shared index is always written; if it is 100, a new
8355 shared index is never written.
8356 By default, the value is 20, so a new shared index is written
8357 if the number of entries in the split index would be greater
8358 than 20 percent of the total number of entries.
8359 See <a href="git-update-index.html">git-update-index(1)</a>.</p>
8360 </dd>
8361 <dt class="hdlist1">splitIndex.sharedIndexExpire</dt>
8362 <dd>
8363 <p>When the split index feature is used, shared index files that
8364 were not modified since the time this variable specifies will
8365 be removed when a new shared index file is created. The value
8366 "now" expires all entries immediately, and "never" suppresses
8367 expiration altogether.
8368 The default value is "2.weeks.ago".
8369 Note that a shared index file is considered modified (for the
8370 purpose of expiration) each time a new split-index file is
8371 either created based on it or read from it.
8372 See <a href="git-update-index.html">git-update-index(1)</a>.</p>
8373 </dd>
8374 <dt class="hdlist1">ssh.variant</dt>
8375 <dd>
8376 <p>By default, Git determines the command line arguments to use
8377 based on the basename of the configured SSH command (configured
8378 using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
8379 the config setting <code>core.sshCommand</code>). If the basename is
8380 unrecognized, Git will attempt to detect support of OpenSSH
8381 options by first invoking the configured SSH command with the
8382 <code>-G</code> (print configuration) option and will subsequently use
8383 OpenSSH options (if that is successful) or no options besides
8384 the host and remote command (if it fails).</p>
8385 <div class="paragraph">
8386 <p>The config variable <code>ssh.variant</code> can be set to override this detection.
8387 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
8388 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
8389 The default auto-detection can be explicitly requested using the value
8390 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
8391 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p>
8392 </div>
8393 <div class="paragraph">
8394 <p>The current command-line parameters used for each variant are as
8395 follows:</p>
8396 </div>
8397 <div class="openblock">
8398 <div class="content">
8399 <div class="ulist">
8400 <ul>
8401 <li>
8402 <p><code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command</p>
8403 </li>
8404 <li>
8405 <p><code>simple</code> - [username@]host command</p>
8406 </li>
8407 <li>
8408 <p><code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command</p>
8409 </li>
8410 <li>
8411 <p><code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command</p>
8412 </li>
8413 </ul>
8414 </div>
8415 </div>
8416 </div>
8417 <div class="paragraph">
8418 <p>Except for the <code>simple</code> variant, command-line parameters are likely to
8419 change as git gains new features.</p>
8420 </div>
8421 </dd>
8422 <dt class="hdlist1">stash.showIncludeUntracked</dt>
8423 <dd>
8424 <p>If this is set to true, the <code>git stash show</code> command will show
8425 the untracked files of a stash entry.  Defaults to false. See
8426 the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.</p>
8427 </dd>
8428 <dt class="hdlist1">stash.showPatch</dt>
8429 <dd>
8430 <p>If this is set to true, the <code>git stash show</code> command without an
8431 option will show the stash entry in patch form.  Defaults to false.
8432 See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.</p>
8433 </dd>
8434 <dt class="hdlist1">stash.showStat</dt>
8435 <dd>
8436 <p>If this is set to true, the <code>git stash show</code> command without an
8437 option will show a diffstat of the stash entry.  Defaults to true.
8438 See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.</p>
8439 </dd>
8440 <dt class="hdlist1">status.relativePaths</dt>
8441 <dd>
8442 <p>By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
8443 current directory. Setting this variable to <code>false</code> shows paths
8444 relative to the repository root (this was the default for Git
8445 prior to v1.5.4).</p>
8446 </dd>
8447 <dt class="hdlist1">status.short</dt>
8448 <dd>
8449 <p>Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
8450 The option --no-short takes precedence over this variable.</p>
8451 </dd>
8452 <dt class="hdlist1">status.branch</dt>
8453 <dd>
8454 <p>Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
8455 The option --no-branch takes precedence over this variable.</p>
8456 </dd>
8457 <dt class="hdlist1">status.aheadBehind</dt>
8458 <dd>
8459 <p>Set to true to enable <code>--ahead-behind</code> and false to enable
8460 <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
8461 non-porcelain status formats.  Defaults to true.</p>
8462 </dd>
8463 <dt class="hdlist1">status.displayCommentPrefix</dt>
8464 <dd>
8465 <p>If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
8466 prefix before each output line (starting with
8467 <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
8468 behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
8469 Defaults to false.</p>
8470 </dd>
8471 <dt class="hdlist1">status.renameLimit</dt>
8472 <dd>
8473 <p>The number of files to consider when performing rename detection
8474 in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
8475 the value of diff.renameLimit.</p>
8476 </dd>
8477 <dt class="hdlist1">status.renames</dt>
8478 <dd>
8479 <p>Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
8480 <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
8481 disabled. If set to "true", basic rename detection is enabled.
8482 If set to "copies" or "copy", Git will detect copies, as well.
8483 Defaults to the value of diff.renames.</p>
8484 </dd>
8485 <dt class="hdlist1">status.showStash</dt>
8486 <dd>
8487 <p>If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
8488 entries currently stashed away.
8489 Defaults to false.</p>
8490 </dd>
8491 <dt class="hdlist1">status.showUntrackedFiles</dt>
8492 <dd>
8493 <p>By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
8494 files which are not currently tracked by Git. Directories which
8495 contain only untracked files, are shown with the directory name
8496 only. Showing untracked files means that Git needs to lstat() all
8497 the files in the whole repository, which might be slow on some
8498 systems. So, this variable controls how the commands display
8499 the untracked files. Possible values are:</p>
8500 <div class="openblock">
8501 <div class="content">
8502 <div class="ulist">
8503 <ul>
8504 <li>
8505 <p><code>no</code> - Show no untracked files.</p>
8506 </li>
8507 <li>
8508 <p><code>normal</code> - Show untracked files and directories.</p>
8509 </li>
8510 <li>
8511 <p><code>all</code> - Show also individual files in untracked directories.</p>
8512 </li>
8513 </ul>
8514 </div>
8515 </div>
8516 </div>
8517 <div class="paragraph">
8518 <p>If this variable is not specified, it defaults to <em>normal</em>.
8519 All usual spellings for Boolean value <code>true</code> are taken as <code>normal</code>
8520 and <code>false</code> as <code>no</code>.
8521 This variable can be overridden with the -u|--untracked-files option
8522 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p>
8523 </div>
8524 </dd>
8525 <dt class="hdlist1">status.submoduleSummary</dt>
8526 <dd>
8527 <p>Defaults to false.
8528 If this is set to a non-zero number or true (identical to -1 or an
8529 unlimited number), the submodule summary will be enabled and a
8530 summary of commits for modified submodules will be shown (see
8531 --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
8532 that the summary output command will be suppressed for all
8533 submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
8534 for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
8535 exception to that rule is that status and commit will show staged
8536 submodule changes. To
8537 also view the summary for ignored submodules you can either use
8538 the --ignore-submodules=dirty command-line option or the <em>git
8539 submodule summary</em> command, which shows a similar output but does
8540 not honor these settings.</p>
8541 </dd>
8542 <dt class="hdlist1">submodule.&lt;name&gt;.url</dt>
8543 <dd>
8544 <p>The URL for a submodule. This variable is copied from the .gitmodules
8545 file to the git config via <em>git submodule init</em>. The user can change
8546 the configured URL before obtaining the submodule via <em>git submodule
8547 update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
8548 set, the presence of this variable is used as a fallback to indicate
8549 whether the submodule is of interest to git commands.
8550 See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.</p>
8551 </dd>
8552 <dt class="hdlist1">submodule.&lt;name&gt;.update</dt>
8553 <dd>
8554 <p>The method by which a submodule is updated by <em>git submodule update</em>,
8555 which is the only affected command, others such as
8556 <em>git checkout --recurse-submodules</em> are unaffected. It exists for
8557 historical reasons, when <em>git submodule</em> was the only command to
8558 interact with submodules; settings like <code>submodule.active</code>
8559 and <code>pull.rebase</code> are more specific. It is populated by
8560 <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
8561 See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.</p>
8562 </dd>
8563 <dt class="hdlist1">submodule.&lt;name&gt;.branch</dt>
8564 <dd>
8565 <p>The remote branch name for a submodule, used by <code>git submodule
8566 update --remote</code>.  Set this option to override the value found in
8567 the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
8568 <a href="gitmodules.html">gitmodules(5)</a> for details.</p>
8569 </dd>
8570 <dt class="hdlist1">submodule.&lt;name&gt;.fetchRecurseSubmodules</dt>
8571 <dd>
8572 <p>This option can be used to control recursive fetching of this
8573 submodule. It can be overridden by using the --[no-]recurse-submodules
8574 command-line option to "git fetch" and "git pull".
8575 This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
8576 file.</p>
8577 </dd>
8578 <dt class="hdlist1">submodule.&lt;name&gt;.ignore</dt>
8579 <dd>
8580 <p>Defines under what circumstances "git status" and the diff family show
8581 a submodule as modified. When set to "all", it will never be considered
8582 modified (but it will nonetheless show up in the output of status and
8583 commit when it has been staged), "dirty" will ignore all changes
8584 to the submodule&#8217;s work tree and
8585 takes only differences between the HEAD of the submodule and the commit
8586 recorded in the superproject into account. "untracked" will additionally
8587 let submodules with modified tracked files in their work tree show up.
8588 Using "none" (the default when this option is not set) also shows
8589 submodules that have untracked files in their work tree as changed.
8590 This setting overrides any setting made in .gitmodules for this submodule,
8591 both settings can be overridden on the command line by using the
8592 "--ignore-submodules" option. The <em>git submodule</em> commands are not
8593 affected by this setting.</p>
8594 </dd>
8595 <dt class="hdlist1">submodule.&lt;name&gt;.active</dt>
8596 <dd>
8597 <p>Boolean value indicating if the submodule is of interest to git
8598 commands.  This config option takes precedence over the
8599 submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
8600 details.</p>
8601 </dd>
8602 <dt class="hdlist1">submodule.active</dt>
8603 <dd>
8604 <p>A repeated field which contains a pathspec used to match against a
8605 submodule&#8217;s path to determine if the submodule is of interest to git
8606 commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.</p>
8607 </dd>
8608 <dt class="hdlist1">submodule.recurse</dt>
8609 <dd>
8610 <p>A boolean indicating if commands should enable the <code>--recurse-submodules</code>
8611 option by default. Defaults to false.</p>
8612 <div class="paragraph">
8613 <p>When set to true, it can be deactivated via the
8614 <code>--no-recurse-submodules</code> option. Note that some Git commands
8615 lacking this option may call some of the above commands affected by
8616 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
8617 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
8618 For these commands a workaround is to temporarily change the
8619 configuration value by using <code>git -c submodule.recurse=0</code>.</p>
8620 </div>
8621 <div class="paragraph">
8622 <p>The following list shows the commands that accept
8623 <code>--recurse-submodules</code> and whether they are supported by this
8624 setting.</p>
8625 </div>
8626 <div class="ulist">
8627 <ul>
8628 <li>
8629 <p><code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
8630 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.</p>
8631 </li>
8632 <li>
8633 <p><code>clone</code> and <code>ls-files</code> are not supported.</p>
8634 </li>
8635 <li>
8636 <p><code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
8637 enabled</p>
8638 </li>
8639 </ul>
8640 </div>
8641 </dd>
8642 <dt class="hdlist1">submodule.propagateBranches</dt>
8643 <dd>
8644 <p>[EXPERIMENTAL] A boolean that enables branching support when
8645 using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
8646 Enabling this will allow certain commands to accept
8647 <code>--recurse-submodules</code> and certain commands that already accept
8648 <code>--recurse-submodules</code> will now consider branches.
8649 Defaults to false.</p>
8650 </dd>
8651 <dt class="hdlist1">submodule.fetchJobs</dt>
8652 <dd>
8653 <p>Specifies how many submodules are fetched/cloned at the same time.
8654 A positive integer allows up to that number of submodules fetched
8655 in parallel. A value of 0 will give some reasonable default.
8656 If unset, it defaults to 1.</p>
8657 </dd>
8658 <dt class="hdlist1">submodule.alternateLocation</dt>
8659 <dd>
8660 <p>Specifies how the submodules obtain alternates when submodules are
8661 cloned. Possible values are <code>no</code>, <code>superproject</code>.
8662 By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
8663 value is set to <code>superproject</code> the submodule to be cloned computes
8664 its alternates location relative to the superprojects alternate.</p>
8665 </dd>
8666 <dt class="hdlist1">submodule.alternateErrorStrategy</dt>
8667 <dd>
8668 <p>Specifies how to treat errors with the alternates for a submodule
8669 as computed via <code>submodule.alternateLocation</code>. Possible values are
8670 <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
8671 or <code>info</code>, and if there is an error with the computed alternate, the
8672 clone proceeds as if no alternate was specified.</p>
8673 </dd>
8674 <dt class="hdlist1">tag.forceSignAnnotated</dt>
8675 <dd>
8676 <p>A boolean to specify whether annotated tags created should be GPG signed.
8677 If <code>--annotate</code> is specified on the command line, it takes
8678 precedence over this option.</p>
8679 </dd>
8680 <dt class="hdlist1">tag.sort</dt>
8681 <dd>
8682 <p>This variable controls the sort ordering of tags when displayed by
8683 <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
8684 value of this variable will be used as the default.</p>
8685 </dd>
8686 <dt class="hdlist1">tag.gpgSign</dt>
8687 <dd>
8688 <p>A boolean to specify whether all tags should be GPG signed.
8689 Use of this option when running in an automated script can
8690 result in a large number of tags being signed. It is therefore
8691 convenient to use an agent to avoid typing your gpg passphrase
8692 several times. Note that this option doesn&#8217;t affect tag signing
8693 behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.</p>
8694 </dd>
8695 <dt class="hdlist1">tar.umask</dt>
8696 <dd>
8697 <p>This variable can be used to restrict the permission bits of
8698 tar archive entries.  The default is 0002, which turns off the
8699 world write bit.  The special value "user" indicates that the
8700 archiving user&#8217;s umask will be used instead.  See umask(2) and
8701 <a href="git-archive.html">git-archive(1)</a>.</p>
8702 </dd>
8703 </dl>
8704 </div>
8705 <div class="paragraph">
8706 <p>Trace2 config settings are only read from the system and global
8707 config files; repository local and worktree config files and <code>-c</code>
8708 command line arguments are not respected.</p>
8709 </div>
8710 <div class="dlist">
8711 <dl>
8712 <dt class="hdlist1">trace2.normalTarget</dt>
8713 <dd>
8714 <p>This variable controls the normal target destination.
8715 It may be overridden by the <code>GIT_TRACE2</code> environment variable.
8716 The following table shows possible values.</p>
8717 </dd>
8718 <dt class="hdlist1">trace2.perfTarget</dt>
8719 <dd>
8720 <p>This variable controls the performance target destination.
8721 It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
8722 The following table shows possible values.</p>
8723 </dd>
8724 <dt class="hdlist1">trace2.eventTarget</dt>
8725 <dd>
8726 <p>This variable controls the event target destination.
8727 It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
8728 The following table shows possible values.</p>
8729 <div class="openblock">
8730 <div class="content">
8731 <div class="ulist">
8732 <ul>
8733 <li>
8734 <p><code>0</code> or <code>false</code> - Disables the target.</p>
8735 </li>
8736 <li>
8737 <p><code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.</p>
8738 </li>
8739 <li>
8740 <p><code>[2-9]</code> - Writes to the already opened file descriptor.</p>
8741 </li>
8742 <li>
8743 <p><code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
8744 already exists and is a directory, the traces will be written to files (one
8745 per process) underneath the given directory.</p>
8746 </li>
8747 <li>
8748 <p><code>af_unix:[&lt;socket-type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
8749 Unix DomainSocket (on platforms that support them).  Socket
8750 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
8751 try both.</p>
8752 </li>
8753 </ul>
8754 </div>
8755 </div>
8756 </div>
8757 </dd>
8758 <dt class="hdlist1">trace2.normalBrief</dt>
8759 <dd>
8760 <p>Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
8761 omitted from normal output.  May be overridden by the
8762 <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.</p>
8763 </dd>
8764 <dt class="hdlist1">trace2.perfBrief</dt>
8765 <dd>
8766 <p>Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
8767 omitted from PERF output.  May be overridden by the
8768 <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.</p>
8769 </dd>
8770 <dt class="hdlist1">trace2.eventBrief</dt>
8771 <dd>
8772 <p>Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
8773 omitted from event output.  May be overridden by the
8774 <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.</p>
8775 </dd>
8776 <dt class="hdlist1">trace2.eventNesting</dt>
8777 <dd>
8778 <p>Integer.  Specifies desired depth of nested regions in the
8779 event output.  Regions deeper than this value will be
8780 omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
8781 environment variable.  Defaults to 2.</p>
8782 </dd>
8783 <dt class="hdlist1">trace2.configParams</dt>
8784 <dd>
8785 <p>A comma-separated list of patterns of "important" config
8786 settings that should be recorded in the trace2 output.
8787 For example, <code>core.*,remote.*.url</code> would cause the trace2
8788 output to contain events listing each configured remote.
8789 May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
8790 variable.  Unset by default.</p>
8791 </dd>
8792 <dt class="hdlist1">trace2.envVars</dt>
8793 <dd>
8794 <p>A comma-separated list of "important" environment variables that should
8795 be recorded in the trace2 output.  For example,
8796 <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
8797 contain events listing the overrides for HTTP user agent and the
8798 location of the Git configuration file (assuming any are set).  May be
8799 overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
8800 default.</p>
8801 </dd>
8802 <dt class="hdlist1">trace2.destinationDebug</dt>
8803 <dd>
8804 <p>Boolean.  When true Git will print error messages when a
8805 trace target destination cannot be opened for writing.
8806 By default, these errors are suppressed and tracing is
8807 silently disabled.  May be overridden by the
8808 <code>GIT_TRACE2_DST_DEBUG</code> environment variable.</p>
8809 </dd>
8810 <dt class="hdlist1">trace2.maxFiles</dt>
8811 <dd>
8812 <p>Integer.  When writing trace files to a target directory, do not
8813 write additional traces if doing so would exceed this many files. Instead,
8814 write a sentinel file that will block further tracing to this
8815 directory. Defaults to 0, which disables this check.</p>
8816 </dd>
8817 <dt class="hdlist1">transfer.credentialsInUrl</dt>
8818 <dd>
8819 <p>A configured URL can contain plaintext credentials in the form
8820 <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
8821 to warn or forbid the use of such configuration (in favor of
8822 using <a href="git-credential.html">git-credential(1)</a>). This will be used on
8823 <a href="git-clone.html">git-clone(1)</a>, <a href="git-fetch.html">git-fetch(1)</a>, <a href="git-push.html">git-push(1)</a>,
8824 and any other direct use of the configured URL.</p>
8825 <div class="paragraph">
8826 <p>Note that this is currently limited to detecting credentials in
8827 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
8828 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p>
8829 </div>
8830 <div class="paragraph">
8831 <p>You might want to enable this to prevent inadvertent credentials
8832 exposure, e.g. because:</p>
8833 </div>
8834 <div class="ulist">
8835 <ul>
8836 <li>
8837 <p>The OS or system where you&#8217;re running git may not provide a way or
8838 otherwise allow you to configure the permissions of the
8839 configuration file where the username and/or password are stored.</p>
8840 </li>
8841 <li>
8842 <p>Even if it does, having such data stored "at rest" might expose you
8843 in other ways, e.g. a backup process might copy the data to another
8844 system.</p>
8845 </li>
8846 <li>
8847 <p>The git programs will pass the full URL to one another as arguments
8848 on the command-line, meaning the credentials will be exposed to other
8849 unprivileged users on systems that allow them to see the full
8850 process list of other users. On linux the "hidepid" setting
8851 documented in procfs(5) allows for configuring this behavior.</p>
8852 <div class="paragraph">
8853 <p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
8854 concerned about credentials exposure due to storing sensitive
8855 data in git&#8217;s configuration files. If you do want to use this, set
8856 <code>transfer.credentialsInUrl</code> to one of these values:</p>
8857 </div>
8858 </li>
8859 <li>
8860 <p><code>allow</code> (default): Git will proceed with its activity without warning.</p>
8861 </li>
8862 <li>
8863 <p><code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
8864 with a plaintext credential.</p>
8865 </li>
8866 <li>
8867 <p><code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
8868 with a plaintext credential.</p>
8869 </li>
8870 </ul>
8871 </div>
8872 </dd>
8873 <dt class="hdlist1">transfer.fsckObjects</dt>
8874 <dd>
8875 <p>When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
8876 not set, the value of this variable is used instead.
8877 Defaults to false.</p>
8878 <div class="paragraph">
8879 <p>When set, the fetch or receive will abort in the case of a malformed
8880 object or a link to a nonexistent object. In addition, various other
8881 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
8882 and potential security issues like the existence of a <code>.GIT</code> directory
8883 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
8884 and v2.17.1 for details). Other sanity and security checks may be
8885 added in future releases.</p>
8886 </div>
8887 <div class="paragraph">
8888 <p>On the receiving side, failing fsckObjects will make those objects
8889 unreachable, see "QUARANTINE ENVIRONMENT" in
8890 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
8891 instead be left unreferenced in the repository.</p>
8892 </div>
8893 <div class="paragraph">
8894 <p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
8895 implementation it cannot be relied upon to leave the object store
8896 clean like <code>receive.fsckObjects</code> can.</p>
8897 </div>
8898 <div class="paragraph">
8899 <p>As objects are unpacked they&#8217;re written to the object store, so there
8900 can be cases where malicious objects get introduced even though the
8901 "fetch" failed, only to have a subsequent "fetch" succeed because only
8902 new incoming objects are checked, not those that have already been
8903 written to the object store. That difference in behavior should not be
8904 relied upon. In the future, such objects may be quarantined for
8905 "fetch" as well.</p>
8906 </div>
8907 <div class="paragraph">
8908 <p>For now, the paranoid need to find some way to emulate the quarantine
8909 environment if they&#8217;d like the same protection as "push". E.g. in the
8910 case of an internal mirror do the mirroring in two steps, one to fetch
8911 the untrusted objects, and then do a second "push" (which will use the
8912 quarantine) to another internal repo, and have internal clients
8913 consume this pushed-to repository, or embargo internal fetches and
8914 only allow them once a full "fsck" has run (and no new fetches have
8915 happened in the meantime).</p>
8916 </div>
8917 </dd>
8918 <dt class="hdlist1">transfer.hideRefs</dt>
8919 <dd>
8920 <p>String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
8921 refs to omit from their initial advertisements.  Use more than
8922 one definition to specify multiple prefix strings. A ref that is
8923 under the hierarchies listed in the value of this variable is
8924 excluded, and is hidden when responding to <code>git push</code> or <code>git
8925 fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
8926 program-specific versions of this config.</p>
8927 <div class="paragraph">
8928 <p>You may also include a <code>!</code> in front of the ref name to negate the entry,
8929 explicitly exposing it, even if an earlier entry marked it as hidden.
8930 If you have multiple hideRefs values, later entries override earlier ones
8931 (and entries in more-specific config files override less-specific ones).</p>
8932 </div>
8933 <div class="paragraph">
8934 <p>If a namespace is in use, the namespace prefix is stripped from each
8935 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
8936 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
8937 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p>
8938 </div>
8939 <div class="paragraph">
8940 <p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
8941 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
8942 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
8943 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
8944 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
8945 <code>receive-pack</code>, on the other hand, will still advertise the object id the
8946 ref is pointing to without mentioning its name (a so-called ".have" line).</p>
8947 </div>
8948 <div class="paragraph">
8949 <p>Even if you hide refs, a client may still be able to steal the target
8950 objects via the techniques described in the "SECURITY" section of the
8951 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
8952 separate repository.</p>
8953 </div>
8954 </dd>
8955 <dt class="hdlist1">transfer.unpackLimit</dt>
8956 <dd>
8957 <p>When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
8958 not set, the value of this variable is used instead.
8959 The default value is 100.</p>
8960 </dd>
8961 <dt class="hdlist1">transfer.advertiseSID</dt>
8962 <dd>
8963 <p>Boolean. When true, client and server processes will advertise their
8964 unique session IDs to their remote counterpart. Defaults to false.</p>
8965 </dd>
8966 <dt class="hdlist1">transfer.bundleURI</dt>
8967 <dd>
8968 <p>When <code>true</code>, local <code>git clone</code> commands will request bundle
8969 information from the remote server (if advertised) and download
8970 bundles before continuing the clone through the Git protocol.
8971 Defaults to <code>false</code>.</p>
8972 </dd>
8973 <dt class="hdlist1">transfer.advertiseObjectInfo</dt>
8974 <dd>
8975 <p>When <code>true</code>, the <code>object-info</code> capability is advertised by
8976 servers. Defaults to false.</p>
8977 </dd>
8978 <dt class="hdlist1">uploadarchive.allowUnreachable</dt>
8979 <dd>
8980 <p>If true, allow clients to use <code>git archive --remote</code> to request
8981 any tree, whether reachable from the ref tips or not. See the
8982 discussion in the "SECURITY" section of
8983 <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
8984 <code>false</code>.</p>
8985 </dd>
8986 <dt class="hdlist1">uploadpack.hideRefs</dt>
8987 <dd>
8988 <p>This variable is the same as <code>transfer.hideRefs</code>, but applies
8989 only to <code>upload-pack</code> (and so affects only fetches, not pushes).
8990 An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
8991 also <code>uploadpack.allowTipSHA1InWant</code>.</p>
8992 </dd>
8993 <dt class="hdlist1">uploadpack.allowTipSHA1InWant</dt>
8994 <dd>
8995 <p>When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
8996 to accept a fetch request that asks for an object at the tip
8997 of a hidden ref (by default, such a request is rejected).
8998 See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
8999 may be able to steal objects via the techniques described in the
9000 "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
9001 best to keep private data in a separate repository.</p>
9002 </dd>
9003 <dt class="hdlist1">uploadpack.allowReachableSHA1InWant</dt>
9004 <dd>
9005 <p>Allow <code>upload-pack</code> to accept a fetch request that asks for an
9006 object that is reachable from any ref tip. However, note that
9007 calculating object reachability is computationally expensive.
9008 Defaults to <code>false</code>.  Even if this is false, a client may be able
9009 to steal objects via the techniques described in the "SECURITY"
9010 section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
9011 keep private data in a separate repository.</p>
9012 </dd>
9013 <dt class="hdlist1">uploadpack.allowAnySHA1InWant</dt>
9014 <dd>
9015 <p>Allow <code>upload-pack</code> to accept a fetch request that asks for any
9016 object at all.
9017 Defaults to <code>false</code>.</p>
9018 </dd>
9019 <dt class="hdlist1">uploadpack.keepAlive</dt>
9020 <dd>
9021 <p>When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
9022 quiet period while <code>pack-objects</code> prepares the pack. Normally
9023 it would output progress information, but if <code>--quiet</code> was used
9024 for the fetch, <code>pack-objects</code> will output nothing at all until
9025 the pack data begins. Some clients and networks may consider
9026 the server to be hung and give up. Setting this option instructs
9027 <code>upload-pack</code> to send an empty keepalive packet every
9028 <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
9029 disables keepalive packets entirely. The default is 5 seconds.</p>
9030 </dd>
9031 <dt class="hdlist1">uploadpack.packObjectsHook</dt>
9032 <dd>
9033 <p>If this option is set, when <code>upload-pack</code> would run
9034 <code>git pack-objects</code> to create a packfile for a client, it will
9035 run this shell command instead.  The <code>pack-objects</code> command and
9036 arguments it <em>would</em> have run (including the <code>git pack-objects</code>
9037 at the beginning) are appended to the shell command. The stdin
9038 and stdout of the hook are treated as if <code>pack-objects</code> itself
9039 was run. I.e., <code>upload-pack</code> will feed input intended for
9040 <code>pack-objects</code> to the hook, and expects a completed packfile on
9041 stdout.</p>
9042 <div class="paragraph">
9043 <p>Note that this configuration variable is only respected when it is specified
9044 in protected configuration (see <a href="#SCOPES">SCOPES</a>). This is a safety measure
9045 against fetching from untrusted repositories.</p>
9046 </div>
9047 </dd>
9048 <dt class="hdlist1">uploadpack.allowFilter</dt>
9049 <dd>
9050 <p>If this option is set, <code>upload-pack</code> will support partial
9051 clone and partial fetch object filtering.</p>
9052 </dd>
9053 <dt class="hdlist1">uploadpackfilter.allow</dt>
9054 <dd>
9055 <p>Provides a default value for unspecified object filters (see: the
9056 below configuration variable). If set to <code>true</code>, this will also
9057 enable all filters which get added in the future.
9058 Defaults to <code>true</code>.</p>
9059 </dd>
9060 <dt class="hdlist1">uploadpackfilter.&lt;filter&gt;.allow</dt>
9061 <dd>
9062 <p>Explicitly allow or ban the object filter corresponding to
9063 <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
9064 <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
9065 If using combined filters, both <code>combine</code> and all of the nested
9066 filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.</p>
9067 </dd>
9068 <dt class="hdlist1">uploadpackfilter.tree.maxDepth</dt>
9069 <dd>
9070 <p>Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
9071 <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
9072 <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
9073 variable had already been set. Has no effect if unset.</p>
9074 </dd>
9075 <dt class="hdlist1">uploadpack.allowRefInWant</dt>
9076 <dd>
9077 <p>If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
9078 feature of the protocol version 2 <code>fetch</code> command.  This feature
9079 is intended for the benefit of load-balanced servers which may
9080 not have the same view of what OIDs their refs point to due to
9081 replication delay.</p>
9082 </dd>
9083 <dt class="hdlist1">url.&lt;base&gt;.insteadOf</dt>
9084 <dd>
9085 <p>Any URL that starts with this value will be rewritten to
9086 start, instead, with &lt;base&gt;. In cases where some site serves a
9087 large number of repositories, and serves them with multiple
9088 access methods, and some users need to use different access
9089 methods, this feature allows people to specify any of the
9090 equivalent URLs and have Git automatically rewrite the URL to
9091 the best alternative for the particular user, even for a
9092 never-before-seen repository on the site.  When more than one
9093 insteadOf strings match a given URL, the longest match is used.</p>
9094 <div class="paragraph">
9095 <p>Note that any protocol restrictions will be applied to the rewritten
9096 URL. If the rewrite changes the URL to use a custom protocol or remote
9097 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
9098 the request.  In particular, protocols you expect to use for submodules
9099 must be set to <code>always</code> rather than the default of <code>user</code>. See the
9100 description of <code>protocol.allow</code> above.</p>
9101 </div>
9102 </dd>
9103 <dt class="hdlist1">url.&lt;base&gt;.pushInsteadOf</dt>
9104 <dd>
9105 <p>Any URL that starts with this value will not be pushed to;
9106 instead, it will be rewritten to start with &lt;base&gt;, and the
9107 resulting URL will be pushed to. In cases where some site serves
9108 a large number of repositories, and serves them with multiple
9109 access methods, some of which do not allow push, this feature
9110 allows people to specify a pull-only URL and have Git
9111 automatically use an appropriate URL to push, even for a
9112 never-before-seen repository on the site.  When more than one
9113 pushInsteadOf strings match a given URL, the longest match is
9114 used.  If a remote has an explicit pushurl, Git will ignore this
9115 setting for that remote.</p>
9116 </dd>
9117 <dt class="hdlist1">user.name</dt>
9118 <dt class="hdlist1">user.email</dt>
9119 <dt class="hdlist1">author.name</dt>
9120 <dt class="hdlist1">author.email</dt>
9121 <dt class="hdlist1">committer.name</dt>
9122 <dt class="hdlist1">committer.email</dt>
9123 <dd>
9124 <p>The <code>user.name</code> and <code>user.email</code> variables determine what ends
9125 up in the <code>author</code> and <code>committer</code> fields of commit
9126 objects.
9127 If you need the <code>author</code> or <code>committer</code> to be different, the
9128 <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
9129 <code>committer.email</code> variables can be set.
9130 All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
9131 <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
9132 <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.</p>
9133 <div class="paragraph">
9134 <p>Note that the <code>name</code> forms of these variables conventionally refer to
9135 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
9136 environment variables section of <a href="git.html">git(1)</a> for more information on
9137 these settings and the <code>credential.username</code> option if you&#8217;re looking
9138 for authentication credentials instead.</p>
9139 </div>
9140 </dd>
9141 <dt class="hdlist1">user.useConfigOnly</dt>
9142 <dd>
9143 <p>Instruct Git to avoid trying to guess defaults for <code>user.email</code>
9144 and <code>user.name</code>, and instead retrieve the values only from the
9145 configuration. For example, if you have multiple email addresses
9146 and would like to use a different one for each repository, then
9147 with this configuration option set to <code>true</code> in the global config
9148 along with a name, Git will prompt you to set up an email before
9149 making new commits in a newly cloned repository.
9150 Defaults to <code>false</code>.</p>
9151 </dd>
9152 <dt class="hdlist1">user.signingKey</dt>
9153 <dd>
9154 <p>If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the
9155 key you want it to automatically when creating a signed tag or
9156 commit, you can override the default selection with this variable.
9157 This option is passed unchanged to gpg&#8217;s --local-user parameter,
9158 so you may specify a key using any method that gpg supports.
9159 If gpg.format is set to <code>ssh</code> this can contain the path to either
9160 your private ssh key or the public key when ssh-agent is used.
9161 Alternatively it can contain a public key prefixed with <code>key::</code>
9162 directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
9163 needs to be available via ssh-agent. If not set Git will call
9164 gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
9165 first key available. For backward compatibility, a raw key which
9166 begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
9167 as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
9168 use the <code>key::</code> form instead.</p>
9169 </dd>
9170 <dt class="hdlist1">versionsort.prereleaseSuffix (deprecated)</dt>
9171 <dd>
9172 <p>Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
9173 <code>versionsort.suffix</code> is set.</p>
9174 </dd>
9175 <dt class="hdlist1">versionsort.suffix</dt>
9176 <dd>
9177 <p>Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
9178 with the same base version but different suffixes are still sorted
9179 lexicographically, resulting e.g. in prerelease tags appearing
9180 after the main release (e.g. "1.0-rc1" after "1.0").  This
9181 variable can be specified to determine the sorting order of tags
9182 with different suffixes.</p>
9183 <div class="paragraph">
9184 <p>By specifying a single suffix in this variable, any tagname containing
9185 that suffix will appear before the corresponding main release.  E.g. if
9186 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
9187 "1.0".  If specified multiple times, once per suffix, then the order of
9188 suffixes in the configuration will determine the sorting order of tagnames
9189 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
9190 configuration, then all "1.0-preX" tags will be listed before any
9191 "1.0-rcX" tags.  The placement of the main release tag relative to tags
9192 with various suffixes can be determined by specifying the empty suffix
9193 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
9194 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
9195 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
9196 "v4.8-bfsX".</p>
9197 </div>
9198 <div class="paragraph">
9199 <p>If more than one suffix matches the same tagname, then that tagname will
9200 be sorted according to the suffix which starts at the earliest position in
9201 the tagname.  If more than one different matching suffix starts at
9202 that earliest position, then that tagname will be sorted according to the
9203 longest of those suffixes.
9204 The sorting order between different suffixes is undefined if they are
9205 in multiple config files.</p>
9206 </div>
9207 </dd>
9208 <dt class="hdlist1">web.browser</dt>
9209 <dd>
9210 <p>Specify a web browser that may be used by some commands.
9211 Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
9212 may use it.</p>
9213 </dd>
9214 <dt class="hdlist1">worktree.guessRemote</dt>
9215 <dd>
9216 <p>If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
9217 <code>--detach</code> is used, then <code>git worktree add</code> defaults to
9218 creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
9219 set to true, <code>worktree add</code> tries to find a remote-tracking
9220 branch whose name uniquely matches the new branch name.  If
9221 such a branch exists, it is checked out and set as "upstream"
9222 for the new branch.  If no such match can be found, it falls
9223 back to creating a new branch from the current HEAD.</p>
9224 </dd>
9225 </dl>
9226 </div>
9227 </div>
9228 </div>
9229 </div>
9230 <div class="sect1">
9231 <h2 id="_bugs">BUGS</h2>
9232 <div class="sectionbody">
9233 <div class="paragraph">
9234 <p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
9235 will result in adding a multi-line key instead of a change, if the subsection
9236 is given with at least one uppercase character. For example when the config
9237 looks like</p>
9238 </div>
9239 <div class="listingblock">
9240 <div class="content">
9241 <pre>  [section.subsection]
9242     key = value1</pre>
9243 </div>
9244 </div>
9245 <div class="paragraph">
9246 <p>and running <code>git config section.Subsection.key value2</code> will result in</p>
9247 </div>
9248 <div class="listingblock">
9249 <div class="content">
9250 <pre>  [section.subsection]
9251     key = value1
9252     key = value2</pre>
9253 </div>
9254 </div>
9255 </div>
9256 </div>
9257 <div class="sect1">
9258 <h2 id="_git">GIT</h2>
9259 <div class="sectionbody">
9260 <div class="paragraph">
9261 <p>Part of the <a href="git.html">git(1)</a> suite</p>
9262 </div>
9263 </div>
9264 </div>
9265 </div>
9266 <div id="footer">
9267 <div id="footer-text">
9268 Last updated 2024-09-03 13:52:44 -0700
9269 </div>
9270 </div>
9271 </body>
9272 </html>