]>
Commit | Line | Data |
---|---|---|
1ab661dd PB |
1 | CONFIGURATION FILE |
2 | ------------------ | |
3 | ||
4 | The git configuration file contains a number of variables that affect | |
5ea5621f JH |
5 | the git command's behavior. `.git/config` file for each repository |
6 | is used to store the information for that repository, and | |
7 | `$HOME/.gitconfig` is used to store per user information to give | |
32043c9f JS |
8 | fallback values for `.git/config` file. The file `/etc/gitconfig` |
9 | can be used to store system-wide defaults. | |
5ea5621f JH |
10 | |
11 | They can be used by both the git plumbing | |
b8936cf0 | 12 | and the porcelains. The variables are divided into sections, where |
1ab661dd PB |
13 | in the fully qualified variable name the variable itself is the last |
14 | dot-separated segment and the section name is everything before the last | |
15 | dot. The variable names are case-insensitive and only alphanumeric | |
16 | characters are allowed. Some variables may appear multiple times. | |
17 | ||
e136f33b JN |
18 | Syntax |
19 | ~~~~~~ | |
20 | ||
1ab661dd | 21 | The syntax is fairly flexible and permissive; whitespaces are mostly |
e136f33b JN |
22 | ignored. The '#' and ';' characters begin comments to the end of line, |
23 | blank lines are ignored. | |
24 | ||
25 | The file consists of sections and variables. A section begins with | |
26 | the name of the section in square brackets and continues until the next | |
27 | section begins. Section names are not case sensitive. Only alphanumeric | |
28 | characters, '`-`' and '`.`' are allowed in section names. Each variable | |
29 | must belong to some section, which means that there must be section | |
30 | header before first setting of a variable. | |
31 | ||
32 | Sections can be further divided into subsections. To begin a subsection | |
33 | put its name in double quotes, separated by space from the section name, | |
34 | in the section header, like in example below: | |
35 | ||
36 | -------- | |
37 | [section "subsection"] | |
38 | ||
39 | -------- | |
40 | ||
191453f6 JN |
41 | Subsection names can contain any characters except newline (doublequote |
42 | '`"`' and backslash have to be escaped as '`\"`' and '`\\`', | |
3dff5379 | 43 | respectively) and are case sensitive. Section header cannot span multiple |
e136f33b JN |
44 | lines. Variables may belong directly to a section or to a given subsection. |
45 | You can have `[section]` if you have `[section "subsection"]`, but you | |
46 | don't need to. | |
47 | ||
48 | There is also (case insensitive) alternative `[section.subsection]` syntax. | |
49 | In this syntax subsection names follow the same restrictions as for section | |
50 | name. | |
51 | ||
52 | All the other lines are recognized as setting variables, in the form | |
53 | 'name = value'. If there is no equal sign on the line, the entire line | |
54 | is taken as 'name' and the variable is recognized as boolean "true". | |
55 | The variable names are case-insensitive and only alphanumeric | |
56 | characters and '`-`' are allowed. There can be more than one value | |
57 | for a given variable; we say then that variable is multivalued. | |
58 | ||
59 | Leading and trailing whitespace in a variable value is discarded. | |
60 | Internal whitespace within a variable value is retained verbatim. | |
61 | ||
62 | The values following the equals sign in variable assign are all either | |
63 | a string, an integer, or a boolean. Boolean values may be given as yes/no, | |
64 | 0/1 or true/false. Case is not significant in boolean values, when | |
65 | converting value to the canonical form using '--bool' type specifier; | |
e0d10e1c | 66 | `git-config` will ensure that the output is "true" or "false". |
e136f33b JN |
67 | |
68 | String values may be entirely or partially enclosed in double quotes. | |
69 | You need to enclose variable value in double quotes if you want to | |
70 | preserve leading or trailing whitespace, or if variable value contains | |
71 | beginning of comment characters (if it contains '#' or ';'). | |
72 | Double quote '`"`' and backslash '`\`' characters in variable value must | |
73 | be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'. | |
74 | ||
75 | The following escape sequences (beside '`\"`' and '`\\`') are recognized: | |
76 | '`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB) | |
77 | and '`\b`' for backspace (BS). No other char escape sequence, nor octal | |
78 | char sequences are valid. | |
79 | ||
80 | Variable value ending in a '`\`' is continued on the next line in the | |
81 | customary UNIX fashion. | |
82 | ||
83 | Some variables may require special value format. | |
1ab661dd PB |
84 | |
85 | Example | |
86 | ~~~~~~~ | |
87 | ||
88 | # Core variables | |
89 | [core] | |
90 | ; Don't trust file modes | |
91 | filemode = false | |
92 | ||
93 | # Our diff algorithm | |
94 | [diff] | |
95 | external = "/usr/local/bin/gnu-diff -u" | |
96 | renames = true | |
97 | ||
910c00c8 AK |
98 | [branch "devel"] |
99 | remote = origin | |
100 | merge = refs/heads/devel | |
101 | ||
e136f33b JN |
102 | # Proxy settings |
103 | [core] | |
29093c28 | 104 | gitProxy="ssh" for "kernel.org" |
e136f33b | 105 | gitProxy=default-proxy ; for the rest |
910c00c8 | 106 | |
1ab661dd PB |
107 | Variables |
108 | ~~~~~~~~~ | |
109 | ||
110 | Note that this list is non-comprehensive and not necessarily complete. | |
b8936cf0 FD |
111 | For command-specific variables, you will find a more detailed description |
112 | in the appropriate manual page. You will find a description of non-core | |
1ab661dd PB |
113 | porcelain configuration variables in the respective porcelain documentation. |
114 | ||
115 | core.fileMode:: | |
116 | If false, the executable bit differences between the index and | |
117 | the working copy are ignored; useful on broken filesystems like FAT. | |
5162e697 | 118 | See linkgit:git-update-index[1]. True by default. |
1ab661dd | 119 | |
9378c161 JH |
120 | core.quotepath:: |
121 | The commands that output paths (e.g. `ls-files`, | |
122 | `diff`), when not given the `-z` option, will quote | |
123 | "unusual" characters in the pathname by enclosing the | |
124 | pathname in a double-quote pair and with backslashes the | |
125 | same way strings in C source code are quoted. If this | |
126 | variable is set to false, the bytes higher than 0x80 are | |
127 | not quoted but output as verbatim. Note that double | |
128 | quote, backslash and control characters are always | |
129 | quoted without `-z` regardless of the setting of this | |
130 | variable. | |
131 | ||
5cb71f82 FL |
132 | core.autocrlf:: |
133 | If true, makes git convert `CRLF` at the end of lines in text files to | |
134 | `LF` when reading from the filesystem, and convert in reverse when | |
135 | writing to the filesystem. The variable can be set to | |
136 | 'input', in which case the conversion happens only while | |
137 | reading from the filesystem but files are written out with | |
138 | `LF` at the end of lines. Currently, which paths to consider | |
139 | "text" (i.e. be subjected to the autocrlf mechanism) is | |
140 | decided purely based on the contents. | |
141 | ||
21e5ad50 SP |
142 | core.safecrlf:: |
143 | If true, makes git check if converting `CRLF` as controlled by | |
144 | `core.autocrlf` is reversible. Git will verify if a command | |
145 | modifies a file in the work tree either directly or indirectly. | |
146 | For example, committing a file followed by checking out the | |
147 | same file should yield the original file in the work tree. If | |
148 | this is not the case for the current setting of | |
149 | `core.autocrlf`, git will reject the file. The variable can | |
150 | be set to "warn", in which case git will only warn about an | |
151 | irreversible conversion but continue the operation. | |
152 | + | |
153 | CRLF conversion bears a slight chance of corrupting data. | |
154 | autocrlf=true will convert CRLF to LF during commit and LF to | |
155 | CRLF during checkout. A file that contains a mixture of LF and | |
156 | CRLF before the commit cannot be recreated by git. For text | |
157 | files this is the right thing to do: it corrects line endings | |
158 | such that we have only LF line endings in the repository. | |
159 | But for binary files that are accidentally classified as text the | |
160 | conversion can corrupt data. | |
161 | + | |
162 | If you recognize such corruption early you can easily fix it by | |
163 | setting the conversion type explicitly in .gitattributes. Right | |
164 | after committing you still have the original file in your work | |
165 | tree and this file is not yet corrupted. You can explicitly tell | |
166 | git that this file is binary and git will handle the file | |
167 | appropriately. | |
168 | + | |
169 | Unfortunately, the desired effect of cleaning up text files with | |
170 | mixed line endings and the undesired effect of corrupting binary | |
171 | files cannot be distinguished. In both cases CRLFs are removed | |
172 | in an irreversible way. For text files this is the right thing | |
173 | to do because CRLFs are line endings, while for binary files | |
174 | converting CRLFs corrupts data. | |
175 | + | |
176 | Note, this safety check does not mean that a checkout will generate a | |
177 | file identical to the original file for a different setting of | |
178 | `core.autocrlf`, but only for the current one. For example, a text | |
179 | file with `LF` would be accepted with `core.autocrlf=input` and could | |
180 | later be checked out with `core.autocrlf=true`, in which case the | |
181 | resulting file would contain `CRLF`, although the original file | |
182 | contained `LF`. However, in both work trees the line endings would be | |
183 | consistent, that is either all `LF` or all `CRLF`, but never mixed. A | |
184 | file with mixed line endings would be reported by the `core.safecrlf` | |
185 | mechanism. | |
186 | ||
78a8d641 JS |
187 | core.symlinks:: |
188 | If false, symbolic links are checked out as small plain files that | |
5162e697 DM |
189 | contain the link text. linkgit:git-update-index[1] and |
190 | linkgit:git-add[1] will not change the recorded type to regular | |
78a8d641 JS |
191 | file. Useful on filesystems like FAT that do not support |
192 | symbolic links. True by default. | |
193 | ||
1ab661dd PB |
194 | core.gitProxy:: |
195 | A "proxy command" to execute (as 'command host port') instead | |
196 | of establishing direct connection to the remote server when | |
197 | using the git protocol for fetching. If the variable value is | |
198 | in the "COMMAND for DOMAIN" format, the command is applied only | |
199 | on hostnames ending with the specified domain string. This variable | |
200 | may be set multiple times and is matched in the given order; | |
201 | the first match wins. | |
b8936cf0 FD |
202 | + |
203 | Can be overridden by the 'GIT_PROXY_COMMAND' environment variable | |
204 | (which always applies universally, without the special "for" | |
205 | handling). | |
1ab661dd PB |
206 | |
207 | core.ignoreStat:: | |
208 | The working copy files are assumed to stay unchanged until you | |
209 | mark them otherwise manually - Git will not detect the file changes | |
210 | by lstat() calls. This is useful on systems where those are very | |
5162e697 | 211 | slow, such as Microsoft Windows. See linkgit:git-update-index[1]. |
1ab661dd PB |
212 | False by default. |
213 | ||
9f0bb90d JH |
214 | core.preferSymlinkRefs:: |
215 | Instead of the default "symref" format for HEAD | |
216 | and other symbolic reference files, use symbolic links. | |
217 | This is sometimes needed to work with old scripts that | |
218 | expect HEAD to be a symbolic link. | |
1ab661dd | 219 | |
e4a15f40 SP |
220 | core.bare:: |
221 | If true this repository is assumed to be 'bare' and has no | |
222 | working directory associated with it. If this is the case a | |
223 | number of commands that require a working directory will be | |
5162e697 | 224 | disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. |
e4a15f40 | 225 | + |
5162e697 DM |
226 | This setting is automatically guessed by linkgit:git-clone[1] or |
227 | linkgit:git-init[1] when the repository was created. By default a | |
e4a15f40 SP |
228 | repository that ends in "/.git" is assumed to be not bare (bare = |
229 | false), while all other repositories are assumed to be bare (bare | |
230 | = true). | |
231 | ||
892c41b9 ML |
232 | core.worktree:: |
233 | Set the path to the working tree. The value will not be | |
234 | used in combination with repositories found automatically in | |
235 | a .git directory (i.e. $GIT_DIR is not set). | |
06ada152 | 236 | This can be overridden by the GIT_WORK_TREE environment |
302cc11a LY |
237 | variable and the '--work-tree' command line option. It can be |
238 | a absolute path or relative path to the directory specified by | |
239 | --git-dir or GIT_DIR. | |
240 | Note: If --git-dir or GIT_DIR are specified but none of | |
241 | --work-tree, GIT_WORK_TREE and core.worktree is specified, | |
242 | the current working directory is regarded as the top directory | |
243 | of your working tree. | |
892c41b9 | 244 | |
6de08ae6 | 245 | core.logAllRefUpdates:: |
14cd5607 | 246 | Enable the reflog. Updates to a ref <ref> is logged to the file |
4057deb5 JH |
247 | "$GIT_DIR/logs/<ref>", by appending the new and old |
248 | SHA1, the date/time and the reason of the update, but | |
249 | only when the file exists. If this configuration | |
250 | variable is set to true, missing "$GIT_DIR/logs/<ref>" | |
251 | file is automatically created for branch heads. | |
a862f97e JH |
252 | + |
253 | This information can be used to determine what commit | |
254 | was the tip of a branch "2 days ago". | |
255 | + | |
256 | This value is true by default in a repository that has | |
257 | a working directory associated with it, and false by | |
258 | default in a bare repository. | |
6de08ae6 | 259 | |
1ab661dd PB |
260 | core.repositoryFormatVersion:: |
261 | Internal variable identifying the repository format and layout | |
262 | version. | |
263 | ||
264 | core.sharedRepository:: | |
d5dc6a76 JF |
265 | When 'group' (or 'true'), the repository is made shareable between |
266 | several users in a group (making sure all the files and objects are | |
267 | group-writable). When 'all' (or 'world' or 'everybody'), the | |
268 | repository will be readable by all users, additionally to being | |
269 | group-shareable. When 'umask' (or 'false'), git will use permissions | |
06cbe855 HO |
270 | reported by umask(2). When '0xxx', where '0xxx' is an octal number, |
271 | files in the repository will have this mode value. '0xxx' will override | |
272 | user's umask value, and thus, users with a safe umask (0077) can use | |
273 | this option. Examples: '0660' is equivalent to 'group'. '0640' is a | |
274 | repository that is group-readable but not group-writable. | |
275 | See linkgit:git-init[1]. False by default. | |
1ab661dd PB |
276 | |
277 | core.warnAmbiguousRefs:: | |
278 | If true, git will warn you if the ref name you passed it is ambiguous | |
279 | and might match multiple refs in the .git/refs/ tree. True by default. | |
280 | ||
3d3e95af | 281 | core.compression:: |
960ccca6 DH |
282 | An integer -1..9, indicating a default compression level. |
283 | -1 is the zlib default. 0 means no compression, | |
284 | and 1..9 are various speed/size tradeoffs, 9 being slowest. | |
dec92309 BD |
285 | If set, this provides a default to other compression variables, |
286 | such as 'core.loosecompression' and 'pack.compression'. | |
960ccca6 DH |
287 | |
288 | core.loosecompression:: | |
12f6c308 | 289 | An integer -1..9, indicating the compression level for objects that |
960ccca6 | 290 | are not in a pack file. -1 is the zlib default. 0 means no |
12f6c308 | 291 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
960ccca6 | 292 | slowest. If not set, defaults to core.compression. If that is |
de1b2460 | 293 | not set, defaults to 1 (best speed). |
12f6c308 | 294 | |
60bb8b14 SP |
295 | core.packedGitWindowSize:: |
296 | Number of bytes of a pack file to map into memory in a | |
297 | single mapping operation. Larger window sizes may allow | |
298 | your system to process a smaller number of large pack files | |
299 | more quickly. Smaller window sizes will negatively affect | |
eb92242f | 300 | performance due to increased calls to the operating system's |
60bb8b14 | 301 | memory manager, but may improve performance when accessing |
22bac0ea SP |
302 | a large number of large pack files. |
303 | + | |
304 | Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 | |
305 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should | |
306 | be reasonable for all users/operating systems. You probably do | |
307 | not need to adjust this value. | |
eb92242f SP |
308 | + |
309 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
60bb8b14 | 310 | |
77ccc5bb SP |
311 | core.packedGitLimit:: |
312 | Maximum number of bytes to map simultaneously into memory | |
313 | from pack files. If Git needs to access more than this many | |
314 | bytes at once to complete an operation it will unmap existing | |
315 | regions to reclaim virtual address space within the process. | |
22bac0ea SP |
316 | + |
317 | Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. | |
318 | This should be reasonable for all users/operating systems, except on | |
319 | the largest projects. You probably do not need to adjust this value. | |
eb92242f SP |
320 | + |
321 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
77ccc5bb | 322 | |
18bdec11 SP |
323 | core.deltaBaseCacheLimit:: |
324 | Maximum number of bytes to reserve for caching base objects | |
325 | that multiple deltafied objects reference. By storing the | |
326 | entire decompressed base objects in a cache Git is able | |
327 | to avoid unpacking and decompressing frequently used base | |
328 | objects multiple times. | |
329 | + | |
330 | Default is 16 MiB on all platforms. This should be reasonable | |
331 | for all users/operating systems, except on the largest projects. | |
332 | You probably do not need to adjust this value. | |
333 | + | |
334 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
335 | ||
e8964a5b | 336 | core.excludesfile:: |
0ba956d3 JS |
337 | In addition to '.gitignore' (per-directory) and |
338 | '.git/info/exclude', git looks into this file for patterns | |
cedb8d5d | 339 | of files which are not meant to be tracked. See |
5162e697 | 340 | linkgit:gitignore[5]. |
0ba956d3 | 341 | |
ef0c2abf AR |
342 | core.editor:: |
343 | Commands such as `commit` and `tag` that lets you edit | |
02783075 | 344 | messages by launching an editor uses the value of this |
ef0c2abf AR |
345 | variable when it is set, and the environment variable |
346 | `GIT_EDITOR` is not set. The order of preference is | |
a644ffde JH |
347 | `GIT_EDITOR` environment, `core.editor`, `VISUAL` and |
348 | `EDITOR` environment variables and then finally `vi`. | |
ef0c2abf | 349 | |
54adf370 BG |
350 | core.pager:: |
351 | The command that git will use to paginate output. Can be overridden | |
352 | with the `GIT_PAGER` environment variable. | |
353 | ||
91af7ae5 JH |
354 | core.whitespace:: |
355 | A comma separated list of common whitespace problems to | |
356 | notice. `git diff` will use `color.diff.whitespace` to | |
357 | highlight them, and `git apply --whitespace=error` will | |
358 | consider them as errors: | |
359 | + | |
360 | * `trailing-space` treats trailing whitespaces at the end of the line | |
361 | as an error (enabled by default). | |
362 | * `space-before-tab` treats a space character that appears immediately | |
363 | before a tab character in the initial indent part of the line as an | |
364 | error (enabled by default). | |
365 | * `indent-with-non-tab` treats a line that is indented with 8 or more | |
127f72e6 | 366 | space characters as an error (not enabled by default). |
b2979ff5 JH |
367 | * `cr-at-eol` treats a carriage-return at the end of line as |
368 | part of the line terminator, i.e. with it, `trailing-space` | |
369 | does not trigger if the character before such a carriage-return | |
370 | is not a whitespace (not enabled by default). | |
91af7ae5 | 371 | |
4514ad4f | 372 | alias.*:: |
5162e697 | 373 | Command aliases for the linkgit:git[1] command wrapper - e.g. |
4514ad4f PB |
374 | after defining "alias.last = cat-file commit HEAD", the invocation |
375 | "git last" is equivalent to "git cat-file commit HEAD". To avoid | |
99b41c84 PB |
376 | confusion and troubles with script usage, aliases that |
377 | hide existing git commands are ignored. Arguments are split by | |
378 | spaces, the usual shell quoting and escaping is supported. | |
379 | quote pair and a backslash can be used to quote them. | |
f368f5a6 JH |
380 | + |
381 | If the alias expansion is prefixed with an exclamation point, | |
382 | it will be treated as a shell command. For example, defining | |
383 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation | |
384 | "git new" is equivalent to running the shell command | |
385 | "gitk --all --not ORIG_HEAD". | |
dfd42a3c | 386 | |
1ab661dd PB |
387 | apply.whitespace:: |
388 | Tells `git-apply` how to handle whitespaces, in the same way | |
5162e697 | 389 | as the '--whitespace' option. See linkgit:git-apply[1]. |
1ab661dd | 390 | |
9902387d | 391 | branch.autosetupmerge:: |
5fdcf75c | 392 | Tells `git-branch` and `git-checkout` to setup new branches |
572fc81d JS |
393 | so that linkgit:git-pull[1] will appropriately merge from the |
394 | starting point branch. Note that even if this option is not set, | |
9902387d | 395 | this behavior can be chosen per-branch using the `--track` |
572fc81d JS |
396 | and `--no-track` options. The valid settings are: `false` -- no |
397 | automatic setup is done; `true` -- automatic setup is done when the | |
398 | starting point is a remote branch; `always` -- automatic setup is | |
399 | done when the starting point is either a local branch or remote | |
400 | branch. This option defaults to true. | |
9902387d | 401 | |
c998ae9b DS |
402 | branch.autosetuprebase:: |
403 | When a new branch is created with `git-branch` or `git-checkout` | |
404 | that tracks another branch, this variable tells git to set | |
405 | up pull to rebase instead of merge (see "branch.<name>.rebase"). | |
406 | When `never`, rebase is never automatically set to true. | |
407 | When `local`, rebase is set to true for tracked branches of | |
408 | other local branches. | |
409 | When `remote`, rebase is set to true for tracked branches of | |
410 | remote branches. | |
411 | When `always`, rebase will be set to true for all tracking | |
412 | branches. | |
413 | See "branch.autosetupmerge" for details on how to set up a | |
414 | branch to track another branch. | |
415 | This option defaults to never. | |
416 | ||
648ad18f SB |
417 | branch.<name>.remote:: |
418 | When in branch <name>, it tells `git fetch` which remote to fetch. | |
62b339a5 | 419 | If this option is not given, `git fetch` defaults to remote "origin". |
648ad18f | 420 | |
5372806a | 421 | branch.<name>.merge:: |
b888d61c DB |
422 | When in branch <name>, it tells `git fetch` the default |
423 | refspec to be marked for merging in FETCH_HEAD. The value is | |
424 | handled like the remote part of a refspec, and must match a | |
425 | ref which is fetched from the remote given by | |
426 | "branch.<name>.remote". | |
62b339a5 JW |
427 | The merge information is used by `git pull` (which at first calls |
428 | `git fetch`) to lookup the default branch for merging. Without | |
429 | this option, `git pull` defaults to merge the first refspec fetched. | |
430 | Specify multiple values to get an octopus merge. | |
9debc324 PB |
431 | If you wish to setup `git pull` so that it merges into <name> from |
432 | another branch in the local repository, you can point | |
433 | branch.<name>.merge to the desired branch, and use the special setting | |
434 | `.` (a period) for branch.<name>.remote. | |
5372806a | 435 | |
aec7b362 LH |
436 | branch.<name>.mergeoptions:: |
437 | Sets default options for merging into branch <name>. The syntax and | |
5162e697 | 438 | supported options are equal to that of linkgit:git-merge[1], but |
aec7b362 LH |
439 | option values containing whitespace characters are currently not |
440 | supported. | |
441 | ||
cd67e4d4 JS |
442 | branch.<name>.rebase:: |
443 | When true, rebase the branch <name> on top of the fetched branch, | |
15ddb6fa DS |
444 | instead of merging the default branch from the default remote when |
445 | "git pull" is run. | |
cd67e4d4 | 446 | *NOTE*: this is a possibly dangerous operation; do *not* use |
5162e697 | 447 | it unless you understand the implications (see linkgit:git-rebase[1] |
cd67e4d4 JS |
448 | for details). |
449 | ||
1658c614 CC |
450 | browser.<tool>.cmd:: |
451 | Specify the command to invoke the specified browser. The | |
452 | specified command is evaluated in shell with the URLs passed | |
453 | as arguments. (See linkgit:git-web--browse[1].) | |
454 | ||
584627b4 CC |
455 | browser.<tool>.path:: |
456 | Override the path for the given tool that may be used to | |
ab989adf CC |
457 | browse HTML help (see '-w' option in linkgit:git-help[1]) or a |
458 | working repository in gitweb (see linkgit:git-instaweb[1]). | |
584627b4 | 459 | |
2122591b | 460 | clean.requireForce:: |
562ca192 JH |
461 | A boolean to make git-clean do nothing unless given -f |
462 | or -n. Defaults to true. | |
2122591b | 463 | |
f3673988 BG |
464 | color.branch:: |
465 | A boolean to enable/disable color in the output of | |
5162e697 | 466 | linkgit:git-branch[1]. May be set to `always`, |
cec99d8c | 467 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
f3673988 BG |
468 | only when the output is to a terminal. Defaults to false. |
469 | ||
470 | color.branch.<slot>:: | |
471 | Use customized color for branch coloration. `<slot>` is one of | |
472 | `current` (the current branch), `local` (a local branch), | |
473 | `remote` (a tracking branch in refs/remotes/), `plain` (other | |
4f193f20 MW |
474 | refs). |
475 | + | |
476 | The value for these configuration variables is a list of colors (at most | |
477 | two) and attributes (at most one), separated by spaces. The colors | |
478 | accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, | |
479 | `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, | |
480 | `blink` and `reverse`. The first color given is the foreground; the | |
481 | second is the background. The position of the attribute, if any, | |
482 | doesn't matter. | |
f3673988 | 483 | |
a159ca0c | 484 | color.diff:: |
cec99d8c JH |
485 | When set to `always`, always use colors in patch. |
486 | When false (or `never`), never. When set to `true` or `auto`, use | |
487 | colors only when the output is to the terminal. Defaults to false. | |
b5376648 | 488 | |
a159ca0c | 489 | color.diff.<slot>:: |
4f193f20 MW |
490 | Use customized color for diff colorization. `<slot>` specifies |
491 | which part of the patch to use the specified color, and is one | |
492 | of `plain` (context text), `meta` (metainformation), `frag` | |
493 | (hunk header), `old` (removed lines), `new` (added lines), | |
91af7ae5 JH |
494 | `commit` (commit headers), or `whitespace` (highlighting |
495 | whitespace errors). The values of these variables may be specified as | |
4f193f20 | 496 | in color.branch.<slot>. |
b5376648 | 497 | |
b4c61ed6 | 498 | color.interactive:: |
47ee06f1 JK |
499 | When set to `always`, always use colors for interactive prompts |
500 | and displays (such as those used by "git add --interactive"). | |
b4c61ed6 JH |
501 | When false (or `never`), never. When set to `true` or `auto`, use |
502 | colors only when the output is to the terminal. Defaults to false. | |
503 | ||
504 | color.interactive.<slot>:: | |
505 | Use customized color for `git add --interactive` | |
506 | output. `<slot>` may be `prompt`, `header`, or `help`, for | |
507 | three distinct types of normal output from interactive | |
508 | programs. The values of these variables may be specified as | |
509 | in color.branch.<slot>. | |
510 | ||
1d77043b JH |
511 | color.pager:: |
512 | A boolean to enable/disable colored output when the pager is in | |
513 | use (default is true). | |
514 | ||
515 | color.status:: | |
516 | A boolean to enable/disable color in the output of | |
5162e697 | 517 | linkgit:git-status[1]. May be set to `always`, |
cec99d8c | 518 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
1d77043b JH |
519 | only when the output is to a terminal. Defaults to false. |
520 | ||
521 | color.status.<slot>:: | |
522 | Use customized color for status colorization. `<slot>` is | |
523 | one of `header` (the header text of the status message), | |
82dca848 SP |
524 | `added` or `updated` (files which are added but not committed), |
525 | `changed` (files which are changed but not added in the index), | |
1d77043b | 526 | or `untracked` (files which are not tracked by git). The values of |
f3673988 | 527 | these variables may be specified as in color.branch.<slot>. |
1d77043b | 528 | |
383e45ce BG |
529 | commit.template:: |
530 | Specify a file to use as the template for new commit messages. | |
531 | ||
6b2f2d98 MK |
532 | color.ui:: |
533 | When set to `always`, always use colors in all git commands which | |
534 | are capable of colored output. When false (or `never`), never. When | |
535 | set to `true` or `auto`, use colors only when the output is to the | |
536 | terminal. When more specific variables of color.* are set, they always | |
537 | take precedence over this setting. Defaults to false. | |
538 | ||
aecbf914 JH |
539 | diff.autorefreshindex:: |
540 | When using `git diff` to compare with work tree | |
541 | files, do not consider stat-only change as changed. | |
542 | Instead, silently run `git update-index --refresh` to | |
543 | update the cached stat information for paths whose | |
544 | contents in the work tree match the contents in the | |
545 | index. This option defaults to true. Note that this | |
546 | affects only `git diff` Porcelain, and not lower level | |
547 | `diff` commands, such as `git diff-files`. | |
548 | ||
77680caa JS |
549 | diff.external:: |
550 | If this config variable is set, diff generation is not | |
551 | performed using the internal diff machinery, but using the | |
552 | given command. Note: if you want to use an external diff | |
553 | program only on a subset of your files, you might want to | |
5162e697 | 554 | use linkgit:gitattributes[5] instead. |
77680caa | 555 | |
1ab661dd PB |
556 | diff.renameLimit:: |
557 | The number of files to consider when performing the copy/rename | |
558 | detection; equivalent to the git diff option '-l'. | |
559 | ||
b68ea12e EW |
560 | diff.renames:: |
561 | Tells git to detect renames. If set to any boolean value, it | |
562 | will enable basic rename detection. If set to "copies" or | |
563 | "copy", it will detect copies, as well. | |
564 | ||
af7cf268 JH |
565 | fetch.unpackLimit:: |
566 | If the number of objects fetched over the git native | |
567 | transfer is below this | |
568 | limit, then the objects will be unpacked into loose object | |
569 | files. However if the number of received objects equals or | |
570 | exceeds this limit then the received pack will be stored as | |
571 | a pack, after adding any missing delta bases. Storing the | |
572 | pack from a push can make the push operation complete faster, | |
80cd9cf9 MB |
573 | especially on slow filesystems. If not set, the value of |
574 | `transfer.unpackLimit` is used instead. | |
af7cf268 | 575 | |
49604a4d BG |
576 | format.numbered:: |
577 | A boolean which can enable sequence numbers in patch subjects. | |
02ff6250 | 578 | Setting this option to "auto" will enable it only if there is |
49604a4d | 579 | more than one patch. See --numbered option in |
5162e697 | 580 | linkgit:git-format-patch[1]. |
49604a4d | 581 | |
1ab661dd PB |
582 | format.headers:: |
583 | Additional email headers to include in a patch to be submitted | |
5162e697 | 584 | by mail. See linkgit:git-format-patch[1]. |
1ab661dd | 585 | |
78cb59c8 JS |
586 | format.suffix:: |
587 | The default for format-patch is to output files with the suffix | |
588 | `.patch`. Use this variable to change that suffix (make sure to | |
589 | include the dot if you want it). | |
1ab661dd | 590 | |
94c22a5e CR |
591 | format.pretty:: |
592 | The default pretty format for log/show/whatchanged command, | |
593 | See linkgit:git-log[1], linkgit:git-show[1], | |
594 | linkgit:git-whatchanged[1]. | |
595 | ||
0d7566a5 TT |
596 | gc.aggressiveWindow:: |
597 | The window size parameter used in the delta compression | |
598 | algorithm used by 'git gc --aggressive'. This defaults | |
599 | to 10. | |
600 | ||
e9831e83 JH |
601 | gc.auto:: |
602 | When there are approximately more than this many loose | |
603 | objects in the repository, `git gc --auto` will pack them. | |
604 | Some Porcelain commands use this command to perform a | |
80cd9cf9 MB |
605 | light-weight garbage collection from time to time. The |
606 | default value is 6700. Setting this to 0 disables it. | |
e9831e83 | 607 | |
17815501 JH |
608 | gc.autopacklimit:: |
609 | When there are more than this many packs that are not | |
610 | marked with `*.keep` file in the repository, `git gc | |
80cd9cf9 | 611 | --auto` consolidates them into one larger pack. The |
97063974 | 612 | default value is 50. Setting this to 0 disables it. |
17815501 | 613 | |
c2120e5e JS |
614 | gc.packrefs:: |
615 | `git gc` does not run `git pack-refs` in a bare repository by | |
616 | default so that older dumb-transport clients can still fetch | |
617 | from the repository. Setting this to `true` lets `git | |
618 | gc` to run `git pack-refs`. Setting this to `false` tells | |
619 | `git gc` never to run `git pack-refs`. The default setting is | |
620 | `notbare`. Enable it only when you know you do not have to | |
621 | support such clients. The default setting will change to `true` | |
622 | at some stage, and setting this to `false` will continue to | |
623 | prevent `git pack-refs` from being run from `git gc`. | |
624 | ||
25ee9731 JS |
625 | gc.pruneexpire:: |
626 | When `git gc` is run, it will call `prune --expire 2.weeks.ago`. | |
627 | Override the grace period with this config variable. | |
628 | ||
4aec56d1 JH |
629 | gc.reflogexpire:: |
630 | `git reflog expire` removes reflog entries older than | |
631 | this time; defaults to 90 days. | |
632 | ||
633 | gc.reflogexpireunreachable:: | |
634 | `git reflog expire` removes reflog entries older than | |
635 | this time and are not reachable from the current tip; | |
636 | defaults to 30 days. | |
637 | ||
48c32424 JH |
638 | gc.rerereresolved:: |
639 | Records of conflicted merge you resolved earlier are | |
640 | kept for this many days when `git rerere gc` is run. | |
5162e697 | 641 | The default is 60 days. See linkgit:git-rerere[1]. |
48c32424 JH |
642 | |
643 | gc.rerereunresolved:: | |
644 | Records of conflicted merge you have not resolved are | |
645 | kept for this many days when `git rerere gc` is run. | |
5162e697 | 646 | The default is 15 days. See linkgit:git-rerere[1]. |
48c32424 | 647 | |
b4372ef1 JS |
648 | rerere.enabled:: |
649 | Activate recording of resolved conflicts, so that identical | |
650 | conflict hunks can be resolved automatically, should they | |
5162e697 | 651 | be encountered again. linkgit:git-rerere[1] command is by |
11c57e6a JH |
652 | default enabled if you create `rr-cache` directory under |
653 | `$GIT_DIR`, but can be disabled by setting this option to false. | |
b4372ef1 | 654 | |
1ab661dd | 655 | gitcvs.enabled:: |
db218723 | 656 | Whether the CVS server interface is enabled for this repository. |
5162e697 | 657 | See linkgit:git-cvsserver[1]. |
1ab661dd PB |
658 | |
659 | gitcvs.logfile:: | |
db218723 | 660 | Path to a log file where the CVS server interface well... logs |
5162e697 | 661 | various stuff. See linkgit:git-cvsserver[1]. |
1ab661dd | 662 | |
8a06a632 MO |
663 | gitcvs.usecrlfattr |
664 | If true, the server will look up the `crlf` attribute for | |
665 | files to determine the '-k' modes to use. If `crlf` is set, | |
666 | the '-k' mode will be left blank, so cvs clients will | |
667 | treat it as text. If `crlf` is explicitly unset, the file | |
668 | will be set with '-kb' mode, which supresses any newline munging | |
669 | the client might otherwise do. If `crlf` is not specified, | |
670 | then 'gitcvs.allbinary' is used. See linkgit:gitattribute[5]. | |
671 | ||
eabb0bfd | 672 | gitcvs.allbinary:: |
90948a42 MO |
673 | This is used if 'gitcvs.usecrlfattr' does not resolve |
674 | the correct '-kb' mode to use. If true, all | |
675 | unresolved files are sent to the client in | |
676 | mode '-kb'. This causes the client to treat them | |
677 | as binary files, which suppresses any newline munging it | |
678 | otherwise might do. Alternatively, if it is set to "guess", | |
679 | then the contents of the file are examined to decide if | |
680 | it is binary, similar to 'core.autocrlf'. | |
abbf5947 | 681 | |
04752868 FL |
682 | gitcvs.dbname:: |
683 | Database used by git-cvsserver to cache revision information | |
684 | derived from the git repository. The exact meaning depends on the | |
685 | used database driver, for SQLite (which is the default driver) this | |
686 | is a filename. Supports variable substitution (see | |
5162e697 | 687 | linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). |
04752868 FL |
688 | Default: '%Ggitcvs.%m.sqlite' |
689 | ||
690 | gitcvs.dbdriver:: | |
691 | Used Perl DBI driver. You can specify any available driver | |
692 | for this here, but it might not work. git-cvsserver is tested | |
693 | with 'DBD::SQLite', reported to work with 'DBD::Pg', and | |
694 | reported *not* to work with 'DBD::mysql'. Experimental feature. | |
695 | May not contain double colons (`:`). Default: 'SQLite'. | |
5162e697 | 696 | See linkgit:git-cvsserver[1]. |
eabb0bfd | 697 | |
04752868 FL |
698 | gitcvs.dbuser, gitcvs.dbpass:: |
699 | Database user and password. Only useful if setting 'gitcvs.dbdriver', | |
700 | since SQLite has no concept of database users and/or passwords. | |
701 | 'gitcvs.dbuser' supports variable substitution (see | |
5162e697 | 702 | linkgit:git-cvsserver[1] for details). |
04752868 | 703 | |
6aeeffd1 JE |
704 | gitcvs.dbTableNamePrefix:: |
705 | Database table name prefix. Prepended to the names of any | |
706 | database tables used, allowing a single database to be used | |
707 | for several repositories. Supports variable substitution (see | |
708 | linkgit:git-cvsserver[1] for details). Any non-alphabetic | |
709 | characters will be replaced with underscores. | |
710 | ||
8a06a632 MO |
711 | All gitcvs variables except for 'gitcvs.usecrlfattr' and |
712 | 'gitcvs.allbinary' can also be specified as | |
713 | 'gitcvs.<access_method>.<varname>' (where 'access_method' | |
02783075 BH |
714 | is one of "ext" and "pserver") to make them apply only for the given |
715 | access method. | |
04752868 | 716 | |
d84ae0db GH |
717 | gui.commitmsgwidth:: |
718 | Defines how wide the commit message window is in the | |
719 | linkgit:git-gui[1]. "75" is the default. | |
720 | ||
721 | gui.diffcontext:: | |
722 | Specifies how many context lines should be used in calls to diff | |
723 | made by the linkgit:git-gui[1]. The default is "5". | |
724 | ||
725 | gui.matchtrackingbranch:: | |
726 | Determines if new branches created with linkgit:git-gui[1] should | |
727 | default to tracking remote branches with matching names or | |
728 | not. Default: "false". | |
729 | ||
730 | gui.newbranchtemplate:: | |
731 | Is used as suggested name when creating new branches using the | |
732 | linkgit:git-gui[1]. | |
733 | ||
734 | gui.pruneduringfetch:: | |
735 | "true" if linkgit:git-gui[1] should prune tracking branches when | |
736 | performing a fetch. The default value is "false". | |
737 | ||
738 | gui.trustmtime:: | |
739 | Determines if linkgit:git-gui[1] should trust the file modification | |
740 | timestamp or not. By default the timestamps are not trusted. | |
741 | ||
742 | gui.spellingdictionary:: | |
743 | Specifies the dictionary used for spell checking commit messages in | |
744 | the linkgit:git-gui[1]. When set to "none" spell checking is turned | |
745 | off. | |
746 | ||
983a9eeb CC |
747 | help.browser:: |
748 | Specify the browser that will be used to display help in the | |
749 | 'web' format. See linkgit:git-help[1]. | |
750 | ||
751 | help.format:: | |
752 | Override the default help format used by linkgit:git-help[1]. | |
753 | Values 'man', 'info', 'web' and 'html' are supported. 'man' is | |
754 | the default. 'web' and 'html' are the same. | |
755 | ||
9c5665aa SV |
756 | http.proxy:: |
757 | Override the HTTP proxy, normally configured using the 'http_proxy' | |
5162e697 | 758 | environment variable (see linkgit:curl[1]). This can be overridden |
14c98218 | 759 | on a per-remote basis; see remote.<name>.proxy |
9c5665aa | 760 | |
1ab661dd PB |
761 | http.sslVerify:: |
762 | Whether to verify the SSL certificate when fetching or pushing | |
37425065 | 763 | over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment |
1ab661dd PB |
764 | variable. |
765 | ||
766 | http.sslCert:: | |
767 | File containing the SSL certificate when fetching or pushing | |
37425065 | 768 | over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment |
1ab661dd PB |
769 | variable. |
770 | ||
771 | http.sslKey:: | |
772 | File containing the SSL private key when fetching or pushing | |
abda1ef5 | 773 | over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment |
1ab661dd PB |
774 | variable. |
775 | ||
776 | http.sslCAInfo:: | |
777 | File containing the certificates to verify the peer with when | |
abda1ef5 | 778 | fetching or pushing over HTTPS. Can be overridden by the |
1ab661dd PB |
779 | 'GIT_SSL_CAINFO' environment variable. |
780 | ||
781 | http.sslCAPath:: | |
782 | Path containing files with the CA certificates to verify the peer | |
37425065 | 783 | with when fetching or pushing over HTTPS. Can be overridden |
1ab661dd PB |
784 | by the 'GIT_SSL_CAPATH' environment variable. |
785 | ||
786 | http.maxRequests:: | |
abda1ef5 | 787 | How many HTTP requests to launch in parallel. Can be overridden |
1ab661dd PB |
788 | by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. |
789 | ||
790 | http.lowSpeedLimit, http.lowSpeedTime:: | |
791 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' | |
792 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. | |
abda1ef5 | 793 | Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and |
1ab661dd PB |
794 | 'GIT_HTTP_LOW_SPEED_TIME' environment variables. |
795 | ||
3ea099d4 SK |
796 | http.noEPSV:: |
797 | A boolean which disables using of EPSV ftp command by curl. | |
befc9c42 | 798 | This can helpful with some "poor" ftp servers which don't |
3ea099d4 SK |
799 | support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' |
800 | environment variable. Default is false (curl will use EPSV). | |
801 | ||
1ab661dd PB |
802 | i18n.commitEncoding:: |
803 | Character encoding the commit messages are stored in; git itself | |
804 | does not care per se, but this information is necessary e.g. when | |
805 | importing commits from emails or in the gitk graphical history | |
806 | browser (and possibly at other places in the future or in other | |
5162e697 | 807 | porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. |
1ab661dd | 808 | |
d2c11a38 JH |
809 | i18n.logOutputEncoding:: |
810 | Character encoding the commit messages are converted to when | |
811 | running `git-log` and friends. | |
812 | ||
983a9eeb CC |
813 | instaweb.browser:: |
814 | Specify the program that will be used to browse your working | |
815 | repository in gitweb. See linkgit:git-instaweb[1]. | |
816 | ||
817 | instaweb.httpd:: | |
818 | The HTTP daemon command-line to start gitweb on your working | |
819 | repository. See linkgit:git-instaweb[1]. | |
820 | ||
821 | instaweb.local:: | |
822 | If true the web server started by linkgit:git-instaweb[1] will | |
823 | be bound to the local IP (127.0.0.1). | |
824 | ||
825 | instaweb.modulepath:: | |
826 | The module path for an apache httpd used by linkgit:git-instaweb[1]. | |
827 | ||
828 | instaweb.port:: | |
829 | The port number to bind the gitweb httpd to. See | |
830 | linkgit:git-instaweb[1]. | |
831 | ||
0f03ca94 PB |
832 | log.showroot:: |
833 | If true, the initial commit will be shown as a big creation event. | |
834 | This is equivalent to a diff against an empty tree. | |
5162e697 | 835 | Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which |
0f03ca94 PB |
836 | normally hide the root commit will now show it. True by default. |
837 | ||
b5578f33 | 838 | man.viewer:: |
b8322ea8 | 839 | Specify the programs that may be used to display help in the |
b5578f33 CC |
840 | 'man' format. See linkgit:git-help[1]. |
841 | ||
f5a84c37 | 842 | include::merge-config.txt[] |
88e7fdf2 | 843 | |
0bb64009 CC |
844 | man.<tool>.cmd:: |
845 | Specify the command to invoke the specified man viewer. The | |
846 | specified command is evaluated in shell with the man page | |
847 | passed as argument. (See linkgit:git-help[1].) | |
848 | ||
7e8114c0 CC |
849 | man.<tool>.path:: |
850 | Override the path for the given tool that may be used to | |
851 | display help in the 'man' format. See linkgit:git-help[1]. | |
852 | ||
77680caa JS |
853 | mergetool.<tool>.path:: |
854 | Override the path for the given tool. This is useful in case | |
855 | your tool is not in the PATH. | |
856 | ||
964473a0 CB |
857 | mergetool.<tool>.cmd:: |
858 | Specify the command to invoke the specified merge tool. The | |
859 | specified command is evaluated in shell with the following | |
860 | variables available: 'BASE' is the name of a temporary file | |
861 | containing the common base of the files to be merged, if available; | |
862 | 'LOCAL' is the name of a temporary file containing the contents of | |
863 | the file on the current branch; 'REMOTE' is the name of a temporary | |
864 | file containing the contents of the file from the branch being | |
865 | merged; 'MERGED' contains the name of the file to which the merge | |
866 | tool should write the results of a successful merge. | |
867 | ||
868 | mergetool.<tool>.trustExitCode:: | |
869 | For a custom merge command, specify whether the exit code of | |
870 | the merge command can be used to determine whether the merge was | |
871 | successful. If this is not set to true then the merge target file | |
872 | timestamp is checked and the merge assumed to have been successful | |
873 | if the file has been updated, otherwise the user is prompted to | |
874 | indicate the success of the merge. | |
875 | ||
44c36d1c CB |
876 | mergetool.keepBackup:: |
877 | After performing a merge, the original file with conflict markers | |
878 | can be saved as a file with a `.orig` extension. If this variable | |
879 | is set to `false` then this file is not preserved. Defaults to | |
880 | `true` (i.e. keep the backup files). | |
881 | ||
4812a93a | 882 | pack.window:: |
5162e697 | 883 | The size of the window used by linkgit:git-pack-objects[1] when no |
4812a93a JK |
884 | window size is given on the command line. Defaults to 10. |
885 | ||
842aaf93 | 886 | pack.depth:: |
5162e697 | 887 | The maximum delta depth used by linkgit:git-pack-objects[1] when no |
618e613a | 888 | maximum depth is given on the command line. Defaults to 50. |
842aaf93 | 889 | |
e93b15cd | 890 | pack.windowMemory:: |
5162e697 | 891 | The window memory size limit used by linkgit:git-pack-objects[1] |
e93b15cd BD |
892 | when no limit is given on the command line. The value can be |
893 | suffixed with "k", "m", or "g". Defaults to 0, meaning no | |
894 | limit. | |
895 | ||
960ccca6 DH |
896 | pack.compression:: |
897 | An integer -1..9, indicating the compression level for objects | |
898 | in a pack file. -1 is the zlib default. 0 means no | |
899 | compression, and 1..9 are various speed/size tradeoffs, 9 being | |
900 | slowest. If not set, defaults to core.compression. If that is | |
dec92309 BD |
901 | not set, defaults to -1, the zlib default, which is "a default |
902 | compromise between speed and compression (currently equivalent | |
903 | to level 6)." | |
960ccca6 | 904 | |
074b2eea | 905 | pack.deltaCacheSize:: |
02783075 | 906 | The maximum memory in bytes used for caching deltas in |
5162e697 | 907 | linkgit:git-pack-objects[1]. |
074b2eea MK |
908 | A value of 0 means no limit. Defaults to 0. |
909 | ||
e3dfddb3 | 910 | pack.deltaCacheLimit:: |
693b86ff | 911 | The maximum size of a delta, that is cached in |
5162e697 | 912 | linkgit:git-pack-objects[1]. Defaults to 1000. |
e3dfddb3 | 913 | |
693b86ff NP |
914 | pack.threads:: |
915 | Specifies the number of threads to spawn when searching for best | |
5162e697 | 916 | delta matches. This requires that linkgit:git-pack-objects[1] |
693b86ff NP |
917 | be compiled with pthreads otherwise this option is ignored with a |
918 | warning. This is meant to reduce packing time on multiprocessor | |
919 | machines. The required amount of memory for the delta search window | |
920 | is however multiplied by the number of threads. | |
833e3df1 AE |
921 | Specifying 0 will cause git to auto-detect the number of CPU's |
922 | and set the number of threads accordingly. | |
693b86ff | 923 | |
4d00bda2 NP |
924 | pack.indexVersion:: |
925 | Specify the default pack index version. Valid values are 1 for | |
926 | legacy pack index used by Git versions prior to 1.5.2, and 2 for | |
927 | the new pack index with capabilities for packs larger than 4 GB | |
928 | as well as proper protection against the repacking of corrupted | |
929 | packs. Version 2 is selected and this config option ignored | |
930 | whenever the corresponding pack is larger than 2 GB. Otherwise | |
931 | the default is 1. | |
932 | ||
dbdbfec4 | 933 | pack.packSizeLimit:: |
2b84b5a8 JS |
934 | The default maximum size of a pack. This setting only affects |
935 | packing to a file, i.e. the git:// protocol is unaffected. It | |
936 | can be overridden by the `\--max-pack-size` option of | |
937 | linkgit:git-repack[1]. | |
938 | ||
1ab661dd PB |
939 | pull.octopus:: |
940 | The default merge strategy to use when pulling multiple branches | |
941 | at once. | |
942 | ||
943 | pull.twohead:: | |
944 | The default merge strategy to use when pulling a single branch. | |
945 | ||
0cc6d346 | 946 | remote.<name>.url:: |
5162e697 DM |
947 | The URL of a remote repository. See linkgit:git-fetch[1] or |
948 | linkgit:git-push[1]. | |
0cc6d346 | 949 | |
14c98218 SV |
950 | remote.<name>.proxy:: |
951 | For remotes that require curl (http, https and ftp), the URL to | |
952 | the proxy to use for that remote. Set to the empty string to | |
953 | disable proxying for that remote. | |
954 | ||
0cc6d346 | 955 | remote.<name>.fetch:: |
5162e697 DM |
956 | The default set of "refspec" for linkgit:git-fetch[1]. See |
957 | linkgit:git-fetch[1]. | |
0cc6d346 SB |
958 | |
959 | remote.<name>.push:: | |
5162e697 DM |
960 | The default set of "refspec" for linkgit:git-push[1]. See |
961 | linkgit:git-push[1]. | |
0cc6d346 | 962 | |
84bb2dfd PB |
963 | remote.<name>.mirror:: |
964 | If true, pushing to this remote will automatically behave | |
965 | as if the `\--mirror` option was given on the command line. | |
966 | ||
1918278e TT |
967 | remote.<name>.skipDefaultUpdate:: |
968 | If true, this remote will be skipped by default when updating | |
5162e697 | 969 | using the update subcommand of linkgit:git-remote[1]. |
1918278e | 970 | |
060aafc1 | 971 | remote.<name>.receivepack:: |
5dee29ac | 972 | The default program to execute on the remote side when pushing. See |
79f43f3d | 973 | option \--receive-pack of linkgit:git-push[1]. |
060aafc1 | 974 | |
5dee29ac UKK |
975 | remote.<name>.uploadpack:: |
976 | The default program to execute on the remote side when fetching. See | |
79f43f3d | 977 | option \--upload-pack of linkgit:git-fetch-pack[1]. |
5dee29ac | 978 | |
047f636d | 979 | remote.<name>.tagopt:: |
79f43f3d UKK |
980 | Setting this value to \--no-tags disables automatic tag following when |
981 | fetching from remote <name> | |
047f636d | 982 | |
1918278e TT |
983 | remotes.<group>:: |
984 | The list of remotes which are fetched by "git remote update | |
5162e697 | 985 | <group>". See linkgit:git-remote[1]. |
1918278e | 986 | |
b6945f57 | 987 | repack.usedeltabaseoffset:: |
5162e697 | 988 | Allow linkgit:git-repack[1] to create packs that uses |
b6945f57 JH |
989 | delta-base offset. Defaults to false. |
990 | ||
1ab661dd | 991 | show.difftree:: |
5162e697 DM |
992 | The default linkgit:git-diff-tree[1] arguments to be used |
993 | for linkgit:git-show[1]. | |
1ab661dd PB |
994 | |
995 | showbranch.default:: | |
5162e697 DM |
996 | The default set of branches for linkgit:git-show-branch[1]. |
997 | See linkgit:git-show-branch[1]. | |
1ab661dd | 998 | |
46f721c8 | 999 | status.relativePaths:: |
5162e697 | 1000 | By default, linkgit:git-status[1] shows paths relative to the |
46f721c8 JK |
1001 | current directory. Setting this variable to `false` shows paths |
1002 | relative to the repository root (this was the default for git | |
1003 | prior to v1.5.4). | |
1004 | ||
ce1a79b6 | 1005 | tar.umask:: |
687157c7 RS |
1006 | This variable can be used to restrict the permission bits of |
1007 | tar archive entries. The default is 0002, which turns off the | |
1008 | world write bit. The special value "user" indicates that the | |
1009 | archiving user's umask will be used instead. See umask(2) and | |
5162e697 | 1010 | linkgit:git-archive[1]. |
ce1a79b6 | 1011 | |
55029ae4 DB |
1012 | url.<base>.insteadOf:: |
1013 | Any URL that starts with this value will be rewritten to | |
1014 | start, instead, with <base>. In cases where some site serves a | |
1015 | large number of repositories, and serves them with multiple | |
1016 | access methods, and some users need to use different access | |
1017 | methods, this feature allows people to specify any of the | |
1018 | equivalent URLs and have git automatically rewrite the URL to | |
1019 | the best alternative for the particular user, even for a | |
844112ca JH |
1020 | never-before-seen repository on the site. When more than one |
1021 | insteadOf strings match a given URL, the longest match is used. | |
55029ae4 | 1022 | |
1ab661dd PB |
1023 | user.email:: |
1024 | Your email address to be recorded in any newly created commits. | |
28a94f88 | 1025 | Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and |
5162e697 | 1026 | 'EMAIL' environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd PB |
1027 | |
1028 | user.name:: | |
1029 | Your full name to be recorded in any newly created commits. | |
abda1ef5 | 1030 | Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' |
5162e697 | 1031 | environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd | 1032 | |
d67778ec | 1033 | user.signingkey:: |
5162e697 | 1034 | If linkgit:git-tag[1] is not selecting the key you want it to |
d67778ec AP |
1035 | automatically when creating a signed tag, you can override the |
1036 | default selection with this variable. This option is passed | |
1037 | unchanged to gpg's --local-user parameter, so you may specify a key | |
1038 | using any method that gpg supports. | |
1039 | ||
1ab661dd | 1040 | whatchanged.difftree:: |
5162e697 DM |
1041 | The default linkgit:git-diff-tree[1] arguments to be used |
1042 | for linkgit:git-whatchanged[1]. | |
1ab661dd PB |
1043 | |
1044 | imap:: | |
1045 | The configuration variables in the 'imap' section are described | |
5162e697 | 1046 | in linkgit:git-imap-send[1]. |
199a9218 | 1047 | |
20dc0016 MK |
1048 | receive.fsckObjects:: |
1049 | If it is set to true, git-receive-pack will check all received | |
1050 | objects. It will abort in the case of a malformed object or a | |
1051 | broken link. The result of an abort are only dangling objects. | |
1052 | Defaults to false. | |
1053 | ||
fc04c412 SP |
1054 | receive.unpackLimit:: |
1055 | If the number of objects received in a push is below this | |
1056 | limit then the objects will be unpacked into loose object | |
1057 | files. However if the number of received objects equals or | |
1058 | exceeds this limit then the received pack will be stored as | |
1059 | a pack, after adding any missing delta bases. Storing the | |
1060 | pack from a push can make the push operation complete faster, | |
80cd9cf9 MB |
1061 | especially on slow filesystems. If not set, the value of |
1062 | `transfer.unpackLimit` is used instead. | |
fc04c412 SP |
1063 | |
1064 | receive.denyNonFastForwards:: | |
199a9218 JS |
1065 | If set to true, git-receive-pack will deny a ref update which is |
1066 | not a fast forward. Use this to prevent such an update via a push, | |
1067 | even if that push is forced. This configuration variable is | |
1068 | set when initializing a shared repository. | |
1069 | ||
e28714c5 JH |
1070 | transfer.unpackLimit:: |
1071 | When `fetch.unpackLimit` or `receive.unpackLimit` are | |
1072 | not set, the value of this variable is used instead. | |
80cd9cf9 | 1073 | The default value is 100. |
983a9eeb CC |
1074 | |
1075 | web.browser:: | |
1076 | Specify a web browser that may be used by some commands. | |
1077 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] | |
1078 | may use it. |