Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1152 lines
47 KiB

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