| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| 2 | "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| 4 | <head> |
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| 6 | <meta name="generator" content="AsciiDoc 7.0.2" /> |
| 7 | <style type="text/css"> |
| 8 | /* Debug borders */ |
| 9 | p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { |
| 10 | /* |
| 11 | border: 1px solid red; |
| 12 | */ |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | margin: 1em 5% 1em 5%; |
| 17 | } |
| 18 | |
| 19 | a { color: blue; } |
| 20 | a:visited { color: fuchsia; } |
| 21 | |
| 22 | em { |
| 23 | font-style: italic; |
| 24 | } |
| 25 | |
| 26 | strong { |
| 27 | font-weight: bold; |
| 28 | } |
| 29 | |
| 30 | tt { |
| 31 | color: navy; |
| 32 | } |
| 33 | |
| 34 | h1, h2, h3, h4, h5, h6 { |
| 35 | color: #527bbd; |
| 36 | font-family: sans-serif; |
| 37 | margin-top: 1.2em; |
| 38 | margin-bottom: 0.5em; |
| 39 | line-height: 1.3; |
| 40 | } |
| 41 | |
| 42 | h1 { |
| 43 | border-bottom: 2px solid silver; |
| 44 | } |
| 45 | h2 { |
| 46 | border-bottom: 2px solid silver; |
| 47 | padding-top: 0.5em; |
| 48 | } |
| 49 | |
| 50 | div.sectionbody { |
| 51 | font-family: serif; |
| 52 | margin-left: 0; |
| 53 | } |
| 54 | |
| 55 | hr { |
| 56 | border: 1px solid silver; |
| 57 | } |
| 58 | |
| 59 | p { |
| 60 | margin-top: 0.5em; |
| 61 | margin-bottom: 0.5em; |
| 62 | } |
| 63 | |
| 64 | pre { |
| 65 | padding: 0; |
| 66 | margin: 0; |
| 67 | } |
| 68 | |
| 69 | span#author { |
| 70 | color: #527bbd; |
| 71 | font-family: sans-serif; |
| 72 | font-weight: bold; |
| 73 | font-size: 1.2em; |
| 74 | } |
| 75 | span#email { |
| 76 | } |
| 77 | span#revision { |
| 78 | font-family: sans-serif; |
| 79 | } |
| 80 | |
| 81 | div#footer { |
| 82 | font-family: sans-serif; |
| 83 | font-size: small; |
| 84 | border-top: 2px solid silver; |
| 85 | padding-top: 0.5em; |
| 86 | margin-top: 4.0em; |
| 87 | } |
| 88 | div#footer-text { |
| 89 | float: left; |
| 90 | padding-bottom: 0.5em; |
| 91 | } |
| 92 | div#footer-badges { |
| 93 | float: right; |
| 94 | padding-bottom: 0.5em; |
| 95 | } |
| 96 | |
| 97 | div#preamble, |
| 98 | div.tableblock, div.imageblock, div.exampleblock, div.verseblock, |
| 99 | div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, |
| 100 | div.admonitionblock { |
| 101 | margin-right: 10%; |
| 102 | margin-top: 1.5em; |
| 103 | margin-bottom: 1.5em; |
| 104 | } |
| 105 | div.admonitionblock { |
| 106 | margin-top: 2.5em; |
| 107 | margin-bottom: 2.5em; |
| 108 | } |
| 109 | |
| 110 | div.content { /* Block element content. */ |
| 111 | padding: 0; |
| 112 | } |
| 113 | |
| 114 | /* Block element titles. */ |
| 115 | div.title, caption.title { |
| 116 | font-family: sans-serif; |
| 117 | font-weight: bold; |
| 118 | text-align: left; |
| 119 | margin-top: 1.0em; |
| 120 | margin-bottom: 0.5em; |
| 121 | } |
| 122 | div.title + * { |
| 123 | margin-top: 0; |
| 124 | } |
| 125 | |
| 126 | td div.title:first-child { |
| 127 | margin-top: 0.0em; |
| 128 | } |
| 129 | div.content div.title:first-child { |
| 130 | margin-top: 0.0em; |
| 131 | } |
| 132 | div.content + div.title { |
| 133 | margin-top: 0.0em; |
| 134 | } |
| 135 | |
| 136 | div.sidebarblock > div.content { |
| 137 | background: #ffffee; |
| 138 | border: 1px solid silver; |
| 139 | padding: 0.5em; |
| 140 | } |
| 141 | |
| 142 | div.listingblock > div.content { |
| 143 | border: 1px solid silver; |
| 144 | background: #f4f4f4; |
| 145 | padding: 0.5em; |
| 146 | } |
| 147 | |
| 148 | div.quoteblock > div.content { |
| 149 | padding-left: 2.0em; |
| 150 | } |
| 151 | div.quoteblock .attribution { |
| 152 | text-align: right; |
| 153 | } |
| 154 | |
| 155 | div.admonitionblock .icon { |
| 156 | vertical-align: top; |
| 157 | font-size: 1.1em; |
| 158 | font-weight: bold; |
| 159 | text-decoration: underline; |
| 160 | color: #527bbd; |
| 161 | padding-right: 0.5em; |
| 162 | } |
| 163 | div.admonitionblock td.content { |
| 164 | padding-left: 0.5em; |
| 165 | border-left: 2px solid silver; |
| 166 | } |
| 167 | |
| 168 | div.exampleblock > div.content { |
| 169 | border-left: 2px solid silver; |
| 170 | padding: 0.5em; |
| 171 | } |
| 172 | |
| 173 | div.verseblock div.content { |
| 174 | white-space: pre; |
| 175 | } |
| 176 | |
| 177 | div.imageblock div.content { padding-left: 0; } |
| 178 | div.imageblock img { border: 1px solid silver; } |
| 179 | span.image img { border-style: none; } |
| 180 | |
| 181 | dl { |
| 182 | margin-top: 0.8em; |
| 183 | margin-bottom: 0.8em; |
| 184 | } |
| 185 | dt { |
| 186 | margin-top: 0.5em; |
| 187 | margin-bottom: 0; |
| 188 | font-style: italic; |
| 189 | } |
| 190 | dd > *:first-child { |
| 191 | margin-top: 0; |
| 192 | } |
| 193 | |
| 194 | ul, ol { |
| 195 | list-style-position: outside; |
| 196 | } |
| 197 | ol.olist2 { |
| 198 | list-style-type: lower-alpha; |
| 199 | } |
| 200 | |
| 201 | div.tableblock > table { |
| 202 | border-color: #527bbd; |
| 203 | border-width: 3px; |
| 204 | } |
| 205 | thead { |
| 206 | font-family: sans-serif; |
| 207 | font-weight: bold; |
| 208 | } |
| 209 | tfoot { |
| 210 | font-weight: bold; |
| 211 | } |
| 212 | |
| 213 | div.hlist { |
| 214 | margin-top: 0.8em; |
| 215 | margin-bottom: 0.8em; |
| 216 | } |
| 217 | td.hlist1 { |
| 218 | vertical-align: top; |
| 219 | font-style: italic; |
| 220 | padding-right: 0.8em; |
| 221 | } |
| 222 | td.hlist2 { |
| 223 | vertical-align: top; |
| 224 | } |
| 225 | |
| 226 | @media print { |
| 227 | div#footer-badges { display: none; } |
| 228 | } |
| 229 | include::./stylesheets/xhtml11-manpage.css[] |
| 230 | /* Workarounds for IE6's broken and incomplete CSS2. */ |
| 231 | |
| 232 | div.sidebar-content { |
| 233 | background: #ffffee; |
| 234 | border: 1px solid silver; |
| 235 | padding: 0.5em; |
| 236 | } |
| 237 | div.sidebar-title, div.image-title { |
| 238 | font-family: sans-serif; |
| 239 | font-weight: bold; |
| 240 | margin-top: 0.0em; |
| 241 | margin-bottom: 0.5em; |
| 242 | } |
| 243 | |
| 244 | div.listingblock div.content { |
| 245 | border: 1px solid silver; |
| 246 | background: #f4f4f4; |
| 247 | padding: 0.5em; |
| 248 | } |
| 249 | |
| 250 | div.quoteblock-content { |
| 251 | padding-left: 2.0em; |
| 252 | } |
| 253 | |
| 254 | div.exampleblock-content { |
| 255 | border-left: 2px solid silver; |
| 256 | padding-left: 0.5em; |
| 257 | } |
| 258 | </style> |
| 259 | <title>git-config(1)</title> |
| 260 | </head> |
| 261 | <body> |
| 262 | <div id="header"> |
| 263 | <h1> |
| 264 | git-config(1) Manual Page |
| 265 | </h1> |
| 266 | <h2>NAME</h2> |
| 267 | <div class="sectionbody"> |
| 268 | <p>git-config - |
| 269 | Get and set repository or global options |
| 270 | </p> |
| 271 | </div> |
| 272 | </div> |
| 273 | <h2>SYNOPSIS</h2> |
| 274 | <div class="sectionbody"> |
| 275 | <div class="verseblock"> |
| Junio C Hamano | 0ddc94d | 2007-08-01 08:42:39 | [diff] [blame] | 276 | <div class="content"><em>git-config</em> [<file-option>] [type] [-z|--null] name [value [value_regex]] |
| 277 | <em>git-config</em> [<file-option>] [type] --add name value |
| 278 | <em>git-config</em> [<file-option>] [type] --replace-all name [value [value_regex]] |
| 279 | <em>git-config</em> [<file-option>] [type] [-z|--null] --get name [value_regex] |
| 280 | <em>git-config</em> [<file-option>] [type] [-z|--null] --get-all name [value_regex] |
| 281 | <em>git-config</em> [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex] |
| 282 | <em>git-config</em> [<file-option>] --unset name [value_regex] |
| 283 | <em>git-config</em> [<file-option>] --unset-all name [value_regex] |
| 284 | <em>git-config</em> [<file-option>] --rename-section old_name new_name |
| 285 | <em>git-config</em> [<file-option>] --remove-section name |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 286 | <em>git-config</em> [<file-option>] [-z|--null] -l | --list |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 287 | <em>git-config</em> [<file-option>] --get-color name [default] |
| 288 | <em>git-config</em> [<file-option>] --get-colorbool name [stdout-is-tty]</div></div> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 289 | </div> |
| 290 | <h2>DESCRIPTION</h2> |
| 291 | <div class="sectionbody"> |
| 292 | <p>You can query/set/replace/unset options with this command. The name is |
| 293 | actually the section and the key separated by a dot, and the value will be |
| 294 | escaped.</p> |
| 295 | <p>Multiple lines can be added to an option by using the <em>--add</em> option. |
| 296 | If you want to update or unset an option which can occur on multiple |
| 297 | lines, a POSIX regexp <tt>value_regex</tt> needs to be given. Only the |
| 298 | existing values that match the regexp are updated or unset. If |
| 299 | you want to handle the lines that do <strong>not</strong> match the regex, just |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 300 | prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>).</p> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 301 | <p>The type specifier can be either <em>--int</em> or <em>--bool</em>, which will make |
| 302 | <em>git-config</em> ensure that the variable(s) are of the given type and |
| 303 | convert the value to the canonical form (simple decimal number for int, |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 304 | a "true" or "false" string for bool). If no type specifier is passed, |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 305 | no checks or transformations are performed on the value.</p> |
| Junio C Hamano | 0ddc94d | 2007-08-01 08:42:39 | [diff] [blame] | 306 | <p>The file-option can be one of <em>--system</em>, <em>--global</em> or <em>--file</em> |
| 307 | which specify where the values will be read from or written to. |
| 308 | The default is to assume the config file of the current repository, |
| 309 | .git/config unless defined otherwise with GIT_DIR and GIT_CONFIG |
| 310 | (see <a href="#FILES">[FILES]</a>).</p> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 311 | <p>This command will fail if:</p> |
| 312 | <ol> |
| 313 | <li> |
| 314 | <p> |
| Junio C Hamano | 0ddc94d | 2007-08-01 08:42:39 | [diff] [blame] | 315 | The config file is invalid, |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 316 | </p> |
| 317 | </li> |
| 318 | <li> |
| 319 | <p> |
| Junio C Hamano | 0ddc94d | 2007-08-01 08:42:39 | [diff] [blame] | 320 | Can not write to the config file, |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 321 | </p> |
| 322 | </li> |
| 323 | <li> |
| 324 | <p> |
| 325 | no section was provided, |
| 326 | </p> |
| 327 | </li> |
| 328 | <li> |
| 329 | <p> |
| 330 | the section or key is invalid, |
| 331 | </p> |
| 332 | </li> |
| 333 | <li> |
| 334 | <p> |
| 335 | you try to unset an option which does not exist, |
| 336 | </p> |
| 337 | </li> |
| 338 | <li> |
| 339 | <p> |
| 340 | you try to unset/set an option for which multiple lines match, or |
| 341 | </p> |
| 342 | </li> |
| 343 | <li> |
| 344 | <p> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 345 | you use <em>--global</em> option without $HOME being properly set. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 346 | </p> |
| 347 | </li> |
| 348 | </ol> |
| 349 | </div> |
| 350 | <h2>OPTIONS</h2> |
| 351 | <div class="sectionbody"> |
| 352 | <dl> |
| 353 | <dt> |
| 354 | --replace-all |
| 355 | </dt> |
| 356 | <dd> |
| 357 | <p> |
| 358 | Default behavior is to replace at most one line. This replaces |
| 359 | all lines matching the key (and optionally the value_regex). |
| 360 | </p> |
| 361 | </dd> |
| 362 | <dt> |
| 363 | --add |
| 364 | </dt> |
| 365 | <dd> |
| 366 | <p> |
| 367 | Adds a new line to the option without altering any existing |
| 368 | values. This is the same as providing <em>^$</em> as the value_regex. |
| 369 | </p> |
| 370 | </dd> |
| 371 | <dt> |
| 372 | --get |
| 373 | </dt> |
| 374 | <dd> |
| 375 | <p> |
| 376 | Get the value for a given key (optionally filtered by a regex |
| 377 | matching the value). Returns error code 1 if the key was not |
| 378 | found and error code 2 if multiple key values were found. |
| 379 | </p> |
| 380 | </dd> |
| 381 | <dt> |
| 382 | --get-all |
| 383 | </dt> |
| 384 | <dd> |
| 385 | <p> |
| 386 | Like get, but does not fail if the number of values for the key |
| 387 | is not exactly one. |
| 388 | </p> |
| 389 | </dd> |
| 390 | <dt> |
| 391 | --get-regexp |
| 392 | </dt> |
| 393 | <dd> |
| 394 | <p> |
| 395 | Like --get-all, but interprets the name as a regular expression. |
| Junio C Hamano | ddc5ad4 | 2007-06-27 07:14:52 | [diff] [blame] | 396 | Also outputs the key names. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 397 | </p> |
| 398 | </dd> |
| 399 | <dt> |
| 400 | --global |
| 401 | </dt> |
| 402 | <dd> |
| 403 | <p> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 404 | For writing options: write to global ~/.gitconfig file rather than |
| 405 | the repository .git/config. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 406 | </p> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 407 | <p>For reading options: read only from global ~/.gitconfig rather than |
| 408 | from all available files.</p> |
| 409 | <p>See also <a href="#FILES">[FILES]</a>.</p> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 410 | </dd> |
| 411 | <dt> |
| Junio C Hamano | 81c711d | 2007-04-20 07:20:14 | [diff] [blame] | 412 | --system |
| 413 | </dt> |
| 414 | <dd> |
| 415 | <p> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 416 | For writing options: write to system-wide $(prefix)/etc/gitconfig |
| 417 | rather than the repository .git/config. |
| Junio C Hamano | 81c711d | 2007-04-20 07:20:14 | [diff] [blame] | 418 | </p> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 419 | <p>For reading options: read only from system-wide $(prefix)/etc/gitconfig |
| 420 | rather than from all available files.</p> |
| 421 | <p>See also <a href="#FILES">[FILES]</a>.</p> |
| Junio C Hamano | 81c711d | 2007-04-20 07:20:14 | [diff] [blame] | 422 | </dd> |
| 423 | <dt> |
| Junio C Hamano | 0ddc94d | 2007-08-01 08:42:39 | [diff] [blame] | 424 | -f config-file, --file config-file |
| 425 | </dt> |
| 426 | <dd> |
| 427 | <p> |
| 428 | Use the given config file instead of the one specified by GIT_CONFIG. |
| 429 | </p> |
| 430 | </dd> |
| 431 | <dt> |
| Junio C Hamano | d15328a | 2007-03-09 09:06:40 | [diff] [blame] | 432 | --remove-section |
| 433 | </dt> |
| 434 | <dd> |
| 435 | <p> |
| 436 | Remove the given section from the configuration file. |
| 437 | </p> |
| 438 | </dd> |
| 439 | <dt> |
| 440 | --rename-section |
| 441 | </dt> |
| 442 | <dd> |
| 443 | <p> |
| 444 | Rename the given section to a new name. |
| 445 | </p> |
| 446 | </dd> |
| 447 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 448 | --unset |
| 449 | </dt> |
| 450 | <dd> |
| 451 | <p> |
| 452 | Remove the line matching the key from config file. |
| 453 | </p> |
| 454 | </dd> |
| 455 | <dt> |
| 456 | --unset-all |
| 457 | </dt> |
| 458 | <dd> |
| 459 | <p> |
| Junio C Hamano | 1055777 | 2007-03-15 07:12:30 | [diff] [blame] | 460 | Remove all lines matching the key from config file. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 461 | </p> |
| 462 | </dd> |
| 463 | <dt> |
| 464 | -l, --list |
| 465 | </dt> |
| 466 | <dd> |
| 467 | <p> |
| 468 | List all variables set in config file. |
| 469 | </p> |
| 470 | </dd> |
| 471 | <dt> |
| 472 | --bool |
| 473 | </dt> |
| 474 | <dd> |
| 475 | <p> |
| 476 | git-config will ensure that the output is "true" or "false" |
| 477 | </p> |
| 478 | </dd> |
| 479 | <dt> |
| 480 | --int |
| 481 | </dt> |
| 482 | <dd> |
| 483 | <p> |
| 484 | git-config will ensure that the output is a simple |
| 485 | decimal number. An optional value suffix of <em>k</em>, <em>m</em>, or <em>g</em> |
| 486 | in the config file will cause the value to be multiplied |
| 487 | by 1024, 1048576, or 1073741824 prior to output. |
| 488 | </p> |
| 489 | </dd> |
| Junio C Hamano | ddc5ad4 | 2007-06-27 07:14:52 | [diff] [blame] | 490 | <dt> |
| 491 | -z, --null |
| 492 | </dt> |
| 493 | <dd> |
| 494 | <p> |
| 495 | For all options that output values and/or keys, always |
| Junio C Hamano | 1f51196 | 2008-01-30 08:28:52 | [diff] [blame] | 496 | end values with the null character (instead of a |
| Junio C Hamano | ddc5ad4 | 2007-06-27 07:14:52 | [diff] [blame] | 497 | newline). Use newline instead as a delimiter between |
| 498 | key and value. This allows for secure parsing of the |
| 499 | output without getting confused e.g. by values that |
| 500 | contain line breaks. |
| 501 | </p> |
| 502 | </dd> |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 503 | <dt> |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 504 | --get-colorbool name [stdout-is-tty] |
| 505 | </dt> |
| 506 | <dd> |
| 507 | <p> |
| 508 | Find the color setting for <tt>name</tt> (e.g. <tt>color.diff</tt>) and output |
| 509 | "true" or "false". <tt>stdout-is-tty</tt> should be either "true" or |
| 510 | "false", and is taken into account when configuration says |
| 511 | "auto". If <tt>stdout-is-tty</tt> is missing, then checks the standard |
| 512 | output of the command itself, and exits with status 0 if color |
| 513 | is to be used, or exits with status 1 otherwise. |
| Junio C Hamano | e3ddb5b | 2008-04-21 00:48:07 | [diff] [blame] | 514 | When the color setting for <tt>name</tt> is undefined, the command uses |
| 515 | <tt>color.ui</tt> as fallback. |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 516 | </p> |
| 517 | </dd> |
| 518 | <dt> |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 519 | --get-color name default |
| 520 | </dt> |
| 521 | <dd> |
| 522 | <p> |
| 523 | Find the color configured for <tt>name</tt> (e.g. <tt>color.diff.new</tt>) and |
| 524 | output it as the ANSI color escape sequence to the standard |
| 525 | output. The optional <tt>default</tt> parameter is used instead, if |
| 526 | there is no color configured for <tt>name</tt>. |
| 527 | </p> |
| 528 | </dd> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 529 | </dl> |
| 530 | </div> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 531 | <h2><a id="FILES"></a>FILES</h2> |
| 532 | <div class="sectionbody"> |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 533 | <p>If not set explicitly with <em>--file</em>, there are three files where |
| Junio C Hamano | 0ddc94d | 2007-08-01 08:42:39 | [diff] [blame] | 534 | git-config will search for configuration options:</p> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 535 | <dl> |
| 536 | <dt> |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 537 | $GIT_DIR/config |
| 538 | </dt> |
| 539 | <dd> |
| 540 | <p> |
| 541 | Repository specific configuration file. (The filename is |
| 542 | of course relative to the repository root, not the working |
| 543 | directory.) |
| 544 | </p> |
| 545 | </dd> |
| 546 | <dt> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 547 | ~/.gitconfig |
| 548 | </dt> |
| 549 | <dd> |
| 550 | <p> |
| 551 | User-specific configuration file. Also called "global" |
| 552 | configuration file. |
| 553 | </p> |
| 554 | </dd> |
| 555 | <dt> |
| 556 | $(prefix)/etc/gitconfig |
| 557 | </dt> |
| 558 | <dd> |
| 559 | <p> |
| 560 | System-wide configuration file. |
| 561 | </p> |
| 562 | </dd> |
| 563 | </dl> |
| 564 | <p>If no further options are given, all reading options will read all of these |
| 565 | files that are available. If the global or the system-wide configuration |
| 566 | file are not available they will be ignored. If the repository configuration |
| 567 | file is not available or readable, git-config will exit with a non-zero |
| 568 | error code. However, in neither case will an error message be issued.</p> |
| 569 | <p>All writing options will per default write to the repository specific |
| 570 | configuration file. Note that this also affects options like <em>--replace-all</em> |
| 571 | and <em>--unset</em>. <strong>git-config will only ever change one file at a time</strong>.</p> |
| 572 | <p>You can override these rules either by command line options or by environment |
| 573 | variables. The <em>--global</em> and the <em>--system</em> options will limit the file used |
| 574 | to the global or system-wide file respectively. The GIT_CONFIG environment |
| 575 | variable has a similar effect, but you can specify any filename you want.</p> |
| 576 | <p>The GIT_CONFIG_LOCAL environment variable on the other hand only changes |
| 577 | the name used instead of the repository configuration file. The global and |
| 578 | the system-wide configuration files will still be read. (For writing options |
| 579 | this will obviously result in the same behavior as using GIT_CONFIG.)</p> |
| 580 | </div> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 581 | <h2>ENVIRONMENT</h2> |
| 582 | <div class="sectionbody"> |
| 583 | <dl> |
| 584 | <dt> |
| 585 | GIT_CONFIG |
| 586 | </dt> |
| 587 | <dd> |
| 588 | <p> |
| 589 | Take the configuration from the given file instead of .git/config. |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 590 | Using the "--global" option forces this to ~/.gitconfig. Using the |
| 591 | "--system" option forces this to $(prefix)/etc/gitconfig. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 592 | </p> |
| 593 | </dd> |
| 594 | <dt> |
| 595 | GIT_CONFIG_LOCAL |
| 596 | </dt> |
| 597 | <dd> |
| 598 | <p> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 599 | Take the configuration from the given file instead if .git/config. |
| 600 | Still read the global and the system-wide configuration files, though. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 601 | </p> |
| 602 | </dd> |
| 603 | </dl> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 604 | <p>See also <a href="#FILES">[FILES]</a>.</p> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 605 | </div> |
| Junio C Hamano | 6fddfe5 | 2007-05-31 07:38:19 | [diff] [blame] | 606 | <h2><a id="EXAMPLES"></a>EXAMPLES</h2> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 607 | <div class="sectionbody"> |
| 608 | <p>Given a .git/config like this:</p> |
| 609 | <div class="literalblock"> |
| 610 | <div class="content"> |
| 611 | <pre><tt># |
| 612 | # This is the config file, and |
| 613 | # a '#' or ';' character indicates |
| 614 | # a comment |
| 615 | #</tt></pre> |
| 616 | </div></div> |
| 617 | <div class="literalblock"> |
| 618 | <div class="content"> |
| 619 | <pre><tt>; core variables |
| 620 | [core] |
| 621 | ; Don't trust file modes |
| 622 | filemode = false</tt></pre> |
| 623 | </div></div> |
| 624 | <div class="literalblock"> |
| 625 | <div class="content"> |
| 626 | <pre><tt>; Our diff algorithm |
| 627 | [diff] |
| 628 | external = "/usr/local/bin/gnu-diff -u" |
| 629 | renames = true</tt></pre> |
| 630 | </div></div> |
| 631 | <div class="literalblock"> |
| 632 | <div class="content"> |
| 633 | <pre><tt>; Proxy settings |
| 634 | [core] |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 635 | gitproxy="proxy-command" for kernel.org |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 636 | gitproxy=default-proxy ; for all the rest</tt></pre> |
| 637 | </div></div> |
| 638 | <p>you can set the filemode to true with</p> |
| 639 | <div class="listingblock"> |
| 640 | <div class="content"> |
| 641 | <pre><tt>% git config core.filemode true</tt></pre> |
| 642 | </div></div> |
| 643 | <p>The hypothetical proxy command entries actually have a postfix to discern |
| 644 | what URL they apply to. Here is how to change the entry for kernel.org |
| 645 | to "ssh".</p> |
| 646 | <div class="listingblock"> |
| 647 | <div class="content"> |
| 648 | <pre><tt>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</tt></pre> |
| 649 | </div></div> |
| 650 | <p>This makes sure that only the key/value pair for kernel.org is replaced.</p> |
| 651 | <p>To delete the entry for renames, do</p> |
| 652 | <div class="listingblock"> |
| 653 | <div class="content"> |
| 654 | <pre><tt>% git config --unset diff.renames</tt></pre> |
| 655 | </div></div> |
| 656 | <p>If you want to delete an entry for a multivar (like core.gitproxy above), |
| 657 | you have to provide a regex matching the value of exactly one line.</p> |
| 658 | <p>To query the value for a given key, do</p> |
| 659 | <div class="listingblock"> |
| 660 | <div class="content"> |
| 661 | <pre><tt>% git config --get core.filemode</tt></pre> |
| 662 | </div></div> |
| 663 | <p>or</p> |
| 664 | <div class="listingblock"> |
| 665 | <div class="content"> |
| 666 | <pre><tt>% git config core.filemode</tt></pre> |
| 667 | </div></div> |
| 668 | <p>or, to query a multivar:</p> |
| 669 | <div class="listingblock"> |
| 670 | <div class="content"> |
| 671 | <pre><tt>% git config --get core.gitproxy "for kernel.org$"</tt></pre> |
| 672 | </div></div> |
| 673 | <p>If you want to know all the values for a multivar, do:</p> |
| 674 | <div class="listingblock"> |
| 675 | <div class="content"> |
| 676 | <pre><tt>% git config --get-all core.gitproxy</tt></pre> |
| 677 | </div></div> |
| 678 | <p>If you like to live dangerous, you can replace <strong>all</strong> core.gitproxy by a |
| 679 | new one with</p> |
| 680 | <div class="listingblock"> |
| 681 | <div class="content"> |
| 682 | <pre><tt>% git config --replace-all core.gitproxy ssh</tt></pre> |
| 683 | </div></div> |
| 684 | <p>However, if you really only want to replace the line for the default proxy, |
| 685 | i.e. the one without a "for …" postfix, do something like this:</p> |
| 686 | <div class="listingblock"> |
| 687 | <div class="content"> |
| 688 | <pre><tt>% git config core.gitproxy ssh '! for '</tt></pre> |
| 689 | </div></div> |
| 690 | <p>To actually match only values with an exclamation mark, you have to</p> |
| 691 | <div class="listingblock"> |
| 692 | <div class="content"> |
| 693 | <pre><tt>% git config section.key value '[!]'</tt></pre> |
| 694 | </div></div> |
| 695 | <p>To add a new proxy, without altering any of the existing ones, use</p> |
| 696 | <div class="listingblock"> |
| 697 | <div class="content"> |
| Junio C Hamano | c71a873 | 2007-08-04 00:27:26 | [diff] [blame] | 698 | <pre><tt>% git config core.gitproxy '"proxy-command" for example.com'</tt></pre> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 699 | </div></div> |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 700 | <p>An example to use customized color from the configuration in your |
| 701 | script:</p> |
| 702 | <div class="listingblock"> |
| 703 | <div class="content"> |
| 704 | <pre><tt>#!/bin/sh |
| 705 | WS=$(git config --get-color color.diff.whitespace "blue reverse") |
| 706 | RESET=$(git config --get-color "" "reset") |
| 707 | echo "${WS}your whitespace color or blue reverse${RESET}"</tt></pre> |
| 708 | </div></div> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 709 | </div> |
| 710 | <h2>CONFIGURATION FILE</h2> |
| 711 | <div class="sectionbody"> |
| 712 | <p>The git configuration file contains a number of variables that affect |
| 713 | the git command's behavior. <tt>.git/config</tt> file for each repository |
| 714 | is used to store the information for that repository, and |
| 715 | <tt>$HOME/.gitconfig</tt> is used to store per user information to give |
| Junio C Hamano | 7955690 | 2007-02-24 11:15:54 | [diff] [blame] | 716 | fallback values for <tt>.git/config</tt> file. The file <tt>/etc/gitconfig</tt> |
| 717 | can be used to store system-wide defaults.</p> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 718 | <p>They can be used by both the git plumbing |
| 719 | and the porcelains. The variables are divided into sections, where |
| 720 | in the fully qualified variable name the variable itself is the last |
| 721 | dot-separated segment and the section name is everything before the last |
| 722 | dot. The variable names are case-insensitive and only alphanumeric |
| 723 | characters are allowed. Some variables may appear multiple times.</p> |
| 724 | <h3>Syntax</h3> |
| 725 | <p>The syntax is fairly flexible and permissive; whitespaces are mostly |
| 726 | ignored. The <em>#</em> and <em>;</em> characters begin comments to the end of line, |
| 727 | blank lines are ignored.</p> |
| 728 | <p>The file consists of sections and variables. A section begins with |
| 729 | the name of the section in square brackets and continues until the next |
| 730 | section begins. Section names are not case sensitive. Only alphanumeric |
| 731 | characters, <em><tt>-</tt></em> and <em><tt>.</tt></em> are allowed in section names. Each variable |
| 732 | must belong to some section, which means that there must be section |
| 733 | header before first setting of a variable.</p> |
| 734 | <p>Sections can be further divided into subsections. To begin a subsection |
| 735 | put its name in double quotes, separated by space from the section name, |
| 736 | in the section header, like in example below:</p> |
| 737 | <div class="listingblock"> |
| 738 | <div class="content"> |
| 739 | <pre><tt> [section "subsection"] |
| 740 | </tt></pre> |
| 741 | </div></div> |
| 742 | <p>Subsection names can contain any characters except newline (doublequote |
| 743 | <em><tt>"</tt></em> and backslash have to be escaped as <em><tt>\"</tt></em> and <em><tt>\\</tt></em>, |
| Junio C Hamano | ee1e428 | 2007-02-04 08:32:04 | [diff] [blame] | 744 | respectively) and are case sensitive. Section header cannot span multiple |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 745 | lines. Variables may belong directly to a section or to a given subsection. |
| 746 | You can have <tt>[section]</tt> if you have <tt>[section "subsection"]</tt>, but you |
| 747 | don't need to.</p> |
| 748 | <p>There is also (case insensitive) alternative <tt>[section.subsection]</tt> syntax. |
| 749 | In this syntax subsection names follow the same restrictions as for section |
| 750 | name.</p> |
| 751 | <p>All the other lines are recognized as setting variables, in the form |
| 752 | <em>name = value</em>. If there is no equal sign on the line, the entire line |
| 753 | is taken as <em>name</em> and the variable is recognized as boolean "true". |
| 754 | The variable names are case-insensitive and only alphanumeric |
| 755 | characters and <em><tt>-</tt></em> are allowed. There can be more than one value |
| 756 | for a given variable; we say then that variable is multivalued.</p> |
| 757 | <p>Leading and trailing whitespace in a variable value is discarded. |
| 758 | Internal whitespace within a variable value is retained verbatim.</p> |
| 759 | <p>The values following the equals sign in variable assign are all either |
| 760 | a string, an integer, or a boolean. Boolean values may be given as yes/no, |
| 761 | 0/1 or true/false. Case is not significant in boolean values, when |
| 762 | converting value to the canonical form using <em>--bool</em> type specifier; |
| 763 | <tt>git-config</tt> will ensure that the output is "true" or "false".</p> |
| 764 | <p>String values may be entirely or partially enclosed in double quotes. |
| 765 | You need to enclose variable value in double quotes if you want to |
| 766 | preserve leading or trailing whitespace, or if variable value contains |
| 767 | beginning of comment characters (if it contains <em>#</em> or <em>;</em>). |
| 768 | Double quote <em><tt>"</tt></em> and backslash <em><tt>\</tt></em> characters in variable value must |
| 769 | be escaped: use <em><tt>\"</tt></em> for <em><tt>"</tt></em> and <em><tt>\\</tt></em> for <em><tt>\</tt></em>.</p> |
| 770 | <p>The following escape sequences (beside <em><tt>\"</tt></em> and <em><tt>\\</tt></em>) are recognized: |
| 771 | <em><tt>\n</tt></em> for newline character (NL), <em><tt>\t</tt></em> for horizontal tabulation (HT, TAB) |
| 772 | and <em><tt>\b</tt></em> for backspace (BS). No other char escape sequence, nor octal |
| 773 | char sequences are valid.</p> |
| 774 | <p>Variable value ending in a <em><tt>\</tt></em> is continued on the next line in the |
| 775 | customary UNIX fashion.</p> |
| 776 | <p>Some variables may require special value format.</p> |
| 777 | <h3>Example</h3> |
| 778 | <div class="literalblock"> |
| 779 | <div class="content"> |
| 780 | <pre><tt># Core variables |
| 781 | [core] |
| 782 | ; Don't trust file modes |
| 783 | filemode = false</tt></pre> |
| 784 | </div></div> |
| 785 | <div class="literalblock"> |
| 786 | <div class="content"> |
| 787 | <pre><tt># Our diff algorithm |
| 788 | [diff] |
| 789 | external = "/usr/local/bin/gnu-diff -u" |
| 790 | renames = true</tt></pre> |
| 791 | </div></div> |
| 792 | <div class="literalblock"> |
| 793 | <div class="content"> |
| 794 | <pre><tt>[branch "devel"] |
| 795 | remote = origin |
| 796 | merge = refs/heads/devel</tt></pre> |
| 797 | </div></div> |
| 798 | <div class="literalblock"> |
| 799 | <div class="content"> |
| 800 | <pre><tt># Proxy settings |
| 801 | [core] |
| Junio C Hamano | c71a873 | 2007-08-04 00:27:26 | [diff] [blame] | 802 | gitProxy="ssh" for "kernel.org" |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 803 | gitProxy=default-proxy ; for the rest</tt></pre> |
| 804 | </div></div> |
| 805 | <h3>Variables</h3> |
| 806 | <p>Note that this list is non-comprehensive and not necessarily complete. |
| 807 | For command-specific variables, you will find a more detailed description |
| 808 | in the appropriate manual page. You will find a description of non-core |
| 809 | porcelain configuration variables in the respective porcelain documentation.</p> |
| 810 | <dl> |
| 811 | <dt> |
| 812 | core.fileMode |
| 813 | </dt> |
| 814 | <dd> |
| 815 | <p> |
| 816 | If false, the executable bit differences between the index and |
| 817 | the working copy are ignored; useful on broken filesystems like FAT. |
| 818 | See <a href="git-update-index.html">git-update-index(1)</a>. True by default. |
| 819 | </p> |
| 820 | </dd> |
| 821 | <dt> |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 822 | core.quotepath |
| 823 | </dt> |
| 824 | <dd> |
| 825 | <p> |
| 826 | The commands that output paths (e.g. <tt>ls-files</tt>, |
| 827 | <tt>diff</tt>), when not given the <tt>-z</tt> option, will quote |
| 828 | "unusual" characters in the pathname by enclosing the |
| 829 | pathname in a double-quote pair and with backslashes the |
| 830 | same way strings in C source code are quoted. If this |
| 831 | variable is set to false, the bytes higher than 0x80 are |
| 832 | not quoted but output as verbatim. Note that double |
| 833 | quote, backslash and control characters are always |
| 834 | quoted without <tt>-z</tt> regardless of the setting of this |
| 835 | variable. |
| 836 | </p> |
| 837 | </dd> |
| 838 | <dt> |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 839 | core.autocrlf |
| 840 | </dt> |
| 841 | <dd> |
| 842 | <p> |
| 843 | If true, makes git convert <tt>CRLF</tt> at the end of lines in text files to |
| 844 | <tt>LF</tt> when reading from the filesystem, and convert in reverse when |
| 845 | writing to the filesystem. The variable can be set to |
| 846 | <em>input</em>, in which case the conversion happens only while |
| 847 | reading from the filesystem but files are written out with |
| 848 | <tt>LF</tt> at the end of lines. Currently, which paths to consider |
| 849 | "text" (i.e. be subjected to the autocrlf mechanism) is |
| 850 | decided purely based on the contents. |
| 851 | </p> |
| 852 | </dd> |
| 853 | <dt> |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 854 | core.safecrlf |
| 855 | </dt> |
| 856 | <dd> |
| 857 | <p> |
| 858 | If true, makes git check if converting <tt>CRLF</tt> as controlled by |
| 859 | <tt>core.autocrlf</tt> is reversible. Git will verify if a command |
| 860 | modifies a file in the work tree either directly or indirectly. |
| 861 | For example, committing a file followed by checking out the |
| 862 | same file should yield the original file in the work tree. If |
| 863 | this is not the case for the current setting of |
| 864 | <tt>core.autocrlf</tt>, git will reject the file. The variable can |
| 865 | be set to "warn", in which case git will only warn about an |
| 866 | irreversible conversion but continue the operation. |
| 867 | </p> |
| 868 | <p>CRLF conversion bears a slight chance of corrupting data. |
| 869 | autocrlf=true will convert CRLF to LF during commit and LF to |
| 870 | CRLF during checkout. A file that contains a mixture of LF and |
| 871 | CRLF before the commit cannot be recreated by git. For text |
| 872 | files this is the right thing to do: it corrects line endings |
| 873 | such that we have only LF line endings in the repository. |
| 874 | But for binary files that are accidentally classified as text the |
| 875 | conversion can corrupt data.</p> |
| 876 | <p>If you recognize such corruption early you can easily fix it by |
| 877 | setting the conversion type explicitly in .gitattributes. Right |
| 878 | after committing you still have the original file in your work |
| 879 | tree and this file is not yet corrupted. You can explicitly tell |
| 880 | git that this file is binary and git will handle the file |
| 881 | appropriately.</p> |
| 882 | <p>Unfortunately, the desired effect of cleaning up text files with |
| 883 | mixed line endings and the undesired effect of corrupting binary |
| 884 | files cannot be distinguished. In both cases CRLFs are removed |
| 885 | in an irreversible way. For text files this is the right thing |
| 886 | to do because CRLFs are line endings, while for binary files |
| 887 | converting CRLFs corrupts data.</p> |
| 888 | <p>Note, this safety check does not mean that a checkout will generate a |
| 889 | file identical to the original file for a different setting of |
| 890 | <tt>core.autocrlf</tt>, but only for the current one. For example, a text |
| 891 | file with <tt>LF</tt> would be accepted with <tt>core.autocrlf=input</tt> and could |
| 892 | later be checked out with <tt>core.autocrlf=true</tt>, in which case the |
| 893 | resulting file would contain <tt>CRLF</tt>, although the original file |
| 894 | contained <tt>LF</tt>. However, in both work trees the line endings would be |
| 895 | consistent, that is either all <tt>LF</tt> or all <tt>CRLF</tt>, but never mixed. A |
| 896 | file with mixed line endings would be reported by the <tt>core.safecrlf</tt> |
| 897 | mechanism.</p> |
| 898 | </dd> |
| 899 | <dt> |
| Junio C Hamano | aa83a7d | 2007-03-05 02:37:29 | [diff] [blame] | 900 | core.symlinks |
| 901 | </dt> |
| 902 | <dd> |
| 903 | <p> |
| 904 | If false, symbolic links are checked out as small plain files that |
| 905 | contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and |
| 906 | <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular |
| 907 | file. Useful on filesystems like FAT that do not support |
| 908 | symbolic links. True by default. |
| 909 | </p> |
| 910 | </dd> |
| 911 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 912 | core.gitProxy |
| 913 | </dt> |
| 914 | <dd> |
| 915 | <p> |
| 916 | A "proxy command" to execute (as <em>command host port</em>) instead |
| 917 | of establishing direct connection to the remote server when |
| 918 | using the git protocol for fetching. If the variable value is |
| 919 | in the "COMMAND for DOMAIN" format, the command is applied only |
| 920 | on hostnames ending with the specified domain string. This variable |
| 921 | may be set multiple times and is matched in the given order; |
| 922 | the first match wins. |
| 923 | </p> |
| 924 | <p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable |
| 925 | (which always applies universally, without the special "for" |
| 926 | handling).</p> |
| 927 | </dd> |
| 928 | <dt> |
| 929 | core.ignoreStat |
| 930 | </dt> |
| 931 | <dd> |
| 932 | <p> |
| 933 | The working copy files are assumed to stay unchanged until you |
| 934 | mark them otherwise manually - Git will not detect the file changes |
| 935 | by lstat() calls. This is useful on systems where those are very |
| 936 | slow, such as Microsoft Windows. See <a href="git-update-index.html">git-update-index(1)</a>. |
| 937 | False by default. |
| 938 | </p> |
| 939 | </dd> |
| 940 | <dt> |
| 941 | core.preferSymlinkRefs |
| 942 | </dt> |
| 943 | <dd> |
| 944 | <p> |
| 945 | Instead of the default "symref" format for HEAD |
| 946 | and other symbolic reference files, use symbolic links. |
| 947 | This is sometimes needed to work with old scripts that |
| 948 | expect HEAD to be a symbolic link. |
| 949 | </p> |
| 950 | </dd> |
| 951 | <dt> |
| Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 952 | core.bare |
| 953 | </dt> |
| 954 | <dd> |
| 955 | <p> |
| 956 | If true this repository is assumed to be <em>bare</em> and has no |
| 957 | working directory associated with it. If this is the case a |
| 958 | number of commands that require a working directory will be |
| 959 | disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>. |
| 960 | </p> |
| 961 | <p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or |
| 962 | <a href="git-init.html">git-init(1)</a> when the repository was created. By default a |
| 963 | repository that ends in "/.git" is assumed to be not bare (bare = |
| 964 | false), while all other repositories are assumed to be bare (bare |
| 965 | = true).</p> |
| 966 | </dd> |
| 967 | <dt> |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 968 | core.worktree |
| 969 | </dt> |
| 970 | <dd> |
| 971 | <p> |
| 972 | Set the path to the working tree. The value will not be |
| 973 | used in combination with repositories found automatically in |
| 974 | a .git directory (i.e. $GIT_DIR is not set). |
| Junio C Hamano | 764a667 | 2007-10-23 01:23:31 | [diff] [blame] | 975 | This can be overridden by the GIT_WORK_TREE environment |
| Junio C Hamano | 7d575a5 | 2008-04-30 08:45:27 | [diff] [blame] | 976 | variable and the <em>--work-tree</em> command line option. It can be |
| 977 | a absolute path or relative path to the directory specified by |
| 978 | --git-dir or GIT_DIR. |
| 979 | Note: If --git-dir or GIT_DIR are specified but none of |
| 980 | --work-tree, GIT_WORK_TREE and core.worktree is specified, |
| 981 | the current working directory is regarded as the top directory |
| 982 | of your working tree. |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 983 | </p> |
| 984 | </dd> |
| 985 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 986 | core.logAllRefUpdates |
| 987 | </dt> |
| 988 | <dd> |
| 989 | <p> |
| Junio C Hamano | cae8627 | 2007-08-21 02:20:49 | [diff] [blame] | 990 | Enable the reflog. Updates to a ref <ref> is logged to the file |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 991 | "$GIT_DIR/logs/<ref>", by appending the new and old |
| 992 | SHA1, the date/time and the reason of the update, but |
| 993 | only when the file exists. If this configuration |
| 994 | variable is set to true, missing "$GIT_DIR/logs/<ref>" |
| 995 | file is automatically created for branch heads. |
| 996 | </p> |
| 997 | <p>This information can be used to determine what commit |
| 998 | was the tip of a branch "2 days ago".</p> |
| 999 | <p>This value is true by default in a repository that has |
| 1000 | a working directory associated with it, and false by |
| 1001 | default in a bare repository.</p> |
| 1002 | </dd> |
| 1003 | <dt> |
| 1004 | core.repositoryFormatVersion |
| 1005 | </dt> |
| 1006 | <dd> |
| 1007 | <p> |
| 1008 | Internal variable identifying the repository format and layout |
| 1009 | version. |
| 1010 | </p> |
| 1011 | </dd> |
| 1012 | <dt> |
| 1013 | core.sharedRepository |
| 1014 | </dt> |
| 1015 | <dd> |
| 1016 | <p> |
| 1017 | When <em>group</em> (or <em>true</em>), the repository is made shareable between |
| 1018 | several users in a group (making sure all the files and objects are |
| 1019 | group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the |
| 1020 | repository will be readable by all users, additionally to being |
| 1021 | group-shareable. When <em>umask</em> (or <em>false</em>), git will use permissions |
| Junio C Hamano | 2f102bb | 2008-04-26 02:23:37 | [diff] [blame] | 1022 | reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number, |
| 1023 | files in the repository will have this mode value. <em>0xxx</em> will override |
| 1024 | user's umask value, and thus, users with a safe umask (0077) can use |
| 1025 | this option. Examples: <em>0660</em> is equivalent to <em>group</em>. <em>0640</em> is a |
| 1026 | repository that is group-readable but not group-writable. |
| 1027 | See <a href="git-init.html">git-init(1)</a>. False by default. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1028 | </p> |
| 1029 | </dd> |
| 1030 | <dt> |
| 1031 | core.warnAmbiguousRefs |
| 1032 | </dt> |
| 1033 | <dd> |
| 1034 | <p> |
| 1035 | If true, git will warn you if the ref name you passed it is ambiguous |
| 1036 | and might match multiple refs in the .git/refs/ tree. True by default. |
| 1037 | </p> |
| 1038 | </dd> |
| 1039 | <dt> |
| 1040 | core.compression |
| 1041 | </dt> |
| 1042 | <dd> |
| 1043 | <p> |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1044 | An integer -1..9, indicating a default compression level. |
| 1045 | -1 is the zlib default. 0 means no compression, |
| 1046 | and 1..9 are various speed/size tradeoffs, 9 being slowest. |
| Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 1047 | If set, this provides a default to other compression variables, |
| 1048 | such as <em>core.loosecompression</em> and <em>pack.compression</em>. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1049 | </p> |
| 1050 | </dd> |
| 1051 | <dt> |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1052 | core.loosecompression |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1053 | </dt> |
| 1054 | <dd> |
| 1055 | <p> |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1056 | An integer -1..9, indicating the compression level for objects that |
| 1057 | are not in a pack file. -1 is the zlib default. 0 means no |
| 1058 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 1059 | slowest. If not set, defaults to core.compression. If that is |
| Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 1060 | not set, defaults to 1 (best speed). |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1061 | </p> |
| 1062 | </dd> |
| 1063 | <dt> |
| 1064 | core.packedGitWindowSize |
| 1065 | </dt> |
| 1066 | <dd> |
| 1067 | <p> |
| 1068 | Number of bytes of a pack file to map into memory in a |
| 1069 | single mapping operation. Larger window sizes may allow |
| 1070 | your system to process a smaller number of large pack files |
| 1071 | more quickly. Smaller window sizes will negatively affect |
| 1072 | performance due to increased calls to the operating system's |
| 1073 | memory manager, but may improve performance when accessing |
| 1074 | a large number of large pack files. |
| 1075 | </p> |
| 1076 | <p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 |
| 1077 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should |
| 1078 | be reasonable for all users/operating systems. You probably do |
| 1079 | not need to adjust this value.</p> |
| 1080 | <p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p> |
| 1081 | </dd> |
| 1082 | <dt> |
| 1083 | core.packedGitLimit |
| 1084 | </dt> |
| 1085 | <dd> |
| 1086 | <p> |
| 1087 | Maximum number of bytes to map simultaneously into memory |
| 1088 | from pack files. If Git needs to access more than this many |
| 1089 | bytes at once to complete an operation it will unmap existing |
| 1090 | regions to reclaim virtual address space within the process. |
| 1091 | </p> |
| 1092 | <p>Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. |
| 1093 | This should be reasonable for all users/operating systems, except on |
| 1094 | the largest projects. You probably do not need to adjust this value.</p> |
| 1095 | <p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p> |
| 1096 | </dd> |
| 1097 | <dt> |
| Junio C Hamano | b8c5128 | 2007-03-19 10:43:30 | [diff] [blame] | 1098 | core.deltaBaseCacheLimit |
| 1099 | </dt> |
| 1100 | <dd> |
| 1101 | <p> |
| 1102 | Maximum number of bytes to reserve for caching base objects |
| 1103 | that multiple deltafied objects reference. By storing the |
| 1104 | entire decompressed base objects in a cache Git is able |
| 1105 | to avoid unpacking and decompressing frequently used base |
| 1106 | objects multiple times. |
| 1107 | </p> |
| 1108 | <p>Default is 16 MiB on all platforms. This should be reasonable |
| 1109 | for all users/operating systems, except on the largest projects. |
| 1110 | You probably do not need to adjust this value.</p> |
| 1111 | <p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p> |
| 1112 | </dd> |
| 1113 | <dt> |
| Junio C Hamano | 1d90cb0 | 2007-07-03 07:05:31 | [diff] [blame] | 1114 | core.excludesfile |
| Junio C Hamano | 5e284b4 | 2007-05-22 07:23:37 | [diff] [blame] | 1115 | </dt> |
| 1116 | <dd> |
| 1117 | <p> |
| 1118 | In addition to <em>.gitignore</em> (per-directory) and |
| 1119 | <em>.git/info/exclude</em>, git looks into this file for patterns |
| Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 1120 | of files which are not meant to be tracked. See |
| 1121 | <a href="gitignore.html">gitignore(5)</a>. |
| Junio C Hamano | 5e284b4 | 2007-05-22 07:23:37 | [diff] [blame] | 1122 | </p> |
| 1123 | </dd> |
| 1124 | <dt> |
| Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 1125 | core.editor |
| 1126 | </dt> |
| 1127 | <dd> |
| 1128 | <p> |
| 1129 | Commands such as <tt>commit</tt> and <tt>tag</tt> that lets you edit |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1130 | messages by launching an editor uses the value of this |
| Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 1131 | variable when it is set, and the environment variable |
| 1132 | <tt>GIT_EDITOR</tt> is not set. The order of preference is |
| Junio C Hamano | de9879a | 2007-07-22 09:33:42 | [diff] [blame] | 1133 | <tt>GIT_EDITOR</tt> environment, <tt>core.editor</tt>, <tt>VISUAL</tt> and |
| 1134 | <tt>EDITOR</tt> environment variables and then finally <tt>vi</tt>. |
| Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 1135 | </p> |
| 1136 | </dd> |
| 1137 | <dt> |
| Junio C Hamano | 28d8ede | 2007-07-05 05:51:38 | [diff] [blame] | 1138 | core.pager |
| 1139 | </dt> |
| 1140 | <dd> |
| 1141 | <p> |
| 1142 | The command that git will use to paginate output. Can be overridden |
| 1143 | with the <tt>GIT_PAGER</tt> environment variable. |
| 1144 | </p> |
| 1145 | </dd> |
| 1146 | <dt> |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 1147 | core.whitespace |
| 1148 | </dt> |
| 1149 | <dd> |
| 1150 | <p> |
| 1151 | A comma separated list of common whitespace problems to |
| 1152 | notice. <tt>git diff</tt> will use <tt>color.diff.whitespace</tt> to |
| 1153 | highlight them, and <tt>git apply --whitespace=error</tt> will |
| 1154 | consider them as errors: |
| 1155 | </p> |
| 1156 | <ul> |
| 1157 | <li> |
| 1158 | <p> |
| 1159 | <tt>trailing-space</tt> treats trailing whitespaces at the end of the line |
| 1160 | as an error (enabled by default). |
| 1161 | </p> |
| 1162 | </li> |
| 1163 | <li> |
| 1164 | <p> |
| 1165 | <tt>space-before-tab</tt> treats a space character that appears immediately |
| 1166 | before a tab character in the initial indent part of the line as an |
| 1167 | error (enabled by default). |
| 1168 | </p> |
| 1169 | </li> |
| 1170 | <li> |
| 1171 | <p> |
| 1172 | <tt>indent-with-non-tab</tt> treats a line that is indented with 8 or more |
| Junio C Hamano | 42a2e2d | 2007-12-16 22:13:42 | [diff] [blame] | 1173 | space characters as an error (not enabled by default). |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 1174 | </p> |
| 1175 | </li> |
| Junio C Hamano | 601f3e5 | 2008-02-25 08:40:42 | [diff] [blame] | 1176 | <li> |
| 1177 | <p> |
| 1178 | <tt>cr-at-eol</tt> treats a carriage-return at the end of line as |
| 1179 | part of the line terminator, i.e. with it, <tt>trailing-space</tt> |
| 1180 | does not trigger if the character before such a carriage-return |
| 1181 | is not a whitespace (not enabled by default). |
| 1182 | </p> |
| 1183 | </li> |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 1184 | </ul> |
| 1185 | </dd> |
| 1186 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1187 | alias.* |
| 1188 | </dt> |
| 1189 | <dd> |
| 1190 | <p> |
| 1191 | Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g. |
| 1192 | after defining "alias.last = cat-file commit HEAD", the invocation |
| 1193 | "git last" is equivalent to "git cat-file commit HEAD". To avoid |
| 1194 | confusion and troubles with script usage, aliases that |
| 1195 | hide existing git commands are ignored. Arguments are split by |
| 1196 | spaces, the usual shell quoting and escaping is supported. |
| 1197 | quote pair and a backslash can be used to quote them. |
| 1198 | </p> |
| Junio C Hamano | dbb6459 | 2007-09-01 11:17:39 | [diff] [blame] | 1199 | <p>If the alias expansion is prefixed with an exclamation point, |
| Junio C Hamano | 9cb74f2 | 2007-02-12 04:15:05 | [diff] [blame] | 1200 | it will be treated as a shell command. For example, defining |
| 1201 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation |
| 1202 | "git new" is equivalent to running the shell command |
| Junio C Hamano | dbb6459 | 2007-09-01 11:17:39 | [diff] [blame] | 1203 | "gitk --all --not ORIG_HEAD".</p> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1204 | </dd> |
| 1205 | <dt> |
| 1206 | apply.whitespace |
| 1207 | </dt> |
| 1208 | <dd> |
| 1209 | <p> |
| 1210 | Tells <tt>git-apply</tt> how to handle whitespaces, in the same way |
| 1211 | as the <em>--whitespace</em> option. See <a href="git-apply.html">git-apply(1)</a>. |
| 1212 | </p> |
| 1213 | </dd> |
| 1214 | <dt> |
| Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 1215 | branch.autosetupmerge |
| 1216 | </dt> |
| 1217 | <dd> |
| 1218 | <p> |
| 1219 | Tells <tt>git-branch</tt> and <tt>git-checkout</tt> to setup new branches |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 1220 | so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the |
| 1221 | starting point branch. Note that even if this option is not set, |
| Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 1222 | this behavior can be chosen per-branch using the <tt>--track</tt> |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 1223 | and <tt>--no-track</tt> options. The valid settings are: <tt>false</tt> — no |
| 1224 | automatic setup is done; <tt>true</tt> — automatic setup is done when the |
| 1225 | starting point is a remote branch; <tt>always</tt> — automatic setup is |
| 1226 | done when the starting point is either a local branch or remote |
| 1227 | branch. This option defaults to true. |
| Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 1228 | </p> |
| 1229 | </dd> |
| 1230 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1231 | branch.<name>.remote |
| 1232 | </dt> |
| 1233 | <dd> |
| 1234 | <p> |
| 1235 | When in branch <name>, it tells <tt>git fetch</tt> which remote to fetch. |
| 1236 | If this option is not given, <tt>git fetch</tt> defaults to remote "origin". |
| 1237 | </p> |
| 1238 | </dd> |
| 1239 | <dt> |
| 1240 | branch.<name>.merge |
| 1241 | </dt> |
| 1242 | <dd> |
| 1243 | <p> |
| Junio C Hamano | c2b4709 | 2007-10-25 06:50:31 | [diff] [blame] | 1244 | When in branch <name>, it tells <tt>git fetch</tt> the default |
| 1245 | refspec to be marked for merging in FETCH_HEAD. The value is |
| 1246 | handled like the remote part of a refspec, and must match a |
| 1247 | ref which is fetched from the remote given by |
| 1248 | "branch.<name>.remote". |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1249 | The merge information is used by <tt>git pull</tt> (which at first calls |
| 1250 | <tt>git fetch</tt>) to lookup the default branch for merging. Without |
| 1251 | this option, <tt>git pull</tt> defaults to merge the first refspec fetched. |
| 1252 | Specify multiple values to get an octopus merge. |
| Junio C Hamano | 6e149c0 | 2007-03-16 10:21:07 | [diff] [blame] | 1253 | If you wish to setup <tt>git pull</tt> so that it merges into <name> from |
| 1254 | another branch in the local repository, you can point |
| 1255 | branch.<name>.merge to the desired branch, and use the special setting |
| 1256 | <tt>.</tt> (a period) for branch.<name>.remote. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1257 | </p> |
| 1258 | </dd> |
| 1259 | <dt> |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1260 | branch.<name>.mergeoptions |
| 1261 | </dt> |
| 1262 | <dd> |
| 1263 | <p> |
| 1264 | Sets default options for merging into branch <name>. The syntax and |
| 1265 | supported options are equal to that of <a href="git-merge.html">git-merge(1)</a>, but |
| 1266 | option values containing whitespace characters are currently not |
| 1267 | supported. |
| 1268 | </p> |
| 1269 | </dd> |
| 1270 | <dt> |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 1271 | branch.<name>.rebase |
| 1272 | </dt> |
| 1273 | <dd> |
| 1274 | <p> |
| 1275 | When true, rebase the branch <name> on top of the fetched branch, |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame^] | 1276 | instead of merging the default branch from the default remote when |
| 1277 | "git pull" is run. |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 1278 | <strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use |
| 1279 | it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a> |
| 1280 | for details). |
| 1281 | </p> |
| 1282 | </dd> |
| 1283 | <dt> |
| Junio C Hamano | 8760ea6 | 2008-03-14 08:58:45 | [diff] [blame] | 1284 | browser.<tool>.cmd |
| 1285 | </dt> |
| 1286 | <dd> |
| 1287 | <p> |
| 1288 | Specify the command to invoke the specified browser. The |
| 1289 | specified command is evaluated in shell with the URLs passed |
| 1290 | as arguments. (See <a href="git-web--browse.html">git-web--browse(1)</a>.) |
| 1291 | </p> |
| 1292 | </dd> |
| 1293 | <dt> |
| Junio C Hamano | e35a6fc | 2008-01-29 09:46:27 | [diff] [blame] | 1294 | browser.<tool>.path |
| 1295 | </dt> |
| 1296 | <dd> |
| 1297 | <p> |
| 1298 | Override the path for the given tool that may be used to |
| 1299 | browse HTML help (see <em>-w</em> option in <a href="git-help.html">git-help(1)</a>) or a |
| 1300 | working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>). |
| 1301 | </p> |
| 1302 | </dd> |
| 1303 | <dt> |
| Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 1304 | clean.requireForce |
| 1305 | </dt> |
| 1306 | <dd> |
| 1307 | <p> |
| Junio C Hamano | 422cfec | 2007-11-08 08:07:45 | [diff] [blame] | 1308 | A boolean to make git-clean do nothing unless given -f |
| 1309 | or -n. Defaults to true. |
| Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 1310 | </p> |
| 1311 | </dd> |
| 1312 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1313 | color.branch |
| 1314 | </dt> |
| 1315 | <dd> |
| 1316 | <p> |
| 1317 | A boolean to enable/disable color in the output of |
| Junio C Hamano | 0fc8cd9 | 2007-12-06 03:26:21 | [diff] [blame] | 1318 | <a href="git-branch.html">git-branch(1)</a>. May be set to <tt>always</tt>, |
| 1319 | <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1320 | only when the output is to a terminal. Defaults to false. |
| 1321 | </p> |
| 1322 | </dd> |
| 1323 | <dt> |
| 1324 | color.branch.<slot> |
| 1325 | </dt> |
| 1326 | <dd> |
| 1327 | <p> |
| 1328 | Use customized color for branch coloration. <tt><slot></tt> is one of |
| 1329 | <tt>current</tt> (the current branch), <tt>local</tt> (a local branch), |
| 1330 | <tt>remote</tt> (a tracking branch in refs/remotes/), <tt>plain</tt> (other |
| 1331 | refs). |
| 1332 | </p> |
| 1333 | <p>The value for these configuration variables is a list of colors (at most |
| 1334 | two) and attributes (at most one), separated by spaces. The colors |
| 1335 | accepted are <tt>normal</tt>, <tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>, |
| 1336 | <tt>magenta</tt>, <tt>cyan</tt> and <tt>white</tt>; the attributes are <tt>bold</tt>, <tt>dim</tt>, <tt>ul</tt>, |
| 1337 | <tt>blink</tt> and <tt>reverse</tt>. The first color given is the foreground; the |
| 1338 | second is the background. The position of the attribute, if any, |
| 1339 | doesn't matter.</p> |
| 1340 | </dd> |
| 1341 | <dt> |
| 1342 | color.diff |
| 1343 | </dt> |
| 1344 | <dd> |
| 1345 | <p> |
| Junio C Hamano | 0fc8cd9 | 2007-12-06 03:26:21 | [diff] [blame] | 1346 | When set to <tt>always</tt>, always use colors in patch. |
| 1347 | When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use |
| 1348 | colors only when the output is to the terminal. Defaults to false. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1349 | </p> |
| 1350 | </dd> |
| 1351 | <dt> |
| 1352 | color.diff.<slot> |
| 1353 | </dt> |
| 1354 | <dd> |
| 1355 | <p> |
| 1356 | Use customized color for diff colorization. <tt><slot></tt> specifies |
| 1357 | which part of the patch to use the specified color, and is one |
| 1358 | of <tt>plain</tt> (context text), <tt>meta</tt> (metainformation), <tt>frag</tt> |
| 1359 | (hunk header), <tt>old</tt> (removed lines), <tt>new</tt> (added lines), |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 1360 | <tt>commit</tt> (commit headers), or <tt>whitespace</tt> (highlighting |
| 1361 | whitespace errors). The values of these variables may be specified as |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1362 | in color.branch.<slot>. |
| 1363 | </p> |
| 1364 | </dd> |
| 1365 | <dt> |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 1366 | color.interactive |
| 1367 | </dt> |
| 1368 | <dd> |
| 1369 | <p> |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1370 | When set to <tt>always</tt>, always use colors for interactive prompts |
| 1371 | and displays (such as those used by "git add --interactive"). |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 1372 | When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use |
| 1373 | colors only when the output is to the terminal. Defaults to false. |
| 1374 | </p> |
| 1375 | </dd> |
| 1376 | <dt> |
| 1377 | color.interactive.<slot> |
| 1378 | </dt> |
| 1379 | <dd> |
| 1380 | <p> |
| 1381 | Use customized color for <tt>git add --interactive</tt> |
| 1382 | output. <tt><slot></tt> may be <tt>prompt</tt>, <tt>header</tt>, or <tt>help</tt>, for |
| 1383 | three distinct types of normal output from interactive |
| 1384 | programs. The values of these variables may be specified as |
| 1385 | in color.branch.<slot>. |
| 1386 | </p> |
| 1387 | </dd> |
| 1388 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1389 | color.pager |
| 1390 | </dt> |
| 1391 | <dd> |
| 1392 | <p> |
| 1393 | A boolean to enable/disable colored output when the pager is in |
| 1394 | use (default is true). |
| 1395 | </p> |
| 1396 | </dd> |
| 1397 | <dt> |
| 1398 | color.status |
| 1399 | </dt> |
| 1400 | <dd> |
| 1401 | <p> |
| 1402 | A boolean to enable/disable color in the output of |
| Junio C Hamano | 0fc8cd9 | 2007-12-06 03:26:21 | [diff] [blame] | 1403 | <a href="git-status.html">git-status(1)</a>. May be set to <tt>always</tt>, |
| 1404 | <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1405 | only when the output is to a terminal. Defaults to false. |
| 1406 | </p> |
| 1407 | </dd> |
| 1408 | <dt> |
| 1409 | color.status.<slot> |
| 1410 | </dt> |
| 1411 | <dd> |
| 1412 | <p> |
| 1413 | Use customized color for status colorization. <tt><slot></tt> is |
| 1414 | one of <tt>header</tt> (the header text of the status message), |
| 1415 | <tt>added</tt> or <tt>updated</tt> (files which are added but not committed), |
| 1416 | <tt>changed</tt> (files which are changed but not added in the index), |
| 1417 | or <tt>untracked</tt> (files which are not tracked by git). The values of |
| 1418 | these variables may be specified as in color.branch.<slot>. |
| 1419 | </p> |
| 1420 | </dd> |
| 1421 | <dt> |
| Junio C Hamano | b968dbb | 2007-07-27 07:26:40 | [diff] [blame] | 1422 | commit.template |
| 1423 | </dt> |
| 1424 | <dd> |
| 1425 | <p> |
| 1426 | Specify a file to use as the template for new commit messages. |
| 1427 | </p> |
| 1428 | </dd> |
| 1429 | <dt> |
| Junio C Hamano | 83d46a2 | 2008-02-21 02:29:42 | [diff] [blame] | 1430 | color.ui |
| 1431 | </dt> |
| 1432 | <dd> |
| 1433 | <p> |
| 1434 | When set to <tt>always</tt>, always use colors in all git commands which |
| 1435 | are capable of colored output. When false (or <tt>never</tt>), never. When |
| 1436 | set to <tt>true</tt> or <tt>auto</tt>, use colors only when the output is to the |
| 1437 | terminal. When more specific variables of color.* are set, they always |
| 1438 | take precedence over this setting. Defaults to false. |
| 1439 | </p> |
| 1440 | </dd> |
| 1441 | <dt> |
| Junio C Hamano | dbb6459 | 2007-09-01 11:17:39 | [diff] [blame] | 1442 | diff.autorefreshindex |
| 1443 | </dt> |
| 1444 | <dd> |
| 1445 | <p> |
| 1446 | When using <tt>git diff</tt> to compare with work tree |
| 1447 | files, do not consider stat-only change as changed. |
| 1448 | Instead, silently run <tt>git update-index --refresh</tt> to |
| 1449 | update the cached stat information for paths whose |
| 1450 | contents in the work tree match the contents in the |
| 1451 | index. This option defaults to true. Note that this |
| 1452 | affects only <tt>git diff</tt> Porcelain, and not lower level |
| 1453 | <tt>diff</tt> commands, such as <tt>git diff-files</tt>. |
| 1454 | </p> |
| 1455 | </dd> |
| 1456 | <dt> |
| Junio C Hamano | 1fbbbc1 | 2007-12-18 07:01:27 | [diff] [blame] | 1457 | diff.external |
| 1458 | </dt> |
| 1459 | <dd> |
| 1460 | <p> |
| 1461 | If this config variable is set, diff generation is not |
| 1462 | performed using the internal diff machinery, but using the |
| 1463 | given command. Note: if you want to use an external diff |
| 1464 | program only on a subset of your files, you might want to |
| 1465 | use <a href="gitattributes.html">gitattributes(5)</a> instead. |
| 1466 | </p> |
| 1467 | </dd> |
| 1468 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1469 | diff.renameLimit |
| 1470 | </dt> |
| 1471 | <dd> |
| 1472 | <p> |
| 1473 | The number of files to consider when performing the copy/rename |
| 1474 | detection; equivalent to the git diff option <em>-l</em>. |
| 1475 | </p> |
| 1476 | </dd> |
| 1477 | <dt> |
| 1478 | diff.renames |
| 1479 | </dt> |
| 1480 | <dd> |
| 1481 | <p> |
| 1482 | Tells git to detect renames. If set to any boolean value, it |
| 1483 | will enable basic rename detection. If set to "copies" or |
| 1484 | "copy", it will detect copies, as well. |
| 1485 | </p> |
| 1486 | </dd> |
| 1487 | <dt> |
| 1488 | fetch.unpackLimit |
| 1489 | </dt> |
| 1490 | <dd> |
| 1491 | <p> |
| 1492 | If the number of objects fetched over the git native |
| 1493 | transfer is below this |
| 1494 | limit, then the objects will be unpacked into loose object |
| 1495 | files. However if the number of received objects equals or |
| 1496 | exceeds this limit then the received pack will be stored as |
| 1497 | a pack, after adding any missing delta bases. Storing the |
| 1498 | pack from a push can make the push operation complete faster, |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 1499 | especially on slow filesystems. If not set, the value of |
| 1500 | <tt>transfer.unpackLimit</tt> is used instead. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1501 | </p> |
| 1502 | </dd> |
| 1503 | <dt> |
| Junio C Hamano | 8c5802d | 2007-11-15 00:13:36 | [diff] [blame] | 1504 | format.numbered |
| 1505 | </dt> |
| 1506 | <dd> |
| 1507 | <p> |
| 1508 | A boolean which can enable sequence numbers in patch subjects. |
| Junio C Hamano | fe98605 | 2007-12-19 07:33:38 | [diff] [blame] | 1509 | Setting this option to "auto" will enable it only if there is |
| Junio C Hamano | 8c5802d | 2007-11-15 00:13:36 | [diff] [blame] | 1510 | more than one patch. See --numbered option in |
| 1511 | <a href="git-format-patch.html">git-format-patch(1)</a>. |
| 1512 | </p> |
| 1513 | </dd> |
| 1514 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1515 | format.headers |
| 1516 | </dt> |
| 1517 | <dd> |
| 1518 | <p> |
| 1519 | Additional email headers to include in a patch to be submitted |
| 1520 | by mail. See <a href="git-format-patch.html">git-format-patch(1)</a>. |
| 1521 | </p> |
| 1522 | </dd> |
| 1523 | <dt> |
| Junio C Hamano | d4c8e11 | 2007-03-04 10:32:38 | [diff] [blame] | 1524 | format.suffix |
| 1525 | </dt> |
| 1526 | <dd> |
| 1527 | <p> |
| 1528 | The default for format-patch is to output files with the suffix |
| 1529 | <tt>.patch</tt>. Use this variable to change that suffix (make sure to |
| 1530 | include the dot if you want it). |
| 1531 | </p> |
| 1532 | </dd> |
| 1533 | <dt> |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 1534 | format.pretty |
| 1535 | </dt> |
| 1536 | <dd> |
| 1537 | <p> |
| 1538 | The default pretty format for log/show/whatchanged command, |
| 1539 | See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, |
| 1540 | <a href="git-whatchanged.html">git-whatchanged(1)</a>. |
| 1541 | </p> |
| 1542 | </dd> |
| 1543 | <dt> |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1544 | gc.aggressiveWindow |
| 1545 | </dt> |
| 1546 | <dd> |
| 1547 | <p> |
| 1548 | The window size parameter used in the delta compression |
| 1549 | algorithm used by <em>git gc --aggressive</em>. This defaults |
| 1550 | to 10. |
| 1551 | </p> |
| 1552 | </dd> |
| 1553 | <dt> |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1554 | gc.auto |
| 1555 | </dt> |
| 1556 | <dd> |
| 1557 | <p> |
| 1558 | When there are approximately more than this many loose |
| 1559 | objects in the repository, <tt>git gc --auto</tt> will pack them. |
| 1560 | Some Porcelain commands use this command to perform a |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 1561 | light-weight garbage collection from time to time. The |
| 1562 | default value is 6700. Setting this to 0 disables it. |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1563 | </p> |
| 1564 | </dd> |
| 1565 | <dt> |
| 1566 | gc.autopacklimit |
| 1567 | </dt> |
| 1568 | <dd> |
| 1569 | <p> |
| 1570 | When there are more than this many packs that are not |
| 1571 | marked with <tt>*.keep</tt> file in the repository, <tt>git gc |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 1572 | --auto</tt> consolidates them into one larger pack. The |
| Junio C Hamano | 25c0b70 | 2008-03-23 09:41:37 | [diff] [blame] | 1573 | default value is 50. Setting this to 0 disables it. |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1574 | </p> |
| 1575 | </dd> |
| 1576 | <dt> |
| Junio C Hamano | 9d52e57 | 2007-02-13 23:48:20 | [diff] [blame] | 1577 | gc.packrefs |
| 1578 | </dt> |
| 1579 | <dd> |
| 1580 | <p> |
| 1581 | <tt>git gc</tt> does not run <tt>git pack-refs</tt> in a bare repository by |
| 1582 | default so that older dumb-transport clients can still fetch |
| 1583 | from the repository. Setting this to <tt>true</tt> lets <tt>git |
| 1584 | gc</tt> to run <tt>git pack-refs</tt>. Setting this to <tt>false</tt> tells |
| 1585 | <tt>git gc</tt> never to run <tt>git pack-refs</tt>. The default setting is |
| 1586 | <tt>notbare</tt>. Enable it only when you know you do not have to |
| 1587 | support such clients. The default setting will change to <tt>true</tt> |
| 1588 | at some stage, and setting this to <tt>false</tt> will continue to |
| 1589 | prevent <tt>git pack-refs</tt> from being run from <tt>git gc</tt>. |
| 1590 | </p> |
| 1591 | </dd> |
| 1592 | <dt> |
| Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 1593 | gc.pruneexpire |
| 1594 | </dt> |
| 1595 | <dd> |
| 1596 | <p> |
| 1597 | When <tt>git gc</tt> is run, it will call <tt>prune --expire 2.weeks.ago</tt>. |
| 1598 | Override the grace period with this config variable. |
| 1599 | </p> |
| 1600 | </dd> |
| 1601 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1602 | gc.reflogexpire |
| 1603 | </dt> |
| 1604 | <dd> |
| 1605 | <p> |
| 1606 | <tt>git reflog expire</tt> removes reflog entries older than |
| 1607 | this time; defaults to 90 days. |
| 1608 | </p> |
| 1609 | </dd> |
| 1610 | <dt> |
| 1611 | gc.reflogexpireunreachable |
| 1612 | </dt> |
| 1613 | <dd> |
| 1614 | <p> |
| 1615 | <tt>git reflog expire</tt> removes reflog entries older than |
| 1616 | this time and are not reachable from the current tip; |
| 1617 | defaults to 30 days. |
| 1618 | </p> |
| 1619 | </dd> |
| 1620 | <dt> |
| 1621 | gc.rerereresolved |
| 1622 | </dt> |
| 1623 | <dd> |
| 1624 | <p> |
| 1625 | Records of conflicted merge you resolved earlier are |
| 1626 | kept for this many days when <tt>git rerere gc</tt> is run. |
| 1627 | The default is 60 days. See <a href="git-rerere.html">git-rerere(1)</a>. |
| 1628 | </p> |
| 1629 | </dd> |
| 1630 | <dt> |
| 1631 | gc.rerereunresolved |
| 1632 | </dt> |
| 1633 | <dd> |
| 1634 | <p> |
| 1635 | Records of conflicted merge you have not resolved are |
| 1636 | kept for this many days when <tt>git rerere gc</tt> is run. |
| 1637 | The default is 15 days. See <a href="git-rerere.html">git-rerere(1)</a>. |
| 1638 | </p> |
| 1639 | </dd> |
| 1640 | <dt> |
| Junio C Hamano | 7a4a283 | 2007-07-07 21:53:22 | [diff] [blame] | 1641 | rerere.enabled |
| 1642 | </dt> |
| 1643 | <dd> |
| 1644 | <p> |
| 1645 | Activate recording of resolved conflicts, so that identical |
| 1646 | conflict hunks can be resolved automatically, should they |
| Junio C Hamano | e0facb9 | 2007-12-05 10:59:48 | [diff] [blame] | 1647 | be encountered again. <a href="git-rerere.html">git-rerere(1)</a> command is by |
| Junio C Hamano | 0e47b23 | 2008-01-15 08:31:10 | [diff] [blame] | 1648 | default enabled if you create <tt>rr-cache</tt> directory under |
| 1649 | <tt>$GIT_DIR</tt>, but can be disabled by setting this option to false. |
| Junio C Hamano | 7a4a283 | 2007-07-07 21:53:22 | [diff] [blame] | 1650 | </p> |
| 1651 | </dd> |
| 1652 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1653 | gitcvs.enabled |
| 1654 | </dt> |
| 1655 | <dd> |
| 1656 | <p> |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1657 | Whether the CVS server interface is enabled for this repository. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1658 | See <a href="git-cvsserver.html">git-cvsserver(1)</a>. |
| 1659 | </p> |
| 1660 | </dd> |
| 1661 | <dt> |
| 1662 | gitcvs.logfile |
| 1663 | </dt> |
| 1664 | <dd> |
| 1665 | <p> |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1666 | Path to a log file where the CVS server interface well… logs |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1667 | various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>. |
| 1668 | </p> |
| 1669 | </dd> |
| 1670 | <dt> |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 1671 | gitcvs.allbinary |
| 1672 | </dt> |
| 1673 | <dd> |
| 1674 | <p> |
| 1675 | If true, all files are sent to the client in mode <em>-kb</em>. This |
| 1676 | causes the client to treat all files as binary files which suppresses |
| 1677 | any newline munging it otherwise might do. A work-around for the |
| 1678 | fact that there is no way yet to set single files to mode <em>-kb</em>. |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1679 | </p> |
| 1680 | </dd> |
| 1681 | <dt> |
| 1682 | gitcvs.dbname |
| 1683 | </dt> |
| 1684 | <dd> |
| 1685 | <p> |
| 1686 | Database used by git-cvsserver to cache revision information |
| 1687 | derived from the git repository. The exact meaning depends on the |
| 1688 | used database driver, for SQLite (which is the default driver) this |
| 1689 | is a filename. Supports variable substitution (see |
| 1690 | <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<tt>;</tt>). |
| 1691 | Default: <em>%Ggitcvs.%m.sqlite</em> |
| 1692 | </p> |
| 1693 | </dd> |
| 1694 | <dt> |
| 1695 | gitcvs.dbdriver |
| 1696 | </dt> |
| 1697 | <dd> |
| 1698 | <p> |
| 1699 | Used Perl DBI driver. You can specify any available driver |
| 1700 | for this here, but it might not work. git-cvsserver is tested |
| 1701 | with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and |
| 1702 | reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature. |
| 1703 | May not contain double colons (<tt>:</tt>). Default: <em>SQLite</em>. |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 1704 | See <a href="git-cvsserver.html">git-cvsserver(1)</a>. |
| 1705 | </p> |
| 1706 | </dd> |
| 1707 | <dt> |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1708 | gitcvs.dbuser, gitcvs.dbpass |
| 1709 | </dt> |
| 1710 | <dd> |
| 1711 | <p> |
| 1712 | Database user and password. Only useful if setting <em>gitcvs.dbdriver</em>, |
| 1713 | since SQLite has no concept of database users and/or passwords. |
| 1714 | <em>gitcvs.dbuser</em> supports variable substitution (see |
| 1715 | <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). |
| 1716 | </p> |
| 1717 | </dd> |
| Junio C Hamano | a74efce | 2008-04-02 08:39:08 | [diff] [blame] | 1718 | <dt> |
| 1719 | gitcvs.dbTableNamePrefix |
| 1720 | </dt> |
| 1721 | <dd> |
| 1722 | <p> |
| 1723 | Database table name prefix. Prepended to the names of any |
| 1724 | database tables used, allowing a single database to be used |
| 1725 | for several repositories. Supports variable substitution (see |
| 1726 | <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). Any non-alphabetic |
| 1727 | characters will be replaced with underscores. |
| 1728 | </p> |
| 1729 | </dd> |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1730 | </dl> |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1731 | <p>All gitcvs variables except for <em>gitcvs.allbinary</em> can also be |
| 1732 | specified as <em>gitcvs.<access_method>.<varname></em> (where <em>access_method</em> |
| 1733 | is one of "ext" and "pserver") to make them apply only for the given |
| 1734 | access method.</p> |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1735 | <dl> |
| 1736 | <dt> |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame^] | 1737 | gui.commitmsgwidth |
| 1738 | </dt> |
| 1739 | <dd> |
| 1740 | <p> |
| 1741 | Defines how wide the commit message window is in the |
| 1742 | <a href="git-gui.html">git-gui(1)</a>. "75" is the default. |
| 1743 | </p> |
| 1744 | </dd> |
| 1745 | <dt> |
| 1746 | gui.diffcontext |
| 1747 | </dt> |
| 1748 | <dd> |
| 1749 | <p> |
| 1750 | Specifies how many context lines should be used in calls to diff |
| 1751 | made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5". |
| 1752 | </p> |
| 1753 | </dd> |
| 1754 | <dt> |
| 1755 | gui.matchtrackingbranch |
| 1756 | </dt> |
| 1757 | <dd> |
| 1758 | <p> |
| 1759 | Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should |
| 1760 | default to tracking remote branches with matching names or |
| 1761 | not. Default: "false". |
| 1762 | </p> |
| 1763 | </dd> |
| 1764 | <dt> |
| 1765 | gui.newbranchtemplate |
| 1766 | </dt> |
| 1767 | <dd> |
| 1768 | <p> |
| 1769 | Is used as suggested name when creating new branches using the |
| 1770 | <a href="git-gui.html">git-gui(1)</a>. |
| 1771 | </p> |
| 1772 | </dd> |
| 1773 | <dt> |
| 1774 | gui.pruneduringfetch |
| 1775 | </dt> |
| 1776 | <dd> |
| 1777 | <p> |
| 1778 | "true" if <a href="git-gui.html">git-gui(1)</a> should prune tracking branches when |
| 1779 | performing a fetch. The default value is "false". |
| 1780 | </p> |
| 1781 | </dd> |
| 1782 | <dt> |
| 1783 | gui.trustmtime |
| 1784 | </dt> |
| 1785 | <dd> |
| 1786 | <p> |
| 1787 | Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification |
| 1788 | timestamp or not. By default the timestamps are not trusted. |
| 1789 | </p> |
| 1790 | </dd> |
| 1791 | <dt> |
| 1792 | gui.spellingdictionary |
| 1793 | </dt> |
| 1794 | <dd> |
| 1795 | <p> |
| 1796 | Specifies the dictionary used for spell checking commit messages in |
| 1797 | the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned |
| 1798 | off. |
| 1799 | </p> |
| 1800 | </dd> |
| 1801 | <dt> |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 1802 | help.browser |
| 1803 | </dt> |
| 1804 | <dd> |
| 1805 | <p> |
| 1806 | Specify the browser that will be used to display help in the |
| 1807 | <em>web</em> format. See <a href="git-help.html">git-help(1)</a>. |
| 1808 | </p> |
| 1809 | </dd> |
| 1810 | <dt> |
| 1811 | help.format |
| 1812 | </dt> |
| 1813 | <dd> |
| 1814 | <p> |
| 1815 | Override the default help format used by <a href="git-help.html">git-help(1)</a>. |
| 1816 | Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is |
| 1817 | the default. <em>web</em> and <em>html</em> are the same. |
| 1818 | </p> |
| 1819 | </dd> |
| 1820 | <dt> |
| Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 1821 | http.proxy |
| 1822 | </dt> |
| 1823 | <dd> |
| 1824 | <p> |
| 1825 | Override the HTTP proxy, normally configured using the <em>http_proxy</em> |
| 1826 | environment variable (see <a href="curl.html">curl(1)</a>). This can be overridden |
| 1827 | on a per-remote basis; see remote.<name>.proxy |
| 1828 | </p> |
| 1829 | </dd> |
| 1830 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1831 | http.sslVerify |
| 1832 | </dt> |
| 1833 | <dd> |
| 1834 | <p> |
| 1835 | Whether to verify the SSL certificate when fetching or pushing |
| 1836 | over HTTPS. Can be overridden by the <em>GIT_SSL_NO_VERIFY</em> environment |
| 1837 | variable. |
| 1838 | </p> |
| 1839 | </dd> |
| 1840 | <dt> |
| 1841 | http.sslCert |
| 1842 | </dt> |
| 1843 | <dd> |
| 1844 | <p> |
| 1845 | File containing the SSL certificate when fetching or pushing |
| 1846 | over HTTPS. Can be overridden by the <em>GIT_SSL_CERT</em> environment |
| 1847 | variable. |
| 1848 | </p> |
| 1849 | </dd> |
| 1850 | <dt> |
| 1851 | http.sslKey |
| 1852 | </dt> |
| 1853 | <dd> |
| 1854 | <p> |
| 1855 | File containing the SSL private key when fetching or pushing |
| 1856 | over HTTPS. Can be overridden by the <em>GIT_SSL_KEY</em> environment |
| 1857 | variable. |
| 1858 | </p> |
| 1859 | </dd> |
| 1860 | <dt> |
| 1861 | http.sslCAInfo |
| 1862 | </dt> |
| 1863 | <dd> |
| 1864 | <p> |
| 1865 | File containing the certificates to verify the peer with when |
| 1866 | fetching or pushing over HTTPS. Can be overridden by the |
| 1867 | <em>GIT_SSL_CAINFO</em> environment variable. |
| 1868 | </p> |
| 1869 | </dd> |
| 1870 | <dt> |
| 1871 | http.sslCAPath |
| 1872 | </dt> |
| 1873 | <dd> |
| 1874 | <p> |
| 1875 | Path containing files with the CA certificates to verify the peer |
| 1876 | with when fetching or pushing over HTTPS. Can be overridden |
| 1877 | by the <em>GIT_SSL_CAPATH</em> environment variable. |
| 1878 | </p> |
| 1879 | </dd> |
| 1880 | <dt> |
| 1881 | http.maxRequests |
| 1882 | </dt> |
| 1883 | <dd> |
| 1884 | <p> |
| 1885 | How many HTTP requests to launch in parallel. Can be overridden |
| 1886 | by the <em>GIT_HTTP_MAX_REQUESTS</em> environment variable. Default is 5. |
| 1887 | </p> |
| 1888 | </dd> |
| 1889 | <dt> |
| 1890 | http.lowSpeedLimit, http.lowSpeedTime |
| 1891 | </dt> |
| 1892 | <dd> |
| 1893 | <p> |
| 1894 | If the HTTP transfer speed is less than <em>http.lowSpeedLimit</em> |
| 1895 | for longer than <em>http.lowSpeedTime</em> seconds, the transfer is aborted. |
| 1896 | Can be overridden by the <em>GIT_HTTP_LOW_SPEED_LIMIT</em> and |
| 1897 | <em>GIT_HTTP_LOW_SPEED_TIME</em> environment variables. |
| 1898 | </p> |
| 1899 | </dd> |
| 1900 | <dt> |
| 1901 | http.noEPSV |
| 1902 | </dt> |
| 1903 | <dd> |
| 1904 | <p> |
| 1905 | A boolean which disables using of EPSV ftp command by curl. |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 1906 | This can helpful with some "poor" ftp servers which don't |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1907 | support EPSV mode. Can be overridden by the <em>GIT_CURL_FTP_NO_EPSV</em> |
| 1908 | environment variable. Default is false (curl will use EPSV). |
| 1909 | </p> |
| 1910 | </dd> |
| 1911 | <dt> |
| 1912 | i18n.commitEncoding |
| 1913 | </dt> |
| 1914 | <dd> |
| 1915 | <p> |
| 1916 | Character encoding the commit messages are stored in; git itself |
| 1917 | does not care per se, but this information is necessary e.g. when |
| 1918 | importing commits from emails or in the gitk graphical history |
| 1919 | browser (and possibly at other places in the future or in other |
| 1920 | porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>. |
| 1921 | </p> |
| 1922 | </dd> |
| 1923 | <dt> |
| 1924 | i18n.logOutputEncoding |
| 1925 | </dt> |
| 1926 | <dd> |
| 1927 | <p> |
| 1928 | Character encoding the commit messages are converted to when |
| 1929 | running <tt>git-log</tt> and friends. |
| 1930 | </p> |
| 1931 | </dd> |
| 1932 | <dt> |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 1933 | instaweb.browser |
| 1934 | </dt> |
| 1935 | <dd> |
| 1936 | <p> |
| 1937 | Specify the program that will be used to browse your working |
| 1938 | repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>. |
| 1939 | </p> |
| 1940 | </dd> |
| 1941 | <dt> |
| 1942 | instaweb.httpd |
| 1943 | </dt> |
| 1944 | <dd> |
| 1945 | <p> |
| 1946 | The HTTP daemon command-line to start gitweb on your working |
| 1947 | repository. See <a href="git-instaweb.html">git-instaweb(1)</a>. |
| 1948 | </p> |
| 1949 | </dd> |
| 1950 | <dt> |
| 1951 | instaweb.local |
| 1952 | </dt> |
| 1953 | <dd> |
| 1954 | <p> |
| 1955 | If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will |
| 1956 | be bound to the local IP (127.0.0.1). |
| 1957 | </p> |
| 1958 | </dd> |
| 1959 | <dt> |
| 1960 | instaweb.modulepath |
| 1961 | </dt> |
| 1962 | <dd> |
| 1963 | <p> |
| 1964 | The module path for an apache httpd used by <a href="git-instaweb.html">git-instaweb(1)</a>. |
| 1965 | </p> |
| 1966 | </dd> |
| 1967 | <dt> |
| 1968 | instaweb.port |
| 1969 | </dt> |
| 1970 | <dd> |
| 1971 | <p> |
| 1972 | The port number to bind the gitweb httpd to. See |
| 1973 | <a href="git-instaweb.html">git-instaweb(1)</a>. |
| 1974 | </p> |
| 1975 | </dd> |
| 1976 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 1977 | log.showroot |
| 1978 | </dt> |
| 1979 | <dd> |
| 1980 | <p> |
| 1981 | If true, the initial commit will be shown as a big creation event. |
| 1982 | This is equivalent to a diff against an empty tree. |
| 1983 | Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which |
| 1984 | normally hide the root commit will now show it. True by default. |
| 1985 | </p> |
| 1986 | </dd> |
| 1987 | <dt> |
| Junio C Hamano | 8b588d5 | 2008-03-15 09:48:37 | [diff] [blame] | 1988 | man.viewer |
| 1989 | </dt> |
| 1990 | <dd> |
| 1991 | <p> |
| 1992 | Specify the programs that may be used to display help in the |
| 1993 | <em>man</em> format. See <a href="git-help.html">git-help(1)</a>. |
| 1994 | </p> |
| 1995 | </dd> |
| 1996 | <dt> |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame^] | 1997 | merge.stat |
| 1998 | </dt> |
| 1999 | <dd> |
| 2000 | <p> |
| 2001 | Whether to print the diffstat berween ORIG_HEAD and merge result |
| 2002 | at the end of the merge. True by default. |
| 2003 | </p> |
| 2004 | </dd> |
| 2005 | <dt> |
| 2006 | merge.log |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2007 | </dt> |
| 2008 | <dd> |
| 2009 | <p> |
| 2010 | Whether to include summaries of merged commits in newly created |
| 2011 | merge commit messages. False by default. |
| 2012 | </p> |
| 2013 | </dd> |
| 2014 | <dt> |
| Junio C Hamano | 103ad7f | 2007-03-14 11:19:26 | [diff] [blame] | 2015 | merge.tool |
| 2016 | </dt> |
| 2017 | <dd> |
| 2018 | <p> |
| 2019 | Controls which merge resolution program is used by |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2020 | <a href="git-mergetool.html">git-mergetool(1)</a>. Valid built-in values are: "kdiff3", |
| 2021 | "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and |
| 2022 | "opendiff". Any other value is treated is custom merge tool |
| 2023 | and there must be a corresponing mergetool.<tool>.cmd option. |
| Junio C Hamano | 103ad7f | 2007-03-14 11:19:26 | [diff] [blame] | 2024 | </p> |
| 2025 | </dd> |
| 2026 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2027 | merge.verbosity |
| 2028 | </dt> |
| 2029 | <dd> |
| 2030 | <p> |
| 2031 | Controls the amount of output shown by the recursive merge |
| 2032 | strategy. Level 0 outputs nothing except a final error |
| 2033 | message if conflicts were detected. Level 1 outputs only |
| 2034 | conflicts, 2 outputs conflicts and file changes. Level 5 and |
| 2035 | above outputs debugging information. The default is level 2. |
| Junio C Hamano | 764a667 | 2007-10-23 01:23:31 | [diff] [blame] | 2036 | Can be overridden by <em>GIT_MERGE_VERBOSITY</em> environment variable. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2037 | </p> |
| 2038 | </dd> |
| 2039 | <dt> |
| Junio C Hamano | e90436a | 2007-04-22 07:22:13 | [diff] [blame] | 2040 | merge.<driver>.name |
| 2041 | </dt> |
| 2042 | <dd> |
| 2043 | <p> |
| 2044 | Defines a human readable name for a custom low-level |
| 2045 | merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details. |
| 2046 | </p> |
| 2047 | </dd> |
| 2048 | <dt> |
| 2049 | merge.<driver>.driver |
| 2050 | </dt> |
| 2051 | <dd> |
| 2052 | <p> |
| 2053 | Defines the command that implements a custom low-level |
| 2054 | merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details. |
| 2055 | </p> |
| 2056 | </dd> |
| 2057 | <dt> |
| 2058 | merge.<driver>.recursive |
| 2059 | </dt> |
| 2060 | <dd> |
| 2061 | <p> |
| 2062 | Names a low-level merge driver to be used when |
| 2063 | performing an internal merge between common ancestors. |
| 2064 | See <a href="gitattributes.html">gitattributes(5)</a> for details. |
| 2065 | </p> |
| 2066 | </dd> |
| 2067 | <dt> |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame^] | 2068 | man.<tool>.cmd |
| 2069 | </dt> |
| 2070 | <dd> |
| 2071 | <p> |
| 2072 | Specify the command to invoke the specified man viewer. The |
| 2073 | specified command is evaluated in shell with the man page |
| 2074 | passed as argument. (See <a href="git-help.html">git-help(1)</a>.) |
| 2075 | </p> |
| 2076 | </dd> |
| 2077 | <dt> |
| 2078 | man.<tool>.path |
| 2079 | </dt> |
| 2080 | <dd> |
| 2081 | <p> |
| 2082 | Override the path for the given tool that may be used to |
| 2083 | display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>. |
| 2084 | </p> |
| 2085 | </dd> |
| 2086 | <dt> |
| Junio C Hamano | 1fbbbc1 | 2007-12-18 07:01:27 | [diff] [blame] | 2087 | mergetool.<tool>.path |
| 2088 | </dt> |
| 2089 | <dd> |
| 2090 | <p> |
| 2091 | Override the path for the given tool. This is useful in case |
| 2092 | your tool is not in the PATH. |
| 2093 | </p> |
| 2094 | </dd> |
| 2095 | <dt> |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2096 | mergetool.<tool>.cmd |
| 2097 | </dt> |
| 2098 | <dd> |
| 2099 | <p> |
| 2100 | Specify the command to invoke the specified merge tool. The |
| 2101 | specified command is evaluated in shell with the following |
| 2102 | variables available: <em>BASE</em> is the name of a temporary file |
| 2103 | containing the common base of the files to be merged, if available; |
| 2104 | <em>LOCAL</em> is the name of a temporary file containing the contents of |
| 2105 | the file on the current branch; <em>REMOTE</em> is the name of a temporary |
| 2106 | file containing the contents of the file from the branch being |
| 2107 | merged; <em>MERGED</em> contains the name of the file to which the merge |
| 2108 | tool should write the results of a successful merge. |
| 2109 | </p> |
| 2110 | </dd> |
| 2111 | <dt> |
| 2112 | mergetool.<tool>.trustExitCode |
| 2113 | </dt> |
| 2114 | <dd> |
| 2115 | <p> |
| 2116 | For a custom merge command, specify whether the exit code of |
| 2117 | the merge command can be used to determine whether the merge was |
| 2118 | successful. If this is not set to true then the merge target file |
| 2119 | timestamp is checked and the merge assumed to have been successful |
| 2120 | if the file has been updated, otherwise the user is prompted to |
| 2121 | indicate the success of the merge. |
| 2122 | </p> |
| 2123 | </dd> |
| 2124 | <dt> |
| 2125 | mergetool.keepBackup |
| 2126 | </dt> |
| 2127 | <dd> |
| 2128 | <p> |
| 2129 | After performing a merge, the original file with conflict markers |
| 2130 | can be saved as a file with a <tt>.orig</tt> extension. If this variable |
| 2131 | is set to <tt>false</tt> then this file is not preserved. Defaults to |
| 2132 | <tt>true</tt> (i.e. keep the backup files). |
| 2133 | </p> |
| 2134 | </dd> |
| 2135 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2136 | pack.window |
| 2137 | </dt> |
| 2138 | <dd> |
| 2139 | <p> |
| 2140 | The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no |
| 2141 | window size is given on the command line. Defaults to 10. |
| 2142 | </p> |
| 2143 | </dd> |
| 2144 | <dt> |
| Junio C Hamano | 91d44c5 | 2007-05-09 07:16:07 | [diff] [blame] | 2145 | pack.depth |
| 2146 | </dt> |
| 2147 | <dd> |
| 2148 | <p> |
| 2149 | The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no |
| 2150 | maximum depth is given on the command line. Defaults to 50. |
| 2151 | </p> |
| 2152 | </dd> |
| 2153 | <dt> |
| Junio C Hamano | 235d53f | 2007-07-13 00:25:15 | [diff] [blame] | 2154 | pack.windowMemory |
| 2155 | </dt> |
| 2156 | <dd> |
| 2157 | <p> |
| 2158 | The window memory size limit used by <a href="git-pack-objects.html">git-pack-objects(1)</a> |
| 2159 | when no limit is given on the command line. The value can be |
| 2160 | suffixed with "k", "m", or "g". Defaults to 0, meaning no |
| 2161 | limit. |
| 2162 | </p> |
| 2163 | </dd> |
| 2164 | <dt> |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 2165 | pack.compression |
| 2166 | </dt> |
| 2167 | <dd> |
| 2168 | <p> |
| 2169 | An integer -1..9, indicating the compression level for objects |
| 2170 | in a pack file. -1 is the zlib default. 0 means no |
| 2171 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 2172 | slowest. If not set, defaults to core.compression. If that is |
| Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 2173 | not set, defaults to -1, the zlib default, which is "a default |
| 2174 | compromise between speed and compression (currently equivalent |
| 2175 | to level 6)." |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 2176 | </p> |
| 2177 | </dd> |
| 2178 | <dt> |
| Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 2179 | pack.deltaCacheSize |
| 2180 | </dt> |
| 2181 | <dd> |
| 2182 | <p> |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 2183 | The maximum memory in bytes used for caching deltas in |
| Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 2184 | <a href="git-pack-objects.html">git-pack-objects(1)</a>. |
| 2185 | A value of 0 means no limit. Defaults to 0. |
| 2186 | </p> |
| 2187 | </dd> |
| 2188 | <dt> |
| 2189 | pack.deltaCacheLimit |
| 2190 | </dt> |
| 2191 | <dd> |
| 2192 | <p> |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 2193 | The maximum size of a delta, that is cached in |
| Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 2194 | <a href="git-pack-objects.html">git-pack-objects(1)</a>. Defaults to 1000. |
| 2195 | </p> |
| 2196 | </dd> |
| 2197 | <dt> |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 2198 | pack.threads |
| 2199 | </dt> |
| 2200 | <dd> |
| 2201 | <p> |
| 2202 | Specifies the number of threads to spawn when searching for best |
| 2203 | delta matches. This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a> |
| 2204 | be compiled with pthreads otherwise this option is ignored with a |
| 2205 | warning. This is meant to reduce packing time on multiprocessor |
| 2206 | machines. The required amount of memory for the delta search window |
| 2207 | is however multiplied by the number of threads. |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 2208 | Specifying 0 will cause git to auto-detect the number of CPU's |
| 2209 | and set the number of threads accordingly. |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 2210 | </p> |
| 2211 | </dd> |
| 2212 | <dt> |
| Junio C Hamano | d814b6d | 2007-11-04 11:13:49 | [diff] [blame] | 2213 | pack.indexVersion |
| 2214 | </dt> |
| 2215 | <dd> |
| 2216 | <p> |
| 2217 | Specify the default pack index version. Valid values are 1 for |
| 2218 | legacy pack index used by Git versions prior to 1.5.2, and 2 for |
| 2219 | the new pack index with capabilities for packs larger than 4 GB |
| 2220 | as well as proper protection against the repacking of corrupted |
| 2221 | packs. Version 2 is selected and this config option ignored |
| 2222 | whenever the corresponding pack is larger than 2 GB. Otherwise |
| 2223 | the default is 1. |
| 2224 | </p> |
| 2225 | </dd> |
| Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 2226 | <dt> |
| 2227 | pack.packSizeLimit |
| 2228 | </dt> |
| 2229 | <dd> |
| 2230 | <p> |
| Junio C Hamano | 49dccaf | 2008-02-10 10:48:01 | [diff] [blame] | 2231 | The default maximum size of a pack. This setting only affects |
| 2232 | packing to a file, i.e. the git:// protocol is unaffected. It |
| 2233 | can be overridden by the <tt>--max-pack-size</tt> option of |
| Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 2234 | <a href="git-repack.html">git-repack(1)</a>. |
| 2235 | </p> |
| 2236 | </dd> |
| Junio C Hamano | d814b6d | 2007-11-04 11:13:49 | [diff] [blame] | 2237 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2238 | pull.octopus |
| 2239 | </dt> |
| 2240 | <dd> |
| 2241 | <p> |
| 2242 | The default merge strategy to use when pulling multiple branches |
| 2243 | at once. |
| 2244 | </p> |
| 2245 | </dd> |
| 2246 | <dt> |
| 2247 | pull.twohead |
| 2248 | </dt> |
| 2249 | <dd> |
| 2250 | <p> |
| 2251 | The default merge strategy to use when pulling a single branch. |
| 2252 | </p> |
| 2253 | </dd> |
| 2254 | <dt> |
| 2255 | remote.<name>.url |
| 2256 | </dt> |
| 2257 | <dd> |
| 2258 | <p> |
| 2259 | The URL of a remote repository. See <a href="git-fetch.html">git-fetch(1)</a> or |
| 2260 | <a href="git-push.html">git-push(1)</a>. |
| 2261 | </p> |
| 2262 | </dd> |
| 2263 | <dt> |
| Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 2264 | remote.<name>.proxy |
| 2265 | </dt> |
| 2266 | <dd> |
| 2267 | <p> |
| 2268 | For remotes that require curl (http, https and ftp), the URL to |
| 2269 | the proxy to use for that remote. Set to the empty string to |
| 2270 | disable proxying for that remote. |
| 2271 | </p> |
| 2272 | </dd> |
| 2273 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2274 | remote.<name>.fetch |
| 2275 | </dt> |
| 2276 | <dd> |
| 2277 | <p> |
| 2278 | The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See |
| 2279 | <a href="git-fetch.html">git-fetch(1)</a>. |
| 2280 | </p> |
| 2281 | </dd> |
| 2282 | <dt> |
| 2283 | remote.<name>.push |
| 2284 | </dt> |
| 2285 | <dd> |
| 2286 | <p> |
| 2287 | The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See |
| 2288 | <a href="git-push.html">git-push(1)</a>. |
| 2289 | </p> |
| 2290 | </dd> |
| 2291 | <dt> |
| Junio C Hamano | 47d68a5 | 2008-05-06 06:35:40 | [diff] [blame] | 2292 | remote.<name>.mirror |
| 2293 | </dt> |
| 2294 | <dd> |
| 2295 | <p> |
| 2296 | If true, pushing to this remote will automatically behave |
| 2297 | as if the <tt>--mirror</tt> option was given on the command line. |
| 2298 | </p> |
| 2299 | </dd> |
| 2300 | <dt> |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2301 | remote.<name>.skipDefaultUpdate |
| 2302 | </dt> |
| 2303 | <dd> |
| 2304 | <p> |
| 2305 | If true, this remote will be skipped by default when updating |
| Junio C Hamano | 618bdde | 2008-01-02 10:51:08 | [diff] [blame] | 2306 | using the update subcommand of <a href="git-remote.html">git-remote(1)</a>. |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2307 | </p> |
| 2308 | </dd> |
| 2309 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2310 | remote.<name>.receivepack |
| 2311 | </dt> |
| 2312 | <dd> |
| 2313 | <p> |
| 2314 | The default program to execute on the remote side when pushing. See |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2315 | option --receive-pack of <a href="git-push.html">git-push(1)</a>. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2316 | </p> |
| 2317 | </dd> |
| 2318 | <dt> |
| 2319 | remote.<name>.uploadpack |
| 2320 | </dt> |
| 2321 | <dd> |
| 2322 | <p> |
| 2323 | The default program to execute on the remote side when fetching. See |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2324 | option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2325 | </p> |
| 2326 | </dd> |
| 2327 | <dt> |
| Junio C Hamano | 17dde0e | 2007-02-26 09:50:21 | [diff] [blame] | 2328 | remote.<name>.tagopt |
| 2329 | </dt> |
| 2330 | <dd> |
| 2331 | <p> |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2332 | Setting this value to --no-tags disables automatic tag following when |
| 2333 | fetching from remote <name> |
| Junio C Hamano | 17dde0e | 2007-02-26 09:50:21 | [diff] [blame] | 2334 | </p> |
| 2335 | </dd> |
| 2336 | <dt> |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2337 | remotes.<group> |
| 2338 | </dt> |
| 2339 | <dd> |
| 2340 | <p> |
| 2341 | The list of remotes which are fetched by "git remote update |
| 2342 | <group>". See <a href="git-remote.html">git-remote(1)</a>. |
| 2343 | </p> |
| 2344 | </dd> |
| 2345 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2346 | repack.usedeltabaseoffset |
| 2347 | </dt> |
| 2348 | <dd> |
| 2349 | <p> |
| 2350 | Allow <a href="git-repack.html">git-repack(1)</a> to create packs that uses |
| 2351 | delta-base offset. Defaults to false. |
| 2352 | </p> |
| 2353 | </dd> |
| 2354 | <dt> |
| 2355 | show.difftree |
| 2356 | </dt> |
| 2357 | <dd> |
| 2358 | <p> |
| 2359 | The default <a href="git-diff-tree.html">git-diff-tree(1)</a> arguments to be used |
| 2360 | for <a href="git-show.html">git-show(1)</a>. |
| 2361 | </p> |
| 2362 | </dd> |
| 2363 | <dt> |
| 2364 | showbranch.default |
| 2365 | </dt> |
| 2366 | <dd> |
| 2367 | <p> |
| 2368 | The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>. |
| 2369 | See <a href="git-show-branch.html">git-show-branch(1)</a>. |
| 2370 | </p> |
| 2371 | </dd> |
| 2372 | <dt> |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 2373 | status.relativePaths |
| 2374 | </dt> |
| 2375 | <dd> |
| 2376 | <p> |
| 2377 | By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the |
| 2378 | current directory. Setting this variable to <tt>false</tt> shows paths |
| 2379 | relative to the repository root (this was the default for git |
| 2380 | prior to v1.5.4). |
| 2381 | </p> |
| 2382 | </dd> |
| 2383 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2384 | tar.umask |
| 2385 | </dt> |
| 2386 | <dd> |
| 2387 | <p> |
| Junio C Hamano | bdebabb | 2007-08-23 00:25:09 | [diff] [blame] | 2388 | This variable can be used to restrict the permission bits of |
| 2389 | tar archive entries. The default is 0002, which turns off the |
| 2390 | world write bit. The special value "user" indicates that the |
| 2391 | archiving user's umask will be used instead. See umask(2) and |
| 2392 | <a href="git-archive.html">git-archive(1)</a>. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2393 | </p> |
| 2394 | </dd> |
| 2395 | <dt> |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 2396 | url.<base>.insteadOf |
| 2397 | </dt> |
| 2398 | <dd> |
| 2399 | <p> |
| 2400 | Any URL that starts with this value will be rewritten to |
| 2401 | start, instead, with <base>. In cases where some site serves a |
| 2402 | large number of repositories, and serves them with multiple |
| 2403 | access methods, and some users need to use different access |
| 2404 | methods, this feature allows people to specify any of the |
| 2405 | equivalent URLs and have git automatically rewrite the URL to |
| 2406 | the best alternative for the particular user, even for a |
| 2407 | never-before-seen repository on the site. When more than one |
| 2408 | insteadOf strings match a given URL, the longest match is used. |
| 2409 | </p> |
| 2410 | </dd> |
| 2411 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2412 | user.email |
| 2413 | </dt> |
| 2414 | <dd> |
| 2415 | <p> |
| 2416 | Your email address to be recorded in any newly created commits. |
| Junio C Hamano | 469d60e | 2007-04-29 18:30:34 | [diff] [blame] | 2417 | Can be overridden by the <em>GIT_AUTHOR_EMAIL</em>, <em>GIT_COMMITTER_EMAIL</em>, and |
| 2418 | <em>EMAIL</em> environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2419 | </p> |
| 2420 | </dd> |
| 2421 | <dt> |
| 2422 | user.name |
| 2423 | </dt> |
| 2424 | <dd> |
| 2425 | <p> |
| 2426 | Your full name to be recorded in any newly created commits. |
| 2427 | Can be overridden by the <em>GIT_AUTHOR_NAME</em> and <em>GIT_COMMITTER_NAME</em> |
| 2428 | environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>. |
| 2429 | </p> |
| 2430 | </dd> |
| 2431 | <dt> |
| 2432 | user.signingkey |
| 2433 | </dt> |
| 2434 | <dd> |
| 2435 | <p> |
| 2436 | If <a href="git-tag.html">git-tag(1)</a> is not selecting the key you want it to |
| 2437 | automatically when creating a signed tag, you can override the |
| 2438 | default selection with this variable. This option is passed |
| 2439 | unchanged to gpg's --local-user parameter, so you may specify a key |
| 2440 | using any method that gpg supports. |
| 2441 | </p> |
| 2442 | </dd> |
| 2443 | <dt> |
| 2444 | whatchanged.difftree |
| 2445 | </dt> |
| 2446 | <dd> |
| 2447 | <p> |
| 2448 | The default <a href="git-diff-tree.html">git-diff-tree(1)</a> arguments to be used |
| 2449 | for <a href="git-whatchanged.html">git-whatchanged(1)</a>. |
| 2450 | </p> |
| 2451 | </dd> |
| 2452 | <dt> |
| 2453 | imap |
| 2454 | </dt> |
| 2455 | <dd> |
| 2456 | <p> |
| 2457 | The configuration variables in the <em>imap</em> section are described |
| 2458 | in <a href="git-imap-send.html">git-imap-send(1)</a>. |
| 2459 | </p> |
| 2460 | </dd> |
| 2461 | <dt> |
| Junio C Hamano | b78d259 | 2008-04-09 09:39:08 | [diff] [blame] | 2462 | receive.fsckObjects |
| 2463 | </dt> |
| 2464 | <dd> |
| 2465 | <p> |
| 2466 | If it is set to true, git-receive-pack will check all received |
| 2467 | objects. It will abort in the case of a malformed object or a |
| 2468 | broken link. The result of an abort are only dangling objects. |
| 2469 | Defaults to false. |
| 2470 | </p> |
| 2471 | </dd> |
| 2472 | <dt> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2473 | receive.unpackLimit |
| 2474 | </dt> |
| 2475 | <dd> |
| 2476 | <p> |
| 2477 | If the number of objects received in a push is below this |
| 2478 | limit then the objects will be unpacked into loose object |
| 2479 | files. However if the number of received objects equals or |
| 2480 | exceeds this limit then the received pack will be stored as |
| 2481 | a pack, after adding any missing delta bases. Storing the |
| 2482 | pack from a push can make the push operation complete faster, |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 2483 | especially on slow filesystems. If not set, the value of |
| 2484 | <tt>transfer.unpackLimit</tt> is used instead. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2485 | </p> |
| 2486 | </dd> |
| 2487 | <dt> |
| 2488 | receive.denyNonFastForwards |
| 2489 | </dt> |
| 2490 | <dd> |
| 2491 | <p> |
| 2492 | If set to true, git-receive-pack will deny a ref update which is |
| 2493 | not a fast forward. Use this to prevent such an update via a push, |
| 2494 | even if that push is forced. This configuration variable is |
| 2495 | set when initializing a shared repository. |
| 2496 | </p> |
| 2497 | </dd> |
| 2498 | <dt> |
| 2499 | transfer.unpackLimit |
| 2500 | </dt> |
| 2501 | <dd> |
| 2502 | <p> |
| 2503 | When <tt>fetch.unpackLimit</tt> or <tt>receive.unpackLimit</tt> are |
| 2504 | not set, the value of this variable is used instead. |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 2505 | The default value is 100. |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2506 | </p> |
| 2507 | </dd> |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 2508 | <dt> |
| 2509 | web.browser |
| 2510 | </dt> |
| 2511 | <dd> |
| 2512 | <p> |
| 2513 | Specify a web browser that may be used by some commands. |
| 2514 | Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a> |
| 2515 | may use it. |
| 2516 | </p> |
| 2517 | </dd> |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2518 | </dl> |
| 2519 | </div> |
| 2520 | <h2>Author</h2> |
| 2521 | <div class="sectionbody"> |
| 2522 | <p>Written by Johannes Schindelin <Johannes.Schindelin@gmx.de></p> |
| 2523 | </div> |
| 2524 | <h2>Documentation</h2> |
| 2525 | <div class="sectionbody"> |
| 2526 | <p>Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.</p> |
| 2527 | </div> |
| 2528 | <h2>GIT</h2> |
| 2529 | <div class="sectionbody"> |
| 2530 | <p>Part of the <a href="git.html">git(7)</a> suite</p> |
| 2531 | </div> |
| 2532 | <div id="footer"> |
| 2533 | <div id="footer-text"> |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame^] | 2534 | Last updated 09-May-2008 05:45:36 UTC |
| Junio C Hamano | 7ad22dc | 2007-01-29 02:55:48 | [diff] [blame] | 2535 | </div> |
| 2536 | </div> |
| 2537 | </body> |
| 2538 | </html> |
