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 have understood the issue and no longer need a specific
1717 help message by setting the corresponding variable to <code>false</code>.</p>
1718 <div class="paragraph">
1719 <p>As they are intended to help human users, these messages are output to
1720 the standard error. When tools that run Git as a subprocess find them
1721 disruptive, they can set <code>GIT_ADVICE=0</code> in the environment to squelch
1722 all advice messages.</p>
1723 </div>
1724 <div class="openblock">
1725 <div class="content">
1726 <div class="dlist">
1727 <dl>
1728 <dt class="hdlist1">addEmbeddedRepo</dt>
1729 <dd>
1730 <p>Shown when the user accidentally adds one
1731 git repo inside of another.</p>
1732 </dd>
1733 <dt class="hdlist1">addEmptyPathspec</dt>
1734 <dd>
1735 <p>Shown when the user runs <code>git add</code> without providing
1736 the pathspec parameter.</p>
1737 </dd>
1738 <dt class="hdlist1">addIgnoredFile</dt>
1739 <dd>
1740 <p>Shown when the user attempts to add an ignored file to
1741 the index.</p>
1742 </dd>
1743 <dt class="hdlist1">amWorkDir</dt>
1744 <dd>
1745 <p>Shown when <a href="git-am.html">git-am(1)</a> fails to apply a patch
1746 file, to tell the user the location of the file.</p>
1747 </dd>
1748 <dt class="hdlist1">ambiguousFetchRefspec</dt>
1749 <dd>
1750 <p>Shown when a fetch refspec for multiple remotes maps to
1751 the same remote-tracking branch namespace and causes branch
1752 tracking set-up to fail.</p>
1753 </dd>
1754 <dt class="hdlist1">checkoutAmbiguousRemoteBranchName</dt>
1755 <dd>
1756 <p>Shown when the argument to
1757 <a href="git-checkout.html">git-checkout(1)</a> and <a href="git-switch.html">git-switch(1)</a>
1758 ambiguously resolves to a
1759 remote tracking branch on more than one remote in
1760 situations where an unambiguous argument would have
1761 otherwise caused a remote-tracking branch to be
1762 checked out. See the <code>checkout.defaultRemote</code>
1763 configuration variable for how to set a given remote
1764 to be used by default in some situations where this
1765 advice would be printed.</p>
1766 </dd>
1767 <dt class="hdlist1">commitBeforeMerge</dt>
1768 <dd>
1769 <p>Shown when <a href="git-merge.html">git-merge(1)</a> refuses to
1770 merge to avoid overwriting local changes.</p>
1771 </dd>
1772 <dt class="hdlist1">detachedHead</dt>
1773 <dd>
1774 <p>Shown when the user uses
1775 <a href="git-switch.html">git-switch(1)</a> or <a href="git-checkout.html">git-checkout(1)</a>
1776 to move to the detached HEAD state, to tell the user how
1777 to create a local branch after the fact.</p>
1778 </dd>
1779 <dt class="hdlist1">diverging</dt>
1780 <dd>
1781 <p>Shown when a fast-forward is not possible.</p>
1782 </dd>
1783 <dt class="hdlist1">fetchShowForcedUpdates</dt>
1784 <dd>
1785 <p>Shown when <a href="git-fetch.html">git-fetch(1)</a> takes a long time
1786 to calculate forced updates after ref updates, or to warn
1787 that the check is disabled.</p>
1788 </dd>
1789 <dt class="hdlist1">forceDeleteBranch</dt>
1790 <dd>
1791 <p>Shown when the user tries to delete a not fully merged
1792 branch without the force option set.</p>
1793 </dd>
1794 <dt class="hdlist1">ignoredHook</dt>
1795 <dd>
1796 <p>Shown when a hook is ignored because the hook is not
1797 set as executable.</p>
1798 </dd>
1799 <dt class="hdlist1">implicitIdentity</dt>
1800 <dd>
1801 <p>Shown when the user&#8217;s information is guessed from the
1802 system username and domain name, to tell the user how to
1803 set their identity configuration.</p>
1804 </dd>
1805 <dt class="hdlist1">mergeConflict</dt>
1806 <dd>
1807 <p>Shown when various commands stop because of conflicts.</p>
1808 </dd>
1809 <dt class="hdlist1">nestedTag</dt>
1810 <dd>
1811 <p>Shown when a user attempts to recursively tag a tag object.</p>
1812 </dd>
1813 <dt class="hdlist1">pushAlreadyExists</dt>
1814 <dd>
1815 <p>Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
1816 does not qualify for fast-forwarding (e.g., a tag.)</p>
1817 </dd>
1818 <dt class="hdlist1">pushFetchFirst</dt>
1819 <dd>
1820 <p>Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
1821 tries to overwrite a remote ref that points at an
1822 object we do not have.</p>
1823 </dd>
1824 <dt class="hdlist1">pushNeedsForce</dt>
1825 <dd>
1826 <p>Shown when <a href="git-push.html">git-push(1)</a> rejects an update that
1827 tries to overwrite a remote ref that points at an
1828 object that is not a commit-ish, or make the remote
1829 ref point at an object that is not a commit-ish.</p>
1830 </dd>
1831 <dt class="hdlist1">pushNonFFCurrent</dt>
1832 <dd>
1833 <p>Shown when <a href="git-push.html">git-push(1)</a> fails due to a
1834 non-fast-forward update to the current branch.</p>
1835 </dd>
1836 <dt class="hdlist1">pushNonFFMatching</dt>
1837 <dd>
1838 <p>Shown when the user ran <a href="git-push.html">git-push(1)</a> and pushed
1839 "matching refs" explicitly (i.e. used <code>:</code>, or
1840 specified a refspec that isn&#8217;t the current branch) and
1841 it resulted in a non-fast-forward error.</p>
1842 </dd>
1843 <dt class="hdlist1">pushRefNeedsUpdate</dt>
1844 <dd>
1845 <p>Shown when <a href="git-push.html">git-push(1)</a> rejects a forced update of
1846 a branch when its remote-tracking ref has updates that we
1847 do not have locally.</p>
1848 </dd>
1849 <dt class="hdlist1">pushUnqualifiedRefname</dt>
1850 <dd>
1851 <p>Shown when <a href="git-push.html">git-push(1)</a> gives up trying to
1852 guess based on the source and destination refs what
1853 remote ref namespace the source belongs in, but where
1854 we can still suggest that the user push to either
1855 <code>refs/heads/*</code> or <code>refs/tags/*</code> based on the type of the
1856 source object.</p>
1857 </dd>
1858 <dt class="hdlist1">pushUpdateRejected</dt>
1859 <dd>
1860 <p>Set this variable to <code>false</code> if you want to disable
1861 <code>pushNonFFCurrent</code>, <code>pushNonFFMatching</code>, <code>pushAlreadyExists</code>,
1862 <code>pushFetchFirst</code>, <code>pushNeedsForce</code>, and <code>pushRefNeedsUpdate</code>
1863 simultaneously.</p>
1864 </dd>
1865 <dt class="hdlist1">rebaseTodoError</dt>
1866 <dd>
1867 <p>Shown when there is an error after editing the rebase todo list.</p>
1868 </dd>
1869 <dt class="hdlist1">refSyntax</dt>
1870 <dd>
1871 <p>Shown when the user provides an illegal ref name, to
1872 tell the user about the ref syntax documentation.</p>
1873 </dd>
1874 <dt class="hdlist1">resetNoRefresh</dt>
1875 <dd>
1876 <p>Shown when <a href="git-reset.html">git-reset(1)</a> takes more than 2
1877 seconds to refresh the index after reset, to tell the user
1878 that they can use the <code>--no-refresh</code> option.</p>
1879 </dd>
1880 <dt class="hdlist1">resolveConflict</dt>
1881 <dd>
1882 <p>Shown by various commands when conflicts
1883 prevent the operation from being performed.</p>
1884 </dd>
1885 <dt class="hdlist1">rmHints</dt>
1886 <dd>
1887 <p>Shown on failure in the output of <a href="git-rm.html">git-rm(1)</a>, to
1888 give directions on how to proceed from the current state.</p>
1889 </dd>
1890 <dt class="hdlist1">sequencerInUse</dt>
1891 <dd>
1892 <p>Shown when a sequencer command is already in progress.</p>
1893 </dd>
1894 <dt class="hdlist1">skippedCherryPicks</dt>
1895 <dd>
1896 <p>Shown when <a href="git-rebase.html">git-rebase(1)</a> skips a commit that has already
1897 been cherry-picked onto the upstream branch.</p>
1898 </dd>
1899 <dt class="hdlist1">sparseIndexExpanded</dt>
1900 <dd>
1901 <p>Shown when a sparse index is expanded to a full index, which is likely
1902 due to an unexpected set of files existing outside of the
1903 sparse-checkout.</p>
1904 </dd>
1905 <dt class="hdlist1">statusAheadBehind</dt>
1906 <dd>
1907 <p>Shown when <a href="git-status.html">git-status(1)</a> computes the ahead/behind
1908 counts for a local ref compared to its remote tracking ref,
1909 and that calculation takes longer than expected. Will not
1910 appear if <code>status.aheadBehind</code> is false or the option
1911 <code>--no-ahead-behind</code> is given.</p>
1912 </dd>
1913 <dt class="hdlist1">statusHints</dt>
1914 <dd>
1915 <p>Show directions on how to proceed from the current
1916 state in the output of <a href="git-status.html">git-status(1)</a>, in
1917 the template shown when writing commit messages in
1918 <a href="git-commit.html">git-commit(1)</a>, and in the help message shown
1919 by <a href="git-switch.html">git-switch(1)</a> or
1920 <a href="git-checkout.html">git-checkout(1)</a> when switching branches.</p>
1921 </dd>
1922 <dt class="hdlist1">statusUoption</dt>
1923 <dd>
1924 <p>Shown when <a href="git-status.html">git-status(1)</a> takes more than 2
1925 seconds to enumerate untracked files, to tell the user that
1926 they can use the <code>-u</code> option.</p>
1927 </dd>
1928 <dt class="hdlist1">submoduleAlternateErrorStrategyDie</dt>
1929 <dd>
1930 <p>Shown when a submodule.alternateErrorStrategy option
1931 configured to "die" causes a fatal error.</p>
1932 </dd>
1933 <dt class="hdlist1">submoduleMergeConflict</dt>
1934 <dd>
1935 <p>Advice shown when a non-trivial submodule merge conflict is
1936 encountered.</p>
1937 </dd>
1938 <dt class="hdlist1">submodulesNotUpdated</dt>
1939 <dd>
1940 <p>Shown when a user runs a submodule command that fails
1941 because <code>git submodule update --init</code> was not run.</p>
1942 </dd>
1943 <dt class="hdlist1">suggestDetachingHead</dt>
1944 <dd>
1945 <p>Shown when <a href="git-switch.html">git-switch(1)</a> refuses to detach HEAD
1946 without the explicit <code>--detach</code> option.</p>
1947 </dd>
1948 <dt class="hdlist1">updateSparsePath</dt>
1949 <dd>
1950 <p>Shown when either <a href="git-add.html">git-add(1)</a> or <a href="git-rm.html">git-rm(1)</a>
1951 is asked to update index entries outside the current sparse
1952 checkout.</p>
1953 </dd>
1954 <dt class="hdlist1">waitingForEditor</dt>
1955 <dd>
1956 <p>Shown when Git is waiting for editor input. Relevant
1957 when e.g. the editor is not launched inside the terminal.</p>
1958 </dd>
1959 <dt class="hdlist1">worktreeAddOrphan</dt>
1960 <dd>
1961 <p>Shown when the user tries to create a worktree from an
1962 invalid reference, to tell the user how to create a new unborn
1963 branch instead.</p>
1964 </dd>
1965 </dl>
1966 </div>
1967 </div>
1968 </div>
1969 </dd>
1970 <dt class="hdlist1">alias.*</dt>
1971 <dd>
1972 <p>Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g.
1973 after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
1974 <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
1975 confusion and troubles with script usage, aliases that
1976 hide existing Git commands are ignored. Arguments are split by
1977 spaces, the usual shell quoting and escaping are supported.
1978 A quote pair or a backslash can be used to quote them.</p>
1979 <div class="paragraph">
1980 <p>Note that the first word of an alias does not necessarily have to be a
1981 command. It can be a command-line option that will be passed into the
1982 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
1983 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
1984 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
1985 running <code>git loud-rebase</code> would be equivalent to
1986 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
1987 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
1988 where the original command does not.</p>
1989 </div>
1990 <div class="paragraph">
1991 <p>If the alias expansion is prefixed with an exclamation point,
1992 it will be treated as a shell command.  For example, defining
1993 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
1994 <code>git new</code> is equivalent to running the shell command
1995 <code>gitk --all --not ORIG_HEAD</code>.  Note:</p>
1996 </div>
1997 <div class="ulist">
1998 <ul>
1999 <li>
2000 <p>Shell commands will be executed from the top-level directory of a
2001 repository, which may not necessarily be the current directory.</p>
2002 </li>
2003 <li>
2004 <p><code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
2005 from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p>
2006 </li>
2007 <li>
2008 <p>Shell command aliases always receive any extra arguments provided to
2009 the Git command-line as positional arguments.</p>
2010 <div class="ulist">
2011 <ul>
2012 <li>
2013 <p>Care should be taken if your shell alias is a "one-liner" script
2014 with multiple commands (e.g. in a pipeline), references multiple
2015 arguments, or is otherwise not able to handle positional arguments
2016 added at the end.  For example: <code>alias.cmd = "!echo $1 | grep $2"</code>
2017 called as <code>git cmd 1 2</code> will be executed as <em>echo $1 | grep $2
2018 1 2</em>, which is not what you want.</p>
2019 </li>
2020 <li>
2021 <p>A convenient way to deal with this is to write your script
2022 operations in an inline function that is then called with any
2023 arguments from the command-line.  For example `alias.cmd = "!c() {
2024 echo $1 | grep $2 ; }; c" will correctly execute the prior example.</p>
2025 </li>
2026 <li>
2027 <p>Setting <code>GIT_TRACE=1</code> can help you debug the command being run for
2028 your alias.</p>
2029 </li>
2030 </ul>
2031 </div>
2032 </li>
2033 </ul>
2034 </div>
2035 </dd>
2036 <dt class="hdlist1">am.keepcr</dt>
2037 <dd>
2038 <p>If true, git-am will call git-mailsplit for patches in mbox format
2039 with parameter <code>--keep-cr</code>. In this case git-mailsplit will
2040 not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
2041 by giving <code>--no-keep-cr</code> from the command line.
2042 See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.</p>
2043 </dd>
2044 <dt class="hdlist1">am.threeWay</dt>
2045 <dd>
2046 <p>By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2047 set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2048 the patch records the identity of blobs it is supposed to apply to and
2049 we have those blobs available locally (equivalent to giving the <code>--3way</code>
2050 option from the command line). Defaults to <code>false</code>.
2051 See <a href="git-am.html">git-am(1)</a>.</p>
2052 </dd>
2053 <dt class="hdlist1">apply.ignoreWhitespace</dt>
2054 <dd>
2055 <p>When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
2056 whitespace, in the same way as the <code>--ignore-space-change</code>
2057 option.
2058 When set to one of: no, none, never, false, it tells <em>git apply</em> to
2059 respect all whitespace differences.
2060 See <a href="git-apply.html">git-apply(1)</a>.</p>
2061 </dd>
2062 <dt class="hdlist1">apply.whitespace</dt>
2063 <dd>
2064 <p>Tells <em>git apply</em> how to handle whitespace, in the same way
2065 as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.</p>
2066 </dd>
2067 <dt class="hdlist1">attr.tree</dt>
2068 <dd>
2069 <p>A reference to a tree in the repository from which to read attributes,
2070 instead of the <code>.gitattributes</code> file in the working tree. If the value
2071 does not resolve to a valid tree object, an empty tree is used instead.
2072 When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2073 command line option are used, this configuration variable has no effect.</p>
2074 </dd>
2075 </dl>
2076 </div>
2077 <div class="admonitionblock note">
2078 <table>
2079 <tr>
2080 <td class="icon">
2081 <div class="title">Note</div>
2082 </td>
2083 <td class="content">
2084 The configuration options in <code>bitmapPseudoMerge.*</code> are considered
2085 EXPERIMENTAL and may be subject to change or be removed entirely in the
2086 future. For more information about the pseudo-merge bitmap feature, see
2087 the "Pseudo-merge bitmaps" section of <a href="gitpacking.html">gitpacking(7)</a>.
2088 </td>
2089 </tr>
2090 </table>
2091 </div>
2092 <div class="dlist">
2093 <dl>
2094 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.pattern</dt>
2095 <dd>
2096 <p>Regular expression used to match reference names. Commits
2097 pointed to by references matching this pattern (and meeting
2098 the below criteria, like <code>bitmapPseudoMerge.&lt;name&gt;.sampleRate</code>
2099 and <code>bitmapPseudoMerge.&lt;name&gt;.threshold</code>) will be considered
2100 for inclusion in a pseudo-merge bitmap.</p>
2101 <div class="paragraph">
2102 <p>Commits are grouped into pseudo-merge groups based on whether or not
2103 any reference(s) that point at a given commit match the pattern, which
2104 is an extended regular expression.</p>
2105 </div>
2106 <div class="paragraph">
2107 <p>Within a pseudo-merge group, commits may be further grouped into
2108 sub-groups based on the capture groups in the pattern. These
2109 sub-groupings are formed from the regular expressions by concatenating
2110 any capture groups from the regular expression, with a <em>-</em> dash in
2111 between.</p>
2112 </div>
2113 <div class="paragraph">
2114 <p>For example, if the pattern is <code>refs/tags/</code>, then all tags (provided
2115 they meet the below criteria) will be considered candidates for the
2116 same pseudo-merge group. However, if the pattern is instead
2117 <code>refs/remotes/([0-9])+/tags/</code>, then tags from different remotes will
2118 be grouped into separate pseudo-merge groups, based on the remote
2119 number.</p>
2120 </div>
2121 </dd>
2122 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.decay</dt>
2123 <dd>
2124 <p>Determines the rate at which consecutive pseudo-merge bitmap
2125 groups decrease in size. Must be non-negative. This parameter
2126 can be thought of as <code>k</code> in the function <code>f(n) = C * n^-k</code>,
2127 where <code>f(n)</code> is the size of the `n`th group.</p>
2128 <div class="paragraph">
2129 <p>Setting the decay rate equal to <code>0</code> will cause all groups to be the
2130 same size. Setting the decay rate equal to <code>1</code> will cause the <code>n`th
2131 group to be `1/n</code> the size of the initial group.  Higher values of the
2132 decay rate cause consecutive groups to shrink at an increasing rate.
2133 The default is <code>1</code>.</p>
2134 </div>
2135 <div class="paragraph">
2136 <p>If all groups are the same size, it is possible that groups containing
2137 newer commits will be able to be used less often than earlier groups,
2138 since it is more likely that the references pointing at newer commits
2139 will be updated more often than a reference pointing at an old commit.</p>
2140 </div>
2141 </dd>
2142 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.sampleRate</dt>
2143 <dd>
2144 <p>Determines the proportion of non-bitmapped commits (among
2145 reference tips) which are selected for inclusion in an
2146 unstable pseudo-merge bitmap. Must be between <code>0</code> and <code>1</code>
2147 (inclusive). The default is <code>1</code>.</p>
2148 </dd>
2149 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.threshold</dt>
2150 <dd>
2151 <p>Determines the minimum age of non-bitmapped commits (among
2152 reference tips, as above) which are candidates for inclusion
2153 in an unstable pseudo-merge bitmap. The default is
2154 <code>1.week.ago</code>.</p>
2155 </dd>
2156 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.maxMerges</dt>
2157 <dd>
2158 <p>Determines the maximum number of pseudo-merge commits among
2159 which commits may be distributed.</p>
2160 <div class="paragraph">
2161 <p>For pseudo-merge groups whose pattern does not contain any capture
2162 groups, this setting is applied for all commits matching the regular
2163 expression. For patterns that have one or more capture groups, this
2164 setting is applied for each distinct capture group.</p>
2165 </div>
2166 <div class="paragraph">
2167 <p>For example, if your capture group is <code>refs/tags/</code>, then this setting
2168 will distribute all tags into a maximum of <code>maxMerges</code> pseudo-merge
2169 commits. However, if your capture group is, say,
2170 <code>refs/remotes/([0-9]+)/tags/</code>, then this setting will be applied to
2171 each remote&#8217;s set of tags individually.</p>
2172 </div>
2173 <div class="paragraph">
2174 <p>Must be non-negative. The default value is 64.</p>
2175 </div>
2176 </dd>
2177 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.stableThreshold</dt>
2178 <dd>
2179 <p>Determines the minimum age of commits (among reference tips,
2180 as above, however stable commits are still considered
2181 candidates even when they have been covered by a bitmap) which
2182 are candidates for a stable a pseudo-merge bitmap. The default
2183 is <code>1.month.ago</code>.</p>
2184 <div class="paragraph">
2185 <p>Setting this threshold to a smaller value (e.g., 1.week.ago) will cause
2186 more stable groups to be generated (which impose a one-time generation
2187 cost) but those groups will likely become stale over time. Using a
2188 larger value incurs the opposite penalty (fewer stable groups which are
2189 more useful).</p>
2190 </div>
2191 </dd>
2192 <dt class="hdlist1">bitmapPseudoMerge.&lt;name&gt;.stableSize</dt>
2193 <dd>
2194 <p>Determines the size (in number of commits) of a stable
2195 psuedo-merge bitmap. The default is <code>512</code>.</p>
2196 </dd>
2197 <dt class="hdlist1">blame.blankBoundary</dt>
2198 <dd>
2199 <p>Show blank commit object name for boundary commits in
2200 <a href="git-blame.html">git-blame(1)</a>. This option defaults to false.</p>
2201 </dd>
2202 <dt class="hdlist1">blame.coloring</dt>
2203 <dd>
2204 <p>This determines the coloring scheme to be applied to blame
2205 output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
2206 or <em>none</em> which is the default.</p>
2207 </dd>
2208 <dt class="hdlist1">blame.date</dt>
2209 <dd>
2210 <p>Specifies the format used to output dates in <a href="git-blame.html">git-blame(1)</a>.
2211 If unset the iso format is used. For supported values,
2212 see the discussion of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.</p>
2213 </dd>
2214 <dt class="hdlist1">blame.showEmail</dt>
2215 <dd>
2216 <p>Show the author email instead of author name in <a href="git-blame.html">git-blame(1)</a>.
2217 This option defaults to false.</p>
2218 </dd>
2219 <dt class="hdlist1">blame.showRoot</dt>
2220 <dd>
2221 <p>Do not treat root commits as boundaries in <a href="git-blame.html">git-blame(1)</a>.
2222 This option defaults to false.</p>
2223 </dd>
2224 <dt class="hdlist1">blame.ignoreRevsFile</dt>
2225 <dd>
2226 <p>Ignore revisions listed in the file, one unabbreviated object name per
2227 line, in <a href="git-blame.html">git-blame(1)</a>.  Whitespace and comments beginning with
2228 <code>#</code> are ignored.  This option may be repeated multiple times.  Empty
2229 file names will reset the list of ignored revisions.  This option will
2230 be handled before the command line option <code>--ignore-revs-file</code>.</p>
2231 </dd>
2232 <dt class="hdlist1">blame.markUnblamableLines</dt>
2233 <dd>
2234 <p>Mark lines that were changed by an ignored revision that we could not
2235 attribute to another commit with a <em>*</em> in the output of
2236 <a href="git-blame.html">git-blame(1)</a>.</p>
2237 </dd>
2238 <dt class="hdlist1">blame.markIgnoredLines</dt>
2239 <dd>
2240 <p>Mark lines that were changed by an ignored revision that we attributed to
2241 another commit with a <em>?</em> in the output of <a href="git-blame.html">git-blame(1)</a>.</p>
2242 </dd>
2243 <dt class="hdlist1">branch.autoSetupMerge</dt>
2244 <dd>
2245 <p>Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
2246 so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
2247 starting point branch. Note that even if this option is not set,
2248 this behavior can be chosen per-branch using the <code>--track</code>
2249 and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
2250 automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
2251 starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;automatic setup is done when the starting point is either a
2252 local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
2253 has a tracking configuration, it is copied to the new
2254 branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
2255 is a remote-tracking branch and the new branch has the same name as the
2256 remote branch. This option defaults to true.</p>
2257 </dd>
2258 <dt class="hdlist1">branch.autoSetupRebase</dt>
2259 <dd>
2260 <p>When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
2261 that tracks another branch, this variable tells Git to set
2262 up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
2263 When <code>never</code>, rebase is never automatically set to true.
2264 When <code>local</code>, rebase is set to true for tracked branches of
2265 other local branches.
2266 When <code>remote</code>, rebase is set to true for tracked branches of
2267 remote-tracking branches.
2268 When <code>always</code>, rebase will be set to true for all tracking
2269 branches.
2270 See "branch.autoSetupMerge" for details on how to set up a
2271 branch to track another branch.
2272 This option defaults to never.</p>
2273 </dd>
2274 <dt class="hdlist1">branch.sort</dt>
2275 <dd>
2276 <p>This variable controls the sort ordering of branches when displayed by
2277 <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
2278 value of this variable will be used as the default.
2279 See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.</p>
2280 </dd>
2281 <dt class="hdlist1">branch.&lt;name&gt;.remote</dt>
2282 <dd>
2283 <p>When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
2284 which remote to fetch from or push to.  The remote to push to
2285 may be overridden with <code>remote.pushDefault</code> (for all branches).
2286 The remote to push to, for the current branch, may be further
2287 overridden by <code>branch.&lt;name&gt;.pushRemote</code>.  If no remote is
2288 configured, or if you are not on any branch and there is more than
2289 one remote defined in the repository, it defaults to <code>origin</code> for
2290 fetching and <code>remote.pushDefault</code> for pushing.
2291 Additionally, <code>.</code> (a period) is the current local repository
2292 (a dot-repository), see <code>branch.&lt;name&gt;.merge</code>'s final note below.</p>
2293 </dd>
2294 <dt class="hdlist1">branch.&lt;name&gt;.pushRemote</dt>
2295 <dd>
2296 <p>When on branch &lt;name&gt;, it overrides <code>branch.&lt;name&gt;.remote</code> for
2297 pushing.  It also overrides <code>remote.pushDefault</code> for pushing
2298 from branch &lt;name&gt;.  When you pull from one place (e.g. your
2299 upstream) and push to another place (e.g. your own publishing
2300 repository), you would want to set <code>remote.pushDefault</code> to
2301 specify the remote to push to for all branches, and use this
2302 option to override it for a specific branch.</p>
2303 </dd>
2304 <dt class="hdlist1">branch.&lt;name&gt;.merge</dt>
2305 <dd>
2306 <p>Defines, together with branch.&lt;name&gt;.remote, the upstream branch
2307 for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
2308 branch to merge and can also affect <em>git push</em> (see push.default).
2309 When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
2310 refspec to be marked for merging in FETCH_HEAD. The value is
2311 handled like the remote part of a refspec, and must match a
2312 ref which is fetched from the remote given by
2313 "branch.&lt;name&gt;.remote".
2314 The merge information is used by <em>git pull</em> (which first calls
2315 <em>git fetch</em>) to lookup the default branch for merging. Without
2316 this option, <em>git pull</em> defaults to merge the first refspec fetched.
2317 Specify multiple values to get an octopus merge.
2318 If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
2319 another branch in the local repository, you can point
2320 branch.&lt;name&gt;.merge to the desired branch, and use the relative path
2321 setting <code>.</code> (a period) for branch.&lt;name&gt;.remote.</p>
2322 </dd>
2323 <dt class="hdlist1">branch.&lt;name&gt;.mergeOptions</dt>
2324 <dd>
2325 <p>Sets default options for merging into branch &lt;name&gt;. The syntax and
2326 supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
2327 option values containing whitespace characters are currently not
2328 supported.</p>
2329 </dd>
2330 <dt class="hdlist1">branch.&lt;name&gt;.rebase</dt>
2331 <dd>
2332 <p>When true, rebase the branch &lt;name&gt; on top of the fetched branch,
2333 instead of merging the default branch from the default remote when
2334 "git pull" is run. See "pull.rebase" for doing this in a non
2335 branch-specific manner.</p>
2336 <div class="paragraph">
2337 <p>When <code>merges</code> (or just <em>m</em>), pass the <code>--rebase-merges</code> option to <em>git rebase</em>
2338 so that the local merge commits are included in the rebase (see
2339 <a href="git-rebase.html">git-rebase(1)</a> for details).</p>
2340 </div>
2341 <div class="paragraph">
2342 <p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
2343 mode.</p>
2344 </div>
2345 <div class="paragraph">
2346 <p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
2347 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
2348 for details).</p>
2349 </div>
2350 </dd>
2351 <dt class="hdlist1">branch.&lt;name&gt;.description</dt>
2352 <dd>
2353 <p>Branch description, can be edited with
2354 <code>git branch --edit-description</code>. Branch description is
2355 automatically added to the format-patch cover letter or
2356 request-pull summary.</p>
2357 </dd>
2358 <dt class="hdlist1">browser.&lt;tool&gt;.cmd</dt>
2359 <dd>
2360 <p>Specify the command to invoke the specified browser. The
2361 specified command is evaluated in shell with the URLs passed
2362 as arguments. (See <a href="git-web&#x2d;&#x2d;browse.html">git-web&#x2d;&#x2d;browse(1)</a>.)</p>
2363 </dd>
2364 <dt class="hdlist1">browser.&lt;tool&gt;.path</dt>
2365 <dd>
2366 <p>Override the path for the given tool that may be used to
2367 browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a
2368 working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>).</p>
2369 </dd>
2370 <dt class="hdlist1">bundle.*</dt>
2371 <dd>
2372 <p>The <code>bundle.*</code> keys may appear in a bundle list file found via the
2373 <code>git clone --bundle-uri</code> option. These keys currently have no effect
2374 if placed in a repository config file, though this will change in the
2375 future. See <a href="technical/bundle-uri.html">the bundle URI design
2376 document</a> for more details.</p>
2377 </dd>
2378 <dt class="hdlist1">bundle.version</dt>
2379 <dd>
2380 <p>This integer value advertises the version of the bundle list format
2381 used by the bundle list. Currently, the only accepted value is <code>1</code>.</p>
2382 </dd>
2383 <dt class="hdlist1">bundle.mode</dt>
2384 <dd>
2385 <p>This string value should be either <code>all</code> or <code>any</code>. This value describes
2386 whether all of the advertised bundles are required to unbundle a
2387 complete understanding of the bundled information (<code>all</code>) or if any one
2388 of the listed bundle URIs is sufficient (<code>any</code>).</p>
2389 </dd>
2390 <dt class="hdlist1">bundle.heuristic</dt>
2391 <dd>
2392 <p>If this string-valued key exists, then the bundle list is designed to
2393 work well with incremental <code>git fetch</code> commands. The heuristic signals
2394 that there are additional keys available for each bundle that help
2395 determine which subset of bundles the client should download. The
2396 only value currently understood is <code>creationToken</code>.</p>
2397 </dd>
2398 <dt class="hdlist1">bundle.&lt;id&gt;.*</dt>
2399 <dd>
2400 <p>The <code>bundle.&lt;id&gt;.*</code> keys are used to describe a single item in the
2401 bundle list, grouped under <code>&lt;id&gt;</code> for identification purposes.</p>
2402 </dd>
2403 <dt class="hdlist1">bundle.&lt;id&gt;.uri</dt>
2404 <dd>
2405 <p>This string value defines the URI by which Git can reach the contents
2406 of this <code>&lt;id&gt;</code>. This URI may be a bundle file or another bundle list.</p>
2407 </dd>
2408 <dt class="hdlist1">checkout.defaultRemote</dt>
2409 <dd>
2410 <p>When you run <code>git checkout &lt;something&gt;</code>
2411 or <code>git switch &lt;something&gt;</code> and only have one
2412 remote, it may implicitly fall back on checking out and
2413 tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
2414 as you have more than one remote with a <code>&lt;something&gt;</code>
2415 reference. This setting allows for setting the name of a
2416 preferred remote that should always win when it comes to
2417 disambiguation. The typical use-case is to set this to
2418 <code>origin</code>.</p>
2419 <div class="paragraph">
2420 <p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
2421 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
2422 or <code>git switch &lt;something&gt;</code>
2423 will checkout the <code>&lt;something&gt;</code> branch on another remote,
2424 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
2425 remote branch. This setting might be used for other checkout-like
2426 commands or functionality in the future.</p>
2427 </div>
2428 </dd>
2429 <dt class="hdlist1">checkout.guess</dt>
2430 <dd>
2431 <p>Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
2432 option in <code>git checkout</code> and <code>git switch</code>. See
2433 <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.</p>
2434 </dd>
2435 <dt class="hdlist1">checkout.workers</dt>
2436 <dd>
2437 <p>The number of parallel workers to use when updating the working tree.
2438 The default is one, i.e. sequential execution. If set to a value less
2439 than one, Git will use as many workers as the number of logical cores
2440 available. This setting and <code>checkout.thresholdForParallelism</code> affect
2441 all commands that perform checkout. E.g. checkout, clone, reset,
2442 sparse-checkout, etc.</p>
2443 <div class="paragraph">
2444 <p>Note: Parallel checkout usually delivers better performance for repositories
2445 located on SSDs or over NFS. For repositories on spinning disks and/or machines
2446 with a small number of cores, the default sequential checkout often performs
2447 better. The size and compression level of a repository might also influence how
2448 well the parallel version performs.</p>
2449 </div>
2450 </dd>
2451 <dt class="hdlist1">checkout.thresholdForParallelism</dt>
2452 <dd>
2453 <p>When running parallel checkout with a small number of files, the cost
2454 of subprocess spawning and inter-process communication might outweigh
2455 the parallelization gains. This setting allows you to define the minimum
2456 number of files for which parallel checkout should be attempted. The
2457 default is 100.</p>
2458 </dd>
2459 <dt class="hdlist1">clean.requireForce</dt>
2460 <dd>
2461 <p>A boolean to make git-clean refuse to delete files unless -f
2462 is given. Defaults to true.</p>
2463 </dd>
2464 <dt class="hdlist1"><code>clone.defaultRemoteName</code></dt>
2465 <dd>
2466 <p>The name of the remote to create when cloning a repository.  Defaults to
2467 <code>origin</code>.
2468 It can be overridden by passing the <code>--origin</code> command-line
2469 option to <a href="git-clone.html">git-clone(1)</a>.</p>
2470 </dd>
2471 <dt class="hdlist1"><code>clone.rejectShallow</code></dt>
2472 <dd>
2473 <p>Reject cloning a repository if it is a shallow one; this can be overridden by
2474 passing the <code>--reject-shallow</code> option on the command line.
2475 See <a href="git-clone.html">git-clone(1)</a>.</p>
2476 </dd>
2477 <dt class="hdlist1"><code>clone.filterSubmodules</code></dt>
2478 <dd>
2479 <p>If a partial clone filter is provided (see <code>--filter</code> in
2480 <a href="git-rev-list.html">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
2481 the filter to submodules.</p>
2482 </dd>
2483 <dt class="hdlist1">color.advice</dt>
2484 <dd>
2485 <p>A boolean to enable/disable color in hints (e.g. when a push
2486 failed, see <code>advice.*</code> for a list).  May be set to <code>always</code>,
2487 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
2488 are used only when the error output goes to a terminal. If
2489 unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2490 </dd>
2491 <dt class="hdlist1">color.advice.hint</dt>
2492 <dd>
2493 <p>Use customized color for hints.</p>
2494 </dd>
2495 <dt class="hdlist1">color.blame.highlightRecent</dt>
2496 <dd>
2497 <p>Specify the line annotation color for <code>git blame --color-by-age</code>
2498 depending upon the age of the line.</p>
2499 <div class="paragraph">
2500 <p>This setting should be set to a comma-separated list of color and
2501 date settings, starting and ending with a color, the dates should be
2502 set from oldest to newest. The metadata will be colored with the
2503 specified colors if the line was introduced before the given
2504 timestamp, overwriting older timestamped colors.</p>
2505 </div>
2506 <div class="paragraph">
2507 <p>Instead of an absolute timestamp relative timestamps work as well,
2508 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p>
2509 </div>
2510 <div class="paragraph">
2511 <p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
2512 colors everything older than one year blue, recent changes between
2513 one month and one year old are kept white, and lines introduced
2514 within the last month are colored red.</p>
2515 </div>
2516 </dd>
2517 <dt class="hdlist1">color.blame.repeatedLines</dt>
2518 <dd>
2519 <p>Use the specified color to colorize line annotations for
2520 <code>git blame --color-lines</code>, if they come from the same commit as the
2521 preceding line. Defaults to cyan.</p>
2522 </dd>
2523 <dt class="hdlist1">color.branch</dt>
2524 <dd>
2525 <p>A boolean to enable/disable color in the output of
2526 <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>,
2527 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
2528 only when the output is to a terminal. If unset, then the
2529 value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2530 </dd>
2531 <dt class="hdlist1">color.branch.&lt;slot&gt;</dt>
2532 <dd>
2533 <p>Use customized color for branch coloration. <code>&lt;slot&gt;</code> is one of
2534 <code>current</code> (the current branch), <code>local</code> (a local branch),
2535 <code>remote</code> (a remote-tracking branch in refs/remotes/),
2536 <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
2537 refs).</p>
2538 </dd>
2539 <dt class="hdlist1">color.diff</dt>
2540 <dd>
2541 <p>Whether to use ANSI escape sequences to add color to patches.
2542 If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>,
2543 <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color
2544 for all patches.  If it is set to <code>true</code> or <code>auto</code>, those
2545 commands will only use color when output is to the terminal.
2546 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
2547 default).</p>
2548 <div class="paragraph">
2549 <p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the
2550 <em>git-diff-*</em> plumbing commands.  Can be overridden on the
2551 command line with the <code>--color[=&lt;when&gt;]</code> option.</p>
2552 </div>
2553 </dd>
2554 <dt class="hdlist1">color.diff.&lt;slot&gt;</dt>
2555 <dd>
2556 <p>Use customized color for diff colorization.  <code>&lt;slot&gt;</code> specifies
2557 which part of the patch to use the specified color, and is one
2558 of <code>context</code> (context text - <code>plain</code> is a historical synonym),
2559 <code>meta</code> (metainformation), <code>frag</code>
2560 (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
2561 <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
2562 (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
2563 <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
2564 <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
2565 <code>newMovedAlternativeDimmed</code> (See the <em>&lt;mode&gt;</em>
2566 setting of <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a> for details),
2567 <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
2568 <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html">git-range-diff(1)</a> for details).</p>
2569 </dd>
2570 <dt class="hdlist1">color.decorate.&lt;slot&gt;</dt>
2571 <dd>
2572 <p>Use customized color for <em>git log --decorate</em> output.  <code>&lt;slot&gt;</code> is one
2573 of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
2574 branches, remote-tracking branches, tags, stash and HEAD, respectively
2575 and <code>grafted</code> for grafted commits.</p>
2576 </dd>
2577 <dt class="hdlist1">color.grep</dt>
2578 <dd>
2579 <p>When set to <code>always</code>, always highlight matches.  When <code>false</code> (or
2580 <code>never</code>), never.  When set to <code>true</code> or <code>auto</code>, use color only
2581 when the output is written to the terminal.  If unset, then the
2582 value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2583 </dd>
2584 <dt class="hdlist1">color.grep.&lt;slot&gt;</dt>
2585 <dd>
2586 <p>Use customized color for grep colorization.  <code>&lt;slot&gt;</code> specifies which
2587 part of the line to use the specified color, and is one of</p>
2588 <div class="openblock">
2589 <div class="content">
2590 <div class="dlist">
2591 <dl>
2592 <dt class="hdlist1"><code>context</code></dt>
2593 <dd>
2594 <p>non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)</p>
2595 </dd>
2596 <dt class="hdlist1"><code>filename</code></dt>
2597 <dd>
2598 <p>filename prefix (when not using <code>-h</code>)</p>
2599 </dd>
2600 <dt class="hdlist1"><code>function</code></dt>
2601 <dd>
2602 <p>function name lines (when using <code>-p</code>)</p>
2603 </dd>
2604 <dt class="hdlist1"><code>lineNumber</code></dt>
2605 <dd>
2606 <p>line number prefix (when using <code>-n</code>)</p>
2607 </dd>
2608 <dt class="hdlist1"><code>column</code></dt>
2609 <dd>
2610 <p>column number prefix (when using <code>--column</code>)</p>
2611 </dd>
2612 <dt class="hdlist1"><code>match</code></dt>
2613 <dd>
2614 <p>matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)</p>
2615 </dd>
2616 <dt class="hdlist1"><code>matchContext</code></dt>
2617 <dd>
2618 <p>matching text in context lines</p>
2619 </dd>
2620 <dt class="hdlist1"><code>matchSelected</code></dt>
2621 <dd>
2622 <p>matching text in selected lines. Also, used to customize the following
2623 <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.</p>
2624 </dd>
2625 <dt class="hdlist1"><code>selected</code></dt>
2626 <dd>
2627 <p>non-matching text in selected lines. Also, used to customize the
2628 following <a href="git-log.html">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
2629 <code>--committer</code>.</p>
2630 </dd>
2631 <dt class="hdlist1"><code>separator</code></dt>
2632 <dd>
2633 <p>separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
2634 and between hunks (<code>--</code>)</p>
2635 </dd>
2636 </dl>
2637 </div>
2638 </div>
2639 </div>
2640 </dd>
2641 <dt class="hdlist1">color.interactive</dt>
2642 <dd>
2643 <p>When set to <code>always</code>, always use colors for interactive prompts
2644 and displays (such as those used by "git-add --interactive" and
2645 "git-clean --interactive"). When false (or <code>never</code>), never.
2646 When set to <code>true</code> or <code>auto</code>, use colors only when the output is
2647 to the terminal. If unset, then the value of <code>color.ui</code> is
2648 used (<code>auto</code> by default).</p>
2649 </dd>
2650 <dt class="hdlist1">color.interactive.&lt;slot&gt;</dt>
2651 <dd>
2652 <p>Use customized color for <em>git add --interactive</em> and <em>git clean
2653 --interactive</em> output. <code>&lt;slot&gt;</code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
2654 or <code>error</code>, for four distinct types of normal output from
2655 interactive commands.</p>
2656 </dd>
2657 <dt class="hdlist1">color.pager</dt>
2658 <dd>
2659 <p>A boolean to specify whether <code>auto</code> color modes should colorize
2660 output going to the pager. Defaults to true; set this to false
2661 if your pager does not understand ANSI color codes.</p>
2662 </dd>
2663 <dt class="hdlist1">color.push</dt>
2664 <dd>
2665 <p>A boolean to enable/disable color in push errors. May be set to
2666 <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
2667 case colors are used only when the error output goes to a terminal.
2668 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2669 </dd>
2670 <dt class="hdlist1">color.push.error</dt>
2671 <dd>
2672 <p>Use customized color for push errors.</p>
2673 </dd>
2674 <dt class="hdlist1">color.remote</dt>
2675 <dd>
2676 <p>If set, keywords at the start of the line are highlighted. The
2677 keywords are "error", "warning", "hint" and "success", and are
2678 matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
2679 <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
2680 <code>color.ui</code> is used (<code>auto</code> by default).</p>
2681 </dd>
2682 <dt class="hdlist1">color.remote.&lt;slot&gt;</dt>
2683 <dd>
2684 <p>Use customized color for each remote keyword. <code>&lt;slot&gt;</code> may be
2685 <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
2686 corresponding keyword.</p>
2687 </dd>
2688 <dt class="hdlist1">color.showBranch</dt>
2689 <dd>
2690 <p>A boolean to enable/disable color in the output of
2691 <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>,
2692 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
2693 only when the output is to a terminal. If unset, then the
2694 value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2695 </dd>
2696 <dt class="hdlist1">color.status</dt>
2697 <dd>
2698 <p>A boolean to enable/disable color in the output of
2699 <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>,
2700 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
2701 only when the output is to a terminal. If unset, then the
2702 value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2703 </dd>
2704 <dt class="hdlist1">color.status.&lt;slot&gt;</dt>
2705 <dd>
2706 <p>Use customized color for status colorization. <code>&lt;slot&gt;</code> is
2707 one of <code>header</code> (the header text of the status message),
2708 <code>added</code> or <code>updated</code> (files which are added but not committed),
2709 <code>changed</code> (files which are changed but not added in the index),
2710 <code>untracked</code> (files which are not tracked by Git),
2711 <code>branch</code> (the current branch),
2712 <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
2713 to red),
2714 <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
2715 respectively, when branch and tracking information is displayed in the
2716 status short-format), or
2717 <code>unmerged</code> (files which have unmerged changes).</p>
2718 </dd>
2719 <dt class="hdlist1">color.transport</dt>
2720 <dd>
2721 <p>A boolean to enable/disable color when pushes are rejected. May be
2722 set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
2723 case colors are used only when the error output goes to a terminal.
2724 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).</p>
2725 </dd>
2726 <dt class="hdlist1">color.transport.rejected</dt>
2727 <dd>
2728 <p>Use customized color when a push was rejected.</p>
2729 </dd>
2730 <dt class="hdlist1">color.ui</dt>
2731 <dd>
2732 <p>This variable determines the default value for variables such
2733 as <code>color.diff</code> and <code>color.grep</code> that control the use of color
2734 per command family. Its scope will expand as more commands learn
2735 configuration to set a default for the <code>--color</code> option.  Set it
2736 to <code>false</code> or <code>never</code> if you prefer Git commands not to use
2737 color unless enabled explicitly with some other configuration
2738 or the <code>--color</code> option. Set it to <code>always</code> if you want all
2739 output not intended for machine consumption to use color, to
2740 <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
2741 want such output to use color when written to the terminal.</p>
2742 </dd>
2743 <dt class="hdlist1">column.ui</dt>
2744 <dd>
2745 <p>Specify whether supported commands should output in columns.
2746 This variable consists of a list of tokens separated by spaces
2747 or commas:</p>
2748 <div class="paragraph">
2749 <p>These options control when the feature should be enabled
2750 (defaults to <em>never</em>):</p>
2751 </div>
2752 <div class="openblock">
2753 <div class="content">
2754 <div class="dlist">
2755 <dl>
2756 <dt class="hdlist1"><code>always</code></dt>
2757 <dd>
2758 <p>always show in columns</p>
2759 </dd>
2760 <dt class="hdlist1"><code>never</code></dt>
2761 <dd>
2762 <p>never show in columns</p>
2763 </dd>
2764 <dt class="hdlist1"><code>auto</code></dt>
2765 <dd>
2766 <p>show in columns if the output is to the terminal</p>
2767 </dd>
2768 </dl>
2769 </div>
2770 </div>
2771 </div>
2772 <div class="paragraph">
2773 <p>These options control layout (defaults to <em>column</em>).  Setting any
2774 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
2775 specified.</p>
2776 </div>
2777 <div class="openblock">
2778 <div class="content">
2779 <div class="dlist">
2780 <dl>
2781 <dt class="hdlist1"><code>column</code></dt>
2782 <dd>
2783 <p>fill columns before rows</p>
2784 </dd>
2785 <dt class="hdlist1"><code>row</code></dt>
2786 <dd>
2787 <p>fill rows before columns</p>
2788 </dd>
2789 <dt class="hdlist1"><code>plain</code></dt>
2790 <dd>
2791 <p>show in one column</p>
2792 </dd>
2793 </dl>
2794 </div>
2795 </div>
2796 </div>
2797 <div class="paragraph">
2798 <p>Finally, these options can be combined with a layout option (defaults
2799 to <em>nodense</em>):</p>
2800 </div>
2801 <div class="openblock">
2802 <div class="content">
2803 <div class="dlist">
2804 <dl>
2805 <dt class="hdlist1"><code>dense</code></dt>
2806 <dd>
2807 <p>make unequal size columns to utilize more space</p>
2808 </dd>
2809 <dt class="hdlist1"><code>nodense</code></dt>
2810 <dd>
2811 <p>make equal size columns</p>
2812 </dd>
2813 </dl>
2814 </div>
2815 </div>
2816 </div>
2817 </dd>
2818 <dt class="hdlist1">column.branch</dt>
2819 <dd>
2820 <p>Specify whether to output branch listing in <code>git branch</code> in columns.
2821 See <code>column.ui</code> for details.</p>
2822 </dd>
2823 <dt class="hdlist1">column.clean</dt>
2824 <dd>
2825 <p>Specify the layout when listing items in <code>git clean -i</code>, which always
2826 shows files and directories in columns. See <code>column.ui</code> for details.</p>
2827 </dd>
2828 <dt class="hdlist1">column.status</dt>
2829 <dd>
2830 <p>Specify whether to output untracked files in <code>git status</code> in columns.
2831 See <code>column.ui</code> for details.</p>
2832 </dd>
2833 <dt class="hdlist1">column.tag</dt>
2834 <dd>
2835 <p>Specify whether to output tag listings in <code>git tag</code> in columns.
2836 See <code>column.ui</code> for details.</p>
2837 </dd>
2838 <dt class="hdlist1">commit.cleanup</dt>
2839 <dd>
2840 <p>This setting overrides the default of the <code>--cleanup</code> option in
2841 <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the
2842 default can be useful when you always want to keep lines that begin
2843 with the comment character <code>#</code> in your log message, in which case you
2844 would do <code>git config commit.cleanup whitespace</code> (note that you will
2845 have to remove the help lines that begin with <code>#</code> in the commit log
2846 template yourself, if you do this).</p>
2847 </dd>
2848 <dt class="hdlist1">commit.gpgSign</dt>
2849 <dd>
2850 <p>A boolean to specify whether all commits should be GPG signed.
2851 Use of this option when doing operations such as rebase can
2852 result in a large number of commits being signed. It may be
2853 convenient to use an agent to avoid typing your GPG passphrase
2854 several times.</p>
2855 </dd>
2856 <dt class="hdlist1">commit.status</dt>
2857 <dd>
2858 <p>A boolean to enable/disable inclusion of status information in the
2859 commit message template when using an editor to prepare the commit
2860 message.  Defaults to true.</p>
2861 </dd>
2862 <dt class="hdlist1">commit.template</dt>
2863 <dd>
2864 <p>Specify the pathname of a file to use as the template for
2865 new commit messages.</p>
2866 </dd>
2867 <dt class="hdlist1">commit.verbose</dt>
2868 <dd>
2869 <p>A boolean or int to specify the level of verbosity with <code>git commit</code>.
2870 See <a href="git-commit.html">git-commit(1)</a>.</p>
2871 </dd>
2872 <dt class="hdlist1">commitGraph.generationVersion</dt>
2873 <dd>
2874 <p>Specifies the type of generation number version to use when writing
2875 or reading the commit-graph file. If version 1 is specified, then
2876 the corrected commit dates will not be written or read. Defaults to
2877 2.</p>
2878 </dd>
2879 <dt class="hdlist1">commitGraph.maxNewFilters</dt>
2880 <dd>
2881 <p>Specifies the default value for the <code>--max-new-filters</code> option of <code>git
2882 commit-graph write</code> (c.f., <a href="git-commit-graph.html">git-commit-graph(1)</a>).</p>
2883 </dd>
2884 <dt class="hdlist1">commitGraph.readChangedPaths</dt>
2885 <dd>
2886 <p>Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if true, and
2887 commitGraph.changedPathsVersion=0 if false. (If commitGraph.changedPathVersion
2888 is also set, commitGraph.changedPathsVersion takes precedence.)</p>
2889 </dd>
2890 <dt class="hdlist1">commitGraph.changedPathsVersion</dt>
2891 <dd>
2892 <p>Specifies the version of the changed-path Bloom filters that Git will read and
2893 write. May be -1, 0, 1, or 2. Note that values greater than 1 may be
2894 incompatible with older versions of Git which do not yet understand
2895 those versions. Use caution when operating in a mixed-version
2896 environment.</p>
2897 <div class="paragraph">
2898 <p>Defaults to -1.</p>
2899 </div>
2900 <div class="paragraph">
2901 <p>If -1, Git will use the version of the changed-path Bloom filters in the
2902 repository, defaulting to 1 if there are none.</p>
2903 </div>
2904 <div class="paragraph">
2905 <p>If 0, Git will not read any Bloom filters, and will write version 1 Bloom
2906 filters when instructed to write.</p>
2907 </div>
2908 <div class="paragraph">
2909 <p>If 1, Git will only read version 1 Bloom filters, and will write version 1
2910 Bloom filters.</p>
2911 </div>
2912 <div class="paragraph">
2913 <p>If 2, Git will only read version 2 Bloom filters, and will write version 2
2914 Bloom filters.</p>
2915 </div>
2916 <div class="paragraph">
2917 <p>See <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.</p>
2918 </div>
2919 </dd>
2920 <dt class="hdlist1">completion.commands</dt>
2921 <dd>
2922 <p>This is only used by git-completion.bash to add or remove
2923 commands from the list of completed commands. Normally only
2924 porcelain commands and a few select others are completed. You
2925 can add more commands, separated by space, in this
2926 variable. Prefixing the command with <em>-</em> will remove it from
2927 the existing list.</p>
2928 </dd>
2929 <dt class="hdlist1">core.fileMode</dt>
2930 <dd>
2931 <p>Tells Git if the executable bit of files in the working tree
2932 is to be honored.</p>
2933 <div class="paragraph">
2934 <p>Some filesystems lose the executable bit when a file that is
2935 marked as executable is checked out, or checks out a
2936 non-executable file with executable bit on.
2937 <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem
2938 to see if it handles the executable bit correctly
2939 and this variable is automatically set as necessary.</p>
2940 </div>
2941 <div class="paragraph">
2942 <p>A repository, however, may be on a filesystem that handles
2943 the filemode correctly, and this variable is set to <em>true</em>
2944 when created, but later may be made accessible from another
2945 environment that loses the filemode (e.g. exporting ext4 via
2946 CIFS mount, visiting a Cygwin created repository with
2947 Git for Windows or Eclipse).
2948 In such a case it may be necessary to set this variable to <em>false</em>.
2949 See <a href="git-update-index.html">git-update-index(1)</a>.</p>
2950 </div>
2951 <div class="paragraph">
2952 <p>The default is true (when core.filemode is not specified in the config file).</p>
2953 </div>
2954 </dd>
2955 <dt class="hdlist1">core.hideDotFiles</dt>
2956 <dd>
2957 <p>(Windows-only) If true, mark newly-created directories and files whose
2958 name starts with a dot as hidden.  If <em>dotGitOnly</em>, only the <code>.git/</code>
2959 directory is hidden, but no other files starting with a dot.  The
2960 default mode is <em>dotGitOnly</em>.</p>
2961 </dd>
2962 <dt class="hdlist1">core.ignoreCase</dt>
2963 <dd>
2964 <p>Internal variable which enables various workarounds to enable
2965 Git to work better on filesystems that are not case sensitive,
2966 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
2967 finds "makefile" when Git expects "Makefile", Git will assume
2968 it is really the same file, and continue to remember it as
2969 "Makefile".</p>
2970 <div class="paragraph">
2971 <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>
2972 will probe and set core.ignoreCase true if appropriate when the repository
2973 is created.</p>
2974 </div>
2975 <div class="paragraph">
2976 <p>Git relies on the proper configuration of this variable for your operating
2977 and file system. Modifying this value may result in unexpected behavior.</p>
2978 </div>
2979 </dd>
2980 <dt class="hdlist1">core.precomposeUnicode</dt>
2981 <dd>
2982 <p>This option is only used by Mac OS implementation of Git.
2983 When core.precomposeUnicode=true, Git reverts the unicode decomposition
2984 of filenames done by Mac OS. This is useful when sharing a repository
2985 between Mac OS and Linux or Windows.
2986 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
2987 When false, file names are handled fully transparent by Git,
2988 which is backward compatible with older versions of Git.</p>
2989 </dd>
2990 <dt class="hdlist1">core.protectHFS</dt>
2991 <dd>
2992 <p>If set to true, do not allow checkout of paths that would
2993 be considered equivalent to <code>.git</code> on an HFS+ filesystem.
2994 Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.</p>
2995 </dd>
2996 <dt class="hdlist1">core.protectNTFS</dt>
2997 <dd>
2998 <p>If set to true, do not allow checkout of paths that would
2999 cause problems with the NTFS filesystem, e.g. conflict with
3000 8.3 "short" names.
3001 Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.</p>
3002 </dd>
3003 <dt class="hdlist1">core.fsmonitor</dt>
3004 <dd>
3005 <p>If set to true, enable the built-in file system monitor
3006 daemon for this working directory (<a href="git-fsmonitor&#x2d;&#x2d;daemon.html">git-fsmonitor&#x2d;&#x2d;daemon(1)</a>).</p>
3007 <div class="paragraph">
3008 <p>Like hook-based file system monitors, the built-in file system monitor
3009 can speed up Git commands that need to refresh the Git index
3010 (e.g. <code>git status</code>) in a working directory with many files.  The
3011 built-in monitor eliminates the need to install and maintain an
3012 external third-party tool.</p>
3013 </div>
3014 <div class="paragraph">
3015 <p>The built-in file system monitor is currently available only on a
3016 limited set of supported platforms.  Currently, this includes Windows
3017 and MacOS.</p>
3018 </div>
3019 <div class="literalblock">
3020 <div class="content">
3021 <pre>Otherwise, this variable contains the pathname of the "fsmonitor"
3022 hook command.</pre>
3023 </div>
3024 </div>
3025 <div class="paragraph">
3026 <p>This hook command is used to identify all files that may have changed
3027 since the requested date/time. This information is used to speed up
3028 git by avoiding unnecessary scanning of files that have not changed.</p>
3029 </div>
3030 <div class="paragraph">
3031 <p>See the "fsmonitor-watchman" section of <a href="githooks.html">githooks(5)</a>.</p>
3032 </div>
3033 <div class="paragraph">
3034 <p>Note that if you concurrently use multiple versions of Git, such
3035 as one version on the command line and another version in an IDE
3036 tool, that the definition of <code>core.fsmonitor</code> was extended to
3037 allow boolean values in addition to hook pathnames.  Git versions
3038 2.35.1 and prior will not understand the boolean values and will
3039 consider the "true" or "false" values as hook pathnames to be
3040 invoked.  Git versions 2.26 thru 2.35.1 default to hook protocol
3041 V2 and will fall back to no fsmonitor (full scan).  Git versions
3042 prior to 2.26 default to hook protocol V1 and will silently
3043 assume there were no changes to report (no scan), so status
3044 commands may report incomplete results.  For this reason, it is
3045 best to upgrade all of your Git versions before using the built-in
3046 file system monitor.</p>
3047 </div>
3048 </dd>
3049 <dt class="hdlist1">core.fsmonitorHookVersion</dt>
3050 <dd>
3051 <p>Sets the protocol version to be used when invoking the
3052 "fsmonitor" hook.</p>
3053 <div class="paragraph">
3054 <p>There are currently versions 1 and 2. When this is not set,
3055 version 2 will be tried first and if it fails then version 1
3056 will be tried. Version 1 uses a timestamp as input to determine
3057 which files have changes since that time but some monitors
3058 like Watchman have race conditions when used with a timestamp.
3059 Version 2 uses an opaque string so that the monitor can return
3060 something that can be used to determine what files have changed
3061 without race conditions.</p>
3062 </div>
3063 </dd>
3064 <dt class="hdlist1">core.trustctime</dt>
3065 <dd>
3066 <p>If false, the ctime differences between the index and the
3067 working tree are ignored; useful when the inode change time
3068 is regularly modified by something outside Git (file system
3069 crawlers and some backup systems).
3070 See <a href="git-update-index.html">git-update-index(1)</a>. True by default.</p>
3071 </dd>
3072 <dt class="hdlist1">core.splitIndex</dt>
3073 <dd>
3074 <p>If true, the split-index feature of the index will be used.
3075 See <a href="git-update-index.html">git-update-index(1)</a>. False by default.</p>
3076 </dd>
3077 <dt class="hdlist1">core.untrackedCache</dt>
3078 <dd>
3079 <p>Determines what to do about the untracked cache feature of the
3080 index. It will be kept, if this variable is unset or set to
3081 <code>keep</code>. It will automatically be added if set to <code>true</code>. And
3082 it will automatically be removed, if set to <code>false</code>. Before
3083 setting it to <code>true</code>, you should check that mtime is working
3084 properly on your system.
3085 See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default, unless
3086 <code>feature.manyFiles</code> is enabled which sets this setting to
3087 <code>true</code> by default.</p>
3088 </dd>
3089 <dt class="hdlist1">core.checkStat</dt>
3090 <dd>
3091 <p>When missing or is set to <code>default</code>, many fields in the stat
3092 structure are checked to detect if a file has been modified
3093 since Git looked at it.  When this configuration variable is
3094 set to <code>minimal</code>, sub-second part of mtime and ctime, the
3095 uid and gid of the owner of the file, the inode number (and
3096 the device number, if Git was compiled to use it), are
3097 excluded from the check among these fields, leaving only the
3098 whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
3099 is set) and the filesize to be checked.</p>
3100 <div class="paragraph">
3101 <p>There are implementations of Git that do not leave usable values in
3102 some fields (e.g. JGit); by excluding these fields from the
3103 comparison, the <code>minimal</code> mode may help interoperability when the
3104 same repository is used by these other systems at the same time.</p>
3105 </div>
3106 </dd>
3107 <dt class="hdlist1">core.quotePath</dt>
3108 <dd>
3109 <p>Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
3110 quote "unusual" characters in the pathname by enclosing the
3111 pathname in double-quotes and escaping those characters with
3112 backslashes in the same way C escapes control characters (e.g.
3113 <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
3114 values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro" in
3115 UTF-8).  If this variable is set to false, bytes higher than
3116 0x80 are not considered "unusual" any more. Double-quotes,
3117 backslash and control characters are always escaped regardless
3118 of the setting of this variable.  A simple space character is
3119 not considered "unusual".  Many commands can output pathnames
3120 completely verbatim using the <code>-z</code> option. The default value
3121 is true.</p>
3122 </dd>
3123 <dt class="hdlist1">core.eol</dt>
3124 <dd>
3125 <p>Sets the line ending type to use in the working directory for
3126 files that are marked as text (either by having the <code>text</code>
3127 attribute set, or by having <code>text=auto</code> and Git auto-detecting
3128 the contents as text).
3129 Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform&#8217;s
3130 native line ending.  The default value is <code>native</code>.  See
3131 <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line
3132 conversion. Note that this value is ignored if <code>core.autocrlf</code>
3133 is set to <code>true</code> or <code>input</code>.</p>
3134 </dd>
3135 <dt class="hdlist1">core.safecrlf</dt>
3136 <dd>
3137 <p>If true, makes Git check if converting <code>CRLF</code> is reversible when
3138 end-of-line conversion is active.  Git will verify if a command
3139 modifies a file in the work tree either directly or indirectly.
3140 For example, committing a file followed by checking out the
3141 same file should yield the original file in the work tree.  If
3142 this is not the case for the current setting of
3143 <code>core.autocrlf</code>, Git will reject the file.  The variable can
3144 be set to "warn", in which case Git will only warn about an
3145 irreversible conversion but continue the operation.</p>
3146 <div class="paragraph">
3147 <p>CRLF conversion bears a slight chance of corrupting data.
3148 When it is enabled, Git will convert CRLF to LF during commit and LF to
3149 CRLF during checkout.  A file that contains a mixture of LF and
3150 CRLF before the commit cannot be recreated by Git.  For text
3151 files this is the right thing to do: it corrects line endings
3152 such that we have only LF line endings in the repository.
3153 But for binary files that are accidentally classified as text the
3154 conversion can corrupt data.</p>
3155 </div>
3156 <div class="paragraph">
3157 <p>If you recognize such corruption early you can easily fix it by
3158 setting the conversion type explicitly in .gitattributes.  Right
3159 after committing you still have the original file in your work
3160 tree and this file is not yet corrupted.  You can explicitly tell
3161 Git that this file is binary and Git will handle the file
3162 appropriately.</p>
3163 </div>
3164 <div class="paragraph">
3165 <p>Unfortunately, the desired effect of cleaning up text files with
3166 mixed line endings and the undesired effect of corrupting binary
3167 files cannot be distinguished.  In both cases CRLFs are removed
3168 in an irreversible way.  For text files this is the right thing
3169 to do because CRLFs are line endings, while for binary files
3170 converting CRLFs corrupts data.</p>
3171 </div>
3172 <div class="paragraph">
3173 <p>Note, this safety check does not mean that a checkout will generate a
3174 file identical to the original file for a different setting of
3175 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one.  For
3176 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
3177 and could later be checked out with <code>core.eol=crlf</code>, in which case the
3178 resulting file would contain <code>CRLF</code>, although the original file
3179 contained <code>LF</code>.  However, in both work trees the line endings would be
3180 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed.  A
3181 file with mixed line endings would be reported by the <code>core.safecrlf</code>
3182 mechanism.</p>
3183 </div>
3184 </dd>
3185 <dt class="hdlist1">core.autocrlf</dt>
3186 <dd>
3187 <p>Setting this variable to "true" is the same as setting
3188 the <code>text</code> attribute to "auto" on all files and core.eol to "crlf".
3189 Set to true if you want to have <code>CRLF</code> line endings in your
3190 working directory and the repository has LF line endings.
3191 This variable can be set to <em>input</em>,
3192 in which case no output conversion is performed.</p>
3193 </dd>
3194 <dt class="hdlist1">core.checkRoundtripEncoding</dt>
3195 <dd>
3196 <p>A comma and/or whitespace separated list of encodings that Git
3197 performs UTF-8 round trip checks on if they are used in an
3198 <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html">gitattributes(5)</a>).
3199 The default value is <code>SHIFT-JIS</code>.</p>
3200 </dd>
3201 <dt class="hdlist1">core.symlinks</dt>
3202 <dd>
3203 <p>If false, symbolic links are checked out as small plain files that
3204 contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and
3205 <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular
3206 file. Useful on filesystems like FAT that do not support
3207 symbolic links.</p>
3208 <div class="paragraph">
3209 <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>
3210 will probe and set core.symlinks false if appropriate when the repository
3211 is created.</p>
3212 </div>
3213 </dd>
3214 <dt class="hdlist1">core.gitProxy</dt>
3215 <dd>
3216 <p>A "proxy command" to execute (as <em>command host port</em>) instead
3217 of establishing direct connection to the remote server when
3218 using the Git protocol for fetching. If the variable value is
3219 in the "COMMAND for DOMAIN" format, the command is applied only
3220 on hostnames ending with the specified domain string. This variable
3221 may be set multiple times and is matched in the given order;
3222 the first match wins.</p>
3223 <div class="paragraph">
3224 <p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
3225 (which always applies universally, without the special "for"
3226 handling).</p>
3227 </div>
3228 <div class="paragraph">
3229 <p>The special string <code>none</code> can be used as the proxy command to
3230 specify that no proxy be used for a given domain pattern.
3231 This is useful for excluding servers inside a firewall from
3232 proxy use, while defaulting to a common proxy for external domains.</p>
3233 </div>
3234 </dd>
3235 <dt class="hdlist1">core.sshCommand</dt>
3236 <dd>
3237 <p>If this variable is set, <code>git fetch</code> and <code>git push</code> will
3238 use the specified command instead of <code>ssh</code> when they need to
3239 connect to a remote system. The command is in the same form as
3240 the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
3241 when the environment variable is set.</p>
3242 </dd>
3243 <dt class="hdlist1">core.ignoreStat</dt>
3244 <dd>
3245 <p>If true, Git will avoid using lstat() calls to detect if files have
3246 changed by setting the "assume-unchanged" bit for those tracked files
3247 which it has updated identically in both the index and working tree.</p>
3248 <div class="paragraph">
3249 <p>When files are modified outside of Git, the user will need to stage
3250 the modified files explicitly (e.g. see <em>Examples</em> section in
3251 <a href="git-update-index.html">git-update-index(1)</a>).
3252 Git will not normally detect changes to those files.</p>
3253 </div>
3254 <div class="paragraph">
3255 <p>This is useful on systems where lstat() calls are very slow, such as
3256 CIFS/Microsoft Windows.</p>
3257 </div>
3258 <div class="paragraph">
3259 <p>False by default.</p>
3260 </div>
3261 </dd>
3262 <dt class="hdlist1">core.preferSymlinkRefs</dt>
3263 <dd>
3264 <p>Instead of the default "symref" format for HEAD
3265 and other symbolic reference files, use symbolic links.
3266 This is sometimes needed to work with old scripts that
3267 expect HEAD to be a symbolic link.</p>
3268 </dd>
3269 <dt class="hdlist1">core.alternateRefsCommand</dt>
3270 <dd>
3271 <p>When advertising tips of available history from an alternate, use the shell to
3272 execute the specified command instead of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. The
3273 first argument is the absolute path of the alternate. Output must contain one
3274 hex object id per line (i.e., the same as produced by <code>git for-each-ref
3275 --format='%(objectname)'</code>).</p>
3276 <div class="paragraph">
3277 <p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
3278 value, as it does not take a repository path as an argument (but you can wrap
3279 the command above in a shell script).</p>
3280 </div>
3281 </dd>
3282 <dt class="hdlist1">core.alternateRefsPrefixes</dt>
3283 <dd>
3284 <p>When listing references from an alternate, list only references that begin
3285 with the given prefix. Prefixes match as if they were given as arguments to
3286 <a href="git-for-each-ref.html">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
3287 whitespace. If <code>core.alternateRefsCommand</code> is set, setting
3288 <code>core.alternateRefsPrefixes</code> has no effect.</p>
3289 </dd>
3290 <dt class="hdlist1">core.bare</dt>
3291 <dd>
3292 <p>If true this repository is assumed to be <em>bare</em> and has no
3293 working directory associated with it.  If this is the case a
3294 number of commands that require a working directory will be
3295 disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>.</p>
3296 <div class="paragraph">
3297 <p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or
3298 <a href="git-init.html">git-init(1)</a> when the repository was created.  By default a
3299 repository that ends in "/.git" is assumed to be not bare (bare =
3300 false), while all other repositories are assumed to be bare (bare
3301 = true).</p>
3302 </div>
3303 </dd>
3304 <dt class="hdlist1">core.worktree</dt>
3305 <dd>
3306 <p>Set the path to the root of the working tree.
3307 If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
3308 is ignored and not used for determining the root of working tree.
3309 This can be overridden by the <code>GIT_WORK_TREE</code> environment
3310 variable and the <code>--work-tree</code> command-line option.
3311 The value can be an absolute path or relative to the path to
3312 the .git directory, which is either specified by --git-dir
3313 or GIT_DIR, or automatically discovered.
3314 If --git-dir or GIT_DIR is specified but none of
3315 --work-tree, GIT_WORK_TREE and core.worktree is specified,
3316 the current working directory is regarded as the top level
3317 of your working tree.</p>
3318 <div class="paragraph">
3319 <p>Note that this variable is honored even when set in a configuration
3320 file in a ".git" subdirectory of a directory and its value differs
3321 from the latter directory (e.g. "/path/to/.git/config" has
3322 core.worktree set to "/different/path"), which is most likely a
3323 misconfiguration.  Running Git commands in the "/path/to" directory will
3324 still use "/different/path" as the root of the work tree and can cause
3325 confusion unless you know what you are doing (e.g. you are creating a
3326 read-only snapshot of the same index to a location different from the
3327 repository&#8217;s usual working tree).</p>
3328 </div>
3329 </dd>
3330 <dt class="hdlist1">core.logAllRefUpdates</dt>
3331 <dd>
3332 <p>Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file
3333 "<code>$GIT_DIR/logs/&lt;ref&gt;</code>", by appending the new and old
3334 SHA-1, the date/time and the reason of the update, but
3335 only when the file exists.  If this configuration
3336 variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/&lt;ref&gt;</code>"
3337 file is automatically created for branch heads (i.e. under
3338 <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
3339 note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
3340 If it is set to <code>always</code>, then a missing reflog is automatically
3341 created for any ref under <code>refs/</code>.</p>
3342 <div class="paragraph">
3343 <p>This information can be used to determine what commit
3344 was the tip of a branch "2 days ago".</p>
3345 </div>
3346 <div class="paragraph">
3347 <p>This value is true by default in a repository that has
3348 a working directory associated with it, and false by
3349 default in a bare repository.</p>
3350 </div>
3351 </dd>
3352 <dt class="hdlist1">core.repositoryFormatVersion</dt>
3353 <dd>
3354 <p>Internal variable identifying the repository format and layout
3355 version.</p>
3356 </dd>
3357 <dt class="hdlist1">core.sharedRepository</dt>
3358 <dd>
3359 <p>When <em>group</em> (or <em>true</em>), the repository is made shareable between
3360 several users in a group (making sure all the files and objects are
3361 group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
3362 repository will be readable by all users, additionally to being
3363 group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
3364 reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
3365 files in the repository will have this mode value. <em>0xxx</em> will override
3366 user&#8217;s umask value (whereas the other options will only override
3367 requested parts of the user&#8217;s umask value). Examples: <em>0660</em> will make
3368 the repo read/write-able for the owner and group, but inaccessible to
3369 others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
3370 repository that is group-readable but not group-writable.
3371 See <a href="git-init.html">git-init(1)</a>. False by default.</p>
3372 </dd>
3373 <dt class="hdlist1">core.warnAmbiguousRefs</dt>
3374 <dd>
3375 <p>If true, Git will warn you if the ref name you passed it is ambiguous
3376 and might match multiple refs in the repository. True by default.</p>
3377 </dd>
3378 <dt class="hdlist1">core.compression</dt>
3379 <dd>
3380 <p>An integer -1..9, indicating a default compression level.
3381 -1 is the zlib default. 0 means no compression,
3382 and 1..9 are various speed/size tradeoffs, 9 being slowest.
3383 If set, this provides a default to other compression variables,
3384 such as <code>core.looseCompression</code> and <code>pack.compression</code>.</p>
3385 </dd>
3386 <dt class="hdlist1">core.looseCompression</dt>
3387 <dd>
3388 <p>An integer -1..9, indicating the compression level for objects that
3389 are not in a pack file. -1 is the zlib default. 0 means no
3390 compression, and 1..9 are various speed/size tradeoffs, 9 being
3391 slowest.  If not set,  defaults to core.compression.  If that is
3392 not set,  defaults to 1 (best speed).</p>
3393 </dd>
3394 <dt class="hdlist1">core.packedGitWindowSize</dt>
3395 <dd>
3396 <p>Number of bytes of a pack file to map into memory in a
3397 single mapping operation.  Larger window sizes may allow
3398 your system to process a smaller number of large pack files
3399 more quickly.  Smaller window sizes will negatively affect
3400 performance due to increased calls to the operating system&#8217;s
3401 memory manager, but may improve performance when accessing
3402 a large number of large pack files.</p>
3403 <div class="paragraph">
3404 <p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
3405 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
3406 be reasonable for all users/operating systems.  You probably do
3407 not need to adjust this value.</p>
3408 </div>
3409 <div class="paragraph">
3410 <p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
3411 </div>
3412 </dd>
3413 <dt class="hdlist1">core.packedGitLimit</dt>
3414 <dd>
3415 <p>Maximum number of bytes to map simultaneously into memory
3416 from pack files.  If Git needs to access more than this many
3417 bytes at once to complete an operation it will unmap existing
3418 regions to reclaim virtual address space within the process.</p>
3419 <div class="paragraph">
3420 <p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
3421 unlimited) on 64 bit platforms.
3422 This should be reasonable for all users/operating systems, except on
3423 the largest projects.  You probably do not need to adjust this value.</p>
3424 </div>
3425 <div class="paragraph">
3426 <p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
3427 </div>
3428 </dd>
3429 <dt class="hdlist1">core.deltaBaseCacheLimit</dt>
3430 <dd>
3431 <p>Maximum number of bytes per thread to reserve for caching base objects
3432 that may be referenced by multiple deltified objects.  By storing the
3433 entire decompressed base objects in a cache Git is able
3434 to avoid unpacking and decompressing frequently used base
3435 objects multiple times.</p>
3436 <div class="paragraph">
3437 <p>Default is 96 MiB on all platforms.  This should be reasonable
3438 for all users/operating systems, except on the largest projects.
3439 You probably do not need to adjust this value.</p>
3440 </div>
3441 <div class="paragraph">
3442 <p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
3443 </div>
3444 </dd>
3445 <dt class="hdlist1">core.bigFileThreshold</dt>
3446 <dd>
3447 <p>The size of files considered "big", which as discussed below
3448 changes the behavior of numerous git commands, as well as how
3449 such files are stored within the repository. The default is
3450 512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
3451 supported.</p>
3452 <div class="paragraph">
3453 <p>Files above the configured limit will be:</p>
3454 </div>
3455 <div class="ulist">
3456 <ul>
3457 <li>
3458 <p>Stored deflated in packfiles, without attempting delta compression.</p>
3459 <div class="paragraph">
3460 <p>The default limit is primarily set with this use-case in mind. With it,
3461 most projects will have their source code and other text files delta
3462 compressed, but not larger binary media files.</p>
3463 </div>
3464 <div class="paragraph">
3465 <p>Storing large files without delta compression avoids excessive memory
3466 usage, at the slight expense of increased disk usage.</p>
3467 </div>
3468 </li>
3469 <li>
3470 <p>Will be treated as if they were labeled "binary" (see
3471 <a href="gitattributes.html">gitattributes(5)</a>). e.g. <a href="git-log.html">git-log(1)</a> and
3472 <a href="git-diff.html">git-diff(1)</a> will not compute diffs for files above this limit.</p>
3473 </li>
3474 <li>
3475 <p>Will generally be streamed when written, which avoids excessive
3476 memory usage, at the cost of some fixed overhead. Commands that make
3477 use of this include <a href="git-archive.html">git-archive(1)</a>,
3478 <a href="git-fast-import.html">git-fast-import(1)</a>, <a href="git-index-pack.html">git-index-pack(1)</a>,
3479 <a href="git-unpack-objects.html">git-unpack-objects(1)</a> and <a href="git-fsck.html">git-fsck(1)</a>.</p>
3480 </li>
3481 </ul>
3482 </div>
3483 </dd>
3484 <dt class="hdlist1">core.excludesFile</dt>
3485 <dd>
3486 <p>Specifies the pathname to the file that contains patterns to
3487 describe paths that are not meant to be tracked, in addition
3488 to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
3489 Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
3490 If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
3491 is used instead. See <a href="gitignore.html">gitignore(5)</a>.</p>
3492 </dd>
3493 <dt class="hdlist1">core.askPass</dt>
3494 <dd>
3495 <p>Some commands (e.g. svn and http interfaces) that interactively
3496 ask for a password can be told to use an external program given
3497 via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
3498 environment variable. If not set, fall back to the value of the
3499 <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
3500 prompt. The external program shall be given a suitable prompt as
3501 command-line argument and write the password on its STDOUT.</p>
3502 </dd>
3503 <dt class="hdlist1">core.attributesFile</dt>
3504 <dd>
3505 <p>In addition to <code>.gitattributes</code> (per-directory) and
3506 <code>.git/info/attributes</code>, Git looks into this file for attributes
3507 (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same
3508 way as for <code>core.excludesFile</code>. Its default value is
3509 <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
3510 set or empty, <code>$HOME/.config/git/attributes</code> is used instead.</p>
3511 </dd>
3512 <dt class="hdlist1">core.hooksPath</dt>
3513 <dd>
3514 <p>By default Git will look for your hooks in the
3515 <code>$GIT_DIR/hooks</code> directory. Set this to different path,
3516 e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
3517 that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
3518 in <code>$GIT_DIR/hooks/pre-receive</code>.</p>
3519 <div class="paragraph">
3520 <p>The path can be either absolute or relative. A relative path is
3521 taken as relative to the directory where the hooks are run (see
3522 the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p>
3523 </div>
3524 <div class="paragraph">
3525 <p>This configuration variable is useful in cases where you&#8217;d like to
3526 centrally configure your Git hooks instead of configuring them on a
3527 per-repository basis, or as a more flexible and centralized
3528 alternative to having an <code>init.templateDir</code> where you&#8217;ve changed
3529 default hooks.</p>
3530 </div>
3531 </dd>
3532 <dt class="hdlist1">core.editor</dt>
3533 <dd>
3534 <p>Commands such as <code>commit</code> and <code>tag</code> that let you edit
3535 messages by launching an editor use the value of this
3536 variable when it is set, and the environment variable
3537 <code>GIT_EDITOR</code> is not set.  See <a href="git-var.html">git-var(1)</a>.</p>
3538 </dd>
3539 <dt class="hdlist1">core.commentChar</dt>
3540 <dt class="hdlist1">core.commentString</dt>
3541 <dd>
3542 <p>Commands such as <code>commit</code> and <code>tag</code> that let you edit
3543 messages consider a line that begins with this character
3544 commented, and removes them after the editor returns
3545 (default <em>#</em>).</p>
3546 <div class="paragraph">
3547 <p>If set to "auto", <code>git-commit</code> would select a character that is not
3548 the beginning character of any line in existing commit messages.</p>
3549 </div>
3550 <div class="paragraph">
3551 <p>Note that these two variables are aliases of each other, and in modern
3552 versions of Git you are free to use a string (e.g., <code>//</code> or <code>⁑⁕⁑</code>) with
3553 <code>commentChar</code>. Versions of Git prior to v2.45.0 will ignore
3554 <code>commentString</code> but will reject a value of <code>commentChar</code> that consists
3555 of more than a single ASCII byte. If you plan to use your config with
3556 older and newer versions of Git, you may want to specify both:</p>
3557 </div>
3558 <div class="literalblock">
3559 <div class="content">
3560 <pre>[core]
3561 # single character for older versions
3562 commentChar = "#"
3563 # string for newer versions (which will override commentChar
3564 # because it comes later in the file)
3565 commentString = "//"</pre>
3566 </div>
3567 </div>
3568 </dd>
3569 <dt class="hdlist1">core.filesRefLockTimeout</dt>
3570 <dd>
3571 <p>The length of time, in milliseconds, to retry when trying to
3572 lock an individual reference. Value 0 means not to retry at
3573 all; -1 means to try indefinitely. Default is 100 (i.e.,
3574 retry for 100ms).</p>
3575 </dd>
3576 <dt class="hdlist1">core.packedRefsTimeout</dt>
3577 <dd>
3578 <p>The length of time, in milliseconds, to retry when trying to
3579 lock the <code>packed-refs</code> file. Value 0 means not to retry at
3580 all; -1 means to try indefinitely. Default is 1000 (i.e.,
3581 retry for 1 second).</p>
3582 </dd>
3583 <dt class="hdlist1">core.pager</dt>
3584 <dd>
3585 <p>Text viewer for use by Git commands (e.g., <em>less</em>).  The value
3586 is meant to be interpreted by the shell.  The order of preference
3587 is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
3588 configuration, then <code>$PAGER</code>, and then the default chosen at
3589 compile time (usually <em>less</em>).</p>
3590 <div class="paragraph">
3591 <p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
3592 (if <code>LESS</code> environment variable is set, Git does not change it at
3593 all).  If you want to selectively override Git&#8217;s default setting
3594 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>.  This will
3595 be passed to the shell by Git, which will translate the final
3596 command to <code>LESS=FRX less -S</code>. The environment does not set the
3597 <code>S</code> option but the command line does, instructing less to truncate
3598 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
3599 deactivate the <code>F</code> option specified by the environment from the
3600 command-line, deactivating the "quit if one screen" behavior of
3601 <code>less</code>.  One can specifically activate some flags for particular
3602 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
3603 line truncation only for <code>git blame</code>.</p>
3604 </div>
3605 <div class="paragraph">
3606 <p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
3607 to <code>-c</code>.  You can override this setting by exporting <code>LV</code> with
3608 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p>
3609 </div>
3610 </dd>
3611 <dt class="hdlist1">core.whitespace</dt>
3612 <dd>
3613 <p>A comma separated list of common whitespace problems to
3614 notice.  <em>git diff</em> will use <code>color.diff.whitespace</code> to
3615 highlight them, and <em>git apply --whitespace=error</em> will
3616 consider them as errors.  You can prefix <code>-</code> to disable
3617 any of them (e.g. <code>-trailing-space</code>):</p>
3618 <div class="ulist">
3619 <ul>
3620 <li>
3621 <p><code>blank-at-eol</code> treats trailing whitespaces at the end of the line
3622 as an error (enabled by default).</p>
3623 </li>
3624 <li>
3625 <p><code>space-before-tab</code> treats a space character that appears immediately
3626 before a tab character in the initial indent part of the line as an
3627 error (enabled by default).</p>
3628 </li>
3629 <li>
3630 <p><code>indent-with-non-tab</code> treats a line that is indented with space
3631 characters instead of the equivalent tabs as an error (not enabled by
3632 default).</p>
3633 </li>
3634 <li>
3635 <p><code>tab-in-indent</code> treats a tab character in the initial indent part of
3636 the line as an error (not enabled by default).</p>
3637 </li>
3638 <li>
3639 <p><code>blank-at-eof</code> treats blank lines added at the end of file as an error
3640 (enabled by default).</p>
3641 </li>
3642 <li>
3643 <p><code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
3644 <code>blank-at-eof</code>.</p>
3645 </li>
3646 <li>
3647 <p><code>cr-at-eol</code> treats a carriage-return at the end of line as
3648 part of the line terminator, i.e. with it, <code>trailing-space</code>
3649 does not trigger if the character before such a carriage-return
3650 is not a whitespace (not enabled by default).</p>
3651 </li>
3652 <li>
3653 <p><code>tabwidth=&lt;n&gt;</code> tells how many character positions a tab occupies; this
3654 is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
3655 errors. The default tab width is 8. Allowed values are 1 to 63.</p>
3656 </li>
3657 </ul>
3658 </div>
3659 </dd>
3660 <dt class="hdlist1">core.fsync</dt>
3661 <dd>
3662 <p>A comma-separated list of components of the repository that
3663 should be hardened via the core.fsyncMethod when created or
3664 modified.  You can disable hardening of any component by
3665 prefixing it with a <em>-</em>.  Items that are not hardened may be
3666 lost in the event of an unclean system shutdown. Unless you
3667 have special requirements, it is recommended that you leave
3668 this option empty or pick one of <code>committed</code>, <code>added</code>,
3669 or <code>all</code>.</p>
3670 <div class="paragraph">
3671 <p>When this configuration is encountered, the set of components starts with
3672 the platform default value, disabled components are removed, and additional
3673 components are added. <code>none</code> resets the state so that the platform default
3674 is ignored.</p>
3675 </div>
3676 <div class="paragraph">
3677 <p>The empty string resets the fsync configuration to the platform
3678 default. The default on most platforms is equivalent to
3679 <code>core.fsync=committed,-loose-object</code>, which has good performance,
3680 but risks losing recent work in the event of an unclean system shutdown.</p>
3681 </div>
3682 <div class="ulist">
3683 <ul>
3684 <li>
3685 <p><code>none</code> clears the set of fsynced components.</p>
3686 </li>
3687 <li>
3688 <p><code>loose-object</code> hardens objects added to the repo in loose-object form.</p>
3689 </li>
3690 <li>
3691 <p><code>pack</code> hardens objects added to the repo in packfile form.</p>
3692 </li>
3693 <li>
3694 <p><code>pack-metadata</code> hardens packfile bitmaps and indexes.</p>
3695 </li>
3696 <li>
3697 <p><code>commit-graph</code> hardens the commit-graph file.</p>
3698 </li>
3699 <li>
3700 <p><code>index</code> hardens the index when it is modified.</p>
3701 </li>
3702 <li>
3703 <p><code>objects</code> is an aggregate option that is equivalent to
3704 <code>loose-object,pack</code>.</p>
3705 </li>
3706 <li>
3707 <p><code>reference</code> hardens references modified in the repo.</p>
3708 </li>
3709 <li>
3710 <p><code>derived-metadata</code> is an aggregate option that is equivalent to
3711 <code>pack-metadata,commit-graph</code>.</p>
3712 </li>
3713 <li>
3714 <p><code>committed</code> is an aggregate option that is currently equivalent to
3715 <code>objects</code>. This mode sacrifices some performance to ensure that work
3716 that is committed to the repository with <code>git commit</code> or similar commands
3717 is hardened.</p>
3718 </li>
3719 <li>
3720 <p><code>added</code> is an aggregate option that is currently equivalent to
3721 <code>committed,index</code>. This mode sacrifices additional performance to
3722 ensure that the results of commands like <code>git add</code> and similar operations
3723 are hardened.</p>
3724 </li>
3725 <li>
3726 <p><code>all</code> is an aggregate option that syncs all individual components above.</p>
3727 </li>
3728 </ul>
3729 </div>
3730 </dd>
3731 <dt class="hdlist1">core.fsyncMethod</dt>
3732 <dd>
3733 <p>A value indicating the strategy Git will use to harden repository data
3734 using fsync and related primitives.</p>
3735 <div class="ulist">
3736 <ul>
3737 <li>
3738 <p><code>fsync</code> uses the fsync() system call or platform equivalents.</p>
3739 </li>
3740 <li>
3741 <p><code>writeout-only</code> issues pagecache writeback requests, but depending on the
3742 filesystem and storage hardware, data added to the repository may not be
3743 durable in the event of a system crash. This is the default mode on macOS.</p>
3744 </li>
3745 <li>
3746 <p><code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
3747 updates in the disk writeback cache and then does a single full fsync of
3748 a dummy file to trigger the disk cache flush at the end of the operation.</p>
3749 <div class="paragraph">
3750 <p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
3751 data is made durable as if <code>fsync</code> was specified. This mode is expected to
3752 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
3753 and on Windows for repos stored on NTFS or ReFS filesystems.</p>
3754 </div>
3755 </li>
3756 </ul>
3757 </div>
3758 </dd>
3759 <dt class="hdlist1">core.fsyncObjectFiles</dt>
3760 <dd>
3761 <p>This boolean will enable <em>fsync()</em> when writing object files.
3762 This setting is deprecated. Use core.fsync instead.</p>
3763 <div class="paragraph">
3764 <p>This setting affects data added to the Git repository in loose-object
3765 form. When set to true, Git will issue an fsync or similar system call
3766 to flush caches so that loose-objects remain consistent in the face
3767 of a unclean system shutdown.</p>
3768 </div>
3769 </dd>
3770 <dt class="hdlist1">core.preloadIndex</dt>
3771 <dd>
3772 <p>Enable parallel index preload for operations like <em>git diff</em></p>
3773 <div class="paragraph">
3774 <p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
3775 on filesystems like NFS that have weak caching semantics and thus
3776 relatively high IO latencies.  When enabled, Git will do the
3777 index comparison to the filesystem data in parallel, allowing
3778 overlapping IO&#8217;s.  Defaults to true.</p>
3779 </div>
3780 </dd>
3781 <dt class="hdlist1">core.unsetenvvars</dt>
3782 <dd>
3783 <p>Windows-only: comma-separated list of environment variables'
3784 names that need to be unset before spawning any other process.
3785 Defaults to <code>PERL5LIB</code> to account for the fact that Git for
3786 Windows insists on using its own Perl interpreter.</p>
3787 </dd>
3788 <dt class="hdlist1">core.restrictinheritedhandles</dt>
3789 <dd>
3790 <p>Windows-only: override whether spawned processes inherit only standard
3791 file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
3792 <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
3793 Windows 7 and later, and <code>false</code> on older Windows versions.</p>
3794 </dd>
3795 <dt class="hdlist1">core.createObject</dt>
3796 <dd>
3797 <p>You can set this to <em>link</em>, in which case a hardlink followed by
3798 a delete of the source are used to make sure that object creation
3799 will not overwrite existing objects.</p>
3800 <div class="paragraph">
3801 <p>On some file system/operating system combinations, this is unreliable.
3802 Set this config setting to <em>rename</em> there; however, this will remove the
3803 check that makes sure that existing object files will not get overwritten.</p>
3804 </div>
3805 </dd>
3806 <dt class="hdlist1">core.notesRef</dt>
3807 <dd>
3808 <p>When showing commit messages, also show notes which are stored in
3809 the given ref.  The ref must be fully qualified.  If the given
3810 ref does not exist, it is not an error but means that no
3811 notes should be printed.</p>
3812 <div class="paragraph">
3813 <p>This setting defaults to "refs/notes/commits", and it can be overridden by
3814 the <code>GIT_NOTES_REF</code> environment variable.  See <a href="git-notes.html">git-notes(1)</a>.</p>
3815 </div>
3816 </dd>
3817 <dt class="hdlist1">core.commitGraph</dt>
3818 <dd>
3819 <p>If true, then git will read the commit-graph file (if it exists)
3820 to parse the graph structure of commits. Defaults to true. See
3821 <a href="git-commit-graph.html">git-commit-graph(1)</a> for more information.</p>
3822 </dd>
3823 <dt class="hdlist1">core.useReplaceRefs</dt>
3824 <dd>
3825 <p>If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
3826 option was given on the command line. See <a href="git.html">git(1)</a> and
3827 <a href="git-replace.html">git-replace(1)</a> for more information.</p>
3828 </dd>
3829 <dt class="hdlist1">core.multiPackIndex</dt>
3830 <dd>
3831 <p>Use the multi-pack-index file to track multiple packfiles using a
3832 single index. See <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a> for more
3833 information. Defaults to true.</p>
3834 </dd>
3835 <dt class="hdlist1">core.sparseCheckout</dt>
3836 <dd>
3837 <p>Enable "sparse checkout" feature. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>
3838 for more information.</p>
3839 </dd>
3840 <dt class="hdlist1">core.sparseCheckoutCone</dt>
3841 <dd>
3842 <p>Enables the "cone mode" of the sparse checkout feature. When the
3843 sparse-checkout file contains a limited set of patterns, this
3844 mode provides significant performance advantages. The "non-cone
3845 mode" can be requested to allow specifying more flexible
3846 patterns by setting this variable to <em>false</em>. See
3847 <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more information.</p>
3848 </dd>
3849 <dt class="hdlist1">core.abbrev</dt>
3850 <dd>
3851 <p>Set the length object names are abbreviated to.  If
3852 unspecified or set to "auto", an appropriate value is
3853 computed based on the approximate number of packed objects
3854 in your repository, which hopefully is enough for
3855 abbreviated object names to stay unique for some time.
3856 If set to "no", no abbreviation is made and the object names
3857 are shown in their full length.
3858 The minimum length is 4.</p>
3859 </dd>
3860 <dt class="hdlist1">core.maxTreeDepth</dt>
3861 <dd>
3862 <p>The maximum depth Git is willing to recurse while traversing a
3863 tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe
3864 to allow Git to abort cleanly, and should not generally need to
3865 be adjusted. When Git is compiled with MSVC, the default is 512.
3866 Otherwise, the default is 2048.</p>
3867 </dd>
3868 <dt class="hdlist1">credential.helper</dt>
3869 <dd>
3870 <p>Specify an external helper to be called when a username or
3871 password credential is needed; the helper may consult external
3872 storage to avoid prompting the user for the credentials. This is
3873 normally the name of a credential helper with possible
3874 arguments, but may also be an absolute path with arguments or, if
3875 preceded by <code>!</code>, shell commands.</p>
3876 <div class="paragraph">
3877 <p>Note that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a>
3878 for details and examples.</p>
3879 </div>
3880 </dd>
3881 <dt class="hdlist1">credential.interactive</dt>
3882 <dd>
3883 <p>By default, Git and any configured credential helpers will ask for
3884 user input when new credentials are required. Many of these helpers
3885 will succeed based on stored credentials if those credentials are
3886 still valid. To avoid the possibility of user interactivity from
3887 Git, set <code>credential.interactive=false</code>. Some credential helpers
3888 respect this option as well.</p>
3889 </dd>
3890 <dt class="hdlist1">credential.useHttpPath</dt>
3891 <dd>
3892 <p>When acquiring credentials, consider the "path" component of an http
3893 or https URL to be important. Defaults to false. See
3894 <a href="gitcredentials.html">gitcredentials(7)</a> for more information.</p>
3895 </dd>
3896 <dt class="hdlist1">credential.username</dt>
3897 <dd>
3898 <p>If no username is set for a network authentication, use this username
3899 by default. See credential.&lt;context&gt;.* below, and
3900 <a href="gitcredentials.html">gitcredentials(7)</a>.</p>
3901 </dd>
3902 <dt class="hdlist1">credential.&lt;url&gt;.*</dt>
3903 <dd>
3904 <p>Any of the credential.* options above can be applied selectively to
3905 some credentials. For example, "credential.https://example.com.username"
3906 would set the default username only for https connections to
3907 example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are
3908 matched.</p>
3909 </dd>
3910 <dt class="hdlist1">credentialCache.ignoreSIGHUP</dt>
3911 <dd>
3912 <p>Tell git-credential-cache&#8212;&#8203;daemon to ignore SIGHUP, instead of quitting.</p>
3913 </dd>
3914 <dt class="hdlist1">credentialStore.lockTimeoutMS</dt>
3915 <dd>
3916 <p>The length of time, in milliseconds, for git-credential-store to retry
3917 when trying to lock the credentials file. A value of 0 means not to retry at
3918 all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
3919 1s).</p>
3920 </dd>
3921 <dt class="hdlist1">diff.autoRefreshIndex</dt>
3922 <dd>
3923 <p>When using <em>git diff</em> to compare with work tree
3924 files, do not consider stat-only changes as changed.
3925 Instead, silently run <code>git update-index --refresh</code> to
3926 update the cached stat information for paths whose
3927 contents in the work tree match the contents in the
3928 index.  This option defaults to true.  Note that this
3929 affects only <em>git diff</em> Porcelain, and not lower level
3930 <em>diff</em> commands such as <em>git diff-files</em>.</p>
3931 </dd>
3932 <dt class="hdlist1">diff.dirstat</dt>
3933 <dd>
3934 <p>A comma separated list of <code>--dirstat</code> parameters specifying the
3935 default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>
3936 and friends. The defaults can be overridden on the command line
3937 (using <code>--dirstat=&lt;param1,param2,...&gt;</code>). The fallback defaults
3938 (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
3939 The following parameters are available:</p>
3940 <div class="openblock">
3941 <div class="content">
3942 <div class="dlist">
3943 <dl>
3944 <dt class="hdlist1"><code>changes</code></dt>
3945 <dd>
3946 <p>Compute the dirstat numbers by counting the lines that have been
3947 removed from the source, or added to the destination. This ignores
3948 the amount of pure code movements within a file.  In other words,
3949 rearranging lines in a file is not counted as much as other changes.
3950 This is the default behavior when no parameter is given.</p>
3951 </dd>
3952 <dt class="hdlist1"><code>lines</code></dt>
3953 <dd>
3954 <p>Compute the dirstat numbers by doing the regular line-based diff
3955 analysis, and summing the removed/added line counts. (For binary
3956 files, count 64-byte chunks instead, since binary files have no
3957 natural concept of lines). This is a more expensive <code>--dirstat</code>
3958 behavior than the <code>changes</code> behavior, but it does count rearranged
3959 lines within a file as much as other changes. The resulting output
3960 is consistent with what you get from the other <code>--*stat</code> options.</p>
3961 </dd>
3962 <dt class="hdlist1"><code>files</code></dt>
3963 <dd>
3964 <p>Compute the dirstat numbers by counting the number of files changed.
3965 Each changed file counts equally in the dirstat analysis. This is
3966 the computationally cheapest <code>--dirstat</code> behavior, since it does
3967 not have to look at the file contents at all.</p>
3968 </dd>
3969 <dt class="hdlist1"><code>cumulative</code></dt>
3970 <dd>
3971 <p>Count changes in a child directory for the parent directory as well.
3972 Note that when using <code>cumulative</code>, the sum of the percentages
3973 reported may exceed 100%. The default (non-cumulative) behavior can
3974 be specified with the <code>noncumulative</code> parameter.</p>
3975 </dd>
3976 <dt class="hdlist1">&lt;limit&gt;</dt>
3977 <dd>
3978 <p>An integer parameter specifies a cut-off percent (3% by default).
3979 Directories contributing less than this percentage of the changes
3980 are not shown in the output.</p>
3981 </dd>
3982 </dl>
3983 </div>
3984 </div>
3985 </div>
3986 <div class="paragraph">
3987 <p>Example: The following will count changed files, while ignoring
3988 directories with less than 10% of the total amount of changed files,
3989 and accumulating child directory counts in the parent directories:
3990 <code>files,10,cumulative</code>.</p>
3991 </div>
3992 </dd>
3993 <dt class="hdlist1">diff.statNameWidth</dt>
3994 <dd>
3995 <p>Limit the width of the filename part in --stat output. If set, applies
3996 to all commands generating --stat output except format-patch.</p>
3997 </dd>
3998 <dt class="hdlist1">diff.statGraphWidth</dt>
3999 <dd>
4000 <p>Limit the width of the graph part in --stat output. If set, applies
4001 to all commands generating --stat output except format-patch.</p>
4002 </dd>
4003 <dt class="hdlist1">diff.context</dt>
4004 <dd>
4005 <p>Generate diffs with &lt;n&gt; lines of context instead of the default
4006 of 3. This value is overridden by the -U option.</p>
4007 </dd>
4008 <dt class="hdlist1">diff.interHunkContext</dt>
4009 <dd>
4010 <p>Show the context between diff hunks, up to the specified number
4011 of lines, thereby fusing the hunks that are close to each other.
4012 This value serves as the default for the <code>--inter-hunk-context</code>
4013 command line option.</p>
4014 </dd>
4015 <dt class="hdlist1">diff.external</dt>
4016 <dd>
4017 <p>If this config variable is set, diff generation is not
4018 performed using the internal diff machinery, but using the
4019 given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;
4020 environment variable.  The command is called with parameters
4021 as described under "git Diffs" in <a href="git.html">git(1)</a>.  Note: if
4022 you want to use an external diff program only on a subset of
4023 your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead.</p>
4024 </dd>
4025 <dt class="hdlist1">diff.trustExitCode</dt>
4026 <dd>
4027 <p>If this boolean value is set to true then the
4028 <code>diff.external</code> command is expected to return exit code
4029 0 if it considers the input files to be equal or 1 if it
4030 considers them to be different, like <code>diff(1)</code>.
4031 If it is set to false, which is the default, then the command
4032 is expected to return exit code 0 regardless of equality.
4033 Any other exit code causes Git to report a fatal error.</p>
4034 </dd>
4035 <dt class="hdlist1">diff.ignoreSubmodules</dt>
4036 <dd>
4037 <p>Sets the default value of --ignore-submodules. Note that this
4038 affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4039 commands such as <em>git diff-files</em>. <em>git checkout</em>
4040 and <em>git switch</em> also honor
4041 this setting when reporting uncommitted changes. Setting it to
4042 <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
4043 and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
4044 overridden by using the --ignore-submodules command-line option.
4045 The <em>git submodule</em> commands are not affected by this setting.
4046 By default this is set to untracked so that any untracked
4047 submodules are ignored.</p>
4048 </dd>
4049 <dt class="hdlist1">diff.mnemonicPrefix</dt>
4050 <dd>
4051 <p>If set, <em>git diff</em> uses a prefix pair that is different from the
4052 standard "a/" and "b/" depending on what is being compared.  When
4053 this configuration is in effect, reverse diff output also swaps
4054 the order of the prefixes:</p>
4055 <div class="dlist">
4056 <dl>
4057 <dt class="hdlist1"><code>git diff</code></dt>
4058 <dd>
4059 <p>compares the (i)ndex and the (w)ork tree;</p>
4060 </dd>
4061 <dt class="hdlist1"><code>git diff HEAD</code></dt>
4062 <dd>
4063 <p>compares a (c)ommit and the (w)ork tree;</p>
4064 </dd>
4065 <dt class="hdlist1"><code>git diff --cached</code></dt>
4066 <dd>
4067 <p>compares a (c)ommit and the (i)ndex;</p>
4068 </dd>
4069 <dt class="hdlist1"><code>git diff HEAD:file1 file2</code></dt>
4070 <dd>
4071 <p>compares an (o)bject and a (w)ork tree entity;</p>
4072 </dd>
4073 <dt class="hdlist1"><code>git diff --no-index a b</code></dt>
4074 <dd>
4075 <p>compares two non-git things (1) and (2).</p>
4076 </dd>
4077 </dl>
4078 </div>
4079 </dd>
4080 <dt class="hdlist1">diff.noPrefix</dt>
4081 <dd>
4082 <p>If set, <em>git diff</em> does not show any source or destination prefix.</p>
4083 </dd>
4084 <dt class="hdlist1">diff.srcPrefix</dt>
4085 <dd>
4086 <p>If set, <em>git diff</em> uses this source prefix. Defaults to "a/".</p>
4087 </dd>
4088 <dt class="hdlist1">diff.dstPrefix</dt>
4089 <dd>
4090 <p>If set, <em>git diff</em> uses this destination prefix. Defaults to "b/".</p>
4091 </dd>
4092 <dt class="hdlist1">diff.relative</dt>
4093 <dd>
4094 <p>If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
4095 and show pathnames relative to the current directory.</p>
4096 </dd>
4097 <dt class="hdlist1">diff.orderFile</dt>
4098 <dd>
4099 <p>File indicating how to order files within a diff.
4100 See the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a> for details.
4101 If <code>diff.orderFile</code> is a relative pathname, it is treated as
4102 relative to the top of the working tree.</p>
4103 </dd>
4104 <dt class="hdlist1">diff.renameLimit</dt>
4105 <dd>
4106 <p>The number of files to consider in the exhaustive portion of
4107 copy/rename detection; equivalent to the <em>git diff</em> option
4108 <code>-l</code>.  If not set, the default value is currently 1000.  This
4109 setting has no effect if rename detection is turned off.</p>
4110 </dd>
4111 <dt class="hdlist1">diff.renames</dt>
4112 <dd>
4113 <p>Whether and how Git detects renames.  If set to "false",
4114 rename detection is disabled. If set to "true", basic rename
4115 detection is enabled.  If set to "copies" or "copy", Git will
4116 detect copies, as well.  Defaults to true.  Note that this
4117 affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and
4118 <a href="git-log.html">git-log(1)</a>, and not lower level commands such as
4119 <a href="git-diff-files.html">git-diff-files(1)</a>.</p>
4120 </dd>
4121 <dt class="hdlist1">diff.suppressBlankEmpty</dt>
4122 <dd>
4123 <p>A boolean to inhibit the standard behavior of printing a space
4124 before each empty output line. Defaults to false.</p>
4125 </dd>
4126 <dt class="hdlist1">diff.submodule</dt>
4127 <dd>
4128 <p>Specify the format in which differences in submodules are
4129 shown.  The "short" format just shows the names of the commits
4130 at the beginning and end of the range. The "log" format lists
4131 the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code>
4132 does. The "diff" format shows an inline diff of the changed
4133 contents of the submodule. Defaults to "short".</p>
4134 </dd>
4135 <dt class="hdlist1">diff.wordRegex</dt>
4136 <dd>
4137 <p>A POSIX Extended Regular Expression used to determine what is a "word"
4138 when performing word-by-word difference calculations.  Character
4139 sequences that match the regular expression are "words", all other
4140 characters are <strong>ignorable</strong> whitespace.</p>
4141 </dd>
4142 <dt class="hdlist1">diff.&lt;driver&gt;.command</dt>
4143 <dd>
4144 <p>The custom diff driver command.  See <a href="gitattributes.html">gitattributes(5)</a>
4145 for details.</p>
4146 </dd>
4147 <dt class="hdlist1">diff.&lt;driver&gt;.trustExitCode</dt>
4148 <dd>
4149 <p>If this boolean value is set to true then the
4150 <code>diff.&lt;driver&gt;.command</code> command is expected to return exit code
4151 0 if it considers the input files to be equal or 1 if it
4152 considers them to be different, like <code>diff(1)</code>.
4153 If it is set to false, which is the default, then the command
4154 is expected to return exit code 0 regardless of equality.
4155 Any other exit code causes Git to report a fatal error.</p>
4156 </dd>
4157 <dt class="hdlist1">diff.&lt;driver&gt;.xfuncname</dt>
4158 <dd>
4159 <p>The regular expression that the diff driver should use to
4160 recognize the hunk header.  A built-in pattern may also be used.
4161 See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4162 </dd>
4163 <dt class="hdlist1">diff.&lt;driver&gt;.binary</dt>
4164 <dd>
4165 <p>Set this option to true to make the diff driver treat files as
4166 binary.  See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4167 </dd>
4168 <dt class="hdlist1">diff.&lt;driver&gt;.textconv</dt>
4169 <dd>
4170 <p>The command that the diff driver should call to generate the
4171 text-converted version of a file.  The result of the
4172 conversion is used to generate a human-readable diff.  See
4173 <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4174 </dd>
4175 <dt class="hdlist1">diff.&lt;driver&gt;.wordRegex</dt>
4176 <dd>
4177 <p>The regular expression that the diff driver should use to
4178 split words in a line.  See <a href="gitattributes.html">gitattributes(5)</a> for
4179 details.</p>
4180 </dd>
4181 <dt class="hdlist1">diff.&lt;driver&gt;.cachetextconv</dt>
4182 <dd>
4183 <p>Set this option to true to make the diff driver cache the text
4184 conversion outputs.  See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4185 <div class="dlist">
4186 <dl>
4187 <dt class="hdlist1"><code>araxis</code></dt>
4188 <dd>
4189 <p>Use Araxis Merge (requires a graphical session)</p>
4190 </dd>
4191 <dt class="hdlist1"><code>bc</code></dt>
4192 <dd>
4193 <p>Use Beyond Compare (requires a graphical session)</p>
4194 </dd>
4195 <dt class="hdlist1"><code>bc3</code></dt>
4196 <dd>
4197 <p>Use Beyond Compare (requires a graphical session)</p>
4198 </dd>
4199 <dt class="hdlist1"><code>bc4</code></dt>
4200 <dd>
4201 <p>Use Beyond Compare (requires a graphical session)</p>
4202 </dd>
4203 <dt class="hdlist1"><code>codecompare</code></dt>
4204 <dd>
4205 <p>Use Code Compare (requires a graphical session)</p>
4206 </dd>
4207 <dt class="hdlist1"><code>deltawalker</code></dt>
4208 <dd>
4209 <p>Use DeltaWalker (requires a graphical session)</p>
4210 </dd>
4211 <dt class="hdlist1"><code>diffmerge</code></dt>
4212 <dd>
4213 <p>Use DiffMerge (requires a graphical session)</p>
4214 </dd>
4215 <dt class="hdlist1"><code>diffuse</code></dt>
4216 <dd>
4217 <p>Use Diffuse (requires a graphical session)</p>
4218 </dd>
4219 <dt class="hdlist1"><code>ecmerge</code></dt>
4220 <dd>
4221 <p>Use ECMerge (requires a graphical session)</p>
4222 </dd>
4223 <dt class="hdlist1"><code>emerge</code></dt>
4224 <dd>
4225 <p>Use Emacs' Emerge</p>
4226 </dd>
4227 <dt class="hdlist1"><code>examdiff</code></dt>
4228 <dd>
4229 <p>Use ExamDiff Pro (requires a graphical session)</p>
4230 </dd>
4231 <dt class="hdlist1"><code>guiffy</code></dt>
4232 <dd>
4233 <p>Use Guiffy&#8217;s Diff Tool (requires a graphical session)</p>
4234 </dd>
4235 <dt class="hdlist1"><code>gvimdiff</code></dt>
4236 <dd>
4237 <p>Use gVim (requires a graphical session)</p>
4238 </dd>
4239 <dt class="hdlist1"><code>kdiff3</code></dt>
4240 <dd>
4241 <p>Use KDiff3 (requires a graphical session)</p>
4242 </dd>
4243 <dt class="hdlist1"><code>kompare</code></dt>
4244 <dd>
4245 <p>Use Kompare (requires a graphical session)</p>
4246 </dd>
4247 <dt class="hdlist1"><code>meld</code></dt>
4248 <dd>
4249 <p>Use Meld (requires a graphical session)</p>
4250 </dd>
4251 <dt class="hdlist1"><code>nvimdiff</code></dt>
4252 <dd>
4253 <p>Use Neovim</p>
4254 </dd>
4255 <dt class="hdlist1"><code>opendiff</code></dt>
4256 <dd>
4257 <p>Use FileMerge (requires a graphical session)</p>
4258 </dd>
4259 <dt class="hdlist1"><code>p4merge</code></dt>
4260 <dd>
4261 <p>Use HelixCore P4Merge (requires a graphical session)</p>
4262 </dd>
4263 <dt class="hdlist1"><code>smerge</code></dt>
4264 <dd>
4265 <p>Use Sublime Merge (requires a graphical session)</p>
4266 </dd>
4267 <dt class="hdlist1"><code>tkdiff</code></dt>
4268 <dd>
4269 <p>Use TkDiff (requires a graphical session)</p>
4270 </dd>
4271 <dt class="hdlist1"><code>vimdiff</code></dt>
4272 <dd>
4273 <p>Use Vim</p>
4274 </dd>
4275 <dt class="hdlist1"><code>vscode</code></dt>
4276 <dd>
4277 <p>Use Visual Studio Code (requires a graphical session)</p>
4278 </dd>
4279 <dt class="hdlist1"><code>winmerge</code></dt>
4280 <dd>
4281 <p>Use WinMerge (requires a graphical session)</p>
4282 </dd>
4283 <dt class="hdlist1"><code>xxdiff</code></dt>
4284 <dd>
4285 <p>Use xxdiff (requires a graphical session)</p>
4286 </dd>
4287 </dl>
4288 </div>
4289 </dd>
4290 <dt class="hdlist1">diff.indentHeuristic</dt>
4291 <dd>
4292 <p>Set this option to <code>false</code> to disable the default heuristics
4293 that shift diff hunk boundaries to make patches easier to read.</p>
4294 </dd>
4295 <dt class="hdlist1">diff.algorithm</dt>
4296 <dd>
4297 <p>Choose a diff algorithm.  The variants are as follows:</p>
4298 <div class="openblock">
4299 <div class="content">
4300 <div class="dlist">
4301 <dl>
4302 <dt class="hdlist1"><code>default</code>, <code>myers</code></dt>
4303 <dd>
4304 <p>The basic greedy diff algorithm. Currently, this is the default.</p>
4305 </dd>
4306 <dt class="hdlist1"><code>minimal</code></dt>
4307 <dd>
4308 <p>Spend extra time to make sure the smallest possible diff is
4309 produced.</p>
4310 </dd>
4311 <dt class="hdlist1"><code>patience</code></dt>
4312 <dd>
4313 <p>Use "patience diff" algorithm when generating patches.</p>
4314 </dd>
4315 <dt class="hdlist1"><code>histogram</code></dt>
4316 <dd>
4317 <p>This algorithm extends the patience algorithm to "support
4318 low-occurrence common elements".</p>
4319 </dd>
4320 </dl>
4321 </div>
4322 </div>
4323 </div>
4324 </dd>
4325 <dt class="hdlist1">diff.wsErrorHighlight</dt>
4326 <dd>
4327 <p>Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
4328 lines of the diff.  Multiple values are separated by comma,
4329 <code>none</code> resets previous values, <code>default</code> reset the list to
4330 <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>.  The
4331 whitespace errors are colored with <code>color.diff.whitespace</code>.
4332 The command line option <code>--ws-error-highlight=&lt;kind&gt;</code>
4333 overrides this setting.</p>
4334 </dd>
4335 <dt class="hdlist1">diff.colorMoved</dt>
4336 <dd>
4337 <p>If set to either a valid <code>&lt;mode&gt;</code> or a true value, moved lines
4338 in a diff are colored differently, for details of valid modes
4339 see <em>--color-moved</em> in <a href="git-diff.html">git-diff(1)</a>. If simply set to
4340 true the default color mode will be used. When set to false,
4341 moved lines are not colored.</p>
4342 </dd>
4343 <dt class="hdlist1">diff.colorMovedWS</dt>
4344 <dd>
4345 <p>When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
4346 this option controls the <code>&lt;mode&gt;</code> how spaces are treated.
4347 For details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html">git-diff(1)</a>.</p>
4348 </dd>
4349 <dt class="hdlist1">diff.tool</dt>
4350 <dd>
4351 <p>Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
4352 This variable overrides the value configured in <code>merge.tool</code>.
4353 The list below shows the valid built-in values.
4354 Any other value is treated as a custom diff tool and requires
4355 that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.</p>
4356 </dd>
4357 <dt class="hdlist1">diff.guitool</dt>
4358 <dd>
4359 <p>Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
4360 the -g/--gui flag is specified. This variable overrides the value
4361 configured in <code>merge.guitool</code>. The list below shows the valid
4362 built-in values. Any other value is treated as a custom diff tool
4363 and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
4364 is defined.</p>
4365 </dd>
4366 <dt class="hdlist1">difftool.&lt;tool&gt;.cmd</dt>
4367 <dd>
4368 <p>Specify the command to invoke the specified diff tool.
4369 The specified command is evaluated in shell with the following
4370 variables available:  <em>LOCAL</em> is set to the name of the temporary
4371 file containing the contents of the diff pre-image and <em>REMOTE</em>
4372 is set to the name of the temporary file containing the contents
4373 of the diff post-image.</p>
4374 <div class="paragraph">
4375 <p>See the <code>--tool=&lt;tool&gt;</code> option in <a href="git-difftool.html">git-difftool(1)</a> for more details.</p>
4376 </div>
4377 </dd>
4378 <dt class="hdlist1">difftool.&lt;tool&gt;.path</dt>
4379 <dd>
4380 <p>Override the path for the given tool.  This is useful in case
4381 your tool is not in the PATH.</p>
4382 </dd>
4383 <dt class="hdlist1">difftool.trustExitCode</dt>
4384 <dd>
4385 <p>Exit difftool if the invoked diff tool returns a non-zero exit status.</p>
4386 <div class="paragraph">
4387 <p>See the <code>--trust-exit-code</code> option in <a href="git-difftool.html">git-difftool(1)</a> for more details.</p>
4388 </div>
4389 </dd>
4390 <dt class="hdlist1">difftool.prompt</dt>
4391 <dd>
4392 <p>Prompt before each invocation of the diff tool.</p>
4393 </dd>
4394 <dt class="hdlist1">difftool.guiDefault</dt>
4395 <dd>
4396 <p>Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
4397 the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
4398 depending on the presence of a <code>DISPLAY</code> environment variable value. The
4399 default is <code>false</code>, where the <code>--gui</code> argument must be provided
4400 explicitly for the <code>diff.guitool</code> to be used.</p>
4401 </dd>
4402 <dt class="hdlist1">extensions.objectFormat</dt>
4403 <dd>
4404 <p>Specify the hash algorithm to use.  The acceptable values are <code>sha1</code> and
4405 <code>sha256</code>.  If not specified, <code>sha1</code> is assumed.  It is an error to specify
4406 this key unless <code>core.repositoryFormatVersion</code> is 1.</p>
4407 <div class="paragraph">
4408 <p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
4409 <a href="git-clone.html">git-clone(1)</a>.  Trying to change it after initialization will not
4410 work and will produce hard-to-diagnose issues.</p>
4411 </div>
4412 </dd>
4413 <dt class="hdlist1">extensions.compatObjectFormat</dt>
4414 <dd>
4415 <p>Specify a compatitbility hash algorithm to use.  The acceptable values
4416 are <code>sha1</code> and <code>sha256</code>.  The value specified must be different from the
4417 value of extensions.objectFormat.  This allows client level
4418 interoperability between git repositories whose objectFormat matches
4419 this compatObjectFormat.  In particular when fully implemented the
4420 pushes and pulls from a repository in whose objectFormat matches
4421 compatObjectFormat.  As well as being able to use oids encoded in
4422 compatObjectFormat in addition to oids encoded with objectFormat to
4423 locally specify objects.</p>
4424 </dd>
4425 <dt class="hdlist1">extensions.refStorage</dt>
4426 <dd>
4427 <p>Specify the ref storage format to use. The acceptable values are:</p>
4428 <div class="ulist">
4429 <ul>
4430 <li>
4431 <p><code>files</code> for loose files with packed-refs. This is the default.</p>
4432 </li>
4433 <li>
4434 <p><code>reftable</code> for the reftable format. This format is experimental and its
4435 internals are subject to change.</p>
4436 <div class="paragraph">
4437 <p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p>
4438 </div>
4439 <div class="paragraph">
4440 <p>Note that this setting should only be set by <a href="git-init.html">git-init(1)</a> or
4441 <a href="git-clone.html">git-clone(1)</a>. Trying to change it after initialization will not
4442 work and will produce hard-to-diagnose issues.</p>
4443 </div>
4444 </li>
4445 </ul>
4446 </div>
4447 </dd>
4448 <dt class="hdlist1">extensions.worktreeConfig</dt>
4449 <dd>
4450 <p>If enabled, then worktrees will load config settings from the
4451 <code>$GIT_DIR/config.worktree</code> file in addition to the
4452 <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
4453 <code>$GIT_DIR</code> are the same for the main working tree, while other
4454 working trees have <code>$GIT_DIR</code> equal to
4455 <code>$GIT_COMMON_DIR/worktrees/&lt;id&gt;/</code>. The settings in the
4456 <code>config.worktree</code> file will override settings from any other
4457 config files.</p>
4458 <div class="paragraph">
4459 <p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
4460 certain values from the common config file to the main working tree&#8217;s
4461 <code>config.worktree</code> file, if present:</p>
4462 </div>
4463 <div class="ulist">
4464 <ul>
4465 <li>
4466 <p><code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
4467 <code>$GIT_COMMON_DIR/config.worktree</code>.</p>
4468 </li>
4469 <li>
4470 <p>If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
4471 to <code>$GIT_COMMON_DIR/config.worktree</code>.</p>
4472 <div class="paragraph">
4473 <p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
4474 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
4475 sparse-checkout settings for each worktree. By default, the <code>git
4476 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
4477 these config values on a per-worktree basis, and uses the
4478 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
4479 worktree independently. See <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more
4480 details.</p>
4481 </div>
4482 <div class="paragraph">
4483 <p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
4484 regardless of the <code>core.repositoryFormatVersion</code> setting.</p>
4485 </div>
4486 </li>
4487 </ul>
4488 </div>
4489 </dd>
4490 <dt class="hdlist1">fastimport.unpackLimit</dt>
4491 <dd>
4492 <p>If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
4493 is below this limit, then the objects will be unpacked into
4494 loose object files.  However, if the number of imported objects
4495 equals or exceeds this limit, then the pack will be stored as a
4496 pack.  Storing the pack from a fast-import can make the import
4497 operation complete faster, especially on slow filesystems.  If
4498 not set, the value of <code>transfer.unpackLimit</code> is used instead.</p>
4499 </dd>
4500 <dt class="hdlist1">feature.*</dt>
4501 <dd>
4502 <p>The config settings that start with <code>feature.</code> modify the defaults of
4503 a group of other config settings. These groups are created by the Git
4504 developer community as recommended defaults and are subject to change.
4505 In particular, new config options may be added with different defaults.</p>
4506 </dd>
4507 <dt class="hdlist1">feature.experimental</dt>
4508 <dd>
4509 <p>Enable config options that are new to Git, and are being considered for
4510 future defaults. Config settings included here may be added or removed
4511 with each release, including minor version updates. These settings may
4512 have unintended interactions since they are so new. Please enable this
4513 setting if you are interested in providing feedback on experimental
4514 features. The new default values are:</p>
4515 <div class="ulist">
4516 <ul>
4517 <li>
4518 <p><code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
4519 skipping more commits at a time, reducing the number of round trips.</p>
4520 </li>
4521 <li>
4522 <p><code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
4523 walking fewer objects.</p>
4524 </li>
4525 <li>
4526 <p><code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
4527 reusing objects from multiple packs instead of just one.</p>
4528 </li>
4529 </ul>
4530 </div>
4531 </dd>
4532 <dt class="hdlist1">feature.manyFiles</dt>
4533 <dd>
4534 <p>Enable config options that optimize for repos with many files in the
4535 working directory. With many files, commands such as <code>git status</code> and
4536 <code>git checkout</code> may be slow and these new defaults improve performance:</p>
4537 <div class="ulist">
4538 <ul>
4539 <li>
4540 <p><code>index.skipHash=true</code> speeds up index writes by not computing a trailing
4541 checksum. Note that this will cause Git versions earlier than 2.13.0 to
4542 refuse to parse the index and Git versions earlier than 2.40.0 will report
4543 a corrupted index during <code>git fsck</code>.</p>
4544 </li>
4545 <li>
4546 <p><code>index.version=4</code> enables path-prefix compression in the index.</p>
4547 </li>
4548 <li>
4549 <p><code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
4550 that mtime is working on your machine.</p>
4551 </li>
4552 </ul>
4553 </div>
4554 </dd>
4555 <dt class="hdlist1">fetch.recurseSubmodules</dt>
4556 <dd>
4557 <p>This option controls whether <code>git fetch</code> (and the underlying fetch
4558 in <code>git pull</code>) will recursively fetch into populated submodules.
4559 This option can be set either to a boolean value or to <em>on-demand</em>.
4560 Setting it to a boolean changes the behavior of fetch and pull to
4561 recurse unconditionally into submodules when set to true or to not
4562 recurse at all when set to false. When set to <em>on-demand</em>, fetch and
4563 pull will only recurse into a populated submodule when its
4564 superproject retrieves a commit that updates the submodule&#8217;s
4565 reference.
4566 Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.</p>
4567 </dd>
4568 <dt class="hdlist1">fetch.fsckObjects</dt>
4569 <dd>
4570 <p>If it is set to true, git-fetch-pack will check all fetched
4571 objects. See <code>transfer.fsckObjects</code> for what&#8217;s
4572 checked. Defaults to false. If not set, the value of
4573 <code>transfer.fsckObjects</code> is used instead.</p>
4574 </dd>
4575 <dt class="hdlist1">fetch.fsck.&lt;msg-id&gt;</dt>
4576 <dd>
4577 <p>Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
4578 <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
4579 the <code>fsck.&lt;msg-id&gt;</code> documentation for details.</p>
4580 </dd>
4581 <dt class="hdlist1">fetch.fsck.skipList</dt>
4582 <dd>
4583 <p>Acts like <code>fsck.skipList</code>, but is used by
4584 <a href="git-fetch-pack.html">git-fetch-pack(1)</a> instead of <a href="git-fsck.html">git-fsck(1)</a>. See
4585 the <code>fsck.skipList</code> documentation for details.</p>
4586 </dd>
4587 <dt class="hdlist1">fetch.unpackLimit</dt>
4588 <dd>
4589 <p>If the number of objects fetched over the Git native
4590 transfer is below this
4591 limit, then the objects will be unpacked into loose object
4592 files. However if the number of received objects equals or
4593 exceeds this limit then the received pack will be stored as
4594 a pack, after adding any missing delta bases.  Storing the
4595 pack from a push can make the push operation complete faster,
4596 especially on slow filesystems.  If not set, the value of
4597 <code>transfer.unpackLimit</code> is used instead.</p>
4598 </dd>
4599 <dt class="hdlist1">fetch.prune</dt>
4600 <dd>
4601 <p>If true, fetch will automatically behave as if the <code>--prune</code>
4602 option was given on the command line.  See also <code>remote.&lt;name&gt;.prune</code>
4603 and the PRUNING section of <a href="git-fetch.html">git-fetch(1)</a>.</p>
4604 </dd>
4605 <dt class="hdlist1">fetch.pruneTags</dt>
4606 <dd>
4607 <p>If true, fetch will automatically behave as if the
4608 <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
4609 if not set already. This allows for setting both this option
4610 and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
4611 refs. See also <code>remote.&lt;name&gt;.pruneTags</code> and the PRUNING
4612 section of <a href="git-fetch.html">git-fetch(1)</a>.</p>
4613 </dd>
4614 <dt class="hdlist1">fetch.all</dt>
4615 <dd>
4616 <p>If true, fetch will attempt to update all available remotes.
4617 This behavior can be overridden by passing <code>--no-all</code> or by
4618 explicitly specifying one or more remote(s) to fetch from.
4619 Defaults to false.</p>
4620 </dd>
4621 <dt class="hdlist1">fetch.output</dt>
4622 <dd>
4623 <p>Control how ref update status is printed. Valid values are
4624 <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
4625 OUTPUT section in <a href="git-fetch.html">git-fetch(1)</a> for details.</p>
4626 </dd>
4627 <dt class="hdlist1">fetch.negotiationAlgorithm</dt>
4628 <dd>
4629 <p>Control how information about the commits in the local repository
4630 is sent when negotiating the contents of the packfile to be sent by
4631 the server.  Set to "consecutive" to use an algorithm that walks
4632 over consecutive commits checking each one.  Set to "skipping" to
4633 use an algorithm that skips commits in an effort to converge
4634 faster, but may result in a larger-than-necessary packfile; or set
4635 to "noop" to not send any information at all, which will almost
4636 certainly result in a larger-than-necessary packfile, but will skip
4637 the negotiation step.  Set to "default" to override settings made
4638 previously and use the default behaviour.  The default is normally
4639 "consecutive", but if <code>feature.experimental</code> is true, then the
4640 default is "skipping".  Unknown values will cause <em>git fetch</em> to
4641 error out.</p>
4642 <div class="paragraph">
4643 <p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
4644 <a href="git-fetch.html">git-fetch(1)</a>.</p>
4645 </div>
4646 </dd>
4647 <dt class="hdlist1">fetch.showForcedUpdates</dt>
4648 <dd>
4649 <p>Set to false to enable <code>--no-show-forced-updates</code> in
4650 <a href="git-fetch.html">git-fetch(1)</a> and <a href="git-pull.html">git-pull(1)</a> commands.
4651 Defaults to true.</p>
4652 </dd>
4653 <dt class="hdlist1">fetch.parallel</dt>
4654 <dd>
4655 <p>Specifies the maximal number of fetch operations to be run in parallel
4656 at a time (submodules, or remotes when the <code>--multiple</code> option of
4657 <a href="git-fetch.html">git-fetch(1)</a> is in effect).</p>
4658 <div class="paragraph">
4659 <p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p>
4660 </div>
4661 <div class="paragraph">
4662 <p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
4663 config setting.</p>
4664 </div>
4665 </dd>
4666 <dt class="hdlist1">fetch.writeCommitGraph</dt>
4667 <dd>
4668 <p>Set to true to write a commit-graph after every <code>git fetch</code> command
4669 that downloads a pack-file from a remote. Using the <code>--split</code> option,
4670 most executions will create a very small commit-graph file on top of
4671 the existing commit-graph file(s). Occasionally, these files will
4672 merge and the write may take longer. Having an updated commit-graph
4673 file helps performance of many Git commands, including <code>git merge-base</code>,
4674 <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.</p>
4675 </dd>
4676 <dt class="hdlist1">fetch.bundleURI</dt>
4677 <dd>
4678 <p>This value stores a URI for downloading Git object data from a bundle
4679 URI before performing an incremental fetch from the origin Git server.
4680 This is similar to how the <code>--bundle-uri</code> option behaves in
4681 <a href="git-clone.html">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
4682 <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
4683 list that is organized for incremental fetches.</p>
4684 <div class="paragraph">
4685 <p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
4686 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
4687 the new bundle URI.</p>
4688 </div>
4689 </dd>
4690 <dt class="hdlist1">fetch.bundleCreationToken</dt>
4691 <dd>
4692 <p>When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
4693 list that uses the "creationToken" heuristic, this config value
4694 stores the maximum <code>creationToken</code> value of the downloaded bundles.
4695 This value is used to prevent downloading bundles in the future
4696 if the advertised <code>creationToken</code> is not strictly larger than this
4697 value.</p>
4698 <div class="paragraph">
4699 <p>The creation token values are chosen by the provider serving the specific
4700 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
4701 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p>
4702 </div>
4703 </dd>
4704 <dt class="hdlist1">filter.&lt;driver&gt;.clean</dt>
4705 <dd>
4706 <p>The command which is used to convert the content of a worktree
4707 file to a blob upon checkin.  See <a href="gitattributes.html">gitattributes(5)</a> for
4708 details.</p>
4709 </dd>
4710 <dt class="hdlist1">filter.&lt;driver&gt;.smudge</dt>
4711 <dd>
4712 <p>The command which is used to convert the content of a blob
4713 object to a worktree file upon checkout.  See
4714 <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
4715 </dd>
4716 <dt class="hdlist1">format.attach</dt>
4717 <dd>
4718 <p>Enable multipart/mixed attachments as the default for
4719 <em>format-patch</em>.  The value can also be a double quoted string
4720 which will enable attachments as the default and set the
4721 value as the boundary.  See the --attach option in
4722 <a href="git-format-patch.html">git-format-patch(1)</a>.  To countermand an earlier
4723 value, set it to an empty string.</p>
4724 </dd>
4725 <dt class="hdlist1">format.from</dt>
4726 <dd>
4727 <p>Provides the default value for the <code>--from</code> option to format-patch.
4728 Accepts a boolean value, or a name and email address.  If false,
4729 format-patch defaults to <code>--no-from</code>, using commit authors directly in
4730 the "From:" field of patch mails.  If true, format-patch defaults to
4731 <code>--from</code>, using your committer identity in the "From:" field of patch
4732 mails and including a "From:" field in the body of the patch mail if
4733 different.  If set to a non-boolean value, format-patch uses that
4734 value instead of your committer identity.  Defaults to false.</p>
4735 </dd>
4736 <dt class="hdlist1">format.forceInBodyFrom</dt>
4737 <dd>
4738 <p>Provides the default value for the <code>--[no-]force-in-body-from</code>
4739 option to format-patch.  Defaults to false.</p>
4740 </dd>
4741 <dt class="hdlist1">format.numbered</dt>
4742 <dd>
4743 <p>A boolean which can enable or disable sequence numbers in patch
4744 subjects.  It defaults to "auto" which enables it only if there
4745 is more than one patch.  It can be enabled or disabled for all
4746 messages by setting it to "true" or "false".  See --numbered
4747 option in <a href="git-format-patch.html">git-format-patch(1)</a>.</p>
4748 </dd>
4749 <dt class="hdlist1">format.headers</dt>
4750 <dd>
4751 <p>Additional email headers to include in a patch to be submitted
4752 by mail.  See <a href="git-format-patch.html">git-format-patch(1)</a>.</p>
4753 </dd>
4754 <dt class="hdlist1">format.to</dt>
4755 <dt class="hdlist1">format.cc</dt>
4756 <dd>
4757 <p>Additional recipients to include in a patch to be submitted
4758 by mail.  See the --to and --cc options in
4759 <a href="git-format-patch.html">git-format-patch(1)</a>.</p>
4760 </dd>
4761 <dt class="hdlist1">format.subjectPrefix</dt>
4762 <dd>
4763 <p>The default for format-patch is to output files with the <em>[PATCH]</em>
4764 subject prefix. Use this variable to change that prefix.</p>
4765 </dd>
4766 <dt class="hdlist1">format.coverFromDescription</dt>
4767 <dd>
4768 <p>The default mode for format-patch to determine which parts of
4769 the cover letter will be populated using the branch&#8217;s
4770 description. See the <code>--cover-from-description</code> option in
4771 <a href="git-format-patch.html">git-format-patch(1)</a>.</p>
4772 </dd>
4773 <dt class="hdlist1">format.signature</dt>
4774 <dd>
4775 <p>The default for format-patch is to output a signature containing
4776 the Git version number. Use this variable to change that default.
4777 Set this variable to the empty string ("") to suppress
4778 signature generation.</p>
4779 </dd>
4780 <dt class="hdlist1">format.signatureFile</dt>
4781 <dd>
4782 <p>Works just like format.signature except the contents of the
4783 file specified by this variable will be used as the signature.</p>
4784 </dd>
4785 <dt class="hdlist1">format.suffix</dt>
4786 <dd>
4787 <p>The default for format-patch is to output files with the suffix
4788 <code>.patch</code>. Use this variable to change that suffix (make sure to
4789 include the dot if you want it).</p>
4790 </dd>
4791 <dt class="hdlist1">format.encodeEmailHeaders</dt>
4792 <dd>
4793 <p>Encode email headers that have non-ASCII characters with
4794 "Q-encoding" (described in RFC 2047) for email transmission.
4795 Defaults to true.</p>
4796 </dd>
4797 <dt class="hdlist1">format.pretty</dt>
4798 <dd>
4799 <p>The default pretty format for log/show/whatchanged command.
4800 See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>,
4801 <a href="git-whatchanged.html">git-whatchanged(1)</a>.</p>
4802 </dd>
4803 <dt class="hdlist1">format.thread</dt>
4804 <dd>
4805 <p>The default threading style for <em>git format-patch</em>.  Can be
4806 a boolean value, or <code>shallow</code> or <code>deep</code>.  <code>shallow</code> threading
4807 makes every mail a reply to the head of the series,
4808 where the head is chosen from the cover letter, the
4809 <code>--in-reply-to</code>, and the first patch mail, in this order.
4810 <code>deep</code> threading makes every mail a reply to the previous one.
4811 A true boolean value is the same as <code>shallow</code>, and a false
4812 value disables threading.</p>
4813 </dd>
4814 <dt class="hdlist1">format.signOff</dt>
4815 <dd>
4816 <p>A boolean value which lets you enable the <code>-s/--signoff</code> option of
4817 format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
4818 patch should be a conscious act and means that you certify you have
4819 the rights to submit this work under the same open source license.
4820 Please see the <em>SubmittingPatches</em> document for further discussion.</p>
4821 </dd>
4822 <dt class="hdlist1">format.coverLetter</dt>
4823 <dd>
4824 <p>A boolean that controls whether to generate a cover-letter when
4825 format-patch is invoked, but in addition can be set to "auto", to
4826 generate a cover-letter only when there&#8217;s more than one patch.
4827 Default is false.</p>
4828 </dd>
4829 <dt class="hdlist1">format.outputDirectory</dt>
4830 <dd>
4831 <p>Set a custom directory to store the resulting files instead of the
4832 current working directory. All directory components will be created.</p>
4833 </dd>
4834 <dt class="hdlist1">format.filenameMaxLength</dt>
4835 <dd>
4836 <p>The maximum length of the output filenames generated by the
4837 <code>format-patch</code> command; defaults to 64.  Can be overridden
4838 by the <code>--filename-max-length=&lt;n&gt;</code> command line option.</p>
4839 </dd>
4840 <dt class="hdlist1">format.useAutoBase</dt>
4841 <dd>
4842 <p>A boolean value which lets you enable the <code>--base=auto</code> option of
4843 format-patch by default. Can also be set to "whenAble" to allow
4844 enabling <code>--base=auto</code> if a suitable base is available, but to skip
4845 adding base info otherwise without the format dying.</p>
4846 </dd>
4847 <dt class="hdlist1">format.notes</dt>
4848 <dd>
4849 <p>Provides the default value for the <code>--notes</code> option to
4850 format-patch. Accepts a boolean value, or a ref which specifies
4851 where to get notes. If false, format-patch defaults to
4852 <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
4853 set to a non-boolean value, format-patch defaults to
4854 <code>--notes=&lt;ref&gt;</code>, where <code>ref</code> is the non-boolean value. Defaults
4855 to false.</p>
4856 <div class="paragraph">
4857 <p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
4858 instead.</p>
4859 </div>
4860 <div class="paragraph">
4861 <p>This configuration can be specified multiple times in order to allow
4862 multiple notes refs to be included. In that case, it will behave
4863 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
4864 value of <code>true</code> will show the default notes, a value of <code>&lt;ref&gt;</code> will
4865 also show notes from that notes ref and a value of <code>false</code> will negate
4866 previous configurations and not show notes.</p>
4867 </div>
4868 <div class="paragraph">
4869 <p>For example,</p>
4870 </div>
4871 <div class="listingblock">
4872 <div class="content">
4873 <pre>[format]
4874         notes = true
4875         notes = foo
4876         notes = false
4877         notes = bar</pre>
4878 </div>
4879 </div>
4880 <div class="paragraph">
4881 <p>will only show notes from <code>refs/notes/bar</code>.</p>
4882 </div>
4883 </dd>
4884 <dt class="hdlist1">format.mboxrd</dt>
4885 <dd>
4886 <p>A boolean value which enables the robust "mboxrd" format when
4887 <code>--stdout</code> is in use to escape "^&gt;+From " lines.</p>
4888 </dd>
4889 <dt class="hdlist1">format.noprefix</dt>
4890 <dd>
4891 <p>If set, do not show any source or destination prefix in patches.
4892 This is equivalent to the <code>diff.noprefix</code> option used by <code>git
4893 diff</code> (but which is not respected by <code>format-patch</code>). Note that
4894 by setting this, the receiver of any patches you generate will
4895 have to apply them using the <code>-p0</code> option.</p>
4896 </dd>
4897 <dt class="hdlist1">fsck.&lt;msg-id&gt;</dt>
4898 <dd>
4899 <p>During fsck git may find issues with legacy data which
4900 wouldn&#8217;t be generated by current versions of git, and which
4901 wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
4902 set. This feature is intended to support working with legacy
4903 repositories containing such data.</p>
4904 <div class="paragraph">
4905 <p>Setting <code>fsck.&lt;msg-id&gt;</code> will be picked up by <a href="git-fsck.html">git-fsck(1)</a>, but
4906 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
4907 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p>
4908 </div>
4909 <div class="paragraph">
4910 <p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
4911 same applies for the corresponding <code>receive.fsck.*</code> and
4912 <code>fetch.fsck.*</code>. variables.</p>
4913 </div>
4914 <div class="paragraph">
4915 <p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
4916 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
4917 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
4918 uniformly configure the same fsck settings in different circumstances,
4919 all three of them must be set to the same values.</p>
4920 </div>
4921 <div class="paragraph">
4922 <p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
4923 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
4924 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
4925 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
4926 with the message ID, e.g. "missingEmail: invalid author/committer
4927 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
4928 will hide that issue.</p>
4929 </div>
4930 <div class="paragraph">
4931 <p>In general, it is better to enumerate existing objects with problems
4932 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
4933 problematic objects share to be ignored, as doing the latter will
4934 allow new instances of the same breakages go unnoticed.</p>
4935 </div>
4936 <div class="paragraph">
4937 <p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
4938 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
4939 will only cause git to warn.</p>
4940 </div>
4941 <div class="paragraph">
4942 <p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
4943 values of <code>&lt;msg-id&gt;</code>.</p>
4944 </div>
4945 </dd>
4946 <dt class="hdlist1">fsck.skipList</dt>
4947 <dd>
4948 <p>The path to a list of object names (i.e. one unabbreviated SHA-1 per
4949 line) that are known to be broken in a non-fatal way and should
4950 be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
4951 lines, and any leading and trailing whitespace are ignored. Everything
4952 but a SHA-1 per line will error out on older versions.</p>
4953 <div class="paragraph">
4954 <p>This feature is useful when an established project should be accepted
4955 despite early commits containing errors that can be safely ignored,
4956 such as invalid committer email addresses.  Note: corrupt objects
4957 cannot be skipped with this setting.</p>
4958 </div>
4959 <div class="paragraph">
4960 <p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
4961 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p>
4962 </div>
4963 <div class="paragraph">
4964 <p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
4965 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
4966 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
4967 uniformly configure the same fsck settings in different circumstances,
4968 all three of them must be set to the same values.</p>
4969 </div>
4970 <div class="paragraph">
4971 <p>Older versions of Git (before 2.20) documented that the object names
4972 list should be sorted. This was never a requirement; the object names
4973 could appear in any order, but when reading the list we tracked whether
4974 the list was sorted for the purposes of an internal binary search
4975 implementation, which could save itself some work with an already sorted
4976 list. Unless you had a humongous list there was no reason to go out of
4977 your way to pre-sort the list. After Git version 2.20 a hash implementation
4978 is used instead, so there&#8217;s now no reason to pre-sort the list.</p>
4979 </div>
4980 </dd>
4981 <dt class="hdlist1">fsmonitor.allowRemote</dt>
4982 <dd>
4983 <p>By default, the fsmonitor daemon refuses to work with network-mounted
4984 repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
4985 behavior.  Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.</p>
4986 </dd>
4987 <dt class="hdlist1">fsmonitor.socketDir</dt>
4988 <dd>
4989 <p>This Mac OS-specific option, if set, specifies the directory in
4990 which to create the Unix domain socket used for communication
4991 between the fsmonitor daemon and various Git commands. The directory must
4992 reside on a native Mac OS filesystem.  Only respected when <code>core.fsmonitor</code>
4993 is set to <code>true</code>.</p>
4994 </dd>
4995 <dt class="hdlist1">gc.aggressiveDepth</dt>
4996 <dd>
4997 <p>The depth parameter used in the delta compression
4998 algorithm used by <em>git gc --aggressive</em>.  This defaults
4999 to 50, which is the default for the <code>--depth</code> option when
5000 <code>--aggressive</code> isn&#8217;t in use.</p>
5001 <div class="paragraph">
5002 <p>See the documentation for the <code>--depth</code> option in
5003 <a href="git-repack.html">git-repack(1)</a> for more details.</p>
5004 </div>
5005 </dd>
5006 <dt class="hdlist1">gc.aggressiveWindow</dt>
5007 <dd>
5008 <p>The window size parameter used in the delta compression
5009 algorithm used by <em>git gc --aggressive</em>.  This defaults
5010 to 250, which is a much more aggressive window size than
5011 the default <code>--window</code> of 10.</p>
5012 <div class="paragraph">
5013 <p>See the documentation for the <code>--window</code> option in
5014 <a href="git-repack.html">git-repack(1)</a> for more details.</p>
5015 </div>
5016 </dd>
5017 <dt class="hdlist1">gc.auto</dt>
5018 <dd>
5019 <p>When there are approximately more than this many loose
5020 objects in the repository, <code>git gc --auto</code> will pack them.
5021 Some Porcelain commands use this command to perform a
5022 light-weight garbage collection from time to time.  The
5023 default value is 6700.</p>
5024 <div class="paragraph">
5025 <p>Setting this to 0 disables not only automatic packing based on the
5026 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
5027 otherwise use to determine if there&#8217;s work to do, such as
5028 <code>gc.autoPackLimit</code>.</p>
5029 </div>
5030 </dd>
5031 <dt class="hdlist1">gc.autoPackLimit</dt>
5032 <dd>
5033 <p>When there are more than this many packs that are not
5034 marked with <code>*.keep</code> file in the repository, <code>git gc
5035 --auto</code> consolidates them into one larger pack.  The
5036 default value is 50.  Setting this to 0 disables it.
5037 Setting <code>gc.auto</code> to 0 will also disable this.</p>
5038 <div class="paragraph">
5039 <p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
5040 use, it&#8217;ll affect how the auto pack limit works.</p>
5041 </div>
5042 </dd>
5043 <dt class="hdlist1">gc.autoDetach</dt>
5044 <dd>
5045 <p>Make <code>git gc --auto</code> return immediately and run in the background
5046 if the system supports it. Default is true. This config variable acts
5047 as a fallback in case <code>maintenance.autoDetach</code> is not set.</p>
5048 </dd>
5049 <dt class="hdlist1">gc.bigPackThreshold</dt>
5050 <dd>
5051 <p>If non-zero, all non-cruft packs larger than this limit are kept
5052 when <code>git gc</code> is run. This is very similar to
5053 <code>--keep-largest-pack</code> except that all non-cruft packs that meet
5054 the threshold are kept, not just the largest pack. Defaults to
5055 zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
5056 <div class="paragraph">
5057 <p>Note that if the number of kept packs is more than gc.autoPackLimit,
5058 this configuration variable is ignored, all packs except the base pack
5059 will be repacked. After this the number of packs should go below
5060 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p>
5061 </div>
5062 <div class="paragraph">
5063 <p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
5064 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
5065 will also be excluded (this is the equivalent of running <code>git gc</code> with
5066 <code>--keep-largest-pack</code>).</p>
5067 </div>
5068 </dd>
5069 <dt class="hdlist1">gc.writeCommitGraph</dt>
5070 <dd>
5071 <p>If true, then gc will rewrite the commit-graph file when
5072 <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
5073 the commit-graph will be updated if housekeeping is
5074 required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
5075 for details.</p>
5076 </dd>
5077 <dt class="hdlist1">gc.logExpiry</dt>
5078 <dd>
5079 <p>If the file gc.log exists, then <code>git gc --auto</code> will print
5080 its content and exit with status zero instead of running
5081 unless that file is more than <em>gc.logExpiry</em> old.  Default is
5082 "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
5083 value.</p>
5084 </dd>
5085 <dt class="hdlist1">gc.packRefs</dt>
5086 <dd>
5087 <p>Running <code>git pack-refs</code> in a repository renders it
5088 unclonable by Git versions prior to 1.5.1.2 over dumb
5089 transports such as HTTP.  This variable determines whether
5090 <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
5091 to enable it within all non-bare repos or it can be set to a
5092 boolean value.  The default is <code>true</code>.</p>
5093 </dd>
5094 <dt class="hdlist1">gc.cruftPacks</dt>
5095 <dd>
5096 <p>Store unreachable objects in a cruft pack (see
5097 <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
5098 is <code>true</code>.</p>
5099 </dd>
5100 <dt class="hdlist1">gc.maxCruftSize</dt>
5101 <dd>
5102 <p>Limit the size of new cruft packs when repacking. When
5103 specified in addition to <code>--max-cruft-size</code>, the command line
5104 option takes priority. See the <code>--max-cruft-size</code> option of
5105 <a href="git-repack.html">git-repack(1)</a>.</p>
5106 </dd>
5107 <dt class="hdlist1">gc.pruneExpire</dt>
5108 <dd>
5109 <p>When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
5110 (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
5111 cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
5112 grace period with this config variable.  The value "now" may be
5113 used to disable this grace period and always prune unreachable
5114 objects immediately, or "never" may be used to suppress pruning.
5115 This feature helps prevent corruption when <em>git gc</em> runs
5116 concurrently with another process writing to the repository; see
5117 the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.</p>
5118 </dd>
5119 <dt class="hdlist1">gc.worktreePruneExpire</dt>
5120 <dd>
5121 <p>When <em>git gc</em> is run, it calls
5122 <em>git worktree prune --expire 3.months.ago</em>.
5123 This config variable can be used to set a different grace
5124 period. The value "now" may be used to disable the grace
5125 period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
5126 may be used to suppress pruning.</p>
5127 </dd>
5128 <dt class="hdlist1">gc.reflogExpire</dt>
5129 <dt class="hdlist1">gc.&lt;pattern&gt;.reflogExpire</dt>
5130 <dd>
5131 <p><em>git reflog expire</em> removes reflog entries older than
5132 this time; defaults to 90 days. The value "now" expires all
5133 entries immediately, and "never" suppresses expiration
5134 altogether. With "&lt;pattern&gt;" (e.g.
5135 "refs/stash") in the middle the setting applies only to
5136 the refs that match the &lt;pattern&gt;.</p>
5137 </dd>
5138 <dt class="hdlist1">gc.reflogExpireUnreachable</dt>
5139 <dt class="hdlist1">gc.&lt;pattern&gt;.reflogExpireUnreachable</dt>
5140 <dd>
5141 <p><em>git reflog expire</em> removes reflog entries older than
5142 this time and are not reachable from the current tip;
5143 defaults to 30 days. The value "now" expires all entries
5144 immediately, and "never" suppresses expiration altogether.
5145 With "&lt;pattern&gt;" (e.g. "refs/stash")
5146 in the middle, the setting applies only to the refs that
5147 match the &lt;pattern&gt;.</p>
5148 <div class="paragraph">
5149 <p>These types of entries are generally created as a result of using <code>git
5150 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
5151 or rebase occurring.  Since these changes are not part of the current
5152 project most users will want to expire them sooner, which is why the
5153 default is more aggressive than <code>gc.reflogExpire</code>.</p>
5154 </div>
5155 </dd>
5156 <dt class="hdlist1">gc.recentObjectsHook</dt>
5157 <dd>
5158 <p>When considering whether or not to remove an object (either when
5159 generating a cruft pack or storing unreachable objects as
5160 loose), use the shell to execute the specified command(s).
5161 Interpret their output as object IDs which Git will consider as
5162 "recent", regardless of their age. By treating their mtimes as
5163 "now", any objects (and their descendants) mentioned in the
5164 output will be kept regardless of their true age.</p>
5165 <div class="paragraph">
5166 <p>Output must contain exactly one hex object ID per line, and nothing
5167 else. Objects which cannot be found in the repository are ignored.
5168 Multiple hooks are supported, but all must exit successfully, else the
5169 operation (either generating a cruft pack or unpacking unreachable
5170 objects) will be halted.</p>
5171 </div>
5172 </dd>
5173 <dt class="hdlist1">gc.repackFilter</dt>
5174 <dd>
5175 <p>When repacking, use the specified filter to move certain
5176 objects into a separate packfile.  See the
5177 <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.</p>
5178 </dd>
5179 <dt class="hdlist1">gc.repackFilterTo</dt>
5180 <dd>
5181 <p>When repacking and using a filter, see <code>gc.repackFilter</code>, the
5182 specified location will be used to create the packfile
5183 containing the filtered out objects. <strong>WARNING:</strong> The
5184 specified location should be accessible, using for example the
5185 Git alternates mechanism, otherwise the repo could be
5186 considered corrupt by Git as it migh not be able to access the
5187 objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
5188 of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
5189 section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.</p>
5190 </dd>
5191 <dt class="hdlist1">gc.rerereResolved</dt>
5192 <dd>
5193 <p>Records of conflicted merge you resolved earlier are
5194 kept for this many days when <em>git rerere gc</em> is run.
5195 You can also use more human-readable "1.month.ago", etc.
5196 The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.</p>
5197 </dd>
5198 <dt class="hdlist1">gc.rerereUnresolved</dt>
5199 <dd>
5200 <p>Records of conflicted merge you have not resolved are
5201 kept for this many days when <em>git rerere gc</em> is run.
5202 You can also use more human-readable "1.month.ago", etc.
5203 The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.</p>
5204 </dd>
5205 <dt class="hdlist1">gitcvs.commitMsgAnnotation</dt>
5206 <dd>
5207 <p>Append this string to each commit message. Set to empty string
5208 to disable this feature. Defaults to "via git-CVS emulator".</p>
5209 </dd>
5210 <dt class="hdlist1">gitcvs.enabled</dt>
5211 <dd>
5212 <p>Whether the CVS server interface is enabled for this repository.
5213 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.</p>
5214 </dd>
5215 <dt class="hdlist1">gitcvs.logFile</dt>
5216 <dd>
5217 <p>Path to a log file where the CVS server interface well&#8230;&#8203; logs
5218 various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>.</p>
5219 </dd>
5220 <dt class="hdlist1">gitcvs.usecrlfattr</dt>
5221 <dd>
5222 <p>If true, the server will look up the end-of-line conversion
5223 attributes for files to determine the <code>-k</code> modes to use. If
5224 the attributes force Git to treat a file as text,
5225 the <code>-k</code> mode will be left blank so CVS clients will
5226 treat it as text. If they suppress text conversion, the file
5227 will be set with <em>-kb</em> mode, which suppresses any newline munging
5228 the client might otherwise do. If the attributes do not allow
5229 the file type to be determined, then <code>gitcvs.allBinary</code> is
5230 used. See <a href="gitattributes.html">gitattributes(5)</a>.</p>
5231 </dd>
5232 <dt class="hdlist1">gitcvs.allBinary</dt>
5233 <dd>
5234 <p>This is used if <code>gitcvs.usecrlfattr</code> does not resolve
5235 the correct <em>-kb</em> mode to use. If true, all
5236 unresolved files are sent to the client in
5237 mode <em>-kb</em>. This causes the client to treat them
5238 as binary files, which suppresses any newline munging it
5239 otherwise might do. Alternatively, if it is set to "guess",
5240 then the contents of the file are examined to decide if
5241 it is binary, similar to <code>core.autocrlf</code>.</p>
5242 </dd>
5243 <dt class="hdlist1">gitcvs.dbName</dt>
5244 <dd>
5245 <p>Database used by git-cvsserver to cache revision information
5246 derived from the Git repository. The exact meaning depends on the
5247 used database driver, for SQLite (which is the default driver) this
5248 is a filename. Supports variable substitution (see
5249 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
5250 Default: <em>%Ggitcvs.%m.sqlite</em></p>
5251 </dd>
5252 <dt class="hdlist1">gitcvs.dbDriver</dt>
5253 <dd>
5254 <p>Used Perl DBI driver. You can specify any available driver
5255 for this here, but it might not work. git-cvsserver is tested
5256 with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
5257 reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
5258 May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
5259 See <a href="git-cvsserver.html">git-cvsserver(1)</a>.</p>
5260 </dd>
5261 <dt class="hdlist1">gitcvs.dbUser, gitcvs.dbPass</dt>
5262 <dd>
5263 <p>Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
5264 since SQLite has no concept of database users and/or passwords.
5265 <em>gitcvs.dbUser</em> supports variable substitution (see
5266 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).</p>
5267 </dd>
5268 <dt class="hdlist1">gitcvs.dbTableNamePrefix</dt>
5269 <dd>
5270 <p>Database table name prefix.  Prepended to the names of any
5271 database tables used, allowing a single database to be used
5272 for several repositories.  Supports variable substitution (see
5273 <a href="git-cvsserver.html">git-cvsserver(1)</a> for details).  Any non-alphabetic
5274 characters will be replaced with underscores.</p>
5275 </dd>
5276 </dl>
5277 </div>
5278 <div class="paragraph">
5279 <p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
5280 <code>gitcvs.allBinary</code> can also be specified as
5281 <em>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</em> (where <em>access_method</em>
5282 is one of "ext" and "pserver") to make them apply only for the given
5283 access method.</p>
5284 </div>
5285 <div class="dlist">
5286 <dl>
5287 <dt class="hdlist1">gitweb.category</dt>
5288 <dt class="hdlist1">gitweb.description</dt>
5289 <dt class="hdlist1">gitweb.owner</dt>
5290 <dt class="hdlist1">gitweb.url</dt>
5291 <dd>
5292 <p>See <a href="gitweb.html">gitweb(1)</a> for description.</p>
5293 </dd>
5294 <dt class="hdlist1">gitweb.avatar</dt>
5295 <dt class="hdlist1">gitweb.blame</dt>
5296 <dt class="hdlist1">gitweb.grep</dt>
5297 <dt class="hdlist1">gitweb.highlight</dt>
5298 <dt class="hdlist1">gitweb.patches</dt>
5299 <dt class="hdlist1">gitweb.pickaxe</dt>
5300 <dt class="hdlist1">gitweb.remote_heads</dt>
5301 <dt class="hdlist1">gitweb.showSizes</dt>
5302 <dt class="hdlist1">gitweb.snapshot</dt>
5303 <dd>
5304 <p>See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description.</p>
5305 </dd>
5306 <dt class="hdlist1">gpg.program</dt>
5307 <dd>
5308 <p>Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when
5309 making or verifying a PGP signature. The program must support the
5310 same command-line interface as GPG, namely, to verify a detached
5311 signature, "<code>gpg --verify $signature - &lt;$file</code>" is run, and the
5312 program is expected to signal a good signature by exiting with
5313 code 0.  To generate an ASCII-armored detached signature, the
5314 standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be
5315 signed, and the program is expected to send the result to its
5316 standard output.</p>
5317 </dd>
5318 <dt class="hdlist1">gpg.format</dt>
5319 <dd>
5320 <p>Specifies which key format to use when signing with <code>--gpg-sign</code>.
5321 Default is "openpgp". Other possible values are "x509", "ssh".</p>
5322 <div class="paragraph">
5323 <p>See <a href="gitformat-signature.html">gitformat-signature(5)</a> for the signature format, which differs
5324 based on the selected <code>gpg.format</code>.</p>
5325 </div>
5326 </dd>
5327 <dt class="hdlist1">gpg.&lt;format&gt;.program</dt>
5328 <dd>
5329 <p>Use this to customize the program used for the signing format you
5330 chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
5331 be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
5332 value for <code>gpg.x509.program</code> is "gpgsm" and <code>gpg.ssh.program</code> is "ssh-keygen".</p>
5333 </dd>
5334 <dt class="hdlist1">gpg.minTrustLevel</dt>
5335 <dd>
5336 <p>Specifies a minimum trust level for signature verification.  If
5337 this option is unset, then signature verification for merge
5338 operations requires a key with at least <code>marginal</code> trust.  Other
5339 operations that perform signature verification require a key
5340 with at least <code>undefined</code> trust.  Setting this option overrides
5341 the required trust-level for all operations.  Supported values,
5342 in increasing order of significance:</p>
5343 <div class="ulist">
5344 <ul>
5345 <li>
5346 <p><code>undefined</code></p>
5347 </li>
5348 <li>
5349 <p><code>never</code></p>
5350 </li>
5351 <li>
5352 <p><code>marginal</code></p>
5353 </li>
5354 <li>
5355 <p><code>fully</code></p>
5356 </li>
5357 <li>
5358 <p><code>ultimate</code></p>
5359 </li>
5360 </ul>
5361 </div>
5362 </dd>
5363 <dt class="hdlist1">gpg.ssh.defaultKeyCommand</dt>
5364 <dd>
5365 <p>This command will be run when user.signingkey is not set and a ssh
5366 signature is requested. On successful exit a valid ssh public key
5367 prefixed with <code>key::</code> is expected in the first line of its output.
5368 This allows for a script doing a dynamic lookup of the correct public
5369 key when it is impractical to statically configure <code>user.signingKey</code>.
5370 For example when keys or SSH Certificates are rotated frequently or
5371 selection of the right key depends on external factors unknown to git.</p>
5372 </dd>
5373 <dt class="hdlist1">gpg.ssh.allowedSignersFile</dt>
5374 <dd>
5375 <p>A file containing ssh public keys which you are willing to trust.
5376 The file consists of one or more lines of principals followed by an ssh
5377 public key.
5378 e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
5379 See ssh-keygen(1) "ALLOWED SIGNERS" for details.
5380 The principal is only used to identify the key and is available when
5381 verifying a signature.</p>
5382 <div class="paragraph">
5383 <p>SSH has no concept of trust levels like gpg does. To be able to differentiate
5384 between valid signatures and trusted signatures the trust level of a signature
5385 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
5386 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p>
5387 </div>
5388 <div class="paragraph">
5389 <p>This file can be set to a location outside of the repository and every developer
5390 maintains their own trust store. A central repository server could generate this
5391 file automatically from ssh keys with push access to verify the code against.
5392 In a corporate setting this file is probably generated at a global location
5393 from automation that already handles developer ssh keys.</p>
5394 </div>
5395 <div class="paragraph">
5396 <p>A repository that only allows signed commits can store the file
5397 in the repository itself using a path relative to the top-level of the working tree.
5398 This way only committers with an already valid key can add or change keys in the keyring.</p>
5399 </div>
5400 <div class="paragraph">
5401 <p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &amp;
5402 valid-before options. Git will mark signatures as valid if the signing key was
5403 valid at the time of the signature&#8217;s creation. This allows users to change a
5404 signing key without invalidating all previously made signatures.</p>
5405 </div>
5406 <div class="paragraph">
5407 <p>Using a SSH CA key with the cert-authority option
5408 (see ssh-keygen(1) "CERTIFICATES") is also valid.</p>
5409 </div>
5410 </dd>
5411 <dt class="hdlist1">gpg.ssh.revocationFile</dt>
5412 <dd>
5413 <p>Either a SSH KRL or a list of revoked public keys (without the principal prefix).
5414 See ssh-keygen(1) for details.
5415 If a public key is found in this file then it will always be treated
5416 as having trust level "never" and signatures will show as invalid.</p>
5417 </dd>
5418 <dt class="hdlist1">grep.lineNumber</dt>
5419 <dd>
5420 <p>If set to true, enable <code>-n</code> option by default.</p>
5421 </dd>
5422 <dt class="hdlist1">grep.column</dt>
5423 <dd>
5424 <p>If set to true, enable the <code>--column</code> option by default.</p>
5425 </dd>
5426 <dt class="hdlist1">grep.patternType</dt>
5427 <dd>
5428 <p>Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
5429 <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
5430 <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
5431 value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
5432 between <em>basic</em> and <em>extended</em>.</p>
5433 </dd>
5434 <dt class="hdlist1">grep.extendedRegexp</dt>
5435 <dd>
5436 <p>If set to true, enable <code>--extended-regexp</code> option by default. This
5437 option is ignored when the <code>grep.patternType</code> option is set to a value
5438 other than <em>default</em>.</p>
5439 </dd>
5440 <dt class="hdlist1">grep.threads</dt>
5441 <dd>
5442 <p>Number of grep worker threads to use. If unset (or set to 0), Git will
5443 use as many threads as the number of logical cores available.</p>
5444 </dd>
5445 <dt class="hdlist1">grep.fullName</dt>
5446 <dd>
5447 <p>If set to true, enable <code>--full-name</code> option by default.</p>
5448 </dd>
5449 <dt class="hdlist1">grep.fallbackToNoIndex</dt>
5450 <dd>
5451 <p>If set to true, fall back to <code>git grep --no-index</code> if <code>git grep</code>
5452 is executed outside of a git repository.  Defaults to false.</p>
5453 </dd>
5454 <dt class="hdlist1">gui.commitMsgWidth</dt>
5455 <dd>
5456 <p>Defines how wide the commit message window is in the
5457 <a href="git-gui.html">git-gui(1)</a>. "75" is the default.</p>
5458 </dd>
5459 <dt class="hdlist1">gui.diffContext</dt>
5460 <dd>
5461 <p>Specifies how many context lines should be used in calls to diff
5462 made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5".</p>
5463 </dd>
5464 <dt class="hdlist1">gui.displayUntracked</dt>
5465 <dd>
5466 <p>Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files
5467 in the file list. The default is "true".</p>
5468 </dd>
5469 <dt class="hdlist1">gui.encoding</dt>
5470 <dd>
5471 <p>Specifies the default character encoding to use for displaying of
5472 file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>.
5473 It can be overridden by setting the <em>encoding</em> attribute
5474 for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>).
5475 If this option is not set, the tools default to the
5476 locale encoding.</p>
5477 </dd>
5478 <dt class="hdlist1">gui.matchTrackingBranch</dt>
5479 <dd>
5480 <p>Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should
5481 default to tracking remote branches with matching names or
5482 not. Default: "false".</p>
5483 </dd>
5484 <dt class="hdlist1">gui.newBranchTemplate</dt>
5485 <dd>
5486 <p>Is used as a suggested name when creating new branches using the
5487 <a href="git-gui.html">git-gui(1)</a>.</p>
5488 </dd>
5489 <dt class="hdlist1">gui.pruneDuringFetch</dt>
5490 <dd>
5491 <p>"true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when
5492 performing a fetch. The default value is "false".</p>
5493 </dd>
5494 <dt class="hdlist1">gui.trustmtime</dt>
5495 <dd>
5496 <p>Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification
5497 timestamp or not. By default the timestamps are not trusted.</p>
5498 </dd>
5499 <dt class="hdlist1">gui.spellingDictionary</dt>
5500 <dd>
5501 <p>Specifies the dictionary used for spell checking commit messages in
5502 the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned
5503 off.</p>
5504 </dd>
5505 <dt class="hdlist1">gui.fastCopyBlame</dt>
5506 <dd>
5507 <p>If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
5508 location detection. It makes blame significantly faster on huge
5509 repositories at the expense of less thorough copy detection.</p>
5510 </dd>
5511 <dt class="hdlist1">gui.copyBlameThreshold</dt>
5512 <dd>
5513 <p>Specifies the threshold to use in <em>git gui blame</em> original location
5514 detection, measured in alphanumeric characters. See the
5515 <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection.</p>
5516 </dd>
5517 <dt class="hdlist1">gui.blamehistoryctx</dt>
5518 <dd>
5519 <p>Specifies the radius of history context in days to show in
5520 <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History
5521 Context</code> menu item is invoked from <em>git gui blame</em>. If this
5522 variable is set to zero, the whole history is shown.</p>
5523 </dd>
5524 <dt class="hdlist1">guitool.&lt;name&gt;.cmd</dt>
5525 <dd>
5526 <p>Specifies the shell command line to execute when the corresponding item
5527 of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
5528 mandatory for every tool. The command is executed from the root of
5529 the working directory, and in the environment it receives the name of
5530 the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
5531 <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
5532 the head is detached, <em>CUR_BRANCH</em> is empty).</p>
5533 </dd>
5534 <dt class="hdlist1">guitool.&lt;name&gt;.needsFile</dt>
5535 <dd>
5536 <p>Run the tool only if a diff is selected in the GUI. It guarantees
5537 that <em>FILENAME</em> is not empty.</p>
5538 </dd>
5539 <dt class="hdlist1">guitool.&lt;name&gt;.noConsole</dt>
5540 <dd>
5541 <p>Run the command silently, without creating a window to display its
5542 output.</p>
5543 </dd>
5544 <dt class="hdlist1">guitool.&lt;name&gt;.noRescan</dt>
5545 <dd>
5546 <p>Don&#8217;t rescan the working directory for changes after the tool
5547 finishes execution.</p>
5548 </dd>
5549 <dt class="hdlist1">guitool.&lt;name&gt;.confirm</dt>
5550 <dd>
5551 <p>Show a confirmation dialog before actually running the tool.</p>
5552 </dd>
5553 <dt class="hdlist1">guitool.&lt;name&gt;.argPrompt</dt>
5554 <dd>
5555 <p>Request a string argument from the user, and pass it to the tool
5556 through the <code>ARGS</code> environment variable. Since requesting an
5557 argument implies confirmation, the <em>confirm</em> option has no effect
5558 if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
5559 the dialog uses a built-in generic prompt; otherwise the exact
5560 value of the variable is used.</p>
5561 </dd>
5562 <dt class="hdlist1">guitool.&lt;name&gt;.revPrompt</dt>
5563 <dd>
5564 <p>Request a single valid revision from the user, and set the
5565 <code>REVISION</code> environment variable. In other aspects this option
5566 is similar to <em>argPrompt</em>, and can be used together with it.</p>
5567 </dd>
5568 <dt class="hdlist1">guitool.&lt;name&gt;.revUnmerged</dt>
5569 <dd>
5570 <p>Show only unmerged branches in the <em>revPrompt</em> subdialog.
5571 This is useful for tools similar to merge or rebase, but not
5572 for things like checkout or reset.</p>
5573 </dd>
5574 <dt class="hdlist1">guitool.&lt;name&gt;.title</dt>
5575 <dd>
5576 <p>Specifies the title to use for the prompt dialog. The default
5577 is the tool name.</p>
5578 </dd>
5579 <dt class="hdlist1">guitool.&lt;name&gt;.prompt</dt>
5580 <dd>
5581 <p>Specifies the general prompt string to display at the top of
5582 the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
5583 The default value includes the actual command.</p>
5584 </dd>
5585 <dt class="hdlist1">help.browser</dt>
5586 <dd>
5587 <p>Specify the browser that will be used to display help in the
5588 <em>web</em> format. See <a href="git-help.html">git-help(1)</a>.</p>
5589 </dd>
5590 <dt class="hdlist1">help.format</dt>
5591 <dd>
5592 <p>Override the default help format used by <a href="git-help.html">git-help(1)</a>.
5593 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
5594 the default. <em>web</em> and <em>html</em> are the same.</p>
5595 </dd>
5596 <dt class="hdlist1">help.autoCorrect</dt>
5597 <dd>
5598 <p>If git detects typos and can identify exactly one valid command similar
5599 to the error, git will try to suggest the correct command or even
5600 run the suggestion automatically. Possible config values are:</p>
5601 <div class="ulist">
5602 <ul>
5603 <li>
5604 <p>0 (default): show the suggested command.</p>
5605 </li>
5606 <li>
5607 <p>positive number: run the suggested command after specified
5608 deciseconds (0.1 sec).</p>
5609 </li>
5610 <li>
5611 <p>"immediate": run the suggested command immediately.</p>
5612 </li>
5613 <li>
5614 <p>"prompt": show the suggestion and prompt for confirmation to run
5615 the command.</p>
5616 </li>
5617 <li>
5618 <p>"never": don&#8217;t run or show any suggested command.</p>
5619 </li>
5620 </ul>
5621 </div>
5622 </dd>
5623 <dt class="hdlist1">help.htmlPath</dt>
5624 <dd>
5625 <p>Specify the path where the HTML documentation resides. File system paths
5626 and URLs are supported. HTML pages will be prefixed with this path when
5627 help is displayed in the <em>web</em> format. This defaults to the documentation
5628 path of your Git installation.</p>
5629 </dd>
5630 <dt class="hdlist1">http.proxy</dt>
5631 <dd>
5632 <p>Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
5633 <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
5634 addition to the syntax understood by curl, it is possible to specify a
5635 proxy string with a user name but no password, in which case git will
5636 attempt to acquire one in the same way it does for other credentials. See
5637 <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is
5638 <em>[protocol://][user[:password]@]proxyhost[:port][/path]</em>. This can be
5639 overridden on a per-remote basis; see remote.&lt;name&gt;.proxy</p>
5640 <div class="paragraph">
5641 <p>Any proxy, however configured, must be completely transparent and must not
5642 modify, transform, or buffer the request or response in any way.  Proxies which
5643 are not completely transparent are known to cause various forms of breakage
5644 with Git.</p>
5645 </div>
5646 </dd>
5647 <dt class="hdlist1">http.proxyAuthMethod</dt>
5648 <dd>
5649 <p>Set the method with which to authenticate against the HTTP proxy. This
5650 only takes effect if the configured proxy string contains a user name part
5651 (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
5652 overridden on a per-remote basis; see <code>remote.&lt;name&gt;.proxyAuthMethod</code>.
5653 Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
5654 variable.  Possible values are:</p>
5655 <div class="openblock">
5656 <div class="content">
5657 <div class="ulist">
5658 <ul>
5659 <li>
5660 <p><code>anyauth</code> - Automatically pick a suitable authentication method. It is
5661 assumed that the proxy answers an unauthenticated request with a 407
5662 status code and one or more Proxy-authenticate headers with supported
5663 authentication methods. This is the default.</p>
5664 </li>
5665 <li>
5666 <p><code>basic</code> - HTTP Basic authentication</p>
5667 </li>
5668 <li>
5669 <p><code>digest</code> - HTTP Digest authentication; this prevents the password from being
5670 transmitted to the proxy in clear text</p>
5671 </li>
5672 <li>
5673 <p><code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
5674 of <code>curl(1)</code>)</p>
5675 </li>
5676 <li>
5677 <p><code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)</p>
5678 </li>
5679 </ul>
5680 </div>
5681 </div>
5682 </div>
5683 </dd>
5684 <dt class="hdlist1">http.proxySSLCert</dt>
5685 <dd>
5686 <p>The pathname of a file that stores a client certificate to use to authenticate
5687 with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
5688 variable.</p>
5689 </dd>
5690 <dt class="hdlist1">http.proxySSLKey</dt>
5691 <dd>
5692 <p>The pathname of a file that stores a private key to use to authenticate with
5693 an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
5694 variable.</p>
5695 </dd>
5696 <dt class="hdlist1">http.proxySSLCertPasswordProtected</dt>
5697 <dd>
5698 <p>Enable Git&#8217;s password prompt for the proxy SSL certificate.  Otherwise OpenSSL
5699 will prompt the user, possibly many times, if the certificate or private key
5700 is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
5701 environment variable.</p>
5702 </dd>
5703 <dt class="hdlist1">http.proxySSLCAInfo</dt>
5704 <dd>
5705 <p>Pathname to the file containing the certificate bundle that should be used to
5706 verify the proxy with when using an HTTPS proxy. Can be overridden by the
5707 <code>GIT_PROXY_SSL_CAINFO</code> environment variable.</p>
5708 </dd>
5709 <dt class="hdlist1">http.emptyAuth</dt>
5710 <dd>
5711 <p>Attempt authentication without seeking a username or password.  This
5712 can be used to attempt GSS-Negotiate authentication without specifying
5713 a username in the URL, as libcurl normally requires a username for
5714 authentication.</p>
5715 </dd>
5716 <dt class="hdlist1">http.proactiveAuth</dt>
5717 <dd>
5718 <p>Attempt authentication without first making an unauthenticated attempt and
5719 receiving a 401 response. This can be used to ensure that all requests are
5720 authenticated. If <code>http.emptyAuth</code> is set to true, this value has no effect.</p>
5721 <div class="paragraph">
5722 <p>If the credential helper used specifies an authentication scheme (i.e., via the
5723 <code>authtype</code> field), that value will be used; if a username and password is
5724 provided without a scheme, then Basic authentication is used.  The value of the
5725 option determines the scheme requested from the helper. Possible values are:</p>
5726 </div>
5727 <div class="openblock">
5728 <div class="content">
5729 <div class="ulist">
5730 <ul>
5731 <li>
5732 <p><code>basic</code> - Request Basic authentication from the helper.</p>
5733 </li>
5734 <li>
5735 <p><code>auto</code> - Allow the helper to pick an appropriate scheme.</p>
5736 </li>
5737 <li>
5738 <p><code>none</code> - Disable proactive authentication.</p>
5739 </li>
5740 </ul>
5741 </div>
5742 </div>
5743 </div>
5744 <div class="paragraph">
5745 <p>Note that TLS should always be used with this configuration, since otherwise it
5746 is easy to accidentally expose plaintext credentials if Basic authentication
5747 is selected.</p>
5748 </div>
5749 </dd>
5750 <dt class="hdlist1">http.delegation</dt>
5751 <dd>
5752 <p>Control GSSAPI credential delegation. The delegation is disabled
5753 by default in libcurl since version 7.21.7. Set parameter to tell
5754 the server what it is allowed to delegate when it comes to user
5755 credentials. Used with GSS/kerberos. Possible values are:</p>
5756 <div class="openblock">
5757 <div class="content">
5758 <div class="ulist">
5759 <ul>
5760 <li>
5761 <p><code>none</code> - Don&#8217;t allow any delegation.</p>
5762 </li>
5763 <li>
5764 <p><code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
5765 Kerberos service ticket, which is a matter of realm policy.</p>
5766 </li>
5767 <li>
5768 <p><code>always</code> - Unconditionally allow the server to delegate.</p>
5769 </li>
5770 </ul>
5771 </div>
5772 </div>
5773 </div>
5774 </dd>
5775 <dt class="hdlist1">http.extraHeader</dt>
5776 <dd>
5777 <p>Pass an additional HTTP header when communicating with a server.  If
5778 more than one such entry exists, all of them are added as extra
5779 headers.  To allow overriding the settings inherited from the system
5780 config, an empty value will reset the extra headers to the empty list.</p>
5781 </dd>
5782 <dt class="hdlist1">http.cookieFile</dt>
5783 <dd>
5784 <p>The pathname of a file containing previously stored cookie lines,
5785 which should be used
5786 in the Git http session, if they match the server. The file format
5787 of the file to read cookies from should be plain HTTP headers or
5788 the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
5789 Set it to an empty string, to accept only new cookies from
5790 the server and send them back in successive requests within same
5791 connection.
5792 NOTE that the file specified with http.cookieFile is used only as
5793 input unless http.saveCookies is set.</p>
5794 </dd>
5795 <dt class="hdlist1">http.saveCookies</dt>
5796 <dd>
5797 <p>If set, store cookies received during requests to the file specified by
5798 http.cookieFile. Has no effect if http.cookieFile is unset, or set to
5799 an empty string.</p>
5800 </dd>
5801 <dt class="hdlist1">http.version</dt>
5802 <dd>
5803 <p>Use the specified HTTP protocol version when communicating with a server.
5804 If you want to force the default. The available and default version depend
5805 on libcurl. Currently the possible values of
5806 this option are:</p>
5807 <div class="ulist">
5808 <ul>
5809 <li>
5810 <p>HTTP/2</p>
5811 </li>
5812 <li>
5813 <p>HTTP/1.1</p>
5814 </li>
5815 </ul>
5816 </div>
5817 </dd>
5818 <dt class="hdlist1">http.curloptResolve</dt>
5819 <dd>
5820 <p>Hostname resolution information that will be used first by
5821 libcurl when sending HTTP requests.  This information should
5822 be in one of the following formats:</p>
5823 <div class="ulist">
5824 <ul>
5825 <li>
5826 <p>[+]HOST:PORT:ADDRESS[,ADDRESS]</p>
5827 </li>
5828 <li>
5829 <p>-HOST:PORT</p>
5830 </li>
5831 </ul>
5832 </div>
5833 <div class="paragraph">
5834 <p>The first format redirects all requests to the given <code>HOST:PORT</code>
5835 to the provided <code>ADDRESS</code>(s). The second format clears all
5836 previous config values for that <code>HOST:PORT</code> combination.  To
5837 allow easy overriding of all the settings inherited from the
5838 system config, an empty value will reset all resolution
5839 information to the empty list.</p>
5840 </div>
5841 </dd>
5842 <dt class="hdlist1">http.sslVersion</dt>
5843 <dd>
5844 <p>The SSL version to use when negotiating an SSL connection, if you
5845 want to force the default.  The available and default version
5846 depend on whether libcurl was built against NSS or OpenSSL and the
5847 particular configuration of the crypto library in use. Internally
5848 this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
5849 documentation for more details on the format of this option and
5850 for the ssl version supported. Currently the possible values of
5851 this option are:</p>
5852 <div class="ulist">
5853 <ul>
5854 <li>
5855 <p>sslv2</p>
5856 </li>
5857 <li>
5858 <p>sslv3</p>
5859 </li>
5860 <li>
5861 <p>tlsv1</p>
5862 </li>
5863 <li>
5864 <p>tlsv1.0</p>
5865 </li>
5866 <li>
5867 <p>tlsv1.1</p>
5868 </li>
5869 <li>
5870 <p>tlsv1.2</p>
5871 </li>
5872 <li>
5873 <p>tlsv1.3</p>
5874 </li>
5875 </ul>
5876 </div>
5877 <div class="paragraph">
5878 <p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
5879 To force git to use libcurl&#8217;s default ssl version and ignore any
5880 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
5881 empty string.</p>
5882 </div>
5883 </dd>
5884 <dt class="hdlist1">http.sslCipherList</dt>
5885 <dd>
5886 <p>A list of SSL ciphers to use when negotiating an SSL connection.
5887 The available ciphers depend on whether libcurl was built against
5888 NSS or OpenSSL and the particular configuration of the crypto
5889 library in use.  Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
5890 option; see the libcurl documentation for more details on the format
5891 of this list.</p>
5892 <div class="paragraph">
5893 <p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
5894 To force git to use libcurl&#8217;s default cipher list and ignore any
5895 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
5896 empty string.</p>
5897 </div>
5898 </dd>
5899 <dt class="hdlist1">http.sslVerify</dt>
5900 <dd>
5901 <p>Whether to verify the SSL certificate when fetching or pushing
5902 over HTTPS. Defaults to true. Can be overridden by the
5903 <code>GIT_SSL_NO_VERIFY</code> environment variable.</p>
5904 </dd>
5905 <dt class="hdlist1">http.sslCert</dt>
5906 <dd>
5907 <p>File containing the SSL certificate when fetching or pushing
5908 over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
5909 variable.</p>
5910 </dd>
5911 <dt class="hdlist1">http.sslKey</dt>
5912 <dd>
5913 <p>File containing the SSL private key when fetching or pushing
5914 over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
5915 variable.</p>
5916 </dd>
5917 <dt class="hdlist1">http.sslCertPasswordProtected</dt>
5918 <dd>
5919 <p>Enable Git&#8217;s password prompt for the SSL certificate.  Otherwise
5920 OpenSSL will prompt the user, possibly many times, if the
5921 certificate or private key is encrypted.  Can be overridden by the
5922 <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.</p>
5923 </dd>
5924 <dt class="hdlist1">http.sslCAInfo</dt>
5925 <dd>
5926 <p>File containing the certificates to verify the peer with when
5927 fetching or pushing over HTTPS. Can be overridden by the
5928 <code>GIT_SSL_CAINFO</code> environment variable.</p>
5929 </dd>
5930 <dt class="hdlist1">http.sslCAPath</dt>
5931 <dd>
5932 <p>Path containing files with the CA certificates to verify the peer
5933 with when fetching or pushing over HTTPS. Can be overridden
5934 by the <code>GIT_SSL_CAPATH</code> environment variable.</p>
5935 </dd>
5936 <dt class="hdlist1">http.sslBackend</dt>
5937 <dd>
5938 <p>Name of the SSL backend to use (e.g. "openssl" or "schannel").
5939 This option is ignored if cURL lacks support for choosing the SSL
5940 backend at runtime.</p>
5941 </dd>
5942 <dt class="hdlist1">http.schannelCheckRevoke</dt>
5943 <dd>
5944 <p>Used to enforce or disable certificate revocation checks in cURL
5945 when http.sslBackend is set to "schannel". Defaults to <code>true</code> if
5946 unset. Only necessary to disable this if Git consistently errors
5947 and the message is about checking the revocation status of a
5948 certificate. This option is ignored if cURL lacks support for
5949 setting the relevant SSL option at runtime.</p>
5950 </dd>
5951 <dt class="hdlist1">http.schannelUseSSLCAInfo</dt>
5952 <dd>
5953 <p>As of cURL v7.60.0, the Secure Channel backend can use the
5954 certificate bundle provided via <code>http.sslCAInfo</code>, but that would
5955 override the Windows Certificate Store. Since this is not desirable
5956 by default, Git will tell cURL not to use that bundle by default
5957 when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
5958 unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.</p>
5959 </dd>
5960 <dt class="hdlist1">http.pinnedPubkey</dt>
5961 <dd>
5962 <p>Public key of the https service. It may either be the filename of
5963 a PEM or DER encoded public key file or a string starting with
5964 <em>sha256//</em> followed by the base64 encoded sha256 hash of the
5965 public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
5966 exit with an error if this option is set but not supported by
5967 cURL.</p>
5968 </dd>
5969 <dt class="hdlist1">http.sslTry</dt>
5970 <dd>
5971 <p>Attempt to use AUTH SSL/TLS and encrypted data transfers
5972 when connecting via regular FTP protocol. This might be needed
5973 if the FTP server requires it for security reasons or you wish
5974 to connect securely whenever remote FTP server supports it.
5975 Default is false since it might trigger certificate verification
5976 errors on misconfigured servers.</p>
5977 </dd>
5978 <dt class="hdlist1">http.maxRequests</dt>
5979 <dd>
5980 <p>How many HTTP requests to launch in parallel. Can be overridden
5981 by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.</p>
5982 </dd>
5983 <dt class="hdlist1">http.minSessions</dt>
5984 <dd>
5985 <p>The number of curl sessions (counted across slots) to be kept across
5986 requests. They will not be ended with curl_easy_cleanup() until
5987 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
5988 value will be capped at 1. Defaults to 1.</p>
5989 </dd>
5990 <dt class="hdlist1">http.postBuffer</dt>
5991 <dd>
5992 <p>Maximum size in bytes of the buffer used by smart HTTP
5993 transports when POSTing data to the remote system.
5994 For requests larger than this buffer size, HTTP/1.1 and
5995 Transfer-Encoding: chunked is used to avoid creating a
5996 massive pack file locally.  Default is 1 MiB, which is
5997 sufficient for most requests.</p>
5998 <div class="paragraph">
5999 <p>Note that raising this limit is only effective for disabling chunked
6000 transfer encoding and therefore should be used only where the remote
6001 server or a proxy only supports HTTP/1.0 or is noncompliant with the
6002 HTTP standard.  Raising this is not, in general, an effective solution
6003 for most push problems, but can increase memory consumption
6004 significantly since the entire buffer is allocated even for small
6005 pushes.</p>
6006 </div>
6007 </dd>
6008 <dt class="hdlist1">http.lowSpeedLimit, http.lowSpeedTime</dt>
6009 <dd>
6010 <p>If the HTTP transfer speed, in bytes per second, is less than
6011 <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
6012 the transfer is aborted.
6013 Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
6014 <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.</p>
6015 </dd>
6016 <dt class="hdlist1">http.noEPSV</dt>
6017 <dd>
6018 <p>A boolean which disables using of EPSV ftp command by curl.
6019 This can be helpful with some "poor" ftp servers which don&#8217;t
6020 support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
6021 environment variable. Default is false (curl will use EPSV).</p>
6022 </dd>
6023 <dt class="hdlist1">http.userAgent</dt>
6024 <dd>
6025 <p>The HTTP USER_AGENT string presented to an HTTP server.  The default
6026 value represents the version of the Git client such as git/1.7.1.
6027 This option allows you to override this value to a more common value
6028 such as Mozilla/4.0.  This may be necessary, for instance, if
6029 connecting through a firewall that restricts HTTP connections to a set
6030 of common USER_AGENT strings (but not including those like git/1.7.1).
6031 Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.</p>
6032 </dd>
6033 <dt class="hdlist1">http.followRedirects</dt>
6034 <dd>
6035 <p>Whether git should follow HTTP redirects. If set to <code>true</code>, git
6036 will transparently follow any redirect issued by a server it
6037 encounters. If set to <code>false</code>, git will treat all redirects as
6038 errors. If set to <code>initial</code>, git will follow redirects only for
6039 the initial request to a remote, but not for subsequent
6040 follow-up HTTP requests. Since git uses the redirected URL as
6041 the base for the follow-up requests, this is generally
6042 sufficient. The default is <code>initial</code>.</p>
6043 </dd>
6044 <dt class="hdlist1">http.&lt;url&gt;.*</dt>
6045 <dd>
6046 <p>Any of the http.* options above can be applied selectively to some URLs.
6047 For a config key to match a URL, each element of the config key is
6048 compared to that of the URL, in the following order:</p>
6049 <div class="openblock">
6050 <div class="content">
6051 <div class="olist arabic">
6052 <ol class="arabic">
6053 <li>
6054 <p>Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
6055 must match exactly between the config key and the URL.</p>
6056 </li>
6057 <li>
6058 <p>Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
6059 This field must match between the config key and the URL. It is
6060 possible to specify a <code>*</code> as part of the host name to match all subdomains
6061 at this level. <code>https://*.example.com/</code> for example would match
6062 <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.</p>
6063 </li>
6064 <li>
6065 <p>Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
6066 This field must match exactly between the config key and the URL.
6067 Omitted port numbers are automatically converted to the correct
6068 default for the scheme before matching.</p>
6069 </li>
6070 <li>
6071 <p>Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
6072 path field of the config key must match the path field of the URL
6073 either exactly or as a prefix of slash-delimited path elements.  This means
6074 a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>.  A prefix can only
6075 match on a slash (<code>/</code>) boundary.  Longer matches take precedence (so a config
6076 key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
6077 key with just path <code>foo/</code>).</p>
6078 </li>
6079 <li>
6080 <p>User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
6081 the config key has a user name it must match the user name in the
6082 URL exactly. If the config key does not have a user name, that
6083 config key will match a URL with any user name (including none),
6084 but at a lower precedence than a config key with a user name.</p>
6085 </li>
6086 </ol>
6087 </div>
6088 </div>
6089 </div>
6090 <div class="paragraph">
6091 <p>The list above is ordered by decreasing precedence; a URL that matches
6092 a config key&#8217;s path is preferred to one that matches its user name. For example,
6093 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
6094 <code>https://example.com/foo</code> will be preferred over a config key match of
6095 <code>https://user@example.com</code>.</p>
6096 </div>
6097 <div class="paragraph">
6098 <p>All URLs are normalized before attempting any matching (the password part,
6099 if embedded in the URL, is always ignored for matching purposes) so that
6100 equivalent URLs that are simply spelled differently will match properly.
6101 Environment variable settings always override any matches.  The URLs that are
6102 matched against are those given directly to Git commands.  This means any URLs
6103 visited as a result of a redirection do not participate in matching.</p>
6104 </div>
6105 </dd>
6106 <dt class="hdlist1">i18n.commitEncoding</dt>
6107 <dd>
6108 <p>Character encoding the commit messages are stored in; Git itself
6109 does not care per se, but this information is necessary e.g. when
6110 importing commits from emails or in the gitk graphical history
6111 browser (and possibly in other places in the future or in other
6112 porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.</p>
6113 </dd>
6114 <dt class="hdlist1">i18n.logOutputEncoding</dt>
6115 <dd>
6116 <p>Character encoding the commit messages are converted to when
6117 running <em>git log</em> and friends.</p>
6118 </dd>
6119 <dt class="hdlist1">imap.folder</dt>
6120 <dd>
6121 <p>The folder to drop the mails into, which is typically the Drafts
6122 folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
6123 "[Gmail]/Drafts". Required.</p>
6124 </dd>
6125 <dt class="hdlist1">imap.tunnel</dt>
6126 <dd>
6127 <p>Command used to set up a tunnel to the IMAP server through which
6128 commands will be piped instead of using a direct network connection
6129 to the server. Required when imap.host is not set.</p>
6130 </dd>
6131 <dt class="hdlist1">imap.host</dt>
6132 <dd>
6133 <p>A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
6134 connections and an <code>imaps://</code> prefix for secure connections.
6135 Ignored when imap.tunnel is set, but required otherwise.</p>
6136 </dd>
6137 <dt class="hdlist1">imap.user</dt>
6138 <dd>
6139 <p>The username to use when logging in to the server.</p>
6140 </dd>
6141 <dt class="hdlist1">imap.pass</dt>
6142 <dd>
6143 <p>The password to use when logging in to the server.</p>
6144 </dd>
6145 <dt class="hdlist1">imap.port</dt>
6146 <dd>
6147 <p>An integer port number to connect to on the server.
6148 Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
6149 Ignored when imap.tunnel is set.</p>
6150 </dd>
6151 <dt class="hdlist1">imap.sslverify</dt>
6152 <dd>
6153 <p>A boolean to enable/disable verification of the server certificate
6154 used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
6155 imap.tunnel is set.</p>
6156 </dd>
6157 <dt class="hdlist1">imap.preformattedHTML</dt>
6158 <dd>
6159 <p>A boolean to enable/disable the use of html encoding when sending
6160 a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
6161 and have a content type of text/html.  Ironically, enabling this
6162 option causes Thunderbird to send the patch as a plain/text,
6163 format=fixed email.  Default is <code>false</code>.</p>
6164 </dd>
6165 <dt class="hdlist1">imap.authMethod</dt>
6166 <dd>
6167 <p>Specify the authentication method for authenticating with the IMAP server.
6168 If Git was built with the NO_CURL option, or if your curl version is older
6169 than 7.34.0, or if you&#8217;re running git-imap-send with the <code>--no-curl</code>
6170 option, the only supported method is <em>CRAM-MD5</em>. If this is not set
6171 then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.</p>
6172 </dd>
6173 <dt class="hdlist1">include.path</dt>
6174 <dt class="hdlist1">includeIf.&lt;condition&gt;.path</dt>
6175 <dd>
6176 <p>Special variables to include other configuration files. See
6177 the "CONFIGURATION FILE" section in the main
6178 <a href="git-config.html">git-config(1)</a> documentation,
6179 specifically the "Includes" and "Conditional Includes" subsections.</p>
6180 </dd>
6181 <dt class="hdlist1">index.recordEndOfIndexEntries</dt>
6182 <dd>
6183 <p>Specifies whether the index file should include an "End Of Index
6184 Entry" section. This reduces index load time on multiprocessor
6185 machines but produces a message "ignoring EOIE extension" when
6186 reading the index using Git versions before 2.20. Defaults to
6187 <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
6188 otherwise.</p>
6189 </dd>
6190 <dt class="hdlist1">index.recordOffsetTable</dt>
6191 <dd>
6192 <p>Specifies whether the index file should include an "Index Entry
6193 Offset Table" section. This reduces index load time on
6194 multiprocessor machines but produces a message "ignoring IEOT
6195 extension" when reading the index using Git versions before 2.20.
6196 Defaults to <em>true</em> if index.threads has been explicitly enabled,
6197 <em>false</em> otherwise.</p>
6198 </dd>
6199 <dt class="hdlist1">index.sparse</dt>
6200 <dd>
6201 <p>When enabled, write the index using sparse-directory entries. This
6202 has no effect unless <code>core.sparseCheckout</code> and
6203 <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.</p>
6204 </dd>
6205 <dt class="hdlist1">index.threads</dt>
6206 <dd>
6207 <p>Specifies the number of threads to spawn when loading the index.
6208 This is meant to reduce index load time on multiprocessor machines.
6209 Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
6210 CPUs and set the number of threads accordingly. Specifying 1 or
6211 <em>false</em> will disable multithreading. Defaults to <em>true</em>.</p>
6212 </dd>
6213 <dt class="hdlist1">index.version</dt>
6214 <dd>
6215 <p>Specify the version with which new index files should be
6216 initialized.  This does not affect existing repositories.
6217 If <code>feature.manyFiles</code> is enabled, then the default is 4.</p>
6218 </dd>
6219 <dt class="hdlist1">index.skipHash</dt>
6220 <dd>
6221 <p>When enabled, do not compute the trailing hash for the index file.
6222 This accelerates Git commands that manipulate the index, such as
6223 <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
6224 checksum, write a trailing set of bytes with value zero, indicating
6225 that the computation was skipped.</p>
6226 <div class="paragraph">
6227 <p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
6228 refuse to parse the index and Git clients older than 2.40.0 will report an
6229 error during <code>git fsck</code>.</p>
6230 </div>
6231 </dd>
6232 </dl>
6233 </div>
6234 <div class="dlist">
6235 <dl>
6236 <dt class="hdlist1"><code>init.templateDir</code></dt>
6237 <dd>
6238 <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>
6239 </dd>
6240 <dt class="hdlist1"><code>init.defaultBranch</code></dt>
6241 <dd>
6242 <p>Allows overriding the default branch name e.g. when initializing
6243 a new repository.</p>
6244 </dd>
6245 <dt class="hdlist1"><code>init.defaultObjectFormat</code></dt>
6246 <dd>
6247 <p>Allows overriding the default object format for new repositories. See
6248 <code>--object-format=</code> in <a href="git-init.html">git-init(1)</a>. Both the command line option
6249 and the <code>GIT_DEFAULT_HASH</code> environment variable take precedence over
6250 this config.</p>
6251 </dd>
6252 <dt class="hdlist1"><code>init.defaultRefFormat</code></dt>
6253 <dd>
6254 <p>Allows overriding the default ref storage format for new repositories.
6255 See <code>--ref-format=</code> in <a href="git-init.html">git-init(1)</a>. Both the command line
6256 option and the <code>GIT_DEFAULT_REF_FORMAT</code> environment variable take
6257 precedence over this config.</p>
6258 </dd>
6259 <dt class="hdlist1">instaweb.browser</dt>
6260 <dd>
6261 <p>Specify the program that will be used to browse your working
6262 repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>.</p>
6263 </dd>
6264 <dt class="hdlist1">instaweb.httpd</dt>
6265 <dd>
6266 <p>The HTTP daemon command-line to start gitweb on your working
6267 repository. See <a href="git-instaweb.html">git-instaweb(1)</a>.</p>
6268 </dd>
6269 <dt class="hdlist1">instaweb.local</dt>
6270 <dd>
6271 <p>If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will
6272 be bound to the local IP (127.0.0.1).</p>
6273 </dd>
6274 <dt class="hdlist1">instaweb.modulePath</dt>
6275 <dd>
6276 <p>The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use
6277 instead of /usr/lib/apache2/modules.  Only used if httpd
6278 is Apache.</p>
6279 </dd>
6280 <dt class="hdlist1">instaweb.port</dt>
6281 <dd>
6282 <p>The port number to bind the gitweb httpd to. See
6283 <a href="git-instaweb.html">git-instaweb(1)</a>.</p>
6284 </dd>
6285 <dt class="hdlist1">interactive.singleKey</dt>
6286 <dd>
6287 <p>When set to true, allow the user to provide one-letter input
6288 with a single key (i.e., without hitting the Enter key) in
6289 interactive commands.  This is currently used by the <code>--patch</code>
6290 mode of <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>,
6291 <a href="git-restore.html">git-restore(1)</a>, <a href="git-commit.html">git-commit(1)</a>,
6292 <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>.</p>
6293 </dd>
6294 <dt class="hdlist1">interactive.diffFilter</dt>
6295 <dd>
6296 <p>When an interactive command (such as <code>git add --patch</code>) shows
6297 a colorized diff, git will pipe the diff through the shell
6298 command defined by this configuration variable. The command may
6299 mark up the diff further for human consumption, provided that it
6300 retains a one-to-one correspondence with the lines in the
6301 original diff. Defaults to disabled (no filtering).</p>
6302 </dd>
6303 <dt class="hdlist1">log.abbrevCommit</dt>
6304 <dd>
6305 <p>If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
6306 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
6307 override this option with <code>--no-abbrev-commit</code>.</p>
6308 </dd>
6309 <dt class="hdlist1">log.date</dt>
6310 <dd>
6311 <p>Set the default date-time mode for the <em>log</em> command.
6312 Setting a value for log.date is similar to using <em>git log</em>'s
6313 <code>--date</code> option.  See <a href="git-log.html">git-log(1)</a> for details.</p>
6314 <div class="paragraph">
6315 <p>If the format is set to "auto:foo" and the pager is in use, format
6316 "foo" will be used for the date format. Otherwise, "default" will
6317 be used.</p>
6318 </div>
6319 </dd>
6320 <dt class="hdlist1">log.decorate</dt>
6321 <dd>
6322 <p>Print out the ref names of any commits that are shown by the log
6323 command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
6324 <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
6325 specified, the full ref name (including prefix) will be printed.
6326 If <em>auto</em> is specified, then if the output is going to a terminal,
6327 the ref names are shown as if <em>short</em> were given, otherwise no ref
6328 names are shown. This is the same as the <code>--decorate</code> option
6329 of the <code>git log</code>.</p>
6330 </dd>
6331 <dt class="hdlist1">log.initialDecorationSet</dt>
6332 <dd>
6333 <p>By default, <code>git log</code> only shows decorations for certain known ref
6334 namespaces. If <em>all</em> is specified, then show all refs as
6335 decorations.</p>
6336 </dd>
6337 <dt class="hdlist1">log.excludeDecoration</dt>
6338 <dd>
6339 <p>Exclude the specified patterns from the log decorations. This is
6340 similar to the <code>--decorate-refs-exclude</code> command-line option, but
6341 the config option can be overridden by the <code>--decorate-refs</code>
6342 option.</p>
6343 </dd>
6344 <dt class="hdlist1">log.diffMerges</dt>
6345 <dd>
6346 <p>Set diff format to be used when <code>--diff-merges=on</code> is
6347 specified, see <code>--diff-merges</code> in <a href="git-log.html">git-log(1)</a> for
6348 details. Defaults to <code>separate</code>.</p>
6349 </dd>
6350 <dt class="hdlist1">log.follow</dt>
6351 <dd>
6352 <p>If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
6353 a single &lt;path&gt; is given.  This has the same limitations as <code>--follow</code>,
6354 i.e. it cannot be used to follow multiple files and does not work well
6355 on non-linear history.</p>
6356 </dd>
6357 <dt class="hdlist1">log.graphColors</dt>
6358 <dd>
6359 <p>A list of colors, separated by commas, that can be used to draw
6360 history lines in <code>git log --graph</code>.</p>
6361 </dd>
6362 <dt class="hdlist1">log.showRoot</dt>
6363 <dd>
6364 <p>If true, the initial commit will be shown as a big creation event.
6365 This is equivalent to a diff against an empty tree.
6366 Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which
6367 normally hide the root commit will now show it. True by default.</p>
6368 </dd>
6369 <dt class="hdlist1">log.showSignature</dt>
6370 <dd>
6371 <p>If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
6372 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--show-signature</code>.</p>
6373 </dd>
6374 <dt class="hdlist1">log.mailmap</dt>
6375 <dd>
6376 <p>If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and
6377 <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
6378 assume <code>--no-use-mailmap</code>. True by default.</p>
6379 </dd>
6380 <dt class="hdlist1">lsrefs.unborn</dt>
6381 <dd>
6382 <p>May be "advertise" (the default), "allow", or "ignore". If "advertise",
6383 the server will respond to the client sending "unborn" (as described in
6384 <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
6385 protocol v2 capability advertisement. "allow" is the same as
6386 "advertise" except that the server will not advertise support for this
6387 feature; this is useful for load-balanced servers that cannot be
6388 updated atomically (for example), since the administrator could
6389 configure "allow", then after a delay, configure "advertise".</p>
6390 </dd>
6391 <dt class="hdlist1">mailinfo.scissors</dt>
6392 <dd>
6393 <p>If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore
6394 <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option
6395 was provided on the command-line. When active, this feature
6396 removes everything from the message body before a scissors
6397 line (i.e. consisting mainly of "&gt;8", "8&lt;" and "-").</p>
6398 </dd>
6399 <dt class="hdlist1">mailmap.file</dt>
6400 <dd>
6401 <p>The location of an augmenting mailmap file. The default
6402 mailmap, located in the root of the repository, is loaded
6403 first, then the mailmap file pointed to by this variable.
6404 The location of the mailmap file may be in a repository
6405 subdirectory, or somewhere outside of the repository itself.
6406 See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>.</p>
6407 </dd>
6408 <dt class="hdlist1">mailmap.blob</dt>
6409 <dd>
6410 <p>Like <code>mailmap.file</code>, but consider the value as a reference to a
6411 blob in the repository. If both <code>mailmap.file</code> and
6412 <code>mailmap.blob</code> are given, both are parsed, with entries from
6413 <code>mailmap.file</code> taking precedence. In a bare repository, this
6414 defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
6415 defaults to empty.</p>
6416 </dd>
6417 <dt class="hdlist1">maintenance.auto</dt>
6418 <dd>
6419 <p>This boolean config option controls whether some commands run
6420 <code>git maintenance run --auto</code> after doing their normal work. Defaults
6421 to true.</p>
6422 </dd>
6423 <dt class="hdlist1">maintenance.autoDetach</dt>
6424 <dd>
6425 <p>Many Git commands trigger automatic maintenance after they have
6426 written data into the repository. This boolean config option
6427 controls whether this automatic maintenance shall happen in the
6428 foreground or whether the maintenance process shall detach and
6429 continue to run in the background.</p>
6430 <div class="paragraph">
6431 <p>If unset, the value of <code>gc.autoDetach</code> is used as a fallback. Defaults
6432 to true if both are unset, meaning that the maintenance process will
6433 detach.</p>
6434 </div>
6435 </dd>
6436 <dt class="hdlist1">maintenance.strategy</dt>
6437 <dd>
6438 <p>This string config option provides a way to specify one of a few
6439 recommended schedules for background maintenance. This only affects
6440 which tasks are run during <code>git maintenance run --schedule=X</code>
6441 commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
6442 Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
6443 then that value is used instead of the one provided by
6444 <code>maintenance.strategy</code>. The possible strategy strings are:</p>
6445 <div class="ulist">
6446 <ul>
6447 <li>
6448 <p><code>none</code>: This default setting implies no tasks are run at any schedule.</p>
6449 </li>
6450 <li>
6451 <p><code>incremental</code>: This setting optimizes for performing small maintenance
6452 activities that do not delete any data. This does not schedule the <code>gc</code>
6453 task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
6454 <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
6455 task weekly.</p>
6456 </li>
6457 </ul>
6458 </div>
6459 </dd>
6460 <dt class="hdlist1">maintenance.&lt;task&gt;.enabled</dt>
6461 <dd>
6462 <p>This boolean config option controls whether the maintenance task
6463 with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
6464 <code>git maintenance run</code>. These config values are ignored if a
6465 <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
6466 is true.</p>
6467 </dd>
6468 <dt class="hdlist1">maintenance.&lt;task&gt;.schedule</dt>
6469 <dd>
6470 <p>This config option controls whether or not the given <code>&lt;task&gt;</code> runs
6471 during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
6472 value must be one of "hourly", "daily", or "weekly".</p>
6473 </dd>
6474 <dt class="hdlist1">maintenance.commit-graph.auto</dt>
6475 <dd>
6476 <p>This integer config option controls how often the <code>commit-graph</code> task
6477 should be run as part of <code>git maintenance run --auto</code>. If zero, then
6478 the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
6479 negative value will force the task to run every time. Otherwise, a
6480 positive value implies the command should run when the number of
6481 reachable commits that are not in the commit-graph file is at least
6482 the value of <code>maintenance.commit-graph.auto</code>. The default value is
6483 100.</p>
6484 </dd>
6485 <dt class="hdlist1">maintenance.loose-objects.auto</dt>
6486 <dd>
6487 <p>This integer config option controls how often the <code>loose-objects</code> task
6488 should be run as part of <code>git maintenance run --auto</code>. If zero, then
6489 the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
6490 negative value will force the task to run every time. Otherwise, a
6491 positive value implies the command should run when the number of
6492 loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
6493 The default value is 100.</p>
6494 </dd>
6495 <dt class="hdlist1">maintenance.incremental-repack.auto</dt>
6496 <dd>
6497 <p>This integer config option controls how often the <code>incremental-repack</code>
6498 task should be run as part of <code>git maintenance run --auto</code>. If zero,
6499 then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
6500 option. A negative value will force the task to run every time.
6501 Otherwise, a positive value implies the command should run when the
6502 number of pack-files not in the multi-pack-index is at least the value
6503 of <code>maintenance.incremental-repack.auto</code>. The default value is 10.</p>
6504 </dd>
6505 <dt class="hdlist1">man.viewer</dt>
6506 <dd>
6507 <p>Specify the programs that may be used to display help in the
6508 <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.</p>
6509 </dd>
6510 <dt class="hdlist1">man.&lt;tool&gt;.cmd</dt>
6511 <dd>
6512 <p>Specify the command to invoke the specified man viewer. The
6513 specified command is evaluated in shell with the man page
6514 passed as an argument. (See <a href="git-help.html">git-help(1)</a>.)</p>
6515 </dd>
6516 <dt class="hdlist1">man.&lt;tool&gt;.path</dt>
6517 <dd>
6518 <p>Override the path for the given tool that may be used to
6519 display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>.</p>
6520 </dd>
6521 <dt class="hdlist1">merge.conflictStyle</dt>
6522 <dd>
6523 <p>Specify the style in which conflicted hunks are written out to
6524 working tree files upon merge.  The default is "merge", which
6525 shows a <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> conflict marker, changes made by one side,
6526 a <code>=======</code> marker, changes made by the other side, and then
6527 a <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> marker.  An alternate style, "diff3", adds a <code>|||||||</code>
6528 marker and the original text before the <code>=======</code> marker.  The
6529 "merge" style tends to produce smaller conflict regions than diff3,
6530 both because of the exclusion of the original text, and because
6531 when a subset of lines match on the two sides, they are just pulled
6532 out of the conflict region.  Another alternate style, "zdiff3", is
6533 similar to diff3 but removes matching lines on the two sides from
6534 the conflict region when those matching lines appear near either
6535 the beginning or end of a conflict region.</p>
6536 </dd>
6537 <dt class="hdlist1">merge.defaultToUpstream</dt>
6538 <dd>
6539 <p>If merge is called without any commit argument, merge the upstream
6540 branches configured for the current branch by using their last
6541 observed values stored in their remote-tracking branches.
6542 The values of the <code>branch.&lt;current branch&gt;.merge</code> that name the
6543 branches at the remote named by <code>branch.&lt;current branch&gt;.remote</code>
6544 are consulted, and then they are mapped via <code>remote.&lt;remote&gt;.fetch</code>
6545 to their corresponding remote-tracking branches, and the tips of
6546 these tracking branches are merged. Defaults to true.</p>
6547 </dd>
6548 <dt class="hdlist1">merge.ff</dt>
6549 <dd>
6550 <p>By default, Git does not create an extra merge commit when merging
6551 a commit that is a descendant of the current commit. Instead, the
6552 tip of the current branch is fast-forwarded. When set to <code>false</code>,
6553 this variable tells Git to create an extra merge commit in such
6554 a case (equivalent to giving the <code>--no-ff</code> option from the command
6555 line). When set to <code>only</code>, only such fast-forward merges are
6556 allowed (equivalent to giving the <code>--ff-only</code> option from the
6557 command line).</p>
6558 </dd>
6559 <dt class="hdlist1">merge.verifySignatures</dt>
6560 <dd>
6561 <p>If true, this is equivalent to the --verify-signatures command
6562 line option. See <a href="git-merge.html">git-merge(1)</a> for details.</p>
6563 </dd>
6564 <dt class="hdlist1">merge.branchdesc</dt>
6565 <dd>
6566 <p>In addition to branch names, populate the log message with
6567 the branch description text associated with them.  Defaults
6568 to false.</p>
6569 </dd>
6570 <dt class="hdlist1">merge.log</dt>
6571 <dd>
6572 <p>In addition to branch names, populate the log message with at
6573 most the specified number of one-line descriptions from the
6574 actual commits that are being merged.  Defaults to false, and
6575 true is a synonym for 20.</p>
6576 </dd>
6577 <dt class="hdlist1">merge.suppressDest</dt>
6578 <dd>
6579 <p>By adding a glob that matches the names of integration
6580 branches to this multi-valued configuration variable, the
6581 default merge message computed for merges into these
6582 integration branches will omit "into &lt;branch name&gt;" from
6583 its title.</p>
6584 <div class="paragraph">
6585 <p>An element with an empty value can be used to clear the list
6586 of globs accumulated from previous configuration entries.
6587 When there is no <code>merge.suppressDest</code> variable defined, the
6588 default value of <code>master</code> is used for backward compatibility.</p>
6589 </div>
6590 </dd>
6591 <dt class="hdlist1">merge.renameLimit</dt>
6592 <dd>
6593 <p>The number of files to consider in the exhaustive portion of
6594 rename detection during a merge.  If not specified, defaults
6595 to the value of diff.renameLimit.  If neither
6596 merge.renameLimit nor diff.renameLimit are specified,
6597 currently defaults to 7000.  This setting has no effect if
6598 rename detection is turned off.</p>
6599 </dd>
6600 <dt class="hdlist1">merge.renames</dt>
6601 <dd>
6602 <p>Whether Git detects renames.  If set to "false", rename detection
6603 is disabled. If set to "true", basic rename detection is enabled.
6604 Defaults to the value of diff.renames.</p>
6605 </dd>
6606 <dt class="hdlist1">merge.directoryRenames</dt>
6607 <dd>
6608 <p>Whether Git detects directory renames, affecting what happens at
6609 merge time to new files added to a directory on one side of
6610 history when that directory was renamed on the other side of
6611 history.  If merge.directoryRenames is set to "false", directory
6612 rename detection is disabled, meaning that such new files will be
6613 left behind in the old directory.  If set to "true", directory
6614 rename detection is enabled, meaning that such new files will be
6615 moved into the new directory.  If set to "conflict", a conflict
6616 will be reported for such paths.  If merge.renames is false,
6617 merge.directoryRenames is ignored and treated as false.  Defaults
6618 to "conflict".</p>
6619 </dd>
6620 <dt class="hdlist1">merge.renormalize</dt>
6621 <dd>
6622 <p>Tell Git that canonical representation of files in the
6623 repository has changed over time (e.g. earlier commits record
6624 text files with CRLF line endings, but recent ones use LF line
6625 endings).  In such a repository, Git can convert the data
6626 recorded in commits to a canonical form before performing a
6627 merge to reduce unnecessary conflicts.  For more information,
6628 see section "Merging branches with differing checkin/checkout
6629 attributes" in <a href="gitattributes.html">gitattributes(5)</a>.</p>
6630 </dd>
6631 <dt class="hdlist1">merge.stat</dt>
6632 <dd>
6633 <p>Whether to print the diffstat between ORIG_HEAD and the merge result
6634 at the end of the merge.  True by default.</p>
6635 </dd>
6636 <dt class="hdlist1">merge.autoStash</dt>
6637 <dd>
6638 <p>When set to true, automatically create a temporary stash entry
6639 before the operation begins, and apply it after the operation
6640 ends.  This means that you can run merge on a dirty worktree.
6641 However, use with care: the final stash application after a
6642 successful merge might result in non-trivial conflicts.
6643 This option can be overridden by the <code>--no-autostash</code> and
6644 <code>--autostash</code> options of <a href="git-merge.html">git-merge(1)</a>.
6645 Defaults to false.</p>
6646 </dd>
6647 <dt class="hdlist1">merge.tool</dt>
6648 <dd>
6649 <p>Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>.
6650 The list below shows the valid built-in values.
6651 Any other value is treated as a custom merge tool and requires
6652 that a corresponding mergetool.&lt;tool&gt;.cmd variable is defined.</p>
6653 </dd>
6654 <dt class="hdlist1">merge.guitool</dt>
6655 <dd>
6656 <p>Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a> when the
6657 -g/--gui flag is specified. The list below shows the valid built-in values.
6658 Any other value is treated as a custom merge tool and requires that a
6659 corresponding mergetool.&lt;guitool&gt;.cmd variable is defined.</p>
6660 <div class="dlist">
6661 <dl>
6662 <dt class="hdlist1"><code>araxis</code></dt>
6663 <dd>
6664 <p>Use Araxis Merge (requires a graphical session)</p>
6665 </dd>
6666 <dt class="hdlist1"><code>bc</code></dt>
6667 <dd>
6668 <p>Use Beyond Compare (requires a graphical session)</p>
6669 </dd>
6670 <dt class="hdlist1"><code>bc3</code></dt>
6671 <dd>
6672 <p>Use Beyond Compare (requires a graphical session)</p>
6673 </dd>
6674 <dt class="hdlist1"><code>bc4</code></dt>
6675 <dd>
6676 <p>Use Beyond Compare (requires a graphical session)</p>
6677 </dd>
6678 <dt class="hdlist1"><code>codecompare</code></dt>
6679 <dd>
6680 <p>Use Code Compare (requires a graphical session)</p>
6681 </dd>
6682 <dt class="hdlist1"><code>deltawalker</code></dt>
6683 <dd>
6684 <p>Use DeltaWalker (requires a graphical session)</p>
6685 </dd>
6686 <dt class="hdlist1"><code>diffmerge</code></dt>
6687 <dd>
6688 <p>Use DiffMerge (requires a graphical session)</p>
6689 </dd>
6690 <dt class="hdlist1"><code>diffuse</code></dt>
6691 <dd>
6692 <p>Use Diffuse (requires a graphical session)</p>
6693 </dd>
6694 <dt class="hdlist1"><code>ecmerge</code></dt>
6695 <dd>
6696 <p>Use ECMerge (requires a graphical session)</p>
6697 </dd>
6698 <dt class="hdlist1"><code>emerge</code></dt>
6699 <dd>
6700 <p>Use Emacs' Emerge</p>
6701 </dd>
6702 <dt class="hdlist1"><code>examdiff</code></dt>
6703 <dd>
6704 <p>Use ExamDiff Pro (requires a graphical session)</p>
6705 </dd>
6706 <dt class="hdlist1"><code>guiffy</code></dt>
6707 <dd>
6708 <p>Use Guiffy&#8217;s Diff Tool (requires a graphical session)</p>
6709 </dd>
6710 <dt class="hdlist1"><code>gvimdiff</code></dt>
6711 <dd>
6712 <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>
6713 </dd>
6714 <dt class="hdlist1"><code>gvimdiff1</code></dt>
6715 <dd>
6716 <p>Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)</p>
6717 </dd>
6718 <dt class="hdlist1"><code>gvimdiff2</code></dt>
6719 <dd>
6720 <p>Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)</p>
6721 </dd>
6722 <dt class="hdlist1"><code>gvimdiff3</code></dt>
6723 <dd>
6724 <p>Use gVim (requires a graphical session) where only the MERGED file is shown</p>
6725 </dd>
6726 <dt class="hdlist1"><code>kdiff3</code></dt>
6727 <dd>
6728 <p>Use KDiff3 (requires a graphical session)</p>
6729 </dd>
6730 <dt class="hdlist1"><code>meld</code></dt>
6731 <dd>
6732 <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>
6733 </dd>
6734 <dt class="hdlist1"><code>nvimdiff</code></dt>
6735 <dd>
6736 <p>Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)</p>
6737 </dd>
6738 <dt class="hdlist1"><code>nvimdiff1</code></dt>
6739 <dd>
6740 <p>Use Neovim with a 2 panes layout (LOCAL and REMOTE)</p>
6741 </dd>
6742 <dt class="hdlist1"><code>nvimdiff2</code></dt>
6743 <dd>
6744 <p>Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)</p>
6745 </dd>
6746 <dt class="hdlist1"><code>nvimdiff3</code></dt>
6747 <dd>
6748 <p>Use Neovim where only the MERGED file is shown</p>
6749 </dd>
6750 <dt class="hdlist1"><code>opendiff</code></dt>
6751 <dd>
6752 <p>Use FileMerge (requires a graphical session)</p>
6753 </dd>
6754 <dt class="hdlist1"><code>p4merge</code></dt>
6755 <dd>
6756 <p>Use HelixCore P4Merge (requires a graphical session)</p>
6757 </dd>
6758 <dt class="hdlist1"><code>smerge</code></dt>
6759 <dd>
6760 <p>Use Sublime Merge (requires a graphical session)</p>
6761 </dd>
6762 <dt class="hdlist1"><code>tkdiff</code></dt>
6763 <dd>
6764 <p>Use TkDiff (requires a graphical session)</p>
6765 </dd>
6766 <dt class="hdlist1"><code>tortoisemerge</code></dt>
6767 <dd>
6768 <p>Use TortoiseMerge (requires a graphical session)</p>
6769 </dd>
6770 <dt class="hdlist1"><code>vimdiff</code></dt>
6771 <dd>
6772 <p>Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)</p>
6773 </dd>
6774 <dt class="hdlist1"><code>vimdiff1</code></dt>
6775 <dd>
6776 <p>Use Vim with a 2 panes layout (LOCAL and REMOTE)</p>
6777 </dd>
6778 <dt class="hdlist1"><code>vimdiff2</code></dt>
6779 <dd>
6780 <p>Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)</p>
6781 </dd>
6782 <dt class="hdlist1"><code>vimdiff3</code></dt>
6783 <dd>
6784 <p>Use Vim where only the MERGED file is shown</p>
6785 </dd>
6786 <dt class="hdlist1"><code>vscode</code></dt>
6787 <dd>
6788 <p>Use Visual Studio Code (requires a graphical session)</p>
6789 </dd>
6790 <dt class="hdlist1"><code>winmerge</code></dt>
6791 <dd>
6792 <p>Use WinMerge (requires a graphical session)</p>
6793 </dd>
6794 <dt class="hdlist1"><code>xxdiff</code></dt>
6795 <dd>
6796 <p>Use xxdiff (requires a graphical session)</p>
6797 </dd>
6798 </dl>
6799 </div>
6800 </dd>
6801 <dt class="hdlist1">merge.verbosity</dt>
6802 <dd>
6803 <p>Controls the amount of output shown by the recursive merge
6804 strategy.  Level 0 outputs nothing except a final error
6805 message if conflicts were detected. Level 1 outputs only
6806 conflicts, 2 outputs conflicts and file changes.  Level 5 and
6807 above outputs debugging information.  The default is level 2.
6808 Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.</p>
6809 </dd>
6810 <dt class="hdlist1">merge.&lt;driver&gt;.name</dt>
6811 <dd>
6812 <p>Defines a human-readable name for a custom low-level
6813 merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
6814 </dd>
6815 <dt class="hdlist1">merge.&lt;driver&gt;.driver</dt>
6816 <dd>
6817 <p>Defines the command that implements a custom low-level
6818 merge driver.  See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
6819 </dd>
6820 <dt class="hdlist1">merge.&lt;driver&gt;.recursive</dt>
6821 <dd>
6822 <p>Names a low-level merge driver to be used when
6823 performing an internal merge between common ancestors.
6824 See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
6825 </dd>
6826 <dt class="hdlist1">mergetool.&lt;tool&gt;.path</dt>
6827 <dd>
6828 <p>Override the path for the given tool.  This is useful in case
6829 your tool is not in the PATH.</p>
6830 </dd>
6831 <dt class="hdlist1">mergetool.&lt;tool&gt;.cmd</dt>
6832 <dd>
6833 <p>Specify the command to invoke the specified merge tool.  The
6834 specified command is evaluated in shell with the following
6835 variables available: <em>BASE</em> is the name of a temporary file
6836 containing the common base of the files to be merged, if available;
6837 <em>LOCAL</em> is the name of a temporary file containing the contents of
6838 the file on the current branch; <em>REMOTE</em> is the name of a temporary
6839 file containing the contents of the file from the branch being
6840 merged; <em>MERGED</em> contains the name of the file to which the merge
6841 tool should write the results of a successful merge.</p>
6842 </dd>
6843 <dt class="hdlist1">mergetool.&lt;tool&gt;.hideResolved</dt>
6844 <dd>
6845 <p>Allows the user to override the global <code>mergetool.hideResolved</code> value
6846 for a specific tool. See <code>mergetool.hideResolved</code> for the full
6847 description.</p>
6848 </dd>
6849 <dt class="hdlist1">mergetool.&lt;tool&gt;.trustExitCode</dt>
6850 <dd>
6851 <p>For a custom merge command, specify whether the exit code of
6852 the merge command can be used to determine whether the merge was
6853 successful.  If this is not set to true then the merge target file
6854 timestamp is checked, and the merge is assumed to have been successful
6855 if the file has been updated; otherwise, the user is prompted to
6856 indicate the success of the merge.</p>
6857 </dd>
6858 <dt class="hdlist1">mergetool.meld.hasOutput</dt>
6859 <dd>
6860 <p>Older versions of <code>meld</code> do not support the <code>--output</code> option.
6861 Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
6862 by inspecting the output of <code>meld --help</code>.  Configuring
6863 <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
6864 use the configured value instead.  Setting <code>mergetool.meld.hasOutput</code>
6865 to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
6866 and <code>false</code> avoids using <code>--output</code>.</p>
6867 </dd>
6868 <dt class="hdlist1">mergetool.meld.useAutoMerge</dt>
6869 <dd>
6870 <p>When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
6871 parts automatically, highlight the conflicting parts, and wait for
6872 user decision.  Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
6873 Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
6874 Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
6875 is supported and will only use <code>--auto-merge</code> when available.  A
6876 value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
6877 default value.</p>
6878 </dd>
6879 <dt class="hdlist1">mergetool.&lt;vimdiff variant&gt;.layout</dt>
6880 <dd>
6881 <p>Configure the split window layout for vimdiff&#8217;s <code>&lt;variant&gt;</code>, which is any of <code>vimdiff</code>,
6882 <code>nvimdiff</code>, <code>gvimdiff</code>.
6883 Upon launching <code>git mergetool</code> with <code>--tool=&lt;variant&gt;</code> (or without <code>--tool</code>
6884 if <code>merge.tool</code> is configured as <code>&lt;variant&gt;</code>), Git will consult
6885 <code>mergetool.&lt;variant&gt;.layout</code> to determine the tool&#8217;s layout. If the
6886 variant-specific configuration is not available, <code>vimdiff</code>'s is used as
6887 fallback.  If that too is not available, a default layout with 4 windows
6888 will be used.  To configure the layout, see the <code>BACKEND SPECIFIC HINTS</code>
6889 section in <a href="git-mergetool.html">git-mergetool(1)</a>.</p>
6890 </dd>
6891 <dt class="hdlist1">mergetool.hideResolved</dt>
6892 <dd>
6893 <p>During a merge, Git will automatically resolve as many conflicts as
6894 possible and write the <em>MERGED</em> file containing conflict markers around
6895 any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
6896 represent the versions of the file from before Git&#8217;s conflict
6897 resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
6898 that only the unresolved conflicts are presented to the merge tool. Can
6899 be configured per-tool via the <code>mergetool.&lt;tool&gt;.hideResolved</code>
6900 configuration variable. Defaults to <code>false</code>.</p>
6901 </dd>
6902 <dt class="hdlist1">mergetool.keepBackup</dt>
6903 <dd>
6904 <p>After performing a merge, the original file with conflict markers
6905 can be saved as a file with a <code>.orig</code> extension.  If this variable
6906 is set to <code>false</code> then this file is not preserved.  Defaults to
6907 <code>true</code> (i.e. keep the backup files).</p>
6908 </dd>
6909 <dt class="hdlist1">mergetool.keepTemporaries</dt>
6910 <dd>
6911 <p>When invoking a custom merge tool, Git uses a set of temporary
6912 files to pass to the tool. If the tool returns an error and this
6913 variable is set to <code>true</code>, then these temporary files will be
6914 preserved; otherwise, they will be removed after the tool has
6915 exited. Defaults to <code>false</code>.</p>
6916 </dd>
6917 <dt class="hdlist1">mergetool.writeToTemp</dt>
6918 <dd>
6919 <p>Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
6920 conflicting files in the worktree by default.  Git will attempt
6921 to use a temporary directory for these files when set <code>true</code>.
6922 Defaults to <code>false</code>.</p>
6923 </dd>
6924 <dt class="hdlist1">mergetool.prompt</dt>
6925 <dd>
6926 <p>Prompt before each invocation of the merge resolution program.</p>
6927 </dd>
6928 <dt class="hdlist1">mergetool.guiDefault</dt>
6929 <dd>
6930 <p>Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
6931 specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
6932 or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
6933 variable value. The default is <code>false</code>, where the <code>--gui</code> argument
6934 must be provided explicitly for the <code>merge.guitool</code> to be used.</p>
6935 </dd>
6936 <dt class="hdlist1">notes.mergeStrategy</dt>
6937 <dd>
6938 <p>Which merge strategy to choose by default when resolving notes
6939 conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
6940 <code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
6941 section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.</p>
6942 <div class="paragraph">
6943 <p>This setting can be overridden by passing the <code>--strategy</code> option to
6944 <a href="git-notes.html">git-notes(1)</a>.</p>
6945 </div>
6946 </dd>
6947 <dt class="hdlist1">notes.&lt;name&gt;.mergeStrategy</dt>
6948 <dd>
6949 <p>Which merge strategy to choose when doing a notes merge into
6950 refs/notes/&lt;name&gt;.  This overrides the more general
6951 "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
6952 <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.</p>
6953 </dd>
6954 <dt class="hdlist1">notes.displayRef</dt>
6955 <dd>
6956 <p>Which ref (or refs, if a glob or specified more than once), in
6957 addition to the default set by <code>core.notesRef</code> or
6958 <code>GIT_NOTES_REF</code>, to read notes from when showing commit
6959 messages with the <em>git log</em> family of commands.</p>
6960 <div class="paragraph">
6961 <p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
6962 environment variable, which must be a colon separated list of refs or
6963 globs.</p>
6964 </div>
6965 <div class="paragraph">
6966 <p>A warning will be issued for refs that do not exist,
6967 but a glob that does not match any refs is silently ignored.</p>
6968 </div>
6969 <div class="paragraph">
6970 <p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
6971 log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
6972 those commands.</p>
6973 </div>
6974 <div class="paragraph">
6975 <p>The effective value of "core.notesRef" (possibly overridden by
6976 GIT_NOTES_REF) is also implicitly added to the list of refs to be
6977 displayed.</p>
6978 </div>
6979 </dd>
6980 <dt class="hdlist1">notes.rewrite.&lt;command&gt;</dt>
6981 <dd>
6982 <p>When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
6983 <code>rebase</code>), if this variable is <code>false</code>, git will not copy
6984 notes from the original to the rewritten commit.  Defaults to
6985 <code>true</code>.  See also "<code>notes.rewriteRef</code>" below.</p>
6986 <div class="paragraph">
6987 <p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
6988 environment variable, which must be a colon separated list of refs or
6989 globs.</p>
6990 </div>
6991 </dd>
6992 <dt class="hdlist1">notes.rewriteMode</dt>
6993 <dd>
6994 <p>When copying notes during a rewrite (see the
6995 "notes.rewrite.&lt;command&gt;" option), determines what to do if
6996 the target commit already has a note.  Must be one of
6997 <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
6998 Defaults to <code>concatenate</code>.</p>
6999 <div class="paragraph">
7000 <p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
7001 environment variable.</p>
7002 </div>
7003 </dd>
7004 <dt class="hdlist1">notes.rewriteRef</dt>
7005 <dd>
7006 <p>When copying notes during a rewrite, specifies the (fully
7007 qualified) ref whose notes should be copied.  May be a glob,
7008 in which case notes in all matching refs will be copied.  You
7009 may also specify this configuration several times.</p>
7010 <div class="paragraph">
7011 <p>Does not have a default value; you must configure this variable to
7012 enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
7013 rewriting for the default commit notes.</p>
7014 </div>
7015 <div class="paragraph">
7016 <p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
7017 See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p>
7018 </div>
7019 </dd>
7020 <dt class="hdlist1">pack.window</dt>
7021 <dd>
7022 <p>The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
7023 window size is given on the command line. Defaults to 10.</p>
7024 </dd>
7025 <dt class="hdlist1">pack.depth</dt>
7026 <dd>
7027 <p>The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no
7028 maximum depth is given on the command line. Defaults to 50.
7029 Maximum value is 4095.</p>
7030 </dd>
7031 <dt class="hdlist1">pack.windowMemory</dt>
7032 <dd>
7033 <p>The maximum size of memory that is consumed by each thread
7034 in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when
7035 no limit is given on the command line.  The value can be
7036 suffixed with "k", "m", or "g".  When left unconfigured (or
7037 set explicitly to 0), there will be no limit.</p>
7038 </dd>
7039 <dt class="hdlist1">pack.compression</dt>
7040 <dd>
7041 <p>An integer -1..9, indicating the compression level for objects
7042 in a pack file. -1 is the zlib default. 0 means no
7043 compression, and 1..9 are various speed/size tradeoffs, 9 being
7044 slowest.  If not set,  defaults to core.compression.  If that is
7045 not set,  defaults to -1, the zlib default, which is "a default
7046 compromise between speed and compression (currently equivalent
7047 to level 6)."</p>
7048 <div class="paragraph">
7049 <p>Note that changing the compression level will not automatically recompress
7050 all existing objects. You can force recompression by passing the -F option
7051 to <a href="git-repack.html">git-repack(1)</a>.</p>
7052 </div>
7053 </dd>
7054 <dt class="hdlist1">pack.allowPackReuse</dt>
7055 <dd>
7056 <p>When true or "single", and when reachability bitmaps are
7057 enabled, pack-objects will try to send parts of the bitmapped
7058 packfile verbatim. When "multi", and when a multi-pack
7059 reachability bitmap is available, pack-objects will try to send
7060 parts of all packs in the MIDX.</p>
7061 <div class="paragraph">
7062 <p>If only a single pack bitmap is available, and <code>pack.allowPackReuse</code>
7063 is set to "multi", reuse parts of just the bitmapped packfile. This
7064 can reduce memory and CPU usage to serve fetches, but might result in
7065 sending a slightly larger pack. Defaults to true.</p>
7066 </div>
7067 </dd>
7068 <dt class="hdlist1">pack.island</dt>
7069 <dd>
7070 <p>An extended regular expression configuring a set of delta
7071 islands. See "DELTA ISLANDS" in <a href="git-pack-objects.html">git-pack-objects(1)</a>
7072 for details.</p>
7073 </dd>
7074 <dt class="hdlist1">pack.islandCore</dt>
7075 <dd>
7076 <p>Specify an island name which gets to have its objects be
7077 packed first. This creates a kind of pseudo-pack at the front
7078 of one pack, so that the objects from the specified island are
7079 hopefully faster to copy into any pack that should be served
7080 to a user requesting these objects. In practice this means
7081 that the island specified should likely correspond to what is
7082 the most commonly cloned in the repo. See also "DELTA ISLANDS"
7083 in <a href="git-pack-objects.html">git-pack-objects(1)</a>.</p>
7084 </dd>
7085 <dt class="hdlist1">pack.deltaCacheSize</dt>
7086 <dd>
7087 <p>The maximum memory in bytes used for caching deltas in
7088 <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack.
7089 This cache is used to speed up the writing object phase by not
7090 having to recompute the final delta result once the best match
7091 for all objects is found.  Repacking large repositories on machines
7092 which are tight with memory might be badly impacted by this though,
7093 especially if this cache pushes the system into swapping.
7094 A value of 0 means no limit. The smallest size of 1 byte may be
7095 used to virtually disable this cache. Defaults to 256 MiB.</p>
7096 </dd>
7097 <dt class="hdlist1">pack.deltaCacheLimit</dt>
7098 <dd>
7099 <p>The maximum size of a delta, that is cached in
7100 <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the
7101 writing object phase by not having to recompute the final delta
7102 result once the best match for all objects is found.
7103 Defaults to 1000. Maximum value is 65535.</p>
7104 </dd>
7105 <dt class="hdlist1">pack.threads</dt>
7106 <dd>
7107 <p>Specifies the number of threads to spawn when searching for best
7108 delta matches.  This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a>
7109 be compiled with pthreads otherwise this option is ignored with a
7110 warning. This is meant to reduce packing time on multiprocessor
7111 machines. The required amount of memory for the delta search window
7112 is however multiplied by the number of threads.
7113 Specifying 0 will cause Git to auto-detect the number of CPUs
7114 and set the number of threads accordingly.</p>
7115 </dd>
7116 <dt class="hdlist1">pack.indexVersion</dt>
7117 <dd>
7118 <p>Specify the default pack index version.  Valid values are 1 for
7119 legacy pack index used by Git versions prior to 1.5.2, and 2 for
7120 the new pack index with capabilities for packs larger than 4 GB
7121 as well as proper protection against the repacking of corrupted
7122 packs.  Version 2 is the default.  Note that version 2 is enforced
7123 and this config option is ignored whenever the corresponding pack is
7124 larger than 2 GB.</p>
7125 <div class="paragraph">
7126 <p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
7127 cloning or fetching over a non-native protocol (e.g. "http")
7128 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
7129 other side may give you a repository that cannot be accessed with your
7130 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
7131 you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate
7132 the <code>*.idx</code> file.</p>
7133 </div>
7134 </dd>
7135 <dt class="hdlist1">pack.packSizeLimit</dt>
7136 <dd>
7137 <p>The maximum size of a pack.  This setting only affects
7138 packing to a file when repacking, i.e. the git:// protocol
7139 is unaffected.  It can be overridden by the <code>--max-pack-size</code>
7140 option of <a href="git-repack.html">git-repack(1)</a>.  Reaching this limit results
7141 in the creation of multiple packfiles.</p>
7142 <div class="paragraph">
7143 <p>Note that this option is rarely useful, and may result in a larger total
7144 on-disk size (because Git will not store deltas between packs) and
7145 worse runtime performance (object lookup within multiple packs is
7146 slower than a single pack, and optimizations like reachability bitmaps
7147 cannot cope with multiple packs).</p>
7148 </div>
7149 <div class="paragraph">
7150 <p>If you need to actively run Git using smaller packfiles (e.g., because your
7151 filesystem does not support large files), this option may help. But if
7152 your goal is to transmit a packfile over a medium that supports limited
7153 sizes (e.g., removable media that cannot store the whole repository),
7154 you are likely better off creating a single large packfile and splitting
7155 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p>
7156 </div>
7157 <div class="paragraph">
7158 <p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
7159 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p>
7160 </div>
7161 </dd>
7162 <dt class="hdlist1">pack.useBitmaps</dt>
7163 <dd>
7164 <p>When true, git will use pack bitmaps (if available) when packing
7165 to stdout (e.g., during the server side of a fetch). Defaults to
7166 true. You should not generally need to turn this off unless
7167 you are debugging pack bitmaps.</p>
7168 </dd>
7169 <dt class="hdlist1">pack.useBitmapBoundaryTraversal</dt>
7170 <dd>
7171 <p>When true, Git will use an experimental algorithm for computing
7172 reachability queries with bitmaps. Instead of building up
7173 complete bitmaps for all of the negated tips and then OR-ing
7174 them together, consider negated tips with existing bitmaps as
7175 additive (i.e. OR-ing them into the result if they exist,
7176 ignoring them otherwise), and build up a bitmap at the boundary
7177 instead.</p>
7178 <div class="paragraph">
7179 <p>When using this algorithm, Git may include too many objects as a result
7180 of not opening up trees belonging to certain UNINTERESTING commits. This
7181 inexactness matches the non-bitmap traversal algorithm.</p>
7182 </div>
7183 <div class="paragraph">
7184 <p>In many cases, this can provide a speed-up over the exact algorithm,
7185 particularly when there is poor bitmap coverage of the negated side of
7186 the query.</p>
7187 </div>
7188 </dd>
7189 <dt class="hdlist1">pack.useSparse</dt>
7190 <dd>
7191 <p>When true, git will default to using the <em>--sparse</em> option in
7192 <em>git pack-objects</em> when the <em>--revs</em> option is present. This
7193 algorithm only walks trees that appear in paths that introduce new
7194 objects. This can have significant performance benefits when
7195 computing a pack to send a small change. However, it is possible
7196 that extra objects are added to the pack-file if the included
7197 commits contain certain types of direct renames. Default is
7198 <code>true</code>.</p>
7199 </dd>
7200 <dt class="hdlist1">pack.preferBitmapTips</dt>
7201 <dd>
7202 <p>When selecting which commits will receive bitmaps, prefer a
7203 commit at the tip of any reference that is a suffix of any value
7204 of this configuration over any other commits in the "selection
7205 window".</p>
7206 <div class="paragraph">
7207 <p>Note that setting this configuration to <code>refs/foo</code> does not mean that
7208 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
7209 necessarily be selected. This is because commits are selected for
7210 bitmaps from within a series of windows of variable length.</p>
7211 </div>
7212 <div class="paragraph">
7213 <p>If a commit at the tip of any reference which is a suffix of any value
7214 of this configuration is seen in a window, it is immediately given
7215 preference over any other commit in that window.</p>
7216 </div>
7217 </dd>
7218 <dt class="hdlist1">pack.writeBitmaps (deprecated)</dt>
7219 <dd>
7220 <p>This is a deprecated synonym for <code>repack.writeBitmaps</code>.</p>
7221 </dd>
7222 <dt class="hdlist1">pack.writeBitmapHashCache</dt>
7223 <dd>
7224 <p>When true, git will include a "hash cache" section in the bitmap
7225 index (if one is written). This cache can be used to feed git&#8217;s
7226 delta heuristics, potentially leading to better deltas between
7227 bitmapped and non-bitmapped objects (e.g., when serving a fetch
7228 between an older, bitmapped pack and objects that have been
7229 pushed since the last gc). The downside is that it consumes 4
7230 bytes per object of disk space. Defaults to true.</p>
7231 <div class="paragraph">
7232 <p>When writing a multi-pack reachability bitmap, no new namehashes are
7233 computed; instead, any namehashes stored in an existing bitmap are
7234 permuted into their appropriate location when writing a new bitmap.</p>
7235 </div>
7236 </dd>
7237 <dt class="hdlist1">pack.writeBitmapLookupTable</dt>
7238 <dd>
7239 <p>When true, Git will include a "lookup table" section in the
7240 bitmap index (if one is written). This table is used to defer
7241 loading individual bitmaps as late as possible. This can be
7242 beneficial in repositories that have relatively large bitmap
7243 indexes. Defaults to false.</p>
7244 </dd>
7245 <dt class="hdlist1">pack.readReverseIndex</dt>
7246 <dd>
7247 <p>When true, git will read any .rev file(s) that may be available
7248 (see: <a href="gitformat-pack.html">gitformat-pack(5)</a>). When false, the reverse index
7249 will be generated from scratch and stored in memory. Defaults to
7250 true.</p>
7251 </dd>
7252 <dt class="hdlist1">pack.writeReverseIndex</dt>
7253 <dd>
7254 <p>When true, git will write a corresponding .rev file (see:
7255 <a href="gitformat-pack.html">gitformat-pack(5)</a>)
7256 for each new packfile that it writes in all places except for
7257 <a href="git-fast-import.html">git-fast-import(1)</a> and in the bulk checkin mechanism.
7258 Defaults to true.</p>
7259 </dd>
7260 <dt class="hdlist1">pager.&lt;cmd&gt;</dt>
7261 <dd>
7262 <p>If the value is boolean, turns on or off pagination of the
7263 output of a particular Git subcommand when writing to a tty.
7264 Otherwise, turns on pagination for the subcommand using the
7265 pager specified by the value of <code>pager.&lt;cmd&gt;</code>.  If <code>--paginate</code>
7266 or <code>--no-pager</code> is specified on the command line, it takes
7267 precedence over this option.  To disable pagination for all
7268 commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.</p>
7269 </dd>
7270 <dt class="hdlist1">pretty.&lt;name&gt;</dt>
7271 <dd>
7272 <p>Alias for a --pretty= format string, as specified in
7273 <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just
7274 as the built-in pretty formats could. For example,
7275 running <code>git config pretty.changelog "format:* %H %s"</code>
7276 would cause the invocation <code>git log --pretty=changelog</code>
7277 to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>.
7278 Note that an alias with the same name as a built-in format
7279 will be silently ignored.</p>
7280 </dd>
7281 <dt class="hdlist1">promisor.quiet</dt>
7282 <dd>
7283 <p>If set to "true" assume <code>--quiet</code> when fetching additional
7284 objects for a partial clone.</p>
7285 </dd>
7286 <dt class="hdlist1">protocol.allow</dt>
7287 <dd>
7288 <p>If set, provide a user defined default policy for all protocols which
7289 don&#8217;t explicitly have a policy (<code>protocol.&lt;name&gt;.allow</code>).  By default,
7290 if unset, known-safe protocols (http, https, git, ssh) have a
7291 default policy of <code>always</code>, known-dangerous protocols (ext) have a
7292 default policy of <code>never</code>, and all other protocols (including file)
7293 have a default policy of <code>user</code>.  Supported policies:</p>
7294 <div class="openblock">
7295 <div class="content">
7296 <div class="ulist">
7297 <ul>
7298 <li>
7299 <p><code>always</code> - protocol is always able to be used.</p>
7300 </li>
7301 <li>
7302 <p><code>never</code> - protocol is never able to be used.</p>
7303 </li>
7304 <li>
7305 <p><code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
7306 either unset or has a value of 1.  This policy should be used when you want a
7307 protocol to be directly usable by the user but don&#8217;t want it used by commands which
7308 execute clone/fetch/push commands without user input, e.g. recursive
7309 submodule initialization.</p>
7310 </li>
7311 </ul>
7312 </div>
7313 </div>
7314 </div>
7315 </dd>
7316 <dt class="hdlist1">protocol.&lt;name&gt;.allow</dt>
7317 <dd>
7318 <p>Set a policy to be used by protocol <code>&lt;name&gt;</code> with clone/fetch/push
7319 commands. See <code>protocol.allow</code> above for the available policies.</p>
7320 <div class="paragraph">
7321 <p>The protocol names currently used by git are:</p>
7322 </div>
7323 <div class="openblock">
7324 <div class="content">
7325 <div class="ulist">
7326 <ul>
7327 <li>
7328 <p><code>file</code>: any local file-based path (including <code>file://</code> URLs,
7329 or local paths)</p>
7330 </li>
7331 <li>
7332 <p><code>git</code>: the anonymous git protocol over a direct TCP
7333 connection (or proxy, if configured)</p>
7334 </li>
7335 <li>
7336 <p><code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
7337 <code>ssh://</code>, etc).</p>
7338 </li>
7339 <li>
7340 <p><code>http</code>: git over http, both "smart http" and "dumb http".
7341 Note that this does <em>not</em> include <code>https</code>; if you want to configure
7342 both, you must do so individually.</p>
7343 </li>
7344 <li>
7345 <p>any external helpers are named by their protocol (e.g., use
7346 <code>hg</code> to allow the <code>git-remote-hg</code> helper)</p>
7347 </li>
7348 </ul>
7349 </div>
7350 </div>
7351 </div>
7352 </dd>
7353 <dt class="hdlist1">protocol.version</dt>
7354 <dd>
7355 <p>If set, clients will attempt to communicate with a server
7356 using the specified protocol version.  If the server does
7357 not support it, communication falls back to version 0.
7358 If unset, the default is <code>2</code>.
7359 Supported versions:</p>
7360 <div class="openblock">
7361 <div class="content">
7362 <div class="ulist">
7363 <ul>
7364 <li>
7365 <p><code>0</code> - the original wire protocol.</p>
7366 </li>
7367 <li>
7368 <p><code>1</code> - the original wire protocol with the addition of a version string
7369 in the initial response from the server.</p>
7370 </li>
7371 <li>
7372 <p><code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>.</p>
7373 </li>
7374 </ul>
7375 </div>
7376 </div>
7377 </div>
7378 </dd>
7379 <dt class="hdlist1">pull.ff</dt>
7380 <dd>
7381 <p>By default, Git does not create an extra merge commit when merging
7382 a commit that is a descendant of the current commit. Instead, the
7383 tip of the current branch is fast-forwarded. When set to <code>false</code>,
7384 this variable tells Git to create an extra merge commit in such
7385 a case (equivalent to giving the <code>--no-ff</code> option from the command
7386 line). When set to <code>only</code>, only such fast-forward merges are
7387 allowed (equivalent to giving the <code>--ff-only</code> option from the
7388 command line). This setting overrides <code>merge.ff</code> when pulling.</p>
7389 </dd>
7390 <dt class="hdlist1">pull.rebase</dt>
7391 <dd>
7392 <p>When true, rebase branches on top of the fetched branch, instead
7393 of merging the default branch from the default remote when "git
7394 pull" is run. See "branch.&lt;name&gt;.rebase" for setting this on a
7395 per-branch basis.</p>
7396 <div class="paragraph">
7397 <p>When <code>merges</code> (or just <em>m</em>), pass the <code>--rebase-merges</code> option to <em>git rebase</em>
7398 so that the local merge commits are included in the rebase (see
7399 <a href="git-rebase.html">git-rebase(1)</a> for details).</p>
7400 </div>
7401 <div class="paragraph">
7402 <p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
7403 mode.</p>
7404 </div>
7405 <div class="paragraph">
7406 <p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
7407 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
7408 for details).</p>
7409 </div>
7410 </dd>
7411 <dt class="hdlist1">pull.octopus</dt>
7412 <dd>
7413 <p>The default merge strategy to use when pulling multiple branches
7414 at once.</p>
7415 </dd>
7416 <dt class="hdlist1">pull.twohead</dt>
7417 <dd>
7418 <p>The default merge strategy to use when pulling a single branch.</p>
7419 </dd>
7420 <dt class="hdlist1">push.autoSetupRemote</dt>
7421 <dd>
7422 <p>If set to "true" assume <code>--set-upstream</code> on default push when no
7423 upstream tracking exists for the current branch; this option
7424 takes effect with push.default options <em>simple</em>, <em>upstream</em>,
7425 and <em>current</em>. It is useful if by default you want new branches
7426 to be pushed to the default remote (like the behavior of
7427 <em>push.default=current</em>) and you also want the upstream tracking
7428 to be set. Workflows most likely to benefit from this option are
7429 <em>simple</em> central workflows where all branches are expected to
7430 have the same name on the remote.</p>
7431 </dd>
7432 <dt class="hdlist1">push.default</dt>
7433 <dd>
7434 <p>Defines the action <code>git push</code> should take if no refspec is
7435 given (whether from the command-line, config, or elsewhere).
7436 Different values are well-suited for
7437 specific workflows; for instance, in a purely central workflow
7438 (i.e. the fetch source is equal to the push destination),
7439 <code>upstream</code> is probably what you want.  Possible values are:</p>
7440 <div class="openblock">
7441 <div class="content">
7442 <div class="ulist">
7443 <ul>
7444 <li>
7445 <p><code>nothing</code> - do not push anything (error out) unless a refspec is
7446 given. This is primarily meant for people who want to
7447 avoid mistakes by always being explicit.</p>
7448 </li>
7449 <li>
7450 <p><code>current</code> - push the current branch to update a branch with the same
7451 name on the receiving end.  Works in both central and non-central
7452 workflows.</p>
7453 </li>
7454 <li>
7455 <p><code>upstream</code> - push the current branch back to the branch whose
7456 changes are usually integrated into the current branch (which is
7457 called <code>@{upstream}</code>).  This mode only makes sense if you are
7458 pushing to the same repository you would normally pull from
7459 (i.e. central workflow).</p>
7460 </li>
7461 <li>
7462 <p><code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.</p>
7463 </li>
7464 <li>
7465 <p><code>simple</code> - push the current branch with the same name on the remote.</p>
7466 <div class="paragraph">
7467 <p>If you are working on a centralized workflow (pushing to the same repository you
7468 pull from, which is typically <code>origin</code>), then you need to configure an upstream
7469 branch with the same name.</p>
7470 </div>
7471 <div class="paragraph">
7472 <p>This mode is the default since Git 2.0, and is the safest option suited for
7473 beginners.</p>
7474 </div>
7475 </li>
7476 <li>
7477 <p><code>matching</code> - push all branches having the same name on both ends.
7478 This makes the repository you are pushing to remember the set of
7479 branches that will be pushed out (e.g. if you always push <em>maint</em>
7480 and <em>master</em> there and no other branches, the repository you push
7481 to will have these two branches, and your local <em>maint</em> and
7482 <em>master</em> will be pushed there).</p>
7483 <div class="paragraph">
7484 <p>To use this mode effectively, you have to make sure <em>all</em> the
7485 branches you would push out are ready to be pushed out before
7486 running <em>git push</em>, as the whole point of this mode is to allow you
7487 to push all of the branches in one go.  If you usually finish work
7488 on only one branch and push out the result, while other branches are
7489 unfinished, this mode is not for you.  Also this mode is not
7490 suitable for pushing into a shared central repository, as other
7491 people may add new branches there, or update the tip of existing
7492 branches outside your control.</p>
7493 </div>
7494 <div class="paragraph">
7495 <p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
7496 new default).</p>
7497 </div>
7498 </li>
7499 </ul>
7500 </div>
7501 </div>
7502 </div>
7503 </dd>
7504 <dt class="hdlist1">push.followTags</dt>
7505 <dd>
7506 <p>If set to true, enable <code>--follow-tags</code> option by default.  You
7507 may override this configuration at time of push by specifying
7508 <code>--no-follow-tags</code>.</p>
7509 </dd>
7510 <dt class="hdlist1">push.gpgSign</dt>
7511 <dd>
7512 <p>May be set to a boolean value, or the string <em>if-asked</em>. A true
7513 value causes all pushes to be GPG signed, as if <code>--signed</code> is
7514 passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes
7515 pushes to be signed if the server supports it, as if
7516 <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
7517 override a value from a lower-priority config file. An explicit
7518 command-line flag always overrides this config option.</p>
7519 </dd>
7520 <dt class="hdlist1">push.pushOption</dt>
7521 <dd>
7522 <p>When no <code>--push-option=&lt;option&gt;</code> argument is given from the
7523 command line, <code>git push</code> behaves as if each &lt;value&gt; of
7524 this variable is given as <code>--push-option=&lt;value&gt;</code>.</p>
7525 <div class="paragraph">
7526 <p>This is a multi-valued variable, and an empty value can be used in a
7527 higher priority configuration file (e.g. <code>.git/config</code> in a
7528 repository) to clear the values inherited from a lower priority
7529 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p>
7530 </div>
7531 <div class="listingblock">
7532 <div class="content">
7533 <pre>Example:
7534
7535 /etc/gitconfig
7536   push.pushoption = a
7537   push.pushoption = b
7538
7539 ~/.gitconfig
7540   push.pushoption = c
7541
7542 repo/.git/config
7543   push.pushoption =
7544   push.pushoption = b
7545
7546 This will result in only b (a and c are cleared).</pre>
7547 </div>
7548 </div>
7549 </dd>
7550 <dt class="hdlist1">push.recurseSubmodules</dt>
7551 <dd>
7552 <p>May be "check", "on-demand", "only", or "no", with the same behavior
7553 as that of "push --recurse-submodules".
7554 If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
7555 set (in which case a <em>true</em> value means <em>on-demand</em>).</p>
7556 </dd>
7557 <dt class="hdlist1">push.useForceIfIncludes</dt>
7558 <dd>
7559 <p>If set to "true", it is equivalent to specifying
7560 <code>--force-if-includes</code> as an option to <a href="git-push.html">git-push(1)</a>
7561 in the command line. Adding <code>--no-force-if-includes</code> at the
7562 time of push overrides this configuration setting.</p>
7563 </dd>
7564 <dt class="hdlist1">push.negotiate</dt>
7565 <dd>
7566 <p>If set to "true", attempt to reduce the size of the packfile
7567 sent by rounds of negotiation in which the client and the
7568 server attempt to find commits in common. If "false", Git will
7569 rely solely on the server&#8217;s ref advertisement to find commits
7570 in common.</p>
7571 </dd>
7572 <dt class="hdlist1">push.useBitmaps</dt>
7573 <dd>
7574 <p>If set to "false", disable use of bitmaps for "git push" even if
7575 <code>pack.useBitmaps</code> is "true", without preventing other git operations
7576 from using bitmaps. Default is true.</p>
7577 </dd>
7578 <dt class="hdlist1">rebase.backend</dt>
7579 <dd>
7580 <p>Default backend to use for rebasing.  Possible choices are
7581 <em>apply</em> or <em>merge</em>.  In the future, if the merge backend gains
7582 all remaining capabilities of the apply backend, this setting
7583 may become unused.</p>
7584 </dd>
7585 <dt class="hdlist1">rebase.stat</dt>
7586 <dd>
7587 <p>Whether to show a diffstat of what changed upstream since the last
7588 rebase. False by default.</p>
7589 </dd>
7590 <dt class="hdlist1">rebase.autoSquash</dt>
7591 <dd>
7592 <p>If set to true, enable the <code>--autosquash</code> option of
7593 <a href="git-rebase.html">git-rebase(1)</a> by default for interactive mode.
7594 This can be overridden with the <code>--no-autosquash</code> option.</p>
7595 </dd>
7596 <dt class="hdlist1">rebase.autoStash</dt>
7597 <dd>
7598 <p>When set to true, automatically create a temporary stash entry
7599 before the operation begins, and apply it after the operation
7600 ends.  This means that you can run rebase on a dirty worktree.
7601 However, use with care: the final stash application after a
7602 successful rebase might result in non-trivial conflicts.
7603 This option can be overridden by the <code>--no-autostash</code> and
7604 <code>--autostash</code> options of <a href="git-rebase.html">git-rebase(1)</a>.
7605 Defaults to false.</p>
7606 </dd>
7607 <dt class="hdlist1">rebase.updateRefs</dt>
7608 <dd>
7609 <p>If set to true enable <code>--update-refs</code> option by default.</p>
7610 </dd>
7611 <dt class="hdlist1">rebase.missingCommitsCheck</dt>
7612 <dd>
7613 <p>If set to "warn", git rebase -i will print a warning if some
7614 commits are removed (e.g. a line was deleted), however the
7615 rebase will still proceed. If set to "error", it will print
7616 the previous warning and stop the rebase, <em>git rebase
7617 --edit-todo</em> can then be used to correct the error. If set to
7618 "ignore", no checking is done.
7619 To drop a commit without warning or error, use the <code>drop</code>
7620 command in the todo list.
7621 Defaults to "ignore".</p>
7622 </dd>
7623 <dt class="hdlist1">rebase.instructionFormat</dt>
7624 <dd>
7625 <p>A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for the
7626 todo list during an interactive rebase.  The format will
7627 automatically have the commit hash prepended to the format.</p>
7628 </dd>
7629 <dt class="hdlist1">rebase.abbreviateCommands</dt>
7630 <dd>
7631 <p>If set to true, <code>git rebase</code> will use abbreviated command names in the
7632 todo list resulting in something like this:</p>
7633 <div class="listingblock">
7634 <div class="content">
7635 <pre>        p deadbee The oneline of the commit
7636         p fa1afe1 The oneline of the next commit
7637         ...</pre>
7638 </div>
7639 </div>
7640 <div class="paragraph">
7641 <p>instead of:</p>
7642 </div>
7643 <div class="listingblock">
7644 <div class="content">
7645 <pre>        pick deadbee The oneline of the commit
7646         pick fa1afe1 The oneline of the next commit
7647         ...</pre>
7648 </div>
7649 </div>
7650 <div class="paragraph">
7651 <p>Defaults to false.</p>
7652 </div>
7653 </dd>
7654 <dt class="hdlist1">rebase.rescheduleFailedExec</dt>
7655 <dd>
7656 <p>Automatically reschedule <code>exec</code> commands that failed. This only makes
7657 sense in interactive mode (or when an <code>--exec</code> option was provided).
7658 This is the same as specifying the <code>--reschedule-failed-exec</code> option.</p>
7659 </dd>
7660 <dt class="hdlist1">rebase.forkPoint</dt>
7661 <dd>
7662 <p>If set to false set <code>--no-fork-point</code> option by default.</p>
7663 </dd>
7664 <dt class="hdlist1">rebase.rebaseMerges</dt>
7665 <dd>
7666 <p>Whether and how to set the <code>--rebase-merges</code> option by default. Can
7667 be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
7668 true or to <code>no-rebase-cousins</code> is equivalent to
7669 <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
7670 equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
7671 equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
7672 command line, with or without an argument, overrides any
7673 <code>rebase.rebaseMerges</code> configuration.</p>
7674 </dd>
7675 <dt class="hdlist1">rebase.maxLabelLength</dt>
7676 <dd>
7677 <p>When generating label names from commit subjects, truncate the names to
7678 this length. By default, the names are truncated to a little less than
7679 <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
7680 corresponding loose refs).</p>
7681 </dd>
7682 <dt class="hdlist1">receive.advertiseAtomic</dt>
7683 <dd>
7684 <p>By default, git-receive-pack will advertise the atomic push
7685 capability to its clients. If you don&#8217;t want to advertise this
7686 capability, set this variable to false.</p>
7687 </dd>
7688 <dt class="hdlist1">receive.advertisePushOptions</dt>
7689 <dd>
7690 <p>When set to true, git-receive-pack will advertise the push options
7691 capability to its clients. False by default.</p>
7692 </dd>
7693 <dt class="hdlist1">receive.autogc</dt>
7694 <dd>
7695 <p>By default, git-receive-pack will run "git maintenance run --auto" after
7696 receiving data from git-push and updating refs.  You can stop
7697 it by setting this variable to false.</p>
7698 </dd>
7699 <dt class="hdlist1">receive.certNonceSeed</dt>
7700 <dd>
7701 <p>By setting this variable to a string, <code>git receive-pack</code>
7702 will accept a <code>git push --signed</code> and verify it by using
7703 a "nonce" protected by HMAC using this string as a secret
7704 key.</p>
7705 </dd>
7706 <dt class="hdlist1">receive.certNonceSlop</dt>
7707 <dd>
7708 <p>When a <code>git push --signed</code> sends a push certificate with a
7709 "nonce" that was issued by a receive-pack serving the same
7710 repository within this many seconds, export the "nonce"
7711 found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
7712 hooks (instead of what the receive-pack asked the sending
7713 side to include).  This may allow writing checks in
7714 <code>pre-receive</code> and <code>post-receive</code> a bit easier.  Instead of
7715 checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
7716 that records by how many seconds the nonce is stale to
7717 decide if they want to accept the certificate, they only
7718 can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.</p>
7719 </dd>
7720 <dt class="hdlist1">receive.fsckObjects</dt>
7721 <dd>
7722 <p>If it is set to true, git-receive-pack will check all received
7723 objects. See <code>transfer.fsckObjects</code> for what&#8217;s checked.
7724 Defaults to false. If not set, the value of
7725 <code>transfer.fsckObjects</code> is used instead.</p>
7726 </dd>
7727 <dt class="hdlist1">receive.fsck.&lt;msg-id&gt;</dt>
7728 <dd>
7729 <p>Acts like <code>fsck.&lt;msg-id&gt;</code>, but is used by
7730 <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
7731 <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.&lt;msg-id&gt;</code> documentation for
7732 details.</p>
7733 </dd>
7734 <dt class="hdlist1">receive.fsck.skipList</dt>
7735 <dd>
7736 <p>Acts like <code>fsck.skipList</code>, but is used by
7737 <a href="git-receive-pack.html">git-receive-pack(1)</a> instead of
7738 <a href="git-fsck.html">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
7739 details.</p>
7740 </dd>
7741 <dt class="hdlist1">receive.keepAlive</dt>
7742 <dd>
7743 <p>After receiving the pack from the client, <code>receive-pack</code> may
7744 produce no output (if <code>--quiet</code> was specified) while processing
7745 the pack, causing some networks to drop the TCP connection.
7746 With this option set, if <code>receive-pack</code> does not transmit
7747 any data in this phase for <code>receive.keepAlive</code> seconds, it will
7748 send a short keepalive packet.  The default is 5 seconds; set
7749 to 0 to disable keepalives entirely.</p>
7750 </dd>
7751 <dt class="hdlist1">receive.unpackLimit</dt>
7752 <dd>
7753 <p>If the number of objects received in a push is below this
7754 limit then the objects will be unpacked into loose object
7755 files. However if the number of received objects equals or
7756 exceeds this limit then the received pack will be stored as
7757 a pack, after adding any missing delta bases.  Storing the
7758 pack from a push can make the push operation complete faster,
7759 especially on slow filesystems.  If not set, the value of
7760 <code>transfer.unpackLimit</code> is used instead.</p>
7761 </dd>
7762 <dt class="hdlist1">receive.maxInputSize</dt>
7763 <dd>
7764 <p>If the size of the incoming pack stream is larger than this
7765 limit, then git-receive-pack will error out, instead of
7766 accepting the pack file. If not set or set to 0, then the size
7767 is unlimited.</p>
7768 </dd>
7769 <dt class="hdlist1">receive.denyDeletes</dt>
7770 <dd>
7771 <p>If set to true, git-receive-pack will deny a ref update that deletes
7772 the ref. Use this to prevent such a ref deletion via a push.</p>
7773 </dd>
7774 <dt class="hdlist1">receive.denyDeleteCurrent</dt>
7775 <dd>
7776 <p>If set to true, git-receive-pack will deny a ref update that
7777 deletes the currently checked out branch of a non-bare repository.</p>
7778 </dd>
7779 <dt class="hdlist1">receive.denyCurrentBranch</dt>
7780 <dd>
7781 <p>If set to true or "refuse", git-receive-pack will deny a ref update
7782 to the currently checked out branch of a non-bare repository.
7783 Such a push is potentially dangerous because it brings the HEAD
7784 out of sync with the index and working tree. If set to "warn",
7785 print a warning of such a push to stderr, but allow the push to
7786 proceed. If set to false or "ignore", allow such pushes with no
7787 message. Defaults to "refuse".</p>
7788 <div class="paragraph">
7789 <p>Another option is "updateInstead" which will update the working
7790 tree if pushing into the current branch.  This option is
7791 intended for synchronizing working directories when one side is not easily
7792 accessible via interactive ssh (e.g. a live web site, hence the requirement
7793 that the working directory be clean). This mode also comes in handy when
7794 developing inside a VM to test and fix code on different Operating Systems.</p>
7795 </div>
7796 <div class="paragraph">
7797 <p>By default, "updateInstead" will refuse the push if the working tree or
7798 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
7799 hook can be used to customize this.  See <a href="githooks.html">githooks(5)</a>.</p>
7800 </div>
7801 </dd>
7802 <dt class="hdlist1">receive.denyNonFastForwards</dt>
7803 <dd>
7804 <p>If set to true, git-receive-pack will deny a ref update which is
7805 not a fast-forward. Use this to prevent such an update via a push,
7806 even if that push is forced. This configuration variable is
7807 set when initializing a shared repository.</p>
7808 </dd>
7809 <dt class="hdlist1">receive.hideRefs</dt>
7810 <dd>
7811 <p>This variable is the same as <code>transfer.hideRefs</code>, but applies
7812 only to <code>receive-pack</code> (and so affects pushes, but not fetches).
7813 An attempt to update or delete a hidden ref by <code>git push</code> is
7814 rejected.</p>
7815 </dd>
7816 <dt class="hdlist1">receive.procReceiveRefs</dt>
7817 <dd>
7818 <p>This is a multi-valued variable that defines reference prefixes
7819 to match the commands in <code>receive-pack</code>.  Commands matching the
7820 prefixes will be executed by an external hook "proc-receive",
7821 instead of the internal <code>execute_commands</code> function.  If this
7822 variable is not defined, the "proc-receive" hook will never be
7823 used, and all commands will be executed by the internal
7824 <code>execute_commands</code> function.</p>
7825 <div class="paragraph">
7826 <p>For example, if this variable is set to "refs/for", pushing to reference
7827 such as "refs/for/master" will not create or update a reference named
7828 "refs/for/master", but may create or update a pull request directly by
7829 running the hook "proc-receive".</p>
7830 </div>
7831 <div class="paragraph">
7832 <p>Optional modifiers can be provided in the beginning of the value to filter
7833 commands for specific actions: create (a), modify (m), delete (d).
7834 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
7835 E.g.:</p>
7836 </div>
7837 <div class="literalblock">
7838 <div class="content">
7839 <pre>git config --system --add receive.procReceiveRefs ad:refs/heads
7840 git config --system --add receive.procReceiveRefs !:refs/heads</pre>
7841 </div>
7842 </div>
7843 </dd>
7844 <dt class="hdlist1">receive.updateServerInfo</dt>
7845 <dd>
7846 <p>If set to true, git-receive-pack will run git-update-server-info
7847 after receiving data from git-push and updating refs.</p>
7848 </dd>
7849 <dt class="hdlist1">receive.shallowUpdate</dt>
7850 <dd>
7851 <p>If set to true, .git/shallow can be updated when new refs
7852 require new shallow roots. Otherwise those refs are rejected.</p>
7853 </dd>
7854 <dt class="hdlist1">reftable.blockSize</dt>
7855 <dd>
7856 <p>The size in bytes used by the reftable backend when writing blocks.
7857 The block size is determined by the writer, and does not have to be a
7858 power of 2. The block size must be larger than the longest reference
7859 name or log entry used in the repository, as references cannot span
7860 blocks.</p>
7861 <div class="paragraph">
7862 <p>Powers of two that are friendly to the virtual memory system or
7863 filesystem (such as 4kB or 8kB) are recommended. Larger sizes (64kB) can
7864 yield better compression, with a possible increased cost incurred by
7865 readers during access.</p>
7866 </div>
7867 <div class="paragraph">
7868 <p>The largest block size is <code>16777215</code> bytes (15.99 MiB). The default value is
7869 <code>4096</code> bytes (4kB). A value of <code>0</code> will use the default value.</p>
7870 </div>
7871 </dd>
7872 <dt class="hdlist1">reftable.restartInterval</dt>
7873 <dd>
7874 <p>The interval at which to create restart points. The reftable backend
7875 determines the restart points at file creation. Every 16 may be
7876 more suitable for smaller block sizes (4k or 8k), every 64 for larger
7877 block sizes (64k).</p>
7878 <div class="paragraph">
7879 <p>More frequent restart points reduces prefix compression and increases
7880 space consumed by the restart table, both of which increase file size.</p>
7881 </div>
7882 <div class="paragraph">
7883 <p>Less frequent restart points makes prefix compression more effective,
7884 decreasing overall file size, with increased penalties for readers
7885 walking through more records after the binary search step.</p>
7886 </div>
7887 <div class="paragraph">
7888 <p>A maximum of <code>65535</code> restart points per block is supported.</p>
7889 </div>
7890 <div class="paragraph">
7891 <p>The default value is to create restart points every 16 records. A value of <code>0</code>
7892 will use the default value.</p>
7893 </div>
7894 </dd>
7895 <dt class="hdlist1">reftable.indexObjects</dt>
7896 <dd>
7897 <p>Whether the reftable backend shall write object blocks. Object blocks
7898 are a reverse mapping of object ID to the references pointing to them.</p>
7899 <div class="paragraph">
7900 <p>The default value is <code>true</code>.</p>
7901 </div>
7902 </dd>
7903 <dt class="hdlist1">reftable.geometricFactor</dt>
7904 <dd>
7905 <p>Whenever the reftable backend appends a new table to the stack, it
7906 performs auto compaction to ensure that there is only a handful of
7907 tables. The backend does this by ensuring that tables form a geometric
7908 sequence regarding the respective sizes of each table.</p>
7909 <div class="paragraph">
7910 <p>By default, the geometric sequence uses a factor of 2, meaning that for any
7911 table, the next-biggest table must at least be twice as big. A maximum factor
7912 of 256 is supported.</p>
7913 </div>
7914 </dd>
7915 <dt class="hdlist1">reftable.lockTimeout</dt>
7916 <dd>
7917 <p>Whenever the reftable backend appends a new table to the stack, it has
7918 to lock the central "tables.list" file before updating it. This config
7919 controls how long the process will wait to acquire the lock in case
7920 another process has already acquired it. Value 0 means not to retry at
7921 all; -1 means to try indefinitely. Default is 100 (i.e., retry for
7922 100ms).</p>
7923 </dd>
7924 <dt class="hdlist1">remote.pushDefault</dt>
7925 <dd>
7926 <p>The remote to push to by default.  Overrides
7927 <code>branch.&lt;name&gt;.remote</code> for all branches, and is overridden by
7928 <code>branch.&lt;name&gt;.pushRemote</code> for specific branches.</p>
7929 </dd>
7930 <dt class="hdlist1">remote.&lt;name&gt;.url</dt>
7931 <dd>
7932 <p>The URL of a remote repository.  See <a href="git-fetch.html">git-fetch(1)</a> or
7933 <a href="git-push.html">git-push(1)</a>. A configured remote can have multiple URLs;
7934 in this case the first is used for fetching, and all are used
7935 for pushing (assuming no <code>remote.&lt;name&gt;.pushurl</code> is defined).
7936 Setting this key to the empty string clears the list of urls,
7937 allowing you to override earlier config.</p>
7938 </dd>
7939 <dt class="hdlist1">remote.&lt;name&gt;.pushurl</dt>
7940 <dd>
7941 <p>The push URL of a remote repository.  See <a href="git-push.html">git-push(1)</a>.
7942 If a <code>pushurl</code> option is present in a configured remote, it
7943 is used for pushing instead of <code>remote.&lt;name&gt;.url</code>. A configured
7944 remote can have multiple push URLs; in this case a push goes to
7945 all of them. Setting this key to the empty string clears the
7946 list of urls, allowing you to override earlier config.</p>
7947 </dd>
7948 <dt class="hdlist1">remote.&lt;name&gt;.proxy</dt>
7949 <dd>
7950 <p>For remotes that require curl (http, https and ftp), the URL to
7951 the proxy to use for that remote.  Set to the empty string to
7952 disable proxying for that remote.</p>
7953 </dd>
7954 <dt class="hdlist1">remote.&lt;name&gt;.proxyAuthMethod</dt>
7955 <dd>
7956 <p>For remotes that require curl (http, https and ftp), the method to use for
7957 authenticating against the proxy in use (probably set in
7958 <code>remote.&lt;name&gt;.proxy</code>). See <code>http.proxyAuthMethod</code>.</p>
7959 </dd>
7960 <dt class="hdlist1">remote.&lt;name&gt;.fetch</dt>
7961 <dd>
7962 <p>The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See
7963 <a href="git-fetch.html">git-fetch(1)</a>.</p>
7964 </dd>
7965 <dt class="hdlist1">remote.&lt;name&gt;.push</dt>
7966 <dd>
7967 <p>The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See
7968 <a href="git-push.html">git-push(1)</a>.</p>
7969 </dd>
7970 <dt class="hdlist1">remote.&lt;name&gt;.mirror</dt>
7971 <dd>
7972 <p>If true, pushing to this remote will automatically behave
7973 as if the <code>--mirror</code> option was given on the command line.</p>
7974 </dd>
7975 <dt class="hdlist1">remote.&lt;name&gt;.skipDefaultUpdate</dt>
7976 <dd>
7977 <p>A deprecated synonym to <code>remote.&lt;name&gt;.skipFetchAll</code> (if
7978 both are set in the configuration files with different
7979 values, the value of the last occurrence will be used).</p>
7980 </dd>
7981 <dt class="hdlist1">remote.&lt;name&gt;.skipFetchAll</dt>
7982 <dd>
7983 <p>If true, this remote will be skipped when updating
7984 using <a href="git-fetch.html">git-fetch(1)</a>, the <code>update</code> subcommand of
7985 <a href="git-remote.html">git-remote(1)</a>, and ignored by the prefetch task
7986 of <code>git maitenance</code>.</p>
7987 </dd>
7988 <dt class="hdlist1">remote.&lt;name&gt;.receivepack</dt>
7989 <dd>
7990 <p>The default program to execute on the remote side when pushing.  See
7991 option --receive-pack of <a href="git-push.html">git-push(1)</a>.</p>
7992 </dd>
7993 <dt class="hdlist1">remote.&lt;name&gt;.uploadpack</dt>
7994 <dd>
7995 <p>The default program to execute on the remote side when fetching.  See
7996 option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.</p>
7997 </dd>
7998 <dt class="hdlist1">remote.&lt;name&gt;.tagOpt</dt>
7999 <dd>
8000 <p>Setting this value to --no-tags disables automatic tag following when
8001 fetching from remote &lt;name&gt;. Setting it to --tags will fetch every
8002 tag from remote &lt;name&gt;, even if they are not reachable from remote
8003 branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can
8004 override this setting. See options --tags and --no-tags of
8005 <a href="git-fetch.html">git-fetch(1)</a>.</p>
8006 </dd>
8007 <dt class="hdlist1">remote.&lt;name&gt;.vcs</dt>
8008 <dd>
8009 <p>Setting this to a value &lt;vcs&gt; will cause Git to interact with
8010 the remote with the git-remote-&lt;vcs&gt; helper.</p>
8011 </dd>
8012 <dt class="hdlist1">remote.&lt;name&gt;.prune</dt>
8013 <dd>
8014 <p>When set to true, fetching from this remote by default will also
8015 remove any remote-tracking references that no longer exist on the
8016 remote (as if the <code>--prune</code> option was given on the command line).
8017 Overrides <code>fetch.prune</code> settings, if any.</p>
8018 </dd>
8019 <dt class="hdlist1">remote.&lt;name&gt;.pruneTags</dt>
8020 <dd>
8021 <p>When set to true, fetching from this remote by default will also
8022 remove any local tags that no longer exist on the remote if pruning
8023 is activated in general via <code>remote.&lt;name&gt;.prune</code>, <code>fetch.prune</code> or
8024 <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.</p>
8025 <div class="paragraph">
8026 <p>See also <code>remote.&lt;name&gt;.prune</code> and the PRUNING section of
8027 <a href="git-fetch.html">git-fetch(1)</a>.</p>
8028 </div>
8029 </dd>
8030 <dt class="hdlist1">remote.&lt;name&gt;.promisor</dt>
8031 <dd>
8032 <p>When set to true, this remote will be used to fetch promisor
8033 objects.</p>
8034 </dd>
8035 <dt class="hdlist1">remote.&lt;name&gt;.partialclonefilter</dt>
8036 <dd>
8037 <p>The filter that will be applied when fetching from this      promisor remote.
8038 Changing or clearing this value will only affect fetches for new commits.
8039 To fetch associated objects for commits already present in the local object
8040 database, use the <code>--refetch</code> option of <a href="git-fetch.html">git-fetch(1)</a>.</p>
8041 </dd>
8042 <dt class="hdlist1">remotes.&lt;group&gt;</dt>
8043 <dd>
8044 <p>The list of remotes which are fetched by "git remote update
8045 &lt;group&gt;".  See <a href="git-remote.html">git-remote(1)</a>.</p>
8046 </dd>
8047 <dt class="hdlist1">repack.useDeltaBaseOffset</dt>
8048 <dd>
8049 <p>By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use
8050 delta-base offset. If you need to share your repository with
8051 Git older than version 1.4.4, either directly or via a dumb
8052 protocol such as http, then you need to set this option to
8053 "false" and repack. Access from old Git versions over the
8054 native protocol are unaffected by this option.</p>
8055 </dd>
8056 <dt class="hdlist1">repack.packKeptObjects</dt>
8057 <dd>
8058 <p>If set to true, makes <code>git repack</code> act as if
8059 <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for
8060 details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
8061 index is being written (either via <code>--write-bitmap-index</code> or
8062 <code>repack.writeBitmaps</code>).</p>
8063 </dd>
8064 <dt class="hdlist1">repack.useDeltaIslands</dt>
8065 <dd>
8066 <p>If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
8067 was passed. Defaults to <code>false</code>.</p>
8068 </dd>
8069 <dt class="hdlist1">repack.writeBitmaps</dt>
8070 <dd>
8071 <p>When true, git will write a bitmap index when packing all
8072 objects to disk (e.g., when <code>git repack -a</code> is run).  This
8073 index can speed up the "counting objects" phase of subsequent
8074 packs created for clones and fetches, at the cost of some disk
8075 space and extra time spent on the initial repack.  This has
8076 no effect if multiple packfiles are created.
8077 Defaults to true on bare repos, false otherwise.</p>
8078 </dd>
8079 <dt class="hdlist1">repack.updateServerInfo</dt>
8080 <dd>
8081 <p>If set to false, <a href="git-repack.html">git-repack(1)</a> will not run
8082 <a href="git-update-server-info.html">git-update-server-info(1)</a>. Defaults to true. Can be overridden
8083 when true by the <code>-n</code> option of <a href="git-repack.html">git-repack(1)</a>.</p>
8084 </dd>
8085 <dt class="hdlist1">repack.cruftWindow</dt>
8086 <dt class="hdlist1">repack.cruftWindowMemory</dt>
8087 <dt class="hdlist1">repack.cruftDepth</dt>
8088 <dt class="hdlist1">repack.cruftThreads</dt>
8089 <dd>
8090 <p>Parameters used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when generating
8091 a cruft pack and the respective parameters are not given over
8092 the command line. See similarly named <code>pack.*</code> configuration
8093 variables for defaults and meaning.</p>
8094 </dd>
8095 <dt class="hdlist1">rerere.autoUpdate</dt>
8096 <dd>
8097 <p>When set to true, <code>git-rerere</code> updates the index with the
8098 resulting contents after it cleanly resolves conflicts using
8099 previously recorded resolutions.  Defaults to false.</p>
8100 </dd>
8101 <dt class="hdlist1">rerere.enabled</dt>
8102 <dd>
8103 <p>Activate recording of resolved conflicts, so that identical
8104 conflict hunks can be resolved automatically, should they be
8105 encountered again.  By default, <a href="git-rerere.html">git-rerere(1)</a> is
8106 enabled if there is an <code>rr-cache</code> directory under the
8107 <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the
8108 repository.</p>
8109 </dd>
8110 <dt class="hdlist1">revert.reference</dt>
8111 <dd>
8112 <p>Setting this variable to true makes <code>git revert</code> behave
8113 as if the <code>--reference</code> option is given.</p>
8114 </dd>
8115 <dt class="hdlist1">safe.bareRepository</dt>
8116 <dd>
8117 <p>Specifies which bare repositories Git will work with. The currently
8118 supported values are:</p>
8119 <div class="ulist">
8120 <ul>
8121 <li>
8122 <p><code>all</code>: Git works with all bare repositories. This is the default.</p>
8123 </li>
8124 <li>
8125 <p><code>explicit</code>: Git only works with bare repositories specified via
8126 the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
8127 environment variable (see <a href="git.html">git(1)</a>).</p>
8128 <div class="paragraph">
8129 <p>If you do not use bare repositories in your workflow, then it may be
8130 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
8131 config. This will protect you from attacks that involve cloning a
8132 repository that contains a bare repository and running a Git command
8133 within that directory.</p>
8134 </div>
8135 <div class="paragraph">
8136 <p>This config setting is only respected in protected configuration (see
8137 <a href="#SCOPES">SCOPES</a>). This prevents untrusted repositories from tampering with
8138 this value.</p>
8139 </div>
8140 </li>
8141 </ul>
8142 </div>
8143 </dd>
8144 <dt class="hdlist1">safe.directory</dt>
8145 <dd>
8146 <p>These config entries specify Git-tracked directories that are
8147 considered safe even if they are owned by someone other than the
8148 current user. By default, Git will refuse to even parse a Git
8149 config of a repository owned by someone else, let alone run its
8150 hooks, and this config setting allows users to specify exceptions,
8151 e.g. for intentionally shared repositories (see the <code>--shared</code>
8152 option in <a href="git-init.html">git-init(1)</a>).</p>
8153 <div class="paragraph">
8154 <p>This is a multi-valued setting, i.e. you can add more than one directory
8155 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
8156 override any such directories specified in the system config), add a
8157 <code>safe.directory</code> entry with an empty value.</p>
8158 </div>
8159 <div class="paragraph">
8160 <p>This config setting is only respected in protected configuration (see
8161 <a href="#SCOPES">SCOPES</a>). This prevents untrusted repositories from tampering with this
8162 value.</p>
8163 </div>
8164 <div class="paragraph">
8165 <p>The value of this setting is interpolated, i.e. <code>~/&lt;path&gt;</code> expands to a
8166 path relative to the home directory and <code>%(prefix)/&lt;path&gt;</code> expands to a
8167 path relative to Git&#8217;s (runtime) prefix.</p>
8168 </div>
8169 <div class="paragraph">
8170 <p>To completely opt-out of this security check, set <code>safe.directory</code> to the
8171 string <code>*</code>. This will allow all repositories to be treated as if their
8172 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
8173 is set in system config and you want to re-enable this protection, then
8174 initialize your list with an empty value before listing the repositories
8175 that you deem safe.  Giving a directory with <code>/*</code> appended to it will
8176 allow access to all repositories under the named directory.</p>
8177 </div>
8178 <div class="paragraph">
8179 <p>As explained, Git only allows you to access repositories owned by
8180 yourself, i.e. the user who is running Git, by default.  When Git
8181 is running as <em>root</em> in a non Windows platform that provides sudo,
8182 however, git checks the SUDO_UID environment variable that sudo creates
8183 and will allow access to the uid recorded as its value in addition to
8184 the id from <em>root</em>.
8185 This is to make it easy to perform a common sequence during installation
8186 "make &amp;&amp; sudo make install".  A git process running under <em>sudo</em> runs as
8187 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
8188 which id the original user has.
8189 If that is not what you would prefer and want git to only trust
8190 repositories that are owned by root instead, then you can remove
8191 the <code>SUDO_UID</code> variable from root&#8217;s environment before invoking git.</p>
8192 </div>
8193 </dd>
8194 <dt class="hdlist1">sendemail.identity</dt>
8195 <dd>
8196 <p>A configuration identity. When given, causes values in the
8197 <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
8198 values in the <em>sendemail</em> section. The default identity is
8199 the value of <code>sendemail.identity</code>.</p>
8200 </dd>
8201 <dt class="hdlist1">sendemail.smtpEncryption</dt>
8202 <dd>
8203 <p>See <a href="git-send-email.html">git-send-email(1)</a> for description.  Note that this
8204 setting is not subject to the <em>identity</em> mechanism.</p>
8205 </dd>
8206 <dt class="hdlist1">sendemail.smtpSSLCertPath</dt>
8207 <dd>
8208 <p>Path to ca-certificates (either a directory or a single file).
8209 Set it to an empty string to disable certificate verification.</p>
8210 </dd>
8211 <dt class="hdlist1">sendemail.&lt;identity&gt;.*</dt>
8212 <dd>
8213 <p>Identity-specific versions of the <em>sendemail.*</em> parameters
8214 found below, taking precedence over those when this
8215 identity is selected, through either the command-line or
8216 <code>sendemail.identity</code>.</p>
8217 </dd>
8218 <dt class="hdlist1">sendemail.multiEdit</dt>
8219 <dd>
8220 <p>If true (default), a single editor instance will be spawned to edit
8221 files you have to edit (patches when <code>--annotate</code> is used, and the
8222 summary when <code>--compose</code> is used). If false, files will be edited one
8223 after the other, spawning a new editor each time.</p>
8224 </dd>
8225 <dt class="hdlist1">sendemail.confirm</dt>
8226 <dd>
8227 <p>Sets the default for whether to confirm before sending. Must be
8228 one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
8229 in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
8230 values.</p>
8231 </dd>
8232 <dt class="hdlist1">sendemail.mailmap</dt>
8233 <dd>
8234 <p>If true, makes <a href="git-send-email.html">git-send-email(1)</a> assume <code>--mailmap</code>,
8235 otherwise assume <code>--no-mailmap</code>. False by default.</p>
8236 </dd>
8237 <dt class="hdlist1">sendemail.mailmap.file</dt>
8238 <dd>
8239 <p>The location of a <a href="git-send-email.html">git-send-email(1)</a> specific augmenting
8240 mailmap file. The default mailmap and <code>mailmap.file</code> are loaded
8241 first. Thus, entries in this file take precedence over entries in
8242 the default mailmap locations. See <a href="gitmailmap.html">gitmailmap(5)</a>.</p>
8243 </dd>
8244 <dt class="hdlist1">sendemail.mailmap.blob</dt>
8245 <dd>
8246 <p>Like <code>sendemail.mailmap.file</code>, but consider the value as a reference
8247 to a blob in the repository. Entries in <code>sendemail.mailmap.file</code>
8248 take precedence over entries here. See <a href="gitmailmap.html">gitmailmap(5)</a>.</p>
8249 </dd>
8250 <dt class="hdlist1">sendemail.aliasesFile</dt>
8251 <dd>
8252 <p>To avoid typing long email addresses, point this to one or more
8253 email aliases files.  You must also supply <code>sendemail.aliasFileType</code>.</p>
8254 </dd>
8255 <dt class="hdlist1">sendemail.aliasFileType</dt>
8256 <dd>
8257 <p>Format of the file(s) specified in sendemail.aliasesFile. Must be
8258 one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.</p>
8259 <div class="paragraph">
8260 <p>What an alias file in each format looks like can be found in
8261 the documentation of the email program of the same name. The
8262 differences and limitations from the standard formats are
8263 described below:</p>
8264 </div>
8265 <div class="openblock">
8266 <div class="content">
8267 <div class="dlist">
8268 <dl>
8269 <dt class="hdlist1">sendmail</dt>
8270 <dd>
8271 <div class="ulist">
8272 <ul>
8273 <li>
8274 <p>Quoted aliases and quoted addresses are not supported: lines that
8275 contain a <code>"</code> symbol are ignored.</p>
8276 </li>
8277 <li>
8278 <p>Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
8279 supported.</p>
8280 </li>
8281 <li>
8282 <p>File inclusion (<code>:include: /path/name</code>) is not supported.</p>
8283 </li>
8284 <li>
8285 <p>Warnings are printed on the standard error output for any
8286 explicitly unsupported constructs, and any other lines that are not
8287 recognized by the parser.</p>
8288 </li>
8289 </ul>
8290 </div>
8291 </dd>
8292 </dl>
8293 </div>
8294 </div>
8295 </div>
8296 </dd>
8297 <dt class="hdlist1">sendemail.annotate</dt>
8298 <dt class="hdlist1">sendemail.bcc</dt>
8299 <dt class="hdlist1">sendemail.cc</dt>
8300 <dt class="hdlist1">sendemail.ccCmd</dt>
8301 <dt class="hdlist1">sendemail.chainReplyTo</dt>
8302 <dt class="hdlist1">sendemail.envelopeSender</dt>
8303 <dt class="hdlist1">sendemail.from</dt>
8304 <dt class="hdlist1">sendemail.headerCmd</dt>
8305 <dt class="hdlist1">sendemail.signedOffByCc</dt>
8306 <dt class="hdlist1">sendemail.smtpPass</dt>
8307 <dt class="hdlist1">sendemail.suppressCc</dt>
8308 <dt class="hdlist1">sendemail.suppressFrom</dt>
8309 <dt class="hdlist1">sendemail.to</dt>
8310 <dt class="hdlist1">sendemail.toCmd</dt>
8311 <dt class="hdlist1">sendemail.smtpDomain</dt>
8312 <dt class="hdlist1">sendemail.smtpServer</dt>
8313 <dt class="hdlist1">sendemail.smtpServerPort</dt>
8314 <dt class="hdlist1">sendemail.smtpServerOption</dt>
8315 <dt class="hdlist1">sendemail.smtpUser</dt>
8316 <dt class="hdlist1">sendemail.thread</dt>
8317 <dt class="hdlist1">sendemail.transferEncoding</dt>
8318 <dt class="hdlist1">sendemail.validate</dt>
8319 <dt class="hdlist1">sendemail.xmailer</dt>
8320 <dd>
8321 <p>These configuration variables all provide a default for
8322 <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
8323 documentation for details.</p>
8324 </dd>
8325 <dt class="hdlist1">sendemail.signedOffCc (deprecated)</dt>
8326 <dd>
8327 <p>Deprecated alias for <code>sendemail.signedOffByCc</code>.</p>
8328 </dd>
8329 <dt class="hdlist1">sendemail.smtpBatchSize</dt>
8330 <dd>
8331 <p>Number of messages to be sent per connection, after that a relogin
8332 will happen.  If the value is 0 or undefined, send all messages in
8333 one connection.
8334 See also the <code>--batch-size</code> option of <a href="git-send-email.html">git-send-email(1)</a>.</p>
8335 </dd>
8336 <dt class="hdlist1">sendemail.smtpReloginDelay</dt>
8337 <dd>
8338 <p>Seconds to wait before reconnecting to the smtp server.
8339 See also the <code>--relogin-delay</code> option of <a href="git-send-email.html">git-send-email(1)</a>.</p>
8340 </dd>
8341 <dt class="hdlist1">sendemail.forbidSendmailVariables</dt>
8342 <dd>
8343 <p>To avoid common misconfiguration mistakes, <a href="git-send-email.html">git-send-email(1)</a>
8344 will abort with a warning if any configuration options for "sendmail"
8345 exist. Set this variable to bypass the check.</p>
8346 </dd>
8347 <dt class="hdlist1">sequence.editor</dt>
8348 <dd>
8349 <p>Text editor used by <code>git rebase -i</code> for editing the rebase instruction file.
8350 The value is meant to be interpreted by the shell when it is used.
8351 It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable.
8352 When not configured, the default commit message editor is used instead.</p>
8353 </dd>
8354 <dt class="hdlist1">showBranch.default</dt>
8355 <dd>
8356 <p>The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>.
8357 See <a href="git-show-branch.html">git-show-branch(1)</a>.</p>
8358 </dd>
8359 <dt class="hdlist1">sparse.expectFilesOutsideOfPatterns</dt>
8360 <dd>
8361 <p>Typically with sparse checkouts, files not matching any
8362 sparsity patterns are marked with a SKIP_WORKTREE bit in the
8363 index and are missing from the working tree.  Accordingly, Git
8364 will ordinarily check whether files with the SKIP_WORKTREE bit
8365 are in fact present in the working tree contrary to
8366 expectations.  If Git finds any, it marks those paths as
8367 present by clearing the relevant SKIP_WORKTREE bits.  This
8368 option can be used to tell Git that such
8369 present-despite-skipped files are expected and to stop
8370 checking for them.</p>
8371 <div class="paragraph">
8372 <p>The default is <code>false</code>, which allows Git to automatically recover
8373 from the list of files in the index and working tree falling out of
8374 sync.</p>
8375 </div>
8376 <div class="paragraph">
8377 <p>Set this to <code>true</code> if you are in a setup where some external factor
8378 relieves Git of the responsibility for maintaining the consistency
8379 between the presence of working tree files and sparsity patterns.  For
8380 example, if you have a Git-aware virtual file system that has a robust
8381 mechanism for keeping the working tree and the sparsity patterns up to
8382 date based on access patterns.</p>
8383 </div>
8384 <div class="paragraph">
8385 <p>Regardless of this setting, Git does not check for
8386 present-despite-skipped files unless sparse checkout is enabled, so
8387 this config option has no effect unless <code>core.sparseCheckout</code> is
8388 <code>true</code>.</p>
8389 </div>
8390 </dd>
8391 <dt class="hdlist1">splitIndex.maxPercentChange</dt>
8392 <dd>
8393 <p>When the split index feature is used, this specifies the
8394 percent of entries the split index can contain compared to the
8395 total number of entries in both the split index and the shared
8396 index before a new shared index is written.
8397 The value should be between 0 and 100. If the value is 0, then
8398 a new shared index is always written; if it is 100, a new
8399 shared index is never written.
8400 By default, the value is 20, so a new shared index is written
8401 if the number of entries in the split index would be greater
8402 than 20 percent of the total number of entries.
8403 See <a href="git-update-index.html">git-update-index(1)</a>.</p>
8404 </dd>
8405 <dt class="hdlist1">splitIndex.sharedIndexExpire</dt>
8406 <dd>
8407 <p>When the split index feature is used, shared index files that
8408 were not modified since the time this variable specifies will
8409 be removed when a new shared index file is created. The value
8410 "now" expires all entries immediately, and "never" suppresses
8411 expiration altogether.
8412 The default value is "2.weeks.ago".
8413 Note that a shared index file is considered modified (for the
8414 purpose of expiration) each time a new split-index file is
8415 either created based on it or read from it.
8416 See <a href="git-update-index.html">git-update-index(1)</a>.</p>
8417 </dd>
8418 <dt class="hdlist1">ssh.variant</dt>
8419 <dd>
8420 <p>By default, Git determines the command line arguments to use
8421 based on the basename of the configured SSH command (configured
8422 using the environment variable <code>GIT_SSH</code> or <code>GIT_SSH_COMMAND</code> or
8423 the config setting <code>core.sshCommand</code>). If the basename is
8424 unrecognized, Git will attempt to detect support of OpenSSH
8425 options by first invoking the configured SSH command with the
8426 <code>-G</code> (print configuration) option and will subsequently use
8427 OpenSSH options (if that is successful) or no options besides
8428 the host and remote command (if it fails).</p>
8429 <div class="paragraph">
8430 <p>The config variable <code>ssh.variant</code> can be set to override this detection.
8431 Valid values are <code>ssh</code> (to use OpenSSH options), <code>plink</code>, <code>putty</code>,
8432 <code>tortoiseplink</code>, <code>simple</code> (no options except the host and remote command).
8433 The default auto-detection can be explicitly requested using the value
8434 <code>auto</code>.  Any other value is treated as <code>ssh</code>.  This setting can also be
8435 overridden via the environment variable <code>GIT_SSH_VARIANT</code>.</p>
8436 </div>
8437 <div class="paragraph">
8438 <p>The current command-line parameters used for each variant are as
8439 follows:</p>
8440 </div>
8441 <div class="openblock">
8442 <div class="content">
8443 <div class="ulist">
8444 <ul>
8445 <li>
8446 <p><code>ssh</code> - [-p port] [-4] [-6] [-o option] [username@]host command</p>
8447 </li>
8448 <li>
8449 <p><code>simple</code> - [username@]host command</p>
8450 </li>
8451 <li>
8452 <p><code>plink</code> or <code>putty</code> - [-P port] [-4] [-6] [username@]host command</p>
8453 </li>
8454 <li>
8455 <p><code>tortoiseplink</code> - [-P port] [-4] [-6] -batch [username@]host command</p>
8456 </li>
8457 </ul>
8458 </div>
8459 </div>
8460 </div>
8461 <div class="paragraph">
8462 <p>Except for the <code>simple</code> variant, command-line parameters are likely to
8463 change as git gains new features.</p>
8464 </div>
8465 </dd>
8466 <dt class="hdlist1">stash.showIncludeUntracked</dt>
8467 <dd>
8468 <p>If this is set to true, the <code>git stash show</code> command will show
8469 the untracked files of a stash entry.  Defaults to false. See
8470 the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.</p>
8471 </dd>
8472 <dt class="hdlist1">stash.showPatch</dt>
8473 <dd>
8474 <p>If this is set to true, the <code>git stash show</code> command without an
8475 option will show the stash entry in patch form.  Defaults to false.
8476 See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.</p>
8477 </dd>
8478 <dt class="hdlist1">stash.showStat</dt>
8479 <dd>
8480 <p>If this is set to true, the <code>git stash show</code> command without an
8481 option will show a diffstat of the stash entry.  Defaults to true.
8482 See the description of the <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>.</p>
8483 </dd>
8484 <dt class="hdlist1">status.relativePaths</dt>
8485 <dd>
8486 <p>By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the
8487 current directory. Setting this variable to <code>false</code> shows paths
8488 relative to the repository root (this was the default for Git
8489 prior to v1.5.4).</p>
8490 </dd>
8491 <dt class="hdlist1">status.short</dt>
8492 <dd>
8493 <p>Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>.
8494 The option --no-short takes precedence over this variable.</p>
8495 </dd>
8496 <dt class="hdlist1">status.branch</dt>
8497 <dd>
8498 <p>Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>.
8499 The option --no-branch takes precedence over this variable.</p>
8500 </dd>
8501 <dt class="hdlist1">status.aheadBehind</dt>
8502 <dd>
8503 <p>Set to true to enable <code>--ahead-behind</code> and false to enable
8504 <code>--no-ahead-behind</code> by default in <a href="git-status.html">git-status(1)</a> for
8505 non-porcelain status formats.  Defaults to true.</p>
8506 </dd>
8507 <dt class="hdlist1">status.displayCommentPrefix</dt>
8508 <dd>
8509 <p>If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment
8510 prefix before each output line (starting with
8511 <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the
8512 behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous.
8513 Defaults to false.</p>
8514 </dd>
8515 <dt class="hdlist1">status.renameLimit</dt>
8516 <dd>
8517 <p>The number of files to consider when performing rename detection
8518 in <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>. Defaults to
8519 the value of diff.renameLimit.</p>
8520 </dd>
8521 <dt class="hdlist1">status.renames</dt>
8522 <dd>
8523 <p>Whether and how Git detects renames in <a href="git-status.html">git-status(1)</a> and
8524 <a href="git-commit.html">git-commit(1)</a> .  If set to "false", rename detection is
8525 disabled. If set to "true", basic rename detection is enabled.
8526 If set to "copies" or "copy", Git will detect copies, as well.
8527 Defaults to the value of diff.renames.</p>
8528 </dd>
8529 <dt class="hdlist1">status.showStash</dt>
8530 <dd>
8531 <p>If set to true, <a href="git-status.html">git-status(1)</a> will display the number of
8532 entries currently stashed away.
8533 Defaults to false.</p>
8534 </dd>
8535 <dt class="hdlist1">status.showUntrackedFiles</dt>
8536 <dd>
8537 <p>By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show
8538 files which are not currently tracked by Git. Directories which
8539 contain only untracked files, are shown with the directory name
8540 only. Showing untracked files means that Git needs to lstat() all
8541 the files in the whole repository, which might be slow on some
8542 systems. So, this variable controls how the commands display
8543 the untracked files. Possible values are:</p>
8544 <div class="openblock">
8545 <div class="content">
8546 <div class="ulist">
8547 <ul>
8548 <li>
8549 <p><code>no</code> - Show no untracked files.</p>
8550 </li>
8551 <li>
8552 <p><code>normal</code> - Show untracked files and directories.</p>
8553 </li>
8554 <li>
8555 <p><code>all</code> - Show also individual files in untracked directories.</p>
8556 </li>
8557 </ul>
8558 </div>
8559 </div>
8560 </div>
8561 <div class="paragraph">
8562 <p>If this variable is not specified, it defaults to <em>normal</em>.
8563 All usual spellings for Boolean value <code>true</code> are taken as <code>normal</code>
8564 and <code>false</code> as <code>no</code>.
8565 This variable can be overridden with the -u|--untracked-files option
8566 of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p>
8567 </div>
8568 </dd>
8569 <dt class="hdlist1">status.submoduleSummary</dt>
8570 <dd>
8571 <p>Defaults to false.
8572 If this is set to a non-zero number or true (identical to -1 or an
8573 unlimited number), the submodule summary will be enabled and a
8574 summary of commits for modified submodules will be shown (see
8575 --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
8576 that the summary output command will be suppressed for all
8577 submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only
8578 for those submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. The only
8579 exception to that rule is that status and commit will show staged
8580 submodule changes. To
8581 also view the summary for ignored submodules you can either use
8582 the --ignore-submodules=dirty command-line option or the <em>git
8583 submodule summary</em> command, which shows a similar output but does
8584 not honor these settings.</p>
8585 </dd>
8586 <dt class="hdlist1">submodule.&lt;name&gt;.url</dt>
8587 <dd>
8588 <p>The URL for a submodule. This variable is copied from the .gitmodules
8589 file to the git config via <em>git submodule init</em>. The user can change
8590 the configured URL before obtaining the submodule via <em>git submodule
8591 update</em>. If neither submodule.&lt;name&gt;.active nor submodule.active are
8592 set, the presence of this variable is used as a fallback to indicate
8593 whether the submodule is of interest to git commands.
8594 See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details.</p>
8595 </dd>
8596 <dt class="hdlist1">submodule.&lt;name&gt;.update</dt>
8597 <dd>
8598 <p>The method by which a submodule is updated by <em>git submodule update</em>,
8599 which is the only affected command, others such as
8600 <em>git checkout --recurse-submodules</em> are unaffected. It exists for
8601 historical reasons, when <em>git submodule</em> was the only command to
8602 interact with submodules; settings like <code>submodule.active</code>
8603 and <code>pull.rebase</code> are more specific. It is populated by
8604 <code>git submodule init</code> from the <a href="gitmodules.html">gitmodules(5)</a> file.
8605 See description of <em>update</em> command in <a href="git-submodule.html">git-submodule(1)</a>.</p>
8606 </dd>
8607 <dt class="hdlist1">submodule.&lt;name&gt;.branch</dt>
8608 <dd>
8609 <p>The remote branch name for a submodule, used by <code>git submodule
8610 update --remote</code>.  Set this option to override the value found in
8611 the <code>.gitmodules</code> file.  See <a href="git-submodule.html">git-submodule(1)</a> and
8612 <a href="gitmodules.html">gitmodules(5)</a> for details.</p>
8613 </dd>
8614 <dt class="hdlist1">submodule.&lt;name&gt;.fetchRecurseSubmodules</dt>
8615 <dd>
8616 <p>This option can be used to control recursive fetching of this
8617 submodule. It can be overridden by using the --[no-]recurse-submodules
8618 command-line option to "git fetch" and "git pull".
8619 This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a>
8620 file.</p>
8621 </dd>
8622 <dt class="hdlist1">submodule.&lt;name&gt;.ignore</dt>
8623 <dd>
8624 <p>Defines under what circumstances "git status" and the diff family show
8625 a submodule as modified. When set to "all", it will never be considered
8626 modified (but it will nonetheless show up in the output of status and
8627 commit when it has been staged), "dirty" will ignore all changes
8628 to the submodule&#8217;s work tree and
8629 takes only differences between the HEAD of the submodule and the commit
8630 recorded in the superproject into account. "untracked" will additionally
8631 let submodules with modified tracked files in their work tree show up.
8632 Using "none" (the default when this option is not set) also shows
8633 submodules that have untracked files in their work tree as changed.
8634 This setting overrides any setting made in .gitmodules for this submodule,
8635 both settings can be overridden on the command line by using the
8636 "--ignore-submodules" option. The <em>git submodule</em> commands are not
8637 affected by this setting.</p>
8638 </dd>
8639 <dt class="hdlist1">submodule.&lt;name&gt;.active</dt>
8640 <dd>
8641 <p>Boolean value indicating if the submodule is of interest to git
8642 commands.  This config option takes precedence over the
8643 submodule.active config option. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for
8644 details.</p>
8645 </dd>
8646 <dt class="hdlist1">submodule.active</dt>
8647 <dd>
8648 <p>A repeated field which contains a pathspec used to match against a
8649 submodule&#8217;s path to determine if the submodule is of interest to git
8650 commands. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for details.</p>
8651 </dd>
8652 <dt class="hdlist1">submodule.recurse</dt>
8653 <dd>
8654 <p>A boolean indicating if commands should enable the <code>--recurse-submodules</code>
8655 option by default. Defaults to false.</p>
8656 <div class="paragraph">
8657 <p>When set to true, it can be deactivated via the
8658 <code>--no-recurse-submodules</code> option. Note that some Git commands
8659 lacking this option may call some of the above commands affected by
8660 <code>submodule.recurse</code>; for instance <code>git remote update</code> will call
8661 <code>git fetch</code> but does not have a <code>--no-recurse-submodules</code> option.
8662 For these commands a workaround is to temporarily change the
8663 configuration value by using <code>git -c submodule.recurse=0</code>.</p>
8664 </div>
8665 <div class="paragraph">
8666 <p>The following list shows the commands that accept
8667 <code>--recurse-submodules</code> and whether they are supported by this
8668 setting.</p>
8669 </div>
8670 <div class="ulist">
8671 <ul>
8672 <li>
8673 <p><code>checkout</code>, <code>fetch</code>, <code>grep</code>, <code>pull</code>, <code>push</code>, <code>read-tree</code>,
8674 <code>reset</code>, <code>restore</code> and <code>switch</code> are always supported.</p>
8675 </li>
8676 <li>
8677 <p><code>clone</code> and <code>ls-files</code> are not supported.</p>
8678 </li>
8679 <li>
8680 <p><code>branch</code> is supported only if <code>submodule.propagateBranches</code> is
8681 enabled</p>
8682 </li>
8683 </ul>
8684 </div>
8685 </dd>
8686 <dt class="hdlist1">submodule.propagateBranches</dt>
8687 <dd>
8688 <p>[EXPERIMENTAL] A boolean that enables branching support when
8689 using <code>--recurse-submodules</code> or <code>submodule.recurse=true</code>.
8690 Enabling this will allow certain commands to accept
8691 <code>--recurse-submodules</code> and certain commands that already accept
8692 <code>--recurse-submodules</code> will now consider branches.
8693 Defaults to false.</p>
8694 </dd>
8695 <dt class="hdlist1">submodule.fetchJobs</dt>
8696 <dd>
8697 <p>Specifies how many submodules are fetched/cloned at the same time.
8698 A positive integer allows up to that number of submodules fetched
8699 in parallel. A value of 0 will give some reasonable default.
8700 If unset, it defaults to 1.</p>
8701 </dd>
8702 <dt class="hdlist1">submodule.alternateLocation</dt>
8703 <dd>
8704 <p>Specifies how the submodules obtain alternates when submodules are
8705 cloned. Possible values are <code>no</code>, <code>superproject</code>.
8706 By default <code>no</code> is assumed, which doesn&#8217;t add references. When the
8707 value is set to <code>superproject</code> the submodule to be cloned computes
8708 its alternates location relative to the superprojects alternate.</p>
8709 </dd>
8710 <dt class="hdlist1">submodule.alternateErrorStrategy</dt>
8711 <dd>
8712 <p>Specifies how to treat errors with the alternates for a submodule
8713 as computed via <code>submodule.alternateLocation</code>. Possible values are
8714 <code>ignore</code>, <code>info</code>, <code>die</code>. Default is <code>die</code>. Note that if set to <code>ignore</code>
8715 or <code>info</code>, and if there is an error with the computed alternate, the
8716 clone proceeds as if no alternate was specified.</p>
8717 </dd>
8718 <dt class="hdlist1">tag.forceSignAnnotated</dt>
8719 <dd>
8720 <p>A boolean to specify whether annotated tags created should be GPG signed.
8721 If <code>--annotate</code> is specified on the command line, it takes
8722 precedence over this option.</p>
8723 </dd>
8724 <dt class="hdlist1">tag.sort</dt>
8725 <dd>
8726 <p>This variable controls the sort ordering of tags when displayed by
8727 <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
8728 value of this variable will be used as the default.</p>
8729 </dd>
8730 <dt class="hdlist1">tag.gpgSign</dt>
8731 <dd>
8732 <p>A boolean to specify whether all tags should be GPG signed.
8733 Use of this option when running in an automated script can
8734 result in a large number of tags being signed. It is therefore
8735 convenient to use an agent to avoid typing your gpg passphrase
8736 several times. Note that this option doesn&#8217;t affect tag signing
8737 behavior enabled by "-u &lt;keyid&gt;" or "--local-user=&lt;keyid&gt;" options.</p>
8738 </dd>
8739 <dt class="hdlist1">tar.umask</dt>
8740 <dd>
8741 <p>This variable can be used to restrict the permission bits of
8742 tar archive entries.  The default is 0002, which turns off the
8743 world write bit.  The special value "user" indicates that the
8744 archiving user&#8217;s umask will be used instead.  See umask(2) and
8745 <a href="git-archive.html">git-archive(1)</a>.</p>
8746 </dd>
8747 </dl>
8748 </div>
8749 <div class="paragraph">
8750 <p>Trace2 config settings are only read from the system and global
8751 config files; repository local and worktree config files and <code>-c</code>
8752 command line arguments are not respected.</p>
8753 </div>
8754 <div class="dlist">
8755 <dl>
8756 <dt class="hdlist1">trace2.normalTarget</dt>
8757 <dd>
8758 <p>This variable controls the normal target destination.
8759 It may be overridden by the <code>GIT_TRACE2</code> environment variable.
8760 The following table shows possible values.</p>
8761 </dd>
8762 <dt class="hdlist1">trace2.perfTarget</dt>
8763 <dd>
8764 <p>This variable controls the performance target destination.
8765 It may be overridden by the <code>GIT_TRACE2_PERF</code> environment variable.
8766 The following table shows possible values.</p>
8767 </dd>
8768 <dt class="hdlist1">trace2.eventTarget</dt>
8769 <dd>
8770 <p>This variable controls the event target destination.
8771 It may be overridden by the <code>GIT_TRACE2_EVENT</code> environment variable.
8772 The following table shows possible values.</p>
8773 <div class="openblock">
8774 <div class="content">
8775 <div class="ulist">
8776 <ul>
8777 <li>
8778 <p><code>0</code> or <code>false</code> - Disables the target.</p>
8779 </li>
8780 <li>
8781 <p><code>1</code> or <code>true</code> - Writes to <code>STDERR</code>.</p>
8782 </li>
8783 <li>
8784 <p><code>[2-9]</code> - Writes to the already opened file descriptor.</p>
8785 </li>
8786 <li>
8787 <p><code>&lt;absolute-pathname&gt;</code> - Writes to the file in append mode. If the target
8788 already exists and is a directory, the traces will be written to files (one
8789 per process) underneath the given directory.</p>
8790 </li>
8791 <li>
8792 <p><code>af_unix:[&lt;socket-type&gt;:]&lt;absolute-pathname&gt;</code> - Write to a
8793 Unix DomainSocket (on platforms that support them).  Socket
8794 type can be either <code>stream</code> or <code>dgram</code>; if omitted Git will
8795 try both.</p>
8796 </li>
8797 </ul>
8798 </div>
8799 </div>
8800 </div>
8801 </dd>
8802 <dt class="hdlist1">trace2.normalBrief</dt>
8803 <dd>
8804 <p>Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
8805 omitted from normal output.  May be overridden by the
8806 <code>GIT_TRACE2_BRIEF</code> environment variable.  Defaults to false.</p>
8807 </dd>
8808 <dt class="hdlist1">trace2.perfBrief</dt>
8809 <dd>
8810 <p>Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
8811 omitted from PERF output.  May be overridden by the
8812 <code>GIT_TRACE2_PERF_BRIEF</code> environment variable.  Defaults to false.</p>
8813 </dd>
8814 <dt class="hdlist1">trace2.eventBrief</dt>
8815 <dd>
8816 <p>Boolean.  When true <code>time</code>, <code>filename</code>, and <code>line</code> fields are
8817 omitted from event output.  May be overridden by the
8818 <code>GIT_TRACE2_EVENT_BRIEF</code> environment variable.  Defaults to false.</p>
8819 </dd>
8820 <dt class="hdlist1">trace2.eventNesting</dt>
8821 <dd>
8822 <p>Integer.  Specifies desired depth of nested regions in the
8823 event output.  Regions deeper than this value will be
8824 omitted.  May be overridden by the <code>GIT_TRACE2_EVENT_NESTING</code>
8825 environment variable.  Defaults to 2.</p>
8826 </dd>
8827 <dt class="hdlist1">trace2.configParams</dt>
8828 <dd>
8829 <p>A comma-separated list of patterns of "important" config
8830 settings that should be recorded in the trace2 output.
8831 For example, <code>core.*,remote.*.url</code> would cause the trace2
8832 output to contain events listing each configured remote.
8833 May be overridden by the <code>GIT_TRACE2_CONFIG_PARAMS</code> environment
8834 variable.  Unset by default.</p>
8835 </dd>
8836 <dt class="hdlist1">trace2.envVars</dt>
8837 <dd>
8838 <p>A comma-separated list of "important" environment variables that should
8839 be recorded in the trace2 output.  For example,
8840 <code>GIT_HTTP_USER_AGENT,GIT_CONFIG</code> would cause the trace2 output to
8841 contain events listing the overrides for HTTP user agent and the
8842 location of the Git configuration file (assuming any are set).  May be
8843 overridden by the <code>GIT_TRACE2_ENV_VARS</code> environment variable.  Unset by
8844 default.</p>
8845 </dd>
8846 <dt class="hdlist1">trace2.destinationDebug</dt>
8847 <dd>
8848 <p>Boolean.  When true Git will print error messages when a
8849 trace target destination cannot be opened for writing.
8850 By default, these errors are suppressed and tracing is
8851 silently disabled.  May be overridden by the
8852 <code>GIT_TRACE2_DST_DEBUG</code> environment variable.</p>
8853 </dd>
8854 <dt class="hdlist1">trace2.maxFiles</dt>
8855 <dd>
8856 <p>Integer.  When writing trace files to a target directory, do not
8857 write additional traces if doing so would exceed this many files. Instead,
8858 write a sentinel file that will block further tracing to this
8859 directory. Defaults to 0, which disables this check.</p>
8860 </dd>
8861 <dt class="hdlist1">transfer.credentialsInUrl</dt>
8862 <dd>
8863 <p>A configured URL can contain plaintext credentials in the form
8864 <code>&lt;protocol&gt;://&lt;user&gt;:&lt;password&gt;@&lt;domain&gt;/&lt;path&gt;</code>. You may want
8865 to warn or forbid the use of such configuration (in favor of
8866 using <a href="git-credential.html">git-credential(1)</a>). This will be used on
8867 <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>,
8868 and any other direct use of the configured URL.</p>
8869 <div class="paragraph">
8870 <p>Note that this is currently limited to detecting credentials in
8871 <code>remote.&lt;name&gt;.url</code> configuration; it won&#8217;t detect credentials in
8872 <code>remote.&lt;name&gt;.pushurl</code> configuration.</p>
8873 </div>
8874 <div class="paragraph">
8875 <p>You might want to enable this to prevent inadvertent credentials
8876 exposure, e.g. because:</p>
8877 </div>
8878 <div class="ulist">
8879 <ul>
8880 <li>
8881 <p>The OS or system where you&#8217;re running git may not provide a way or
8882 otherwise allow you to configure the permissions of the
8883 configuration file where the username and/or password are stored.</p>
8884 </li>
8885 <li>
8886 <p>Even if it does, having such data stored "at rest" might expose you
8887 in other ways, e.g. a backup process might copy the data to another
8888 system.</p>
8889 </li>
8890 <li>
8891 <p>The git programs will pass the full URL to one another as arguments
8892 on the command-line, meaning the credentials will be exposed to other
8893 unprivileged users on systems that allow them to see the full
8894 process list of other users. On linux the "hidepid" setting
8895 documented in procfs(5) allows for configuring this behavior.</p>
8896 <div class="paragraph">
8897 <p>If such concerns don&#8217;t apply to you then you probably don&#8217;t need to be
8898 concerned about credentials exposure due to storing sensitive
8899 data in git&#8217;s configuration files. If you do want to use this, set
8900 <code>transfer.credentialsInUrl</code> to one of these values:</p>
8901 </div>
8902 </li>
8903 <li>
8904 <p><code>allow</code> (default): Git will proceed with its activity without warning.</p>
8905 </li>
8906 <li>
8907 <p><code>warn</code>: Git will write a warning message to <code>stderr</code> when parsing a URL
8908 with a plaintext credential.</p>
8909 </li>
8910 <li>
8911 <p><code>die</code>: Git will write a failure message to <code>stderr</code> when parsing a URL
8912 with a plaintext credential.</p>
8913 </li>
8914 </ul>
8915 </div>
8916 </dd>
8917 <dt class="hdlist1">transfer.fsckObjects</dt>
8918 <dd>
8919 <p>When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are
8920 not set, the value of this variable is used instead.
8921 Defaults to false.</p>
8922 <div class="paragraph">
8923 <p>When set, the fetch or receive will abort in the case of a malformed
8924 object or a link to a nonexistent object. In addition, various other
8925 issues are checked for, including legacy issues (see <code>fsck.&lt;msg-id&gt;</code>),
8926 and potential security issues like the existence of a <code>.GIT</code> directory
8927 or a malicious <code>.gitmodules</code> file (see the release notes for v2.2.1
8928 and v2.17.1 for details). Other sanity and security checks may be
8929 added in future releases.</p>
8930 </div>
8931 <div class="paragraph">
8932 <p>On the receiving side, failing fsckObjects will make those objects
8933 unreachable, see "QUARANTINE ENVIRONMENT" in
8934 <a href="git-receive-pack.html">git-receive-pack(1)</a>. On the fetch side, malformed objects will
8935 instead be left unreferenced in the repository.</p>
8936 </div>
8937 <div class="paragraph">
8938 <p>Due to the non-quarantine nature of the <code>fetch.fsckObjects</code>
8939 implementation it cannot be relied upon to leave the object store
8940 clean like <code>receive.fsckObjects</code> can.</p>
8941 </div>
8942 <div class="paragraph">
8943 <p>As objects are unpacked they&#8217;re written to the object store, so there
8944 can be cases where malicious objects get introduced even though the
8945 "fetch" failed, only to have a subsequent "fetch" succeed because only
8946 new incoming objects are checked, not those that have already been
8947 written to the object store. That difference in behavior should not be
8948 relied upon. In the future, such objects may be quarantined for
8949 "fetch" as well.</p>
8950 </div>
8951 <div class="paragraph">
8952 <p>For now, the paranoid need to find some way to emulate the quarantine
8953 environment if they&#8217;d like the same protection as "push". E.g. in the
8954 case of an internal mirror do the mirroring in two steps, one to fetch
8955 the untrusted objects, and then do a second "push" (which will use the
8956 quarantine) to another internal repo, and have internal clients
8957 consume this pushed-to repository, or embargo internal fetches and
8958 only allow them once a full "fsck" has run (and no new fetches have
8959 happened in the meantime).</p>
8960 </div>
8961 </dd>
8962 <dt class="hdlist1">transfer.hideRefs</dt>
8963 <dd>
8964 <p>String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which
8965 refs to omit from their initial advertisements.  Use more than
8966 one definition to specify multiple prefix strings. A ref that is
8967 under the hierarchies listed in the value of this variable is
8968 excluded, and is hidden when responding to <code>git push</code> or <code>git
8969 fetch</code>.  See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for
8970 program-specific versions of this config.</p>
8971 <div class="paragraph">
8972 <p>You may also include a <code>!</code> in front of the ref name to negate the entry,
8973 explicitly exposing it, even if an earlier entry marked it as hidden.
8974 If you have multiple hideRefs values, later entries override earlier ones
8975 (and entries in more-specific config files override less-specific ones).</p>
8976 </div>
8977 <div class="paragraph">
8978 <p>If a namespace is in use, the namespace prefix is stripped from each
8979 reference before it is matched against <code>transfer.hiderefs</code> patterns. In
8980 order to match refs before stripping, add a <code>^</code> in front of the ref name. If
8981 you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p>
8982 </div>
8983 <div class="paragraph">
8984 <p>For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and
8985 the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code>
8986 is omitted from the advertisements. If <code>uploadpack.allowRefInWant</code> is set,
8987 <code>upload-pack</code> will treat <code>want-ref refs/heads/master</code> in a protocol v2
8988 <code>fetch</code> command as if <code>refs/namespaces/foo/refs/heads/master</code> did not exist.
8989 <code>receive-pack</code>, on the other hand, will still advertise the object id the
8990 ref is pointing to without mentioning its name (a so-called ".have" line).</p>
8991 </div>
8992 <div class="paragraph">
8993 <p>Even if you hide refs, a client may still be able to steal the target
8994 objects via the techniques described in the "SECURITY" section of the
8995 <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to keep private data in a
8996 separate repository.</p>
8997 </div>
8998 </dd>
8999 <dt class="hdlist1">transfer.unpackLimit</dt>
9000 <dd>
9001 <p>When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are
9002 not set, the value of this variable is used instead.
9003 The default value is 100.</p>
9004 </dd>
9005 <dt class="hdlist1">transfer.advertiseSID</dt>
9006 <dd>
9007 <p>Boolean. When true, client and server processes will advertise their
9008 unique session IDs to their remote counterpart. Defaults to false.</p>
9009 </dd>
9010 <dt class="hdlist1">transfer.bundleURI</dt>
9011 <dd>
9012 <p>When <code>true</code>, local <code>git clone</code> commands will request bundle
9013 information from the remote server (if advertised) and download
9014 bundles before continuing the clone through the Git protocol.
9015 Defaults to <code>false</code>.</p>
9016 </dd>
9017 <dt class="hdlist1">transfer.advertiseObjectInfo</dt>
9018 <dd>
9019 <p>When <code>true</code>, the <code>object-info</code> capability is advertised by
9020 servers. Defaults to false.</p>
9021 </dd>
9022 <dt class="hdlist1">uploadarchive.allowUnreachable</dt>
9023 <dd>
9024 <p>If true, allow clients to use <code>git archive --remote</code> to request
9025 any tree, whether reachable from the ref tips or not. See the
9026 discussion in the "SECURITY" section of
9027 <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to
9028 <code>false</code>.</p>
9029 </dd>
9030 <dt class="hdlist1">uploadpack.hideRefs</dt>
9031 <dd>
9032 <p>This variable is the same as <code>transfer.hideRefs</code>, but applies
9033 only to <code>upload-pack</code> (and so affects only fetches, not pushes).
9034 An attempt to fetch a hidden ref by <code>git fetch</code> will fail.  See
9035 also <code>uploadpack.allowTipSHA1InWant</code>.</p>
9036 </dd>
9037 <dt class="hdlist1">uploadpack.allowTipSHA1InWant</dt>
9038 <dd>
9039 <p>When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code>
9040 to accept a fetch request that asks for an object at the tip
9041 of a hidden ref (by default, such a request is rejected).
9042 See also <code>uploadpack.hideRefs</code>.  Even if this is false, a client
9043 may be able to steal objects via the techniques described in the
9044 "SECURITY" section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s
9045 best to keep private data in a separate repository.</p>
9046 </dd>
9047 <dt class="hdlist1">uploadpack.allowReachableSHA1InWant</dt>
9048 <dd>
9049 <p>Allow <code>upload-pack</code> to accept a fetch request that asks for an
9050 object that is reachable from any ref tip. However, note that
9051 calculating object reachability is computationally expensive.
9052 Defaults to <code>false</code>.  Even if this is false, a client may be able
9053 to steal objects via the techniques described in the "SECURITY"
9054 section of the <a href="gitnamespaces.html">gitnamespaces(7)</a> man page; it&#8217;s best to
9055 keep private data in a separate repository.</p>
9056 </dd>
9057 <dt class="hdlist1">uploadpack.allowAnySHA1InWant</dt>
9058 <dd>
9059 <p>Allow <code>upload-pack</code> to accept a fetch request that asks for any
9060 object at all.
9061 Defaults to <code>false</code>.</p>
9062 </dd>
9063 <dt class="hdlist1">uploadpack.keepAlive</dt>
9064 <dd>
9065 <p>When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a
9066 quiet period while <code>pack-objects</code> prepares the pack. Normally
9067 it would output progress information, but if <code>--quiet</code> was used
9068 for the fetch, <code>pack-objects</code> will output nothing at all until
9069 the pack data begins. Some clients and networks may consider
9070 the server to be hung and give up. Setting this option instructs
9071 <code>upload-pack</code> to send an empty keepalive packet every
9072 <code>uploadpack.keepAlive</code> seconds. Setting this option to 0
9073 disables keepalive packets entirely. The default is 5 seconds.</p>
9074 </dd>
9075 <dt class="hdlist1">uploadpack.packObjectsHook</dt>
9076 <dd>
9077 <p>If this option is set, when <code>upload-pack</code> would run
9078 <code>git pack-objects</code> to create a packfile for a client, it will
9079 run this shell command instead.  The <code>pack-objects</code> command and
9080 arguments it <em>would</em> have run (including the <code>git pack-objects</code>
9081 at the beginning) are appended to the shell command. The stdin
9082 and stdout of the hook are treated as if <code>pack-objects</code> itself
9083 was run. I.e., <code>upload-pack</code> will feed input intended for
9084 <code>pack-objects</code> to the hook, and expects a completed packfile on
9085 stdout.</p>
9086 <div class="paragraph">
9087 <p>Note that this configuration variable is only respected when it is specified
9088 in protected configuration (see <a href="#SCOPES">SCOPES</a>). This is a safety measure
9089 against fetching from untrusted repositories.</p>
9090 </div>
9091 </dd>
9092 <dt class="hdlist1">uploadpack.allowFilter</dt>
9093 <dd>
9094 <p>If this option is set, <code>upload-pack</code> will support partial
9095 clone and partial fetch object filtering.</p>
9096 </dd>
9097 <dt class="hdlist1">uploadpackfilter.allow</dt>
9098 <dd>
9099 <p>Provides a default value for unspecified object filters (see: the
9100 below configuration variable). If set to <code>true</code>, this will also
9101 enable all filters which get added in the future.
9102 Defaults to <code>true</code>.</p>
9103 </dd>
9104 <dt class="hdlist1">uploadpackfilter.&lt;filter&gt;.allow</dt>
9105 <dd>
9106 <p>Explicitly allow or ban the object filter corresponding to
9107 <code>&lt;filter&gt;</code>, where <code>&lt;filter&gt;</code> may be one of: <code>blob:none</code>,
9108 <code>blob:limit</code>, <code>object:type</code>, <code>tree</code>, <code>sparse:oid</code>, or <code>combine</code>.
9109 If using combined filters, both <code>combine</code> and all of the nested
9110 filter kinds must be allowed. Defaults to <code>uploadpackfilter.allow</code>.</p>
9111 </dd>
9112 <dt class="hdlist1">uploadpackfilter.tree.maxDepth</dt>
9113 <dd>
9114 <p>Only allow <code>--filter=tree:&lt;n&gt;</code> when <code>&lt;n&gt;</code> is no more than the value of
9115 <code>uploadpackfilter.tree.maxDepth</code>. If set, this also implies
9116 <code>uploadpackfilter.tree.allow=true</code>, unless this configuration
9117 variable had already been set. Has no effect if unset.</p>
9118 </dd>
9119 <dt class="hdlist1">uploadpack.allowRefInWant</dt>
9120 <dd>
9121 <p>If this option is set, <code>upload-pack</code> will support the <code>ref-in-want</code>
9122 feature of the protocol version 2 <code>fetch</code> command.  This feature
9123 is intended for the benefit of load-balanced servers which may
9124 not have the same view of what OIDs their refs point to due to
9125 replication delay.</p>
9126 </dd>
9127 <dt class="hdlist1">url.&lt;base&gt;.insteadOf</dt>
9128 <dd>
9129 <p>Any URL that starts with this value will be rewritten to
9130 start, instead, with &lt;base&gt;. In cases where some site serves a
9131 large number of repositories, and serves them with multiple
9132 access methods, and some users need to use different access
9133 methods, this feature allows people to specify any of the
9134 equivalent URLs and have Git automatically rewrite the URL to
9135 the best alternative for the particular user, even for a
9136 never-before-seen repository on the site.  When more than one
9137 insteadOf strings match a given URL, the longest match is used.</p>
9138 <div class="paragraph">
9139 <p>Note that any protocol restrictions will be applied to the rewritten
9140 URL. If the rewrite changes the URL to use a custom protocol or remote
9141 helper, you may need to adjust the <code>protocol.*.allow</code> config to permit
9142 the request.  In particular, protocols you expect to use for submodules
9143 must be set to <code>always</code> rather than the default of <code>user</code>. See the
9144 description of <code>protocol.allow</code> above.</p>
9145 </div>
9146 </dd>
9147 <dt class="hdlist1">url.&lt;base&gt;.pushInsteadOf</dt>
9148 <dd>
9149 <p>Any URL that starts with this value will not be pushed to;
9150 instead, it will be rewritten to start with &lt;base&gt;, and the
9151 resulting URL will be pushed to. In cases where some site serves
9152 a large number of repositories, and serves them with multiple
9153 access methods, some of which do not allow push, this feature
9154 allows people to specify a pull-only URL and have Git
9155 automatically use an appropriate URL to push, even for a
9156 never-before-seen repository on the site.  When more than one
9157 pushInsteadOf strings match a given URL, the longest match is
9158 used.  If a remote has an explicit pushurl, Git will ignore this
9159 setting for that remote.</p>
9160 </dd>
9161 <dt class="hdlist1">user.name</dt>
9162 <dt class="hdlist1">user.email</dt>
9163 <dt class="hdlist1">author.name</dt>
9164 <dt class="hdlist1">author.email</dt>
9165 <dt class="hdlist1">committer.name</dt>
9166 <dt class="hdlist1">committer.email</dt>
9167 <dd>
9168 <p>The <code>user.name</code> and <code>user.email</code> variables determine what ends
9169 up in the <code>author</code> and <code>committer</code> fields of commit
9170 objects.
9171 If you need the <code>author</code> or <code>committer</code> to be different, the
9172 <code>author.name</code>, <code>author.email</code>, <code>committer.name</code>, or
9173 <code>committer.email</code> variables can be set.
9174 All of these can be overridden by the <code>GIT_AUTHOR_NAME</code>,
9175 <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_NAME</code>,
9176 <code>GIT_COMMITTER_EMAIL</code>, and <code>EMAIL</code> environment variables.</p>
9177 <div class="paragraph">
9178 <p>Note that the <code>name</code> forms of these variables conventionally refer to
9179 some form of a personal name.  See <a href="git-commit.html">git-commit(1)</a> and the
9180 environment variables section of <a href="git.html">git(1)</a> for more information on
9181 these settings and the <code>credential.username</code> option if you&#8217;re looking
9182 for authentication credentials instead.</p>
9183 </div>
9184 </dd>
9185 <dt class="hdlist1">user.useConfigOnly</dt>
9186 <dd>
9187 <p>Instruct Git to avoid trying to guess defaults for <code>user.email</code>
9188 and <code>user.name</code>, and instead retrieve the values only from the
9189 configuration. For example, if you have multiple email addresses
9190 and would like to use a different one for each repository, then
9191 with this configuration option set to <code>true</code> in the global config
9192 along with a name, Git will prompt you to set up an email before
9193 making new commits in a newly cloned repository.
9194 Defaults to <code>false</code>.</p>
9195 </dd>
9196 <dt class="hdlist1">user.signingKey</dt>
9197 <dd>
9198 <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
9199 key you want it to automatically when creating a signed tag or
9200 commit, you can override the default selection with this variable.
9201 This option is passed unchanged to gpg&#8217;s --local-user parameter,
9202 so you may specify a key using any method that gpg supports.
9203 If gpg.format is set to <code>ssh</code> this can contain the path to either
9204 your private ssh key or the public key when ssh-agent is used.
9205 Alternatively it can contain a public key prefixed with <code>key::</code>
9206 directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
9207 needs to be available via ssh-agent. If not set Git will call
9208 gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
9209 first key available. For backward compatibility, a raw key which
9210 begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
9211 as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
9212 use the <code>key::</code> form instead.</p>
9213 </dd>
9214 <dt class="hdlist1">versionsort.prereleaseSuffix (deprecated)</dt>
9215 <dd>
9216 <p>Deprecated alias for <code>versionsort.suffix</code>.  Ignored if
9217 <code>versionsort.suffix</code> is set.</p>
9218 </dd>
9219 <dt class="hdlist1">versionsort.suffix</dt>
9220 <dd>
9221 <p>Even when version sort is used in <a href="git-tag.html">git-tag(1)</a>, tagnames
9222 with the same base version but different suffixes are still sorted
9223 lexicographically, resulting e.g. in prerelease tags appearing
9224 after the main release (e.g. "1.0-rc1" after "1.0").  This
9225 variable can be specified to determine the sorting order of tags
9226 with different suffixes.</p>
9227 <div class="paragraph">
9228 <p>By specifying a single suffix in this variable, any tagname containing
9229 that suffix will appear before the corresponding main release.  E.g. if
9230 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
9231 "1.0".  If specified multiple times, once per suffix, then the order of
9232 suffixes in the configuration will determine the sorting order of tagnames
9233 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
9234 configuration, then all "1.0-preX" tags will be listed before any
9235 "1.0-rcX" tags.  The placement of the main release tag relative to tags
9236 with various suffixes can be determined by specifying the empty suffix
9237 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck", and
9238 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
9239 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
9240 "v4.8-bfsX".</p>
9241 </div>
9242 <div class="paragraph">
9243 <p>If more than one suffix matches the same tagname, then that tagname will
9244 be sorted according to the suffix which starts at the earliest position in
9245 the tagname.  If more than one different matching suffix starts at
9246 that earliest position, then that tagname will be sorted according to the
9247 longest of those suffixes.
9248 The sorting order between different suffixes is undefined if they are
9249 in multiple config files.</p>
9250 </div>
9251 </dd>
9252 <dt class="hdlist1">web.browser</dt>
9253 <dd>
9254 <p>Specify a web browser that may be used by some commands.
9255 Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a>
9256 may use it.</p>
9257 </dd>
9258 <dt class="hdlist1">worktree.guessRemote</dt>
9259 <dd>
9260 <p>If no branch is specified and neither <code>-b</code> nor <code>-B</code> nor
9261 <code>--detach</code> is used, then <code>git worktree add</code> defaults to
9262 creating a new branch from HEAD.  If <code>worktree.guessRemote</code> is
9263 set to true, <code>worktree add</code> tries to find a remote-tracking
9264 branch whose name uniquely matches the new branch name.  If
9265 such a branch exists, it is checked out and set as "upstream"
9266 for the new branch.  If no such match can be found, it falls
9267 back to creating a new branch from the current HEAD.</p>
9268 </dd>
9269 </dl>
9270 </div>
9271 </div>
9272 </div>
9273 </div>
9274 <div class="sect1">
9275 <h2 id="_bugs">BUGS</h2>
9276 <div class="sectionbody">
9277 <div class="paragraph">
9278 <p>When using the deprecated <code>[section.subsection]</code> syntax, changing a value
9279 will result in adding a multi-line key instead of a change, if the subsection
9280 is given with at least one uppercase character. For example when the config
9281 looks like</p>
9282 </div>
9283 <div class="listingblock">
9284 <div class="content">
9285 <pre>  [section.subsection]
9286     key = value1</pre>
9287 </div>
9288 </div>
9289 <div class="paragraph">
9290 <p>and running <code>git config section.Subsection.key value2</code> will result in</p>
9291 </div>
9292 <div class="listingblock">
9293 <div class="content">
9294 <pre>  [section.subsection]
9295     key = value1
9296     key = value2</pre>
9297 </div>
9298 </div>
9299 </div>
9300 </div>
9301 <div class="sect1">
9302 <h2 id="_git">GIT</h2>
9303 <div class="sectionbody">
9304 <div class="paragraph">
9305 <p>Part of the <a href="git.html">git(1)</a> suite</p>
9306 </div>
9307 </div>
9308 </div>
9309 </div>
9310 <div id="footer">
9311 <div id="footer-text">
9312 Last updated 2024-09-03 13:52:44 -0700
9313 </div>
9314 </div>
9315 </body>
9316 </html>