logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

git-config.1 (351703B)

    

  1. '\" t
  2. .\"     Title: git-config
  3. .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
  5. .\"      Date: 2025-03-14
  6. .\"    Manual: Git Manual
  7. .\"    Source: Git 2.49.0
  8. .\"  Language: English
  9. .\"
  10. .TH "GIT\-CONFIG" "1" "2025-03-14" "Git 2\&.49\&.0" "Git Manual"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el       .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. git-config \- Get and set repository or global options
  32. .SH "SYNOPSIS"
  33. .sp
  34. .nf
  35. \fIgit config list\fR [<file\-option>] [<display\-option>] [\-\-includes]
  36. \fIgit config get\fR [<file\-option>] [<display\-option>] [\-\-includes] [\-\-all] [\-\-regexp] [\-\-value=<value>] [\-\-fixed\-value] [\-\-default=<default>] <name>
  37. \fIgit config set\fR [<file\-option>] [\-\-type=<type>] [\-\-all] [\-\-value=<value>] [\-\-fixed\-value] <name> <value>
  38. \fIgit config unset\fR [<file\-option>] [\-\-all] [\-\-value=<value>] [\-\-fixed\-value] <name>
  39. \fIgit config rename\-section\fR [<file\-option>] <old\-name> <new\-name>
  40. \fIgit config remove\-section\fR [<file\-option>] <name>
  41. \fIgit config edit\fR [<file\-option>]
  42. \fIgit config\fR [<file\-option>] \-\-get\-colorbool <name> [<stdout\-is\-tty>]
  43. .fi
  44. .SH "DESCRIPTION"
  45. .sp
  46. You can query/set/replace/unset options with this command\&. The name is actually the section and the key separated by a dot, and the value will be escaped\&.
  47. .sp
  48. Multiple lines can be added to an option by using the \fB\-\-append\fR option\&. If you want to update or unset an option which can occur on multiple lines, a \fBvalue\-pattern\fR (which is an extended regular expression, unless the \fB\-\-fixed\-value\fR option is given) needs to be given\&. Only the existing values that match the pattern are updated or unset\&. If you want to handle the lines that do \fBnot\fR match the pattern, just prepend a single exclamation mark in front (see also the section called \(lqEXAMPLES\(rq), but note that this only works when the \fB\-\-fixed\-value\fR option is not in use\&.
  49. .sp
  50. The \fB\-\-type=\fR\fI<type>\fR option instructs \fIgit config\fR to ensure that incoming and outgoing values are canonicalize\-able under the given <type>\&. If no \fB\-\-type=\fR\fI<type>\fR is given, no canonicalization will be performed\&. Callers may unset an existing \fB\-\-type\fR specifier with \fB\-\-no\-type\fR\&.
  51. .sp
  52. When reading, the values are read from the system, global and repository local configuration files by default, and options \fB\-\-system\fR, \fB\-\-global\fR, \fB\-\-local\fR, \fB\-\-worktree\fR and \fB\-\-file\fR \fI<filename>\fR can be used to tell the command to read from only that location (see the section called \(lqFILES\(rq)\&.
  53. .sp
  54. When writing, the new value is written to the repository local configuration file by default, and options \fB\-\-system\fR, \fB\-\-global\fR, \fB\-\-worktree\fR, \fB\-\-file\fR \fI<filename>\fR can be used to tell the command to write to that location (you can say \fB\-\-local\fR but that is the default)\&.
  55. .sp
  56. This command will fail with non\-zero status upon error\&. Some exit codes are:
  57. .sp
  58. .RS 4
  59. .ie n \{\
  60. \h'-04'\(bu\h'+03'\c
  61. .\}
  62. .el \{\
  63. .sp -1
  64. .IP \(bu 2.3
  65. .\}
  66. The section or key is invalid (ret=1),
  67. .RE
  68. .sp
  69. .RS 4
  70. .ie n \{\
  71. \h'-04'\(bu\h'+03'\c
  72. .\}
  73. .el \{\
  74. .sp -1
  75. .IP \(bu 2.3
  76. .\}
  77. no section or name was provided (ret=2),
  78. .RE
  79. .sp
  80. .RS 4
  81. .ie n \{\
  82. \h'-04'\(bu\h'+03'\c
  83. .\}
  84. .el \{\
  85. .sp -1
  86. .IP \(bu 2.3
  87. .\}
  88. the config file is invalid (ret=3),
  89. .RE
  90. .sp
  91. .RS 4
  92. .ie n \{\
  93. \h'-04'\(bu\h'+03'\c
  94. .\}
  95. .el \{\
  96. .sp -1
  97. .IP \(bu 2.3
  98. .\}
  99. the config file cannot be written (ret=4),
  100. .RE
  101. .sp
  102. .RS 4
  103. .ie n \{\
  104. \h'-04'\(bu\h'+03'\c
  105. .\}
  106. .el \{\
  107. .sp -1
  108. .IP \(bu 2.3
  109. .\}
  110. you try to unset an option which does not exist (ret=5),
  111. .RE
  112. .sp
  113. .RS 4
  114. .ie n \{\
  115. \h'-04'\(bu\h'+03'\c
  116. .\}
  117. .el \{\
  118. .sp -1
  119. .IP \(bu 2.3
  120. .\}
  121. you try to unset/set an option for which multiple lines match (ret=5), or
  122. .RE
  123. .sp
  124. .RS 4
  125. .ie n \{\
  126. \h'-04'\(bu\h'+03'\c
  127. .\}
  128. .el \{\
  129. .sp -1
  130. .IP \(bu 2.3
  131. .\}
  132. you try to use an invalid regexp (ret=6)\&.
  133. .RE
  134. .sp
  135. On success, the command returns the exit code 0\&.
  136. .sp
  137. A list of all available configuration variables can be obtained using the \fBgit\fR \fBhelp\fR \fB\-\-config\fR command\&.
  138. .SH "COMMANDS"
  139. .PP
  140. list
  141. .RS 4
  142. List all variables set in config file, along with their values\&.
  143. .RE
  144. .PP
  145. get
  146. .RS 4
  147. Emits the value of the specified key\&. If key is present multiple times in the configuration, emits the last value\&. If
  148. \fB\-\-all\fR
  149. is specified, emits all values associated with key\&. Returns error code 1 if key is not present\&.
  150. .RE
  151. .PP
  152. set
  153. .RS 4
  154. Set value for one or more config options\&. By default, this command refuses to write multi\-valued config options\&. Passing
  155. \fB\-\-all\fR
  156. will replace all multi\-valued config options with the new value, whereas
  157. \fB\-\-value=\fR
  158. will replace all config options whose values match the given pattern\&.
  159. .RE
  160. .PP
  161. unset
  162. .RS 4
  163. Unset value for one or more config options\&. By default, this command refuses to unset multi\-valued keys\&. Passing
  164. \fB\-\-all\fR
  165. will unset all multi\-valued config options, whereas
  166. \fB\-\-value\fR
  167. will unset all config options whose values match the given pattern\&.
  168. .RE
  169. .PP
  170. rename\-section
  171. .RS 4
  172. Rename the given section to a new name\&.
  173. .RE
  174. .PP
  175. remove\-section
  176. .RS 4
  177. Remove the given section from the configuration file\&.
  178. .RE
  179. .PP
  180. edit
  181. .RS 4
  182. Opens an editor to modify the specified config file; either
  183. \fB\-\-system\fR,
  184. \fB\-\-global\fR,
  185. \fB\-\-local\fR
  186. (default),
  187. \fB\-\-worktree\fR, or
  188. \fB\-\-file\fR
  189. \fI<config\-file>\fR\&.
  190. .RE
  191. .SH "OPTIONS"
  192. .PP
  193. \-\-replace\-all
  194. .RS 4
  195. Default behavior is to replace at most one line\&. This replaces all lines matching the key (and optionally the
  196. \fBvalue\-pattern\fR)\&.
  197. .RE
  198. .PP
  199. \-\-append
  200. .RS 4
  201. Adds a new line to the option without altering any existing values\&. This is the same as providing
  202. \fI\-\-value=^$\fR
  203. in
  204. \fBset\fR\&.
  205. .RE
  206. .PP
  207. \-\-comment <message>
  208. .RS 4
  209. Append a comment at the end of new or modified lines\&.
  210. .sp
  211. .if n \{\
  212. .RS 4
  213. .\}
  214. .nf
  215. If _<message>_ begins with one or more whitespaces followed
  216. by "#", it is used as\-is\&.  If it begins with "#", a space is
  217. prepended before it is used\&.  Otherwise, a string " # " (a
  218. space followed by a hash followed by a space) is prepended
  219. to it\&.  And the resulting string is placed immediately after
  220. the value defined for the variable\&.  The _<message>_ must
  221. not contain linefeed characters (no multi\-line comments are
  222. permitted)\&.
  223. .fi
  224. .if n \{\
  225. .RE
  226. .\}
  227. .RE
  228. .PP
  229. \-\-all
  230. .RS 4
  231. With
  232. \fBget\fR, return all values for a multi\-valued key\&.
  233. .RE
  234. .PP
  235. \-\-regexp
  236. .RS 4
  237. With
  238. \fBget\fR, interpret the name as a regular expression\&. Regular expression matching is currently case\-sensitive and done against a canonicalized version of the key in which section and variable names are lowercased, but subsection names are not\&.
  239. .RE
  240. .PP
  241. \-\-url=<URL>
  242. .RS 4
  243. When given a two\-part <name> as <section>\&.<key>, the value for <section>\&.<URL>\&.<key> whose <URL> part matches the best to the given URL is returned (if no such key exists, the value for <section>\&.<key> is used as a fallback)\&. When given just the <section> as name, do so for all the keys in the section and list them\&. Returns error code 1 if no value is found\&.
  244. .RE
  245. .PP
  246. \-\-global
  247. .RS 4
  248. For writing options: write to global
  249. \fB~/\&.gitconfig\fR
  250. file rather than the repository \&.\fBgit/config\fR, write to
  251. \fB$XDG_CONFIG_HOME/git/config\fR
  252. file if this file exists and the
  253. \fB~/\&.gitconfig\fR
  254. file doesn\(cqt\&.
  255. .sp
  256. For reading options: read only from global
  257. \fB~/\&.gitconfig\fR
  258. and from
  259. \fB$XDG_CONFIG_HOME/git/config\fR
  260. rather than from all available files\&.
  261. .sp
  262. See also
  263. the section called \(lqFILES\(rq\&.
  264. .RE
  265. .PP
  266. \-\-system
  267. .RS 4
  268. For writing options: write to system\-wide
  269. \fB$\fR(\fBprefix\fR)\fB/etc/gitconfig\fR
  270. rather than the repository \&.\fBgit/config\fR\&.
  271. .sp
  272. For reading options: read only from system\-wide
  273. \fB$\fR(\fBprefix\fR)\fB/etc/gitconfig\fR
  274. rather than from all available files\&.
  275. .sp
  276. See also
  277. the section called \(lqFILES\(rq\&.
  278. .RE
  279. .PP
  280. \-\-local
  281. .RS 4
  282. For writing options: write to the repository \&.\fBgit/config\fR
  283. file\&. This is the default behavior\&.
  284. .sp
  285. For reading options: read only from the repository \&.\fBgit/config\fR
  286. rather than from all available files\&.
  287. .sp
  288. See also
  289. the section called \(lqFILES\(rq\&.
  290. .RE
  291. .PP
  292. \-\-worktree
  293. .RS 4
  294. Similar to
  295. \fB\-\-local\fR
  296. except that
  297. \fB$GIT_DIR/config\&.worktree\fR
  298. is read from or written to if
  299. \fBextensions\&.worktreeConfig\fR
  300. is enabled\&. If not it\(cqs the same as
  301. \fB\-\-local\fR\&. Note that
  302. \fB$GIT_DIR\fR
  303. is equal to
  304. \fB$GIT_COMMON_DIR\fR
  305. for the main working tree, but is of the form
  306. \fB$GIT_DIR/worktrees/\fR\fI<id>\fR\fB/\fR
  307. for other working trees\&. See
  308. \fBgit-worktree\fR(1)
  309. to learn how to enable
  310. \fBextensions\&.worktreeConfig\fR\&.
  311. .RE
  312. .PP
  313. \-f <config\-file>, \-\-file <config\-file>
  314. .RS 4
  315. For writing options: write to the specified file rather than the repository \&.\fBgit/config\fR\&.
  316. .sp
  317. For reading options: read only from the specified file rather than from all available files\&.
  318. .sp
  319. See also
  320. the section called \(lqFILES\(rq\&.
  321. .RE
  322. .PP
  323. \-\-blob <blob>
  324. .RS 4
  325. Similar to
  326. \fB\-\-file\fR
  327. but use the given blob instead of a file\&. E\&.g\&. you can use
  328. \fImaster:\&.gitmodules\fR
  329. to read values from the file
  330. \fI\&.gitmodules\fR
  331. in the master branch\&. See "SPECIFYING REVISIONS" section in
  332. \fBgitrevisions\fR(7)
  333. for a more complete list of ways to spell blob names\&.
  334. .RE
  335. .PP
  336. \-\-fixed\-value
  337. .RS 4
  338. When used with the
  339. \fBvalue\-pattern\fR
  340. argument, treat
  341. \fBvalue\-pattern\fR
  342. as an exact string instead of a regular expression\&. This will restrict the name/value pairs that are matched to only those where the value is exactly equal to the
  343. \fBvalue\-pattern\fR\&.
  344. .RE
  345. .PP
  346. \-\-type <type>
  347. .RS 4
  348. \fIgit config\fR
  349. will ensure that any input or output is valid under the given type constraint(s), and will canonicalize outgoing values in
  350. \fI<type>\fR\*(Aqs canonical form\&.
  351. .sp
  352. Valid
  353. \fI<type>\fR\*(Aqs include:
  354. .sp
  355. .RS 4
  356. .ie n \{\
  357. \h'-04'\(bu\h'+03'\c
  358. .\}
  359. .el \{\
  360. .sp -1
  361. .IP \(bu 2.3
  362. .\}
  363. \fIbool\fR: canonicalize values
  364. \fBtrue\fR,
  365. \fByes\fR,\fBon\fR, and positive numbers as "true", and values
  366. \fBfalse\fR,
  367. \fBno\fR,
  368. \fBoff\fR
  369. and
  370. \fB0\fR
  371. as "false"\&.
  372. .RE
  373. .sp
  374. .RS 4
  375. .ie n \{\
  376. \h'-04'\(bu\h'+03'\c
  377. .\}
  378. .el \{\
  379. .sp -1
  380. .IP \(bu 2.3
  381. .\}
  382. \fIint\fR: canonicalize values as simple decimal numbers\&. An optional suffix of
  383. \fIk\fR,
  384. \fIm\fR, or
  385. \fIg\fR
  386. will cause the value to be multiplied by 1024, 1048576, or 1073741824 upon input\&.
  387. .RE
  388. .sp
  389. .RS 4
  390. .ie n \{\
  391. \h'-04'\(bu\h'+03'\c
  392. .\}
  393. .el \{\
  394. .sp -1
  395. .IP \(bu 2.3
  396. .\}
  397. \fIbool\-or\-int\fR: canonicalize according to either
  398. \fIbool\fR
  399. or
  400. \fIint\fR, as described above\&.
  401. .RE
  402. .sp
  403. .RS 4
  404. .ie n \{\
  405. \h'-04'\(bu\h'+03'\c
  406. .\}
  407. .el \{\
  408. .sp -1
  409. .IP \(bu 2.3
  410. .\}
  411. \fIpath\fR: canonicalize by expanding a leading
  412. \fB~\fR
  413. to the value of
  414. \fB$HOME\fR
  415. and
  416. \fB~user\fR
  417. to the home directory for the specified user\&. This specifier has no effect when setting the value (but you can use
  418. \fBgit\fR
  419. \fBconfig\fR
  420. \fBsection\&.variable\fR
  421. \fB~/\fR
  422. from the command line to let your shell do the expansion\&.)
  423. .RE
  424. .sp
  425. .RS 4
  426. .ie n \{\
  427. \h'-04'\(bu\h'+03'\c
  428. .\}
  429. .el \{\
  430. .sp -1
  431. .IP \(bu 2.3
  432. .\}
  433. \fIexpiry\-date\fR: canonicalize by converting from a fixed or relative date\-string to a timestamp\&. This specifier has no effect when setting the value\&.
  434. .RE
  435. .sp
  436. .RS 4
  437. .ie n \{\
  438. \h'-04'\(bu\h'+03'\c
  439. .\}
  440. .el \{\
  441. .sp -1
  442. .IP \(bu 2.3
  443. .\}
  444. \fIcolor\fR: When getting a value, canonicalize by converting to an ANSI color escape sequence\&. When setting a value, a sanity\-check is performed to ensure that the given value is canonicalize\-able as an ANSI color, but it is written as\-is\&.
  445. .RE
  446. .RE
  447. .PP
  448. \-\-bool, \-\-int, \-\-bool\-or\-int, \-\-path, \-\-expiry\-date
  449. .RS 4
  450. Historical options for selecting a type specifier\&. Prefer instead
  451. \fB\-\-type\fR
  452. (see above)\&.
  453. .RE
  454. .PP
  455. \-\-no\-type
  456. .RS 4
  457. Un\-sets the previously set type specifier (if one was previously set)\&. This option requests that
  458. \fIgit config\fR
  459. not canonicalize the retrieved variable\&.
  460. \fB\-\-no\-type\fR
  461. has no effect without
  462. \fB\-\-type=\fR\fI<type>\fR
  463. or
  464. \fB\-\-\fR\fI<type>\fR\&.
  465. .RE
  466. .PP
  467. \-z, \-\-null
  468. .RS 4
  469. For all options that output values and/or keys, always end values with the null character (instead of a newline)\&. Use newline instead as a delimiter between key and value\&. This allows for secure parsing of the output without getting confused e\&.g\&. by values that contain line breaks\&.
  470. .RE
  471. .PP
  472. \-\-name\-only
  473. .RS 4
  474. Output only the names of config variables for
  475. \fBlist\fR
  476. or
  477. \fBget\fR\&.
  478. .RE
  479. .PP
  480. \-\-show\-origin
  481. .RS 4
  482. Augment the output of all queried config options with the origin type (file, standard input, blob, command line) and the actual origin (config file path, ref, or blob id if applicable)\&.
  483. .RE
  484. .PP
  485. \-\-show\-scope
  486. .RS 4
  487. Similar to
  488. \fB\-\-show\-origin\fR
  489. in that it augments the output of all queried config options with the scope of that value (worktree, local, global, system, command)\&.
  490. .RE
  491. .PP
  492. \-\-get\-colorbool <name> [<stdout\-is\-tty>]
  493. .RS 4
  494. Find the color setting for
  495. \fI<name>\fR
  496. (e\&.g\&.
  497. \fBcolor\&.diff\fR) and output "true" or "false"\&.
  498. \fI<stdout\-is\-tty>\fR
  499. should be either "true" or "false", and is taken into account when configuration says "auto"\&. If
  500. \fI<stdout\-is\-tty>\fR
  501. is missing, then checks the standard output of the command itself, and exits with status 0 if color is to be used, or exits with status 1 otherwise\&. When the color setting for
  502. \fBname\fR
  503. is undefined, the command uses
  504. \fBcolor\&.ui\fR
  505. as fallback\&.
  506. .RE
  507. .PP
  508. \-\-[no\-]includes
  509. .RS 4
  510. Respect
  511. \fBinclude\&.\fR* directives in config files when looking up values\&. Defaults to
  512. \fBoff\fR
  513. when a specific file is given (e\&.g\&., using
  514. \fB\-\-file\fR,
  515. \fB\-\-global\fR, etc) and
  516. \fBon\fR
  517. when searching all config files\&.
  518. .RE
  519. .PP
  520. \-\-default <value>
  521. .RS 4
  522. When using
  523. \fBget\fR, and the requested variable is not found, behave as if <value> were the value assigned to that variable\&.
  524. .RE
  525. .SH "DEPRECATED MODES"
  526. .sp
  527. The following modes have been deprecated in favor of subcommands\&. It is recommended to migrate to the new syntax\&.
  528. .PP
  529. \fIgit config <name>\fR
  530. .RS 4
  531. Replaced by
  532. \fBgit\fR
  533. \fBconfig\fR
  534. \fBget\fR
  535. \fI<name>\fR\&.
  536. .RE
  537. .PP
  538. \fIgit config <name> <value> [<value\-pattern>]\fR
  539. .RS 4
  540. Replaced by
  541. \fBgit\fR
  542. \fBconfig\fR
  543. \fBset\fR
  544. [\fB\-\-value=\fR\fI<pattern>\fR]
  545. \fI<name>\fR
  546. \fI<value>\fR\&.
  547. .RE
  548. .PP
  549. \-l, \-\-list
  550. .RS 4
  551. Replaced by
  552. \fBgit\fR
  553. \fBconfig\fR
  554. \fBlist\fR\&.
  555. .RE
  556. .PP
  557. \-\-get <name> [<value\-pattern>]
  558. .RS 4
  559. Replaced by
  560. \fBgit\fR
  561. \fBconfig\fR
  562. \fBget\fR
  563. [\fB\-\-value=\fR\fI<pattern>\fR]
  564. \fI<name>\fR\&.
  565. .RE
  566. .PP
  567. \-\-get\-all <name> [<value\-pattern>]
  568. .RS 4
  569. Replaced by
  570. \fBgit\fR
  571. \fBconfig\fR
  572. \fBget\fR
  573. [\fB\-\-value=\fR\fI<pattern>\fR]
  574. \fB\-\-all\fR
  575. \fI<name>\fR\&.
  576. .RE
  577. .PP
  578. \-\-get\-regexp <name\-regexp>
  579. .RS 4
  580. Replaced by
  581. \fBgit\fR
  582. \fBconfig\fR
  583. \fBget\fR
  584. \fB\-\-all\fR
  585. \fB\-\-show\-names\fR
  586. \fB\-\-regexp\fR
  587. \fI<name\-regexp>\fR\&.
  588. .RE
  589. .PP
  590. \-\-get\-urlmatch <name> <URL>
  591. .RS 4
  592. Replaced by
  593. \fBgit\fR
  594. \fBconfig\fR
  595. \fBget\fR
  596. \fB\-\-all\fR
  597. \fB\-\-show\-names\fR
  598. \fB\-\-url=\fR\fI<URL>\fR
  599. \fI<name>\fR\&.
  600. .RE
  601. .PP
  602. \-\-get\-color <name> [<default>]
  603. .RS 4
  604. Replaced by
  605. \fBgit\fR
  606. \fBconfig\fR
  607. \fBget\fR
  608. \fB\-\-type=color\fR
  609. [\fB\-\-default=\fR\fI<default>\fR]
  610. \fI<name>\fR\&.
  611. .RE
  612. .PP
  613. \-\-add <name> <value>
  614. .RS 4
  615. Replaced by
  616. \fBgit\fR
  617. \fBconfig\fR
  618. \fBset\fR
  619. \fB\-\-append\fR
  620. \fI<name>\fR
  621. \fI<value>\fR\&.
  622. .RE
  623. .PP
  624. \-\-unset <name> [<value\-pattern>]
  625. .RS 4
  626. Replaced by
  627. \fBgit\fR
  628. \fBconfig\fR
  629. \fBunset\fR
  630. [\fB\-\-value=\fR\fI<pattern>\fR]
  631. \fI<name>\fR\&.
  632. .RE
  633. .PP
  634. \-\-unset\-all <name> [<value\-pattern>]
  635. .RS 4
  636. Replaced by
  637. \fBgit\fR
  638. \fBconfig\fR
  639. \fBunset\fR
  640. [\fB\-\-value=\fR\fI<pattern>\fR]
  641. \fB\-\-all\fR
  642. \fI<name>\fR\&.
  643. .RE
  644. .PP
  645. \-\-rename\-section <old\-name> <new\-name>
  646. .RS 4
  647. Replaced by
  648. \fBgit\fR
  649. \fBconfig\fR
  650. \fBrename\-section\fR
  651. \fI<old\-name>\fR
  652. \fI<new\-name>\fR\&.
  653. .RE
  654. .PP
  655. \-\-remove\-section <name>
  656. .RS 4
  657. Replaced by
  658. \fBgit\fR
  659. \fBconfig\fR
  660. \fBremove\-section\fR
  661. \fI<name>\fR\&.
  662. .RE
  663. .PP
  664. \-e, \-\-edit
  665. .RS 4
  666. Replaced by
  667. \fBgit\fR
  668. \fBconfig\fR
  669. \fBedit\fR\&.
  670. .RE
  671. .SH "CONFIGURATION"
  672. .sp
  673. \fBpager\&.config\fR is only respected when listing configuration, i\&.e\&., when using \fBlist\fR or \fBget\fR which may return multiple results\&. The default is to use a pager\&.
  674. .SH "FILES"
  675. .sp
  676. By default, \fIgit config\fR will read configuration options from multiple files:
  677. .PP
  678. $(prefix)/etc/gitconfig
  679. .RS 4
  680. System\-wide configuration file\&.
  681. .RE
  682. .PP
  683. $XDG_CONFIG_HOME/git/config, ~/\&.gitconfig
  684. .RS 4
  685. User\-specific configuration files\&. When the XDG_CONFIG_HOME environment variable is not set or empty, $HOME/\&.config/ is used as $XDG_CONFIG_HOME\&.
  686. .sp
  687. These are also called "global" configuration files\&. If both files exist, both files are read in the order given above\&.
  688. .RE
  689. .PP
  690. $GIT_DIR/config
  691. .RS 4
  692. Repository specific configuration file\&.
  693. .RE
  694. .PP
  695. $GIT_DIR/config\&.worktree
  696. .RS 4
  697. This is optional and is only searched when
  698. \fBextensions\&.worktreeConfig\fR
  699. is present in $GIT_DIR/config\&.
  700. .RE
  701. .sp
  702. You may also provide additional configuration parameters when running any git command by using the \fB\-c\fR option\&. See \fBgit\fR(1) for details\&.
  703. .sp
  704. Options will be read from all of these files that are available\&. If the global or the system\-wide configuration files are missing or unreadable they will be ignored\&. If the repository configuration file is missing or unreadable, \fIgit config\fR will exit with a non\-zero error code\&. An error message is produced if the file is unreadable, but not if it is missing\&.
  705. .sp
  706. The files are read in the order given above, with last value found taking precedence over values read earlier\&. When multiple values are taken then all values of a key from all files will be used\&.
  707. .sp
  708. By default, options are only written to the repository specific configuration file\&. Note that this also affects options like \fBset\fR and \fBunset\fR\&. \fB\fIgit config\fR\fR\fB will only ever change one file at a time\fR\&.
  709. .sp
  710. You can limit which configuration sources are read from or written to by specifying the path of a file with the \fB\-\-file\fR option, or by specifying a configuration scope with \fB\-\-system\fR, \fB\-\-global\fR, \fB\-\-local\fR, or \fB\-\-worktree\fR\&. For more, see the section called \(lqOPTIONS\(rq above\&.
  711. .SH "SCOPES"
  712. .sp
  713. Each configuration source falls within a configuration scope\&. The scopes are:
  714. .PP
  715. system
  716. .RS 4
  717. $(prefix)/etc/gitconfig
  718. .RE
  719. .PP
  720. global
  721. .RS 4
  722. $XDG_CONFIG_HOME/git/config
  723. .sp
  724. ~/\&.gitconfig
  725. .RE
  726. .PP
  727. local
  728. .RS 4
  729. $GIT_DIR/config
  730. .RE
  731. .PP
  732. worktree
  733. .RS 4
  734. $GIT_DIR/config\&.worktree
  735. .RE
  736. .PP
  737. command
  738. .RS 4
  739. GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see
  740. the section called \(lqENVIRONMENT\(rq
  741. below)
  742. .sp
  743. the
  744. \fB\-c\fR
  745. option
  746. .RE
  747. .sp
  748. With the exception of \fIcommand\fR, each scope corresponds to a command line option: \fB\-\-system\fR, \fB\-\-global\fR, \fB\-\-local\fR, \fB\-\-worktree\fR\&.
  749. .sp
  750. When reading options, specifying a scope will only read options from the files within that scope\&. When writing options, specifying a scope will write to the files within that scope (instead of the repository specific configuration file)\&. See the section called \(lqOPTIONS\(rq above for a complete description\&.
  751. .sp
  752. Most configuration options are respected regardless of the scope it is defined in, but some options are only respected in certain scopes\&. See the respective option\(cqs documentation for the full details\&.
  753. .SS "Protected configuration"
  754. .sp
  755. Protected configuration refers to the \fIsystem\fR, \fIglobal\fR, and \fIcommand\fR scopes\&. For security reasons, certain options are only respected when they are specified in protected configuration, and ignored otherwise\&.
  756. .sp
  757. Git treats these scopes as if they are controlled by the user or a trusted administrator\&. This is because an attacker who controls these scopes can do substantial harm without using Git, so it is assumed that the user\(cqs environment protects these scopes against attackers\&.
  758. .SH "ENVIRONMENT"
  759. .PP
  760. GIT_CONFIG_GLOBAL, GIT_CONFIG_SYSTEM
  761. .RS 4
  762. Take the configuration from the given files instead from global or system\-level configuration\&. See
  763. \fBgit\fR(1)
  764. for details\&.
  765. .RE
  766. .PP
  767. GIT_CONFIG_NOSYSTEM
  768. .RS 4
  769. Whether to skip reading settings from the system\-wide $(prefix)/etc/gitconfig file\&. See
  770. \fBgit\fR(1)
  771. for details\&.
  772. .RE
  773. .sp
  774. See also the section called \(lqFILES\(rq\&.
  775. .PP
  776. GIT_CONFIG_COUNT, GIT_CONFIG_KEY_<n>, GIT_CONFIG_VALUE_<n>
  777. .RS 4
  778. If GIT_CONFIG_COUNT is set to a positive number, all environment pairs GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> up to that number will be added to the process\(cqs runtime configuration\&. The config pairs are zero\-indexed\&. Any missing key or value is treated as an error\&. An empty GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no pairs are processed\&. These environment variables will override values in configuration files, but will be overridden by any explicit options passed via
  779. \fBgit\fR
  780. \fB\-c\fR\&.
  781. .sp
  782. This is useful for cases where you want to spawn multiple git commands with a common configuration but cannot depend on a configuration file, for example when writing scripts\&.
  783. .RE
  784. .PP
  785. GIT_CONFIG
  786. .RS 4
  787. If no
  788. \fB\-\-file\fR
  789. option is provided to
  790. \fBgit\fR
  791. \fBconfig\fR, use the file given by
  792. \fBGIT_CONFIG\fR
  793. as if it were provided via
  794. \fB\-\-file\fR\&. This variable has no effect on other Git commands, and is mostly for historical compatibility; there is generally no reason to use it instead of the
  795. \fB\-\-file\fR
  796. option\&.
  797. .RE
  798. .SH "EXAMPLES"
  799. .sp
  800. Given a \&.git/config like this:
  801. .sp
  802. .if n \{\
  803. .RS 4
  804. .\}
  805. .nf
  806. #
  807. # This is the config file, and
  808. # a \*(Aq#\*(Aq or \*(Aq;\*(Aq character indicates
  809. # a comment
  810. #
  812. ; core variables
  813. [core]
  814.         ; Don\*(Aqt trust file modes
  815.         filemode = false
  817. ; Our diff algorithm
  818. [diff]
  819.         external = /usr/local/bin/diff\-wrapper
  820.         renames = true
  822. ; Proxy settings
  823. [core]
  824.         gitproxy=proxy\-command for kernel\&.org
  825.         gitproxy=default\-proxy ; for all the rest
  827. ; HTTP
  828. [http]
  829.         sslVerify
  830. [http "https://weak\&.example\&.com"]
  831.         sslVerify = false
  832.         cookieFile = /tmp/cookie\&.txt
  833. .fi
  834. .if n \{\
  835. .RE
  836. .\}
  837. .sp
  838. you can set the filemode to true with
  839. .sp
  840. .if n \{\
  841. .RS 4
  842. .\}
  843. .nf
  844. % git config set core\&.filemode true
  845. .fi
  846. .if n \{\
  847. .RE
  848. .\}
  849. .sp
  850. The hypothetical proxy command entries actually have a postfix to discern what URL they apply to\&. Here is how to change the entry for kernel\&.org to "ssh"\&.
  851. .sp
  852. .if n \{\
  853. .RS 4
  854. .\}
  855. .nf
  856. % git config set \-\-value=\*(Aqfor kernel\&.org$\*(Aq core\&.gitproxy \*(Aq"ssh" for kernel\&.org\*(Aq
  857. .fi
  858. .if n \{\
  859. .RE
  860. .\}
  861. .sp
  862. This makes sure that only the key/value pair for kernel\&.org is replaced\&.
  863. .sp
  864. To delete the entry for renames, do
  865. .sp
  866. .if n \{\
  867. .RS 4
  868. .\}
  869. .nf
  870. % git config unset diff\&.renames
  871. .fi
  872. .if n \{\
  873. .RE
  874. .\}
  875. .sp
  876. If you want to delete an entry for a multivar (like core\&.gitproxy above), you have to provide a regex matching the value of exactly one line\&.
  877. .sp
  878. To query the value for a given key, do
  879. .sp
  880. .if n \{\
  881. .RS 4
  882. .\}
  883. .nf
  884. % git config get core\&.filemode
  885. .fi
  886. .if n \{\
  887. .RE
  888. .\}
  889. .sp
  890. or, to query a multivar:
  891. .sp
  892. .if n \{\
  893. .RS 4
  894. .\}
  895. .nf
  896. % git config get \-\-value="for kernel\&.org$" core\&.gitproxy
  897. .fi
  898. .if n \{\
  899. .RE
  900. .\}
  901. .sp
  902. If you want to know all the values for a multivar, do:
  903. .sp
  904. .if n \{\
  905. .RS 4
  906. .\}
  907. .nf
  908. % git config get \-\-all \-\-show\-names core\&.gitproxy
  909. .fi
  910. .if n \{\
  911. .RE
  912. .\}
  913. .sp
  914. If you like to live dangerously, you can replace \fBall\fR core\&.gitproxy by a new one with
  915. .sp
  916. .if n \{\
  917. .RS 4
  918. .\}
  919. .nf
  920. % git config set \-\-all core\&.gitproxy ssh
  921. .fi
  922. .if n \{\
  923. .RE
  924. .\}
  925. .sp
  926. However, if you really only want to replace the line for the default proxy, i\&.e\&. the one without a "for \&...\:" postfix, do something like this:
  927. .sp
  928. .if n \{\
  929. .RS 4
  930. .\}
  931. .nf
  932. % git config set \-\-value=\*(Aq! for \*(Aq core\&.gitproxy ssh
  933. .fi
  934. .if n \{\
  935. .RE
  936. .\}
  937. .sp
  938. To actually match only values with an exclamation mark, you have to
  939. .sp
  940. .if n \{\
  941. .RS 4
  942. .\}
  943. .nf
  944. % git config set \-\-value=\*(Aq[!]\*(Aq section\&.key value
  945. .fi
  946. .if n \{\
  947. .RE
  948. .\}
  949. .sp
  950. To add a new proxy, without altering any of the existing ones, use
  951. .sp
  952. .if n \{\
  953. .RS 4
  954. .\}
  955. .nf
  956. % git config set \-\-append core\&.gitproxy \*(Aq"proxy\-command" for example\&.com\*(Aq
  957. .fi
  958. .if n \{\
  959. .RE
  960. .\}
  961. .sp
  962. An example to use customized color from the configuration in your script:
  963. .sp
  964. .if n \{\
  965. .RS 4
  966. .\}
  967. .nf
  968. #!/bin/sh
  969. WS=$(git config get \-\-type=color \-\-default="blue reverse" color\&.diff\&.whitespace)
  970. RESET=$(git config get \-\-type=color \-\-default="reset" "")
  971. echo "${WS}your whitespace color or blue reverse${RESET}"
  972. .fi
  973. .if n \{\
  974. .RE
  975. .\}
  976. .sp
  977. For URLs in \fBhttps://weak\&.example\&.com\fR, \fBhttp\&.sslVerify\fR is set to false, while it is set to \fBtrue\fR for all others:
  978. .sp
  979. .if n \{\
  980. .RS 4
  981. .\}
  982. .nf
  983. % git config get \-\-type=bool \-\-url=https://good\&.example\&.com http\&.sslverify
  984. true
  985. % git config get \-\-type=bool \-\-url=https://weak\&.example\&.com http\&.sslverify
  986. false
  987. % git config get \-\-url=https://weak\&.example\&.com http
  988. http\&.cookieFile /tmp/cookie\&.txt
  989. http\&.sslverify false
  990. .fi
  991. .if n \{\
  992. .RE
  993. .\}
  994. .SH "CONFIGURATION FILE"
  995. .sp
  996. The Git configuration file contains a number of variables that affect the Git commands\*(Aq behavior\&. The files \&.\fBgit/config\fR and optionally \fBconfig\&.worktree\fR (see the "CONFIGURATION FILE" section of \fBgit-worktree\fR(1)) in each repository are used to store the configuration for that repository, and \fB$HOME/\&.gitconfig\fR is used to store a per\-user configuration as fallback values for the \&.\fBgit/config\fR file\&. The file \fB/etc/gitconfig\fR can be used to store a system\-wide default configuration\&.
  997. .sp
  998. The configuration variables are used by both the Git plumbing and the porcelain commands\&. The variables are divided into sections, wherein the fully qualified variable name of the variable itself is the last dot\-separated segment and the section name is everything before the last dot\&. The variable names are case\-insensitive, allow only alphanumeric characters and \fB\-\fR, and must start with an alphabetic character\&. Some variables may appear multiple times; we say then that the variable is multivalued\&.
  999. .SS "Syntax"
  1000. .sp
  1001. The syntax is fairly flexible and permissive\&. Whitespace characters, which in this context are the space character (SP) and the horizontal tabulation (HT), are mostly ignored\&. The \fI#\fR and \fI;\fR characters begin comments to the end of line\&. Blank lines are ignored\&.
  1002. .sp
  1003. The file consists of sections and variables\&. A section begins with the name of the section in square brackets and continues until the next section begins\&. Section names are case\-insensitive\&. Only alphanumeric characters, \fB\-\fR and \&. are allowed in section names\&. Each variable must belong to some section, which means that there must be a section header before the first setting of a variable\&.
  1004. .sp
  1005. Sections can be further divided into subsections\&. To begin a subsection put its name in double quotes, separated by space from the section name, in the section header, like in the example below:
  1006. .sp
  1007. .if n \{\
  1008. .RS 4
  1009. .\}
  1010. .nf
  1011.         [section "subsection"]
  1012. .fi
  1013. .if n \{\
  1014. .RE
  1015. .\}
  1016. .sp
  1017. Subsection names are case sensitive and can contain any characters except newline and the null byte\&. Doublequote " and backslash can be included by escaping them as \e" and \e\e, respectively\&. Backslashes preceding other characters are dropped when reading; for example, \et is read as \fBt\fR and \e0 is read as \fB0\fR\&. Section headers cannot span multiple lines\&. Variables may belong directly to a section or to a given subsection\&. You can have [\fBsection\fR] if you have [\fBsection\fR "subsection"], but you don\(cqt need to\&.
  1018. .sp
  1019. There is also a deprecated [\fBsection\&.subsection\fR] syntax\&. With this syntax, the subsection name is converted to lower\-case and is also compared case sensitively\&. These subsection names follow the same restrictions as section names\&.
  1020. .sp
  1021. All the other lines (and the remainder of the line after the section header) are recognized as setting variables, in the form \fIname = value\fR (or just \fIname\fR, which is a short\-hand to say that the variable is the boolean "true")\&. The variable names are case\-insensitive, allow only alphanumeric characters and \fB\-\fR, and must start with an alphabetic character\&.
  1022. .sp
  1023. Whitespace characters surrounding \fBname\fR, \fB=\fR and \fBvalue\fR are discarded\&. Internal whitespace characters within \fIvalue\fR are retained verbatim\&. Comments starting with either # or ; and extending to the end of line are discarded\&. A line that defines a value can be continued to the next line by ending it with a backslash (\e); the backslash and the end\-of\-line characters are discarded\&.
  1024. .sp
  1025. If \fBvalue\fR needs to contain leading or trailing whitespace characters, it must be enclosed in double quotation marks (")\&. Inside double quotation marks, double quote (") and backslash (\e) characters must be escaped: use \e" for " and \e\e for \e\&.
  1026. .sp
  1027. The following escape sequences (beside \e" and \e\e) are recognized: \en for newline character (NL), \et for horizontal tabulation (HT, TAB) and \eb for backspace (BS)\&. Other char escape sequences (including octal escape sequences) are invalid\&.
  1028. .SS "Includes"
  1029. .sp
  1030. The \fBinclude\fR and \fBincludeIf\fR sections allow you to include config directives from another source\&. These sections behave identically to each other with the exception that \fBincludeIf\fR sections may be ignored if their condition does not evaluate to true; see "Conditional includes" below\&.
  1031. .sp
  1032. You can include a config file from another by setting the special \fBinclude\&.path\fR (or \fBincludeIf\&.\fR*\&.\fBpath\fR) variable to the name of the file to be included\&. The variable takes a pathname as its value, and is subject to tilde expansion\&. These variables can be given multiple times\&.
  1033. .sp
  1034. The contents of the included file are inserted immediately, as if they had been found at the location of the include directive\&. If the value of the variable is a relative path, the path is considered to be relative to the configuration file in which the include directive was found\&. See below for examples\&.
  1035. .SS "Conditional includes"
  1036. .sp
  1037. You can conditionally include a config file from another by setting an \fBincludeIf\&.\fR\fI<condition>\fR\fB\&.path\fR variable to the name of the file to be included\&.
  1038. .sp
  1039. The condition starts with a keyword followed by a colon and some data whose format and meaning depends on the keyword\&. Supported keywords are:
  1040. .PP
  1041. \fBgitdir\fR
  1042. .RS 4
  1043. The data that follows the keyword
  1044. \fBgitdir:\fR
  1045. is used as a glob pattern\&. If the location of the \&.git directory matches the pattern, the include condition is met\&.
  1046. .sp
  1047. The \&.git location may be auto\-discovered, or come from
  1048. \fB$GIT_DIR\fR
  1049. environment variable\&. If the repository is auto\-discovered via a \&.git file (e\&.g\&. from submodules, or a linked worktree), the \&.git location would be the final location where the \&.git directory is, not where the \&.git file is\&.
  1050. .sp
  1051. The pattern can contain standard globbing wildcards and two additional ones, **/ and
  1052. \fB/\fR**, that can match multiple path components\&. Please refer to
  1053. \fBgitignore\fR(5)
  1054. for details\&. For convenience:
  1055. .sp
  1056. .RS 4
  1057. .ie n \{\
  1058. \h'-04'\(bu\h'+03'\c
  1059. .\}
  1060. .el \{\
  1061. .sp -1
  1062. .IP \(bu 2.3
  1063. .\}
  1064. If the pattern starts with
  1065. \fB~/\fR,
  1066. \fB~\fR
  1067. will be substituted with the content of the environment variable
  1068. \fBHOME\fR\&.
  1069. .RE
  1070. .sp
  1071. .RS 4
  1072. .ie n \{\
  1073. \h'-04'\(bu\h'+03'\c
  1074. .\}
  1075. .el \{\
  1076. .sp -1
  1077. .IP \(bu 2.3
  1078. .\}
  1079. If the pattern starts with \&.\fB/\fR, it is replaced with the directory containing the current config file\&.
  1080. .RE
  1081. .sp
  1082. .RS 4
  1083. .ie n \{\
  1084. \h'-04'\(bu\h'+03'\c
  1085. .\}
  1086. .el \{\
  1087. .sp -1
  1088. .IP \(bu 2.3
  1089. .\}
  1090. If the pattern does not start with either
  1091. \fB~/\fR, \&.\fB/\fR
  1092. or
  1093. \fB/\fR, **/ will be automatically prepended\&. For example, the pattern
  1094. \fBfoo/bar\fR
  1095. becomes **/foo/bar and would match
  1096. \fB/any/path/to/foo/bar\fR\&.
  1097. .RE
  1098. .sp
  1099. .RS 4
  1100. .ie n \{\
  1101. \h'-04'\(bu\h'+03'\c
  1102. .\}
  1103. .el \{\
  1104. .sp -1
  1105. .IP \(bu 2.3
  1106. .\}
  1107. If the pattern ends with
  1108. \fB/\fR, ** will be automatically added\&. For example, the pattern
  1109. \fBfoo/\fR
  1110. becomes
  1111. \fBfoo/\fR**\&. In other words, it matches "foo" and everything inside, recursively\&.
  1112. .RE
  1113. .RE
  1114. .PP
  1115. \fBgitdir/i\fR
  1116. .RS 4
  1117. This is the same as
  1118. \fBgitdir\fR
  1119. except that matching is done case\-insensitively (e\&.g\&. on case\-insensitive file systems)
  1120. .RE
  1121. .PP
  1122. \fBonbranch\fR
  1123. .RS 4
  1124. The data that follows the keyword
  1125. \fBonbranch:\fR
  1126. is taken to be a pattern with standard globbing wildcards and two additional ones, **/ and
  1127. \fB/\fR**, that can match multiple path components\&. If we are in a worktree where the name of the branch that is currently checked out matches the pattern, the include condition is met\&.
  1128. .sp
  1129. If the pattern ends with
  1130. \fB/\fR, ** will be automatically added\&. For example, the pattern
  1131. \fBfoo/\fR
  1132. becomes
  1133. \fBfoo/\fR**\&. In other words, it matches all branches that begin with
  1134. \fBfoo/\fR\&. This is useful if your branches are organized hierarchically and you would like to apply a configuration to all the branches in that hierarchy\&.
  1135. .RE
  1136. .PP
  1137. \fBhasconfig:remote\&.\fR*\&.\fBurl:\fR
  1138. .RS 4
  1139. The data that follows this keyword is taken to be a pattern with standard globbing wildcards and two additional ones, **/ and
  1140. \fB/\fR**, that can match multiple components\&. The first time this keyword is seen, the rest of the config files will be scanned for remote URLs (without applying any values)\&. If there exists at least one remote URL that matches this pattern, the include condition is met\&.
  1141. .sp
  1142. Files included by this option (directly or indirectly) are not allowed to contain remote URLs\&.
  1143. .sp
  1144. Note that unlike other includeIf conditions, resolving this condition relies on information that is not yet known at the point of reading the condition\&. A typical use case is this option being present as a system\-level or global\-level config, and the remote URL being in a local\-level config; hence the need to scan ahead when resolving this condition\&. In order to avoid the chicken\-and\-egg problem in which potentially\-included files can affect whether such files are potentially included, Git breaks the cycle by prohibiting these files from affecting the resolution of these conditions (thus, prohibiting them from declaring remote URLs)\&.
  1145. .sp
  1146. As for the naming of this keyword, it is for forwards compatibility with a naming scheme that supports more variable\-based include conditions, but currently Git only supports the exact keyword described above\&.
  1147. .RE
  1148. .sp
  1149. A few more notes on matching via \fBgitdir\fR and \fBgitdir/i\fR:
  1150. .sp
  1151. .RS 4
  1152. .ie n \{\
  1153. \h'-04'\(bu\h'+03'\c
  1154. .\}
  1155. .el \{\
  1156. .sp -1
  1157. .IP \(bu 2.3
  1158. .\}
  1159. Symlinks in
  1160. \fB$GIT_DIR\fR
  1161. are not resolved before matching\&.
  1162. .RE
  1163. .sp
  1164. .RS 4
  1165. .ie n \{\
  1166. \h'-04'\(bu\h'+03'\c
  1167. .\}
  1168. .el \{\
  1169. .sp -1
  1170. .IP \(bu 2.3
  1171. .\}
  1172. Both the symlink & realpath versions of paths will be matched outside of
  1173. \fB$GIT_DIR\fR\&. E\&.g\&. if ~/git is a symlink to /mnt/storage/git, both
  1174. \fBgitdir:~/git\fR
  1175. and
  1176. \fBgitdir:/mnt/storage/git\fR
  1177. will match\&.
  1178. .sp
  1179. This was not the case in the initial release of this feature in v2\&.13\&.0, which only matched the realpath version\&. Configuration that wants to be compatible with the initial release of this feature needs to either specify only the realpath version, or both versions\&.
  1180. .RE
  1181. .sp
  1182. .RS 4
  1183. .ie n \{\
  1184. \h'-04'\(bu\h'+03'\c
  1185. .\}
  1186. .el \{\
  1187. .sp -1
  1188. .IP \(bu 2.3
  1189. .\}
  1190. Note that "\&.\&./" is not special and will match literally, which is unlikely what you want\&.
  1191. .RE
  1192. .SS "Example"
  1193. .sp
  1194. .if n \{\
  1195. .RS 4
  1196. .\}
  1197. .nf
  1198. # Core variables
  1199. [core]
  1200.         ; Don\*(Aqt trust file modes
  1201.         filemode = false
  1203. # Our diff algorithm
  1204. [diff]
  1205.         external = /usr/local/bin/diff\-wrapper
  1206.         renames = true
  1208. [branch "devel"]
  1209.         remote = origin
  1210.         merge = refs/heads/devel
  1212. # Proxy settings
  1213. [core]
  1214.         gitProxy="ssh" for "kernel\&.org"
  1215.         gitProxy=default\-proxy ; for the rest
  1217. [include]
  1218.         path = /path/to/foo\&.inc ; include by absolute path
  1219.         path = foo\&.inc ; find "foo\&.inc" relative to the current file
  1220.         path = ~/foo\&.inc ; find "foo\&.inc" in your `$HOME` directory
  1222. ; include if $GIT_DIR is /path/to/foo/\&.git
  1223. [includeIf "gitdir:/path/to/foo/\&.git"]
  1224.         path = /path/to/foo\&.inc
  1226. ; include for all repositories inside /path/to/group
  1227. [includeIf "gitdir:/path/to/group/"]
  1228.         path = /path/to/foo\&.inc
  1230. ; include for all repositories inside $HOME/to/group
  1231. [includeIf "gitdir:~/to/group/"]
  1232.         path = /path/to/foo\&.inc
  1234. ; relative paths are always relative to the including
  1235. ; file (if the condition is true); their location is not
  1236. ; affected by the condition
  1237. [includeIf "gitdir:/path/to/group/"]
  1238.         path = foo\&.inc
  1240. ; include only if we are in a worktree where foo\-branch is
  1241. ; currently checked out
  1242. [includeIf "onbranch:foo\-branch"]
  1243.         path = foo\&.inc
  1245. ; include only if a remote with the given URL exists (note
  1246. ; that such a URL may be provided later in a file or in a
  1247. ; file read after this file is read, as seen in this example)
  1248. [includeIf "hasconfig:remote\&.*\&.url:https://example\&.com/**"]
  1249.         path = foo\&.inc
  1250. [remote "origin"]
  1251.         url = https://example\&.com/git
  1252. .fi
  1253. .if n \{\
  1254. .RE
  1255. .\}
  1256. .SS "Values"
  1257. .sp
  1258. Values of many variables are treated as a simple string, but there are variables that take values of specific types and there are rules as to how to spell them\&.
  1259. .PP
  1260. boolean
  1261. .RS 4
  1262. When a variable is said to take a boolean value, many synonyms are accepted for
  1263. \fItrue\fR
  1264. and
  1265. \fIfalse\fR; these are all case\-insensitive\&.
  1266. .PP
  1267. true
  1268. .RS 4
  1269. Boolean true literals are
  1270. \fByes\fR,
  1271. \fBon\fR,
  1272. \fBtrue\fR, and
  1273. \fB1\fR\&. Also, a variable defined without
  1274. \fB=\fR
  1275. \fI<value>\fR
  1276. is taken as true\&.
  1277. .RE
  1278. .PP
  1279. false
  1280. .RS 4
  1281. Boolean false literals are
  1282. \fBno\fR,
  1283. \fBoff\fR,
  1284. \fBfalse\fR,
  1285. \fB0\fR
  1286. and the empty string\&.
  1287. .sp
  1288. When converting a value to its canonical form using the
  1289. \fB\-\-type=bool\fR
  1290. type specifier,
  1291. \fIgit config\fR
  1292. will ensure that the output is "true" or "false" (spelled in lowercase)\&.
  1293. .RE
  1294. .RE
  1295. .PP
  1296. integer
  1297. .RS 4
  1298. The value for many variables that specify various sizes can be suffixed with
  1299. \fBk\fR,
  1300. \fBM\fR,\&...\: to mean "scale the number by 1024", "by 1024x1024", etc\&.
  1301. .RE
  1302. .PP
  1303. color
  1304. .RS 4
  1305. The value for a variable that takes a color is a list of colors (at most two, one for foreground and one for background) and attributes (as many as you want), separated by spaces\&.
  1306. .sp
  1307. The basic colors accepted are
  1308. \fBnormal\fR,
  1309. \fBblack\fR,
  1310. \fBred\fR,
  1311. \fBgreen\fR,
  1312. \fByellow\fR,
  1313. \fBblue\fR,
  1314. \fBmagenta\fR,
  1315. \fBcyan\fR,
  1316. \fBwhite\fR
  1317. and
  1318. \fBdefault\fR\&. The first color given is the foreground; the second is the background\&. All the basic colors except
  1319. \fBnormal\fR
  1320. and
  1321. \fBdefault\fR
  1322. have a bright variant that can be specified by prefixing the color with
  1323. \fBbright\fR, like
  1324. \fBbrightred\fR\&.
  1325. .sp
  1326. The color
  1327. \fBnormal\fR
  1328. makes no change to the color\&. It is the same as an empty string, but can be used as the foreground color when specifying a background color alone (for example, "normal red")\&.
  1329. .sp
  1330. The color
  1331. \fBdefault\fR
  1332. explicitly resets the color to the terminal default, for example to specify a cleared background\&. Although it varies between terminals, this is usually not the same as setting to "white black"\&.
  1333. .sp
  1334. Colors may also be given as numbers between 0 and 255; these use ANSI 256\-color mode (but note that not all terminals may support this)\&. If your terminal supports it, you may also specify 24\-bit RGB values as hex, like #ff0ab3, or 12\-bit RGB values like #f1b, which is equivalent to the 24\-bit color #ff11bb\&.
  1335. .sp
  1336. The accepted attributes are
  1337. \fBbold\fR,
  1338. \fBdim\fR,
  1339. \fBul\fR,
  1340. \fBblink\fR,
  1341. \fBreverse\fR,
  1342. \fBitalic\fR, and
  1343. \fBstrike\fR
  1344. (for crossed\-out or "strikethrough" letters)\&. The position of any attributes with respect to the colors (before, after, or in between), doesn\(cqt matter\&. Specific attributes may be turned off by prefixing them with
  1345. \fBno\fR
  1346. or
  1347. \fBno\-\fR
  1348. (e\&.g\&.,
  1349. \fBnoreverse\fR,
  1350. \fBno\-ul\fR, etc)\&.
  1351. .sp
  1352. The pseudo\-attribute
  1353. \fBreset\fR
  1354. resets all colors and attributes before applying the specified coloring\&. For example,
  1355. \fBreset\fR
  1356. \fBgreen\fR
  1357. will result in a green foreground and default background without any active attributes\&.
  1358. .sp
  1359. An empty color string produces no color effect at all\&. This can be used to avoid coloring specific elements without disabling color entirely\&.
  1360. .sp
  1361. For git\(cqs pre\-defined color slots, the attributes are meant to be reset at the beginning of each item in the colored output\&. So setting
  1362. \fBcolor\&.decorate\&.branch\fR
  1363. to
  1364. \fBblack\fR
  1365. will paint that branch name in a plain
  1366. \fBblack\fR, even if the previous thing on the same output line (e\&.g\&. opening parenthesis before the list of branch names in
  1367. \fBlog\fR
  1368. \fB\-\-decorate\fR
  1369. output) is set to be painted with
  1370. \fBbold\fR
  1371. or some other attribute\&. However, custom log formats may do more complicated and layered coloring, and the negated forms may be useful there\&.
  1372. .RE
  1373. .PP
  1374. pathname
  1375. .RS 4
  1376. A variable that takes a pathname value can be given a string that begins with "\fB~/\fR" or "\fB~user/\fR", and the usual tilde expansion happens to such a string:
  1377. \fB~/\fR
  1378. is expanded to the value of
  1379. \fB$HOME\fR, and
  1380. \fB~user/\fR
  1381. to the specified user\(cqs home directory\&.
  1382. .sp
  1383. If a path starts with %(\fBprefix\fR)\fB/\fR, the remainder is interpreted as a path relative to Git\(cqs "runtime prefix", i\&.e\&. relative to the location where Git itself was installed\&. For example, %(\fBprefix\fR)\fB/bin/\fR
  1384. refers to the directory in which the Git executable itself lives\&. If Git was compiled without runtime prefix support, the compiled\-in prefix will be substituted instead\&. In the unlikely event that a literal path needs to be specified that should
  1385. \fInot\fR
  1386. be expanded, it needs to be prefixed by \&.\fB/\fR, like so: \&.\fB/\fR%(\fBprefix\fR)\fB/bin\fR\&.
  1387. .RE
  1388. .SS "Variables"
  1389. .sp
  1390. Note that this list is non\-comprehensive and not necessarily complete\&. For command\-specific variables, you will find a more detailed description in the appropriate manual page\&.
  1391. .sp
  1392. Other git\-related tools may and do use their own variables\&. When inventing new variables for use in your own tool, make sure their names do not conflict with those that are used by Git itself and other popular tools, and describe them in your documentation\&.
  1393. .PP
  1394. \fBadd\&.ignoreErrors\fR, \fBadd\&.ignore\-errors\fR (deprecated)
  1395. .RS 4
  1396. Tells
  1397. \fBgit\fR
  1398. \fBadd\fR
  1399. to continue adding files when some files cannot be added due to indexing errors\&. Equivalent to the
  1400. \fB\-\-ignore\-errors\fR
  1401. option of
  1402. \fBgit-add\fR(1)\&.
  1403. \fBadd\&.ignore\-errors\fR
  1404. is deprecated, as it does not follow the usual naming convention for configuration variables\&.
  1405. .RE
  1406. .PP
  1407. advice\&.*
  1408. .RS 4
  1409. These variables control various optional help messages designed to aid new users\&. When left unconfigured, Git will give the message alongside instructions on how to squelch it\&. You can tell Git that you have understood the issue and no longer need a specific help message by setting the corresponding variable to
  1410. \fBfalse\fR\&.
  1411. .sp
  1412. As they are intended to help human users, these messages are output to the standard error\&. When tools that run Git as a subprocess find them disruptive, they can set
  1413. \fBGIT_ADVICE=0\fR
  1414. in the environment to squelch all advice messages\&.
  1415. .PP
  1416. addEmbeddedRepo
  1417. .RS 4
  1418. Shown when the user accidentally adds one git repo inside of another\&.
  1419. .RE
  1420. .PP
  1421. addEmptyPathspec
  1422. .RS 4
  1423. Shown when the user runs
  1424. \fBgit\fR
  1425. \fBadd\fR
  1426. without providing the pathspec parameter\&.
  1427. .RE
  1428. .PP
  1429. addIgnoredFile
  1430. .RS 4
  1431. Shown when the user attempts to add an ignored file to the index\&.
  1432. .RE
  1433. .PP
  1434. amWorkDir
  1435. .RS 4
  1436. Shown when
  1437. \fBgit-am\fR(1)
  1438. fails to apply a patch file, to tell the user the location of the file\&.
  1439. .RE
  1440. .PP
  1441. ambiguousFetchRefspec
  1442. .RS 4
  1443. Shown when a fetch refspec for multiple remotes maps to the same remote\-tracking branch namespace and causes branch tracking set\-up to fail\&.
  1444. .RE
  1445. .PP
  1446. checkoutAmbiguousRemoteBranchName
  1447. .RS 4
  1448. Shown when the argument to
  1449. \fBgit-checkout\fR(1)
  1450. and
  1451. \fBgit-switch\fR(1)
  1452. ambiguously resolves to a remote tracking branch on more than one remote in situations where an unambiguous argument would have otherwise caused a remote\-tracking branch to be checked out\&. See the
  1453. \fBcheckout\&.defaultRemote\fR
  1454. configuration variable for how to set a given remote to be used by default in some situations where this advice would be printed\&.
  1455. .RE
  1456. .PP
  1457. commitBeforeMerge
  1458. .RS 4
  1459. Shown when
  1460. \fBgit-merge\fR(1)
  1461. refuses to merge to avoid overwriting local changes\&.
  1462. .RE
  1463. .PP
  1464. detachedHead
  1465. .RS 4
  1466. Shown when the user uses
  1467. \fBgit-switch\fR(1)
  1468. or
  1469. \fBgit-checkout\fR(1)
  1470. to move to the detached HEAD state, to tell the user how to create a local branch after the fact\&.
  1471. .RE
  1472. .PP
  1473. diverging
  1474. .RS 4
  1475. Shown when a fast\-forward is not possible\&.
  1476. .RE
  1477. .PP
  1478. fetchShowForcedUpdates
  1479. .RS 4
  1480. Shown when
  1481. \fBgit-fetch\fR(1)
  1482. takes a long time to calculate forced updates after ref updates, or to warn that the check is disabled\&.
  1483. .RE
  1484. .PP
  1485. forceDeleteBranch
  1486. .RS 4
  1487. Shown when the user tries to delete a not fully merged branch without the force option set\&.
  1488. .RE
  1489. .PP
  1490. ignoredHook
  1491. .RS 4
  1492. Shown when a hook is ignored because the hook is not set as executable\&.
  1493. .RE
  1494. .PP
  1495. implicitIdentity
  1496. .RS 4
  1497. Shown when the user\(cqs information is guessed from the system username and domain name, to tell the user how to set their identity configuration\&.
  1498. .RE
  1499. .PP
  1500. mergeConflict
  1501. .RS 4
  1502. Shown when various commands stop because of conflicts\&.
  1503. .RE
  1504. .PP
  1505. nestedTag
  1506. .RS 4
  1507. Shown when a user attempts to recursively tag a tag object\&.
  1508. .RE
  1509. .PP
  1510. pushAlreadyExists
  1511. .RS 4
  1512. Shown when
  1513. \fBgit-push\fR(1)
  1514. rejects an update that does not qualify for fast\-forwarding (e\&.g\&., a tag\&.)
  1515. .RE
  1516. .PP
  1517. pushFetchFirst
  1518. .RS 4
  1519. Shown when
  1520. \fBgit-push\fR(1)
  1521. rejects an update that tries to overwrite a remote ref that points at an object we do not have\&.
  1522. .RE
  1523. .PP
  1524. pushNeedsForce
  1525. .RS 4
  1526. Shown when
  1527. \fBgit-push\fR(1)
  1528. rejects an update that tries to overwrite a remote ref that points at an object that is not a commit\-ish, or make the remote ref point at an object that is not a commit\-ish\&.
  1529. .RE
  1530. .PP
  1531. pushNonFFCurrent
  1532. .RS 4
  1533. Shown when
  1534. \fBgit-push\fR(1)
  1535. fails due to a non\-fast\-forward update to the current branch\&.
  1536. .RE
  1537. .PP
  1538. pushNonFFMatching
  1539. .RS 4
  1540. Shown when the user ran
  1541. \fBgit-push\fR(1)
  1542. and pushed "matching refs" explicitly (i\&.e\&. used
  1543. \fB:\fR, or specified a refspec that isn\(cqt the current branch) and it resulted in a non\-fast\-forward error\&.
  1544. .RE
  1545. .PP
  1546. pushRefNeedsUpdate
  1547. .RS 4
  1548. Shown when
  1549. \fBgit-push\fR(1)
  1550. rejects a forced update of a branch when its remote\-tracking ref has updates that we do not have locally\&.
  1551. .RE
  1552. .PP
  1553. pushUnqualifiedRefname
  1554. .RS 4
  1555. Shown when
  1556. \fBgit-push\fR(1)
  1557. gives up trying to guess based on the source and destination refs what remote ref namespace the source belongs in, but where we can still suggest that the user push to either
  1558. \fBrefs/heads/\fR* or
  1559. \fBrefs/tags/\fR* based on the type of the source object\&.
  1560. .RE
  1561. .PP
  1562. pushUpdateRejected
  1563. .RS 4
  1564. Set this variable to
  1565. \fBfalse\fR
  1566. if you want to disable
  1567. \fBpushNonFFCurrent\fR,
  1568. \fBpushNonFFMatching\fR,
  1569. \fBpushAlreadyExists\fR,
  1570. \fBpushFetchFirst\fR,
  1571. \fBpushNeedsForce\fR, and
  1572. \fBpushRefNeedsUpdate\fR
  1573. simultaneously\&.
  1574. .RE
  1575. .PP
  1576. rebaseTodoError
  1577. .RS 4
  1578. Shown when there is an error after editing the rebase todo list\&.
  1579. .RE
  1580. .PP
  1581. refSyntax
  1582. .RS 4
  1583. Shown when the user provides an illegal ref name, to tell the user about the ref syntax documentation\&.
  1584. .RE
  1585. .PP
  1586. resetNoRefresh
  1587. .RS 4
  1588. Shown when
  1589. \fBgit-reset\fR(1)
  1590. takes more than 2 seconds to refresh the index after reset, to tell the user that they can use the
  1591. \fB\-\-no\-refresh\fR
  1592. option\&.
  1593. .RE
  1594. .PP
  1595. resolveConflict
  1596. .RS 4
  1597. Shown by various commands when conflicts prevent the operation from being performed\&.
  1598. .RE
  1599. .PP
  1600. rmHints
  1601. .RS 4
  1602. Shown on failure in the output of
  1603. \fBgit-rm\fR(1), to give directions on how to proceed from the current state\&.
  1604. .RE
  1605. .PP
  1606. sequencerInUse
  1607. .RS 4
  1608. Shown when a sequencer command is already in progress\&.
  1609. .RE
  1610. .PP
  1611. skippedCherryPicks
  1612. .RS 4
  1613. Shown when
  1614. \fBgit-rebase\fR(1)
  1615. skips a commit that has already been cherry\-picked onto the upstream branch\&.
  1616. .RE
  1617. .PP
  1618. sparseIndexExpanded
  1619. .RS 4
  1620. Shown when a sparse index is expanded to a full index, which is likely due to an unexpected set of files existing outside of the sparse\-checkout\&.
  1621. .RE
  1622. .PP
  1623. statusAheadBehind
  1624. .RS 4
  1625. Shown when
  1626. \fBgit-status\fR(1)
  1627. computes the ahead/behind counts for a local ref compared to its remote tracking ref, and that calculation takes longer than expected\&. Will not appear if
  1628. \fBstatus\&.aheadBehind\fR
  1629. is false or the option
  1630. \fB\-\-no\-ahead\-behind\fR
  1631. is given\&.
  1632. .RE
  1633. .PP
  1634. statusHints
  1635. .RS 4
  1636. Show directions on how to proceed from the current state in the output of
  1637. \fBgit-status\fR(1), in the template shown when writing commit messages in
  1638. \fBgit-commit\fR(1), and in the help message shown by
  1639. \fBgit-switch\fR(1)
  1640. or
  1641. \fBgit-checkout\fR(1)
  1642. when switching branches\&.
  1643. .RE
  1644. .PP
  1645. statusUoption
  1646. .RS 4
  1647. Shown when
  1648. \fBgit-status\fR(1)
  1649. takes more than 2 seconds to enumerate untracked files, to tell the user that they can use the
  1650. \fB\-u\fR
  1651. option\&.
  1652. .RE
  1653. .PP
  1654. submoduleAlternateErrorStrategyDie
  1655. .RS 4
  1656. Shown when a submodule\&.alternateErrorStrategy option configured to "die" causes a fatal error\&.
  1657. .RE
  1658. .PP
  1659. submoduleMergeConflict
  1660. .RS 4
  1661. Advice shown when a non\-trivial submodule merge conflict is encountered\&.
  1662. .RE
  1663. .PP
  1664. submodulesNotUpdated
  1665. .RS 4
  1666. Shown when a user runs a submodule command that fails because
  1667. \fBgit\fR
  1668. \fBsubmodule\fR
  1669. \fBupdate\fR
  1670. \fB\-\-init\fR
  1671. was not run\&.
  1672. .RE
  1673. .PP
  1674. suggestDetachingHead
  1675. .RS 4
  1676. Shown when
  1677. \fBgit-switch\fR(1)
  1678. refuses to detach HEAD without the explicit
  1679. \fB\-\-detach\fR
  1680. option\&.
  1681. .RE
  1682. .PP
  1683. updateSparsePath
  1684. .RS 4
  1685. Shown when either
  1686. \fBgit-add\fR(1)
  1687. or
  1688. \fBgit-rm\fR(1)
  1689. is asked to update index entries outside the current sparse checkout\&.
  1690. .RE
  1691. .PP
  1692. waitingForEditor
  1693. .RS 4
  1694. Shown when Git is waiting for editor input\&. Relevant when e\&.g\&. the editor is not launched inside the terminal\&.
  1695. .RE
  1696. .PP
  1697. worktreeAddOrphan
  1698. .RS 4
  1699. Shown when the user tries to create a worktree from an invalid reference, to tell the user how to create a new unborn branch instead\&.
  1700. .RE
  1701. .RE
  1702. .PP
  1703. alias\&.*
  1704. .RS 4
  1705. Command aliases for the
  1706. \fBgit\fR(1)
  1707. command wrapper \- e\&.g\&. after defining
  1708. \fBalias\&.last\fR
  1709. \fB=\fR
  1710. \fBcat\-file\fR
  1711. \fBcommit\fR
  1712. \fBHEAD\fR, the invocation
  1713. \fBgit\fR
  1714. \fBlast\fR
  1715. is equivalent to
  1716. \fBgit\fR
  1717. \fBcat\-file\fR
  1718. \fBcommit\fR
  1719. \fBHEAD\fR\&. To avoid confusion and troubles with script usage, aliases that hide existing Git commands are ignored\&. Arguments are split by spaces, the usual shell quoting and escaping are supported\&. A quote pair or a backslash can be used to quote them\&.
  1720. .sp
  1721. Note that the first word of an alias does not necessarily have to be a command\&. It can be a command\-line option that will be passed into the invocation of
  1722. \fBgit\fR\&. In particular, this is useful when used with
  1723. \fB\-c\fR
  1724. to pass in one\-time configurations or
  1725. \fB\-p\fR
  1726. to force pagination\&. For example,
  1727. \fBloud\-rebase\fR
  1728. \fB=\fR
  1729. \fB\-c\fR
  1730. \fBcommit\&.verbose=true\fR
  1731. \fBrebase\fR
  1732. can be defined such that running
  1733. \fBgit\fR
  1734. \fBloud\-rebase\fR
  1735. would be equivalent to
  1736. \fBgit\fR
  1737. \fB\-c\fR
  1738. \fBcommit\&.verbose=true\fR
  1739. \fBrebase\fR\&. Also,
  1740. \fBps\fR
  1741. \fB=\fR
  1742. \fB\-p\fR
  1743. \fBstatus\fR
  1744. would be a helpful alias since
  1745. \fBgit\fR
  1746. \fBps\fR
  1747. would paginate the output of
  1748. \fBgit\fR
  1749. \fBstatus\fR
  1750. where the original command does not\&.
  1751. .sp
  1752. If the alias expansion is prefixed with an exclamation point, it will be treated as a shell command\&. For example, defining
  1753. \fBalias\&.new\fR
  1754. \fB=\fR
  1755. !gitk
  1756. \fB\-\-all\fR
  1757. \fB\-\-not\fR
  1758. \fBORIG_HEAD\fR, the invocation
  1759. \fBgit\fR
  1760. \fBnew\fR
  1761. is equivalent to running the shell command
  1762. \fBgitk\fR
  1763. \fB\-\-all\fR
  1764. \fB\-\-not\fR
  1765. \fBORIG_HEAD\fR\&. Note:
  1766. .sp
  1767. .RS 4
  1768. .ie n \{\
  1769. \h'-04'\(bu\h'+03'\c
  1770. .\}
  1771. .el \{\
  1772. .sp -1
  1773. .IP \(bu 2.3
  1774. .\}
  1775. Shell commands will be executed from the top\-level directory of a repository, which may not necessarily be the current directory\&.
  1776. .RE
  1777. .sp
  1778. .RS 4
  1779. .ie n \{\
  1780. \h'-04'\(bu\h'+03'\c
  1781. .\}
  1782. .el \{\
  1783. .sp -1
  1784. .IP \(bu 2.3
  1785. .\}
  1786. \fBGIT_PREFIX\fR
  1787. is set as returned by running
  1788. \fBgit\fR
  1789. \fBrev\-parse\fR
  1790. \fB\-\-show\-prefix\fR
  1791. from the original current directory\&. See
  1792. \fBgit-rev-parse\fR(1)\&.
  1793. .RE
  1794. .sp
  1795. .RS 4
  1796. .ie n \{\
  1797. \h'-04'\(bu\h'+03'\c
  1798. .\}
  1799. .el \{\
  1800. .sp -1
  1801. .IP \(bu 2.3
  1802. .\}
  1803. Shell command aliases always receive any extra arguments provided to the Git command\-line as positional arguments\&.
  1804. .sp
  1805. .RS 4
  1806. .ie n \{\
  1807. \h'-04'\(bu\h'+03'\c
  1808. .\}
  1809. .el \{\
  1810. .sp -1
  1811. .IP \(bu 2.3
  1812. .\}
  1813. Care should be taken if your shell alias is a "one\-liner" script with multiple commands (e\&.g\&. in a pipeline), references multiple arguments, or is otherwise not able to handle positional arguments added at the end\&. For example:
  1814. \fBalias\&.cmd\fR
  1815. \fB=\fR
  1816. "!echo
  1817. \fB$1\fR
  1818. |
  1819. \fBgrep\fR
  1820. \fB$2\fR" called as
  1821. \fBgit\fR
  1822. \fBcmd\fR
  1823. \fB1\fR
  1824. \fB2\fR
  1825. will be executed as
  1826. \fIecho $1 | grep $2 1 2\fR, which is not what you want\&.
  1827. .RE
  1828. .sp
  1829. .RS 4
  1830. .ie n \{\
  1831. \h'-04'\(bu\h'+03'\c
  1832. .\}
  1833. .el \{\
  1834. .sp -1
  1835. .IP \(bu 2.3
  1836. .\}
  1837. A convenient way to deal with this is to write your script operations in an inline function that is then called with any arguments from the command\-line\&. For example `alias\&.cmd = "!c() { echo $1 | grep $2 ; }; c" will correctly execute the prior example\&.
  1838. .RE
  1839. .sp
  1840. .RS 4
  1841. .ie n \{\
  1842. \h'-04'\(bu\h'+03'\c
  1843. .\}
  1844. .el \{\
  1845. .sp -1
  1846. .IP \(bu 2.3
  1847. .\}
  1848. Setting
  1849. \fBGIT_TRACE=1\fR
  1850. can help you debug the command being run for your alias\&.
  1851. .RE
  1852. .RE
  1853. .RE
  1854. .PP
  1855. am\&.keepcr
  1856. .RS 4
  1857. If true, git\-am will call git\-mailsplit for patches in mbox format with parameter
  1858. \fB\-\-keep\-cr\fR\&. In this case git\-mailsplit will not remove \er from lines ending with \er\en\&. Can be overridden by giving
  1859. \fB\-\-no\-keep\-cr\fR
  1860. from the command line\&. See
  1861. \fBgit-am\fR(1),
  1862. \fBgit-mailsplit\fR(1)\&.
  1863. .RE
  1864. .PP
  1865. am\&.threeWay
  1866. .RS 4
  1867. By default,
  1868. \fBgit\fR
  1869. \fBam\fR
  1870. will fail if the patch does not apply cleanly\&. When set to true, this setting tells
  1871. \fBgit\fR
  1872. \fBam\fR
  1873. to fall back on 3\-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally (equivalent to giving the
  1874. \fB\-\-3way\fR
  1875. option from the command line)\&. Defaults to
  1876. \fBfalse\fR\&. See
  1877. \fBgit-am\fR(1)\&.
  1878. .RE
  1879. .PP
  1880. apply\&.ignoreWhitespace
  1881. .RS 4
  1882. When set to
  1883. \fIchange\fR, tells
  1884. \fIgit apply\fR
  1885. to ignore changes in whitespace, in the same way as the
  1886. \fB\-\-ignore\-space\-change\fR
  1887. option\&. When set to one of: no, none, never, false, it tells
  1888. \fIgit apply\fR
  1889. to respect all whitespace differences\&. See
  1890. \fBgit-apply\fR(1)\&.
  1891. .RE
  1892. .PP
  1893. apply\&.whitespace
  1894. .RS 4
  1895. Tells
  1896. \fIgit apply\fR
  1897. how to handle whitespace, in the same way as the
  1898. \fB\-\-whitespace\fR
  1899. option\&. See
  1900. \fBgit-apply\fR(1)\&.
  1901. .RE
  1902. .PP
  1903. attr\&.tree
  1904. .RS 4
  1905. A reference to a tree in the repository from which to read attributes, instead of the \&.\fBgitattributes\fR
  1906. file in the working tree\&. If the value does not resolve to a valid tree object, an empty tree is used instead\&. When the
  1907. \fBGIT_ATTR_SOURCE\fR
  1908. environment variable or
  1909. \fB\-\-attr\-source\fR
  1910. command line option are used, this configuration variable has no effect\&.
  1911. .RE
  1912. .if n \{\
  1913. .sp
  1914. .\}
  1915. .RS 4
  1916. .it 1 an-trap
  1917. .nr an-no-space-flag 1
  1918. .nr an-break-flag 1
  1919. .br
  1920. .ps +1
  1921. \fBNote\fR
  1922. .ps -1
  1923. .br
  1924. .sp
  1925. The configuration options in \fBbitmapPseudoMerge\&.\fR* are considered EXPERIMENTAL and may be subject to change or be removed entirely in the future\&. For more information about the pseudo\-merge bitmap feature, see the "Pseudo\-merge bitmaps" section of \fBgitpacking\fR(7)\&.
  1926. .sp .5v
  1927. .RE
  1928. .PP
  1929. bitmapPseudoMerge\&.<name>\&.pattern
  1930. .RS 4
  1931. Regular expression used to match reference names\&. Commits pointed to by references matching this pattern (and meeting the below criteria, like
  1932. \fBbitmapPseudoMerge\&.\fR\fI<name>\fR\fB\&.sampleRate\fR
  1933. and
  1934. \fBbitmapPseudoMerge\&.\fR\fI<name>\fR\fB\&.threshold\fR) will be considered for inclusion in a pseudo\-merge bitmap\&.
  1935. .sp
  1936. Commits are grouped into pseudo\-merge groups based on whether or not any reference(s) that point at a given commit match the pattern, which is an extended regular expression\&.
  1937. .sp
  1938. Within a pseudo\-merge group, commits may be further grouped into sub\-groups based on the capture groups in the pattern\&. These sub\-groupings are formed from the regular expressions by concatenating any capture groups from the regular expression, with a
  1939. \fI\-\fR
  1940. dash in between\&.
  1941. .sp
  1942. For example, if the pattern is
  1943. \fBrefs/tags/\fR, then all tags (provided they meet the below criteria) will be considered candidates for the same pseudo\-merge group\&. However, if the pattern is instead
  1944. \fBrefs/remotes/\fR([\fB0\-9\fR])\fB+/tags/\fR, then tags from different remotes will be grouped into separate pseudo\-merge groups, based on the remote number\&.
  1945. .RE
  1946. .PP
  1947. bitmapPseudoMerge\&.<name>\&.decay
  1948. .RS 4
  1949. Determines the rate at which consecutive pseudo\-merge bitmap groups decrease in size\&. Must be non\-negative\&. This parameter can be thought of as
  1950. \fBk\fR
  1951. in the function
  1952. \fBf\fR(\fBn\fR)
  1953. \fB=\fR
  1954. \fBC\fR
  1955. *
  1956. \fBn^\-k\fR, where
  1957. \fBf\fR(\fBn\fR) is the size of the `n`th group\&.
  1958. .sp
  1959. Setting the decay rate equal to
  1960. \fB0\fR
  1961. will cause all groups to be the same size\&. Setting the decay rate equal to
  1962. \fB1\fR
  1963. will cause the
  1964. \fBn\fR`th
  1965. \fBgroup\fR
  1966. \fBto\fR
  1967. \fBbe\fR
  1968. `1/n the size of the initial group\&. Higher values of the decay rate cause consecutive groups to shrink at an increasing rate\&. The default is
  1969. \fB1\fR\&.
  1970. .sp
  1971. If all groups are the same size, it is possible that groups containing newer commits will be able to be used less often than earlier groups, since it is more likely that the references pointing at newer commits will be updated more often than a reference pointing at an old commit\&.
  1972. .RE
  1973. .PP
  1974. bitmapPseudoMerge\&.<name>\&.sampleRate
  1975. .RS 4
  1976. Determines the proportion of non\-bitmapped commits (among reference tips) which are selected for inclusion in an unstable pseudo\-merge bitmap\&. Must be between
  1977. \fB0\fR
  1978. and
  1979. \fB1\fR
  1980. (inclusive)\&. The default is
  1981. \fB1\fR\&.
  1982. .RE
  1983. .PP
  1984. bitmapPseudoMerge\&.<name>\&.threshold
  1985. .RS 4
  1986. Determines the minimum age of non\-bitmapped commits (among reference tips, as above) which are candidates for inclusion in an unstable pseudo\-merge bitmap\&. The default is
  1987. \fB1\&.week\&.ago\fR\&.
  1988. .RE
  1989. .PP
  1990. bitmapPseudoMerge\&.<name>\&.maxMerges
  1991. .RS 4
  1992. Determines the maximum number of pseudo\-merge commits among which commits may be distributed\&.
  1993. .sp
  1994. For pseudo\-merge groups whose pattern does not contain any capture groups, this setting is applied for all commits matching the regular expression\&. For patterns that have one or more capture groups, this setting is applied for each distinct capture group\&.
  1995. .sp
  1996. For example, if your capture group is
  1997. \fBrefs/tags/\fR, then this setting will distribute all tags into a maximum of
  1998. \fBmaxMerges\fR
  1999. pseudo\-merge commits\&. However, if your capture group is, say,
  2000. \fBrefs/remotes/\fR([\fB0\-9\fR]\fB+\fR)\fB/tags/\fR, then this setting will be applied to each remote\(cqs set of tags individually\&.
  2001. .sp
  2002. Must be non\-negative\&. The default value is 64\&.
  2003. .RE
  2004. .PP
  2005. bitmapPseudoMerge\&.<name>\&.stableThreshold
  2006. .RS 4
  2007. Determines the minimum age of commits (among reference tips, as above, however stable commits are still considered candidates even when they have been covered by a bitmap) which are candidates for a stable a pseudo\-merge bitmap\&. The default is
  2008. \fB1\&.month\&.ago\fR\&.
  2009. .sp
  2010. Setting this threshold to a smaller value (e\&.g\&., 1\&.week\&.ago) will cause more stable groups to be generated (which impose a one\-time generation cost) but those groups will likely become stale over time\&. Using a larger value incurs the opposite penalty (fewer stable groups which are more useful)\&.
  2011. .RE
  2012. .PP
  2013. bitmapPseudoMerge\&.<name>\&.stableSize
  2014. .RS 4
  2015. Determines the size (in number of commits) of a stable psuedo\-merge bitmap\&. The default is
  2016. \fB512\fR\&.
  2017. .RE
  2018. .PP
  2019. blame\&.blankBoundary
  2020. .RS 4
  2021. Show blank commit object name for boundary commits in
  2022. \fBgit-blame\fR(1)\&. This option defaults to false\&.
  2023. .RE
  2024. .PP
  2025. blame\&.coloring
  2026. .RS 4
  2027. This determines the coloring scheme to be applied to blame output\&. It can be
  2028. \fIrepeatedLines\fR,
  2029. \fIhighlightRecent\fR, or
  2030. \fInone\fR
  2031. which is the default\&.
  2032. .RE
  2033. .PP
  2034. blame\&.date
  2035. .RS 4
  2036. Specifies the format used to output dates in
  2037. \fBgit-blame\fR(1)\&. If unset the iso format is used\&. For supported values, see the discussion of the
  2038. \fB\-\-date\fR
  2039. option at
  2040. \fBgit-log\fR(1)\&.
  2041. .RE
  2042. .PP
  2043. blame\&.showEmail
  2044. .RS 4
  2045. Show the author email instead of author name in
  2046. \fBgit-blame\fR(1)\&. This option defaults to false\&.
  2047. .RE
  2048. .PP
  2049. blame\&.showRoot
  2050. .RS 4
  2051. Do not treat root commits as boundaries in
  2052. \fBgit-blame\fR(1)\&. This option defaults to false\&.
  2053. .RE
  2054. .PP
  2055. blame\&.ignoreRevsFile
  2056. .RS 4
  2057. Ignore revisions listed in the file, one unabbreviated object name per line, in
  2058. \fBgit-blame\fR(1)\&. Whitespace and comments beginning with # are ignored\&. This option may be repeated multiple times\&. Empty file names will reset the list of ignored revisions\&. This option will be handled before the command line option
  2059. \fB\-\-ignore\-revs\-file\fR\&.
  2060. .RE
  2061. .PP
  2062. blame\&.markUnblamableLines
  2063. .RS 4
  2064. Mark lines that were changed by an ignored revision that we could not attribute to another commit with a
  2065. \fI*\fR
  2066. in the output of
  2067. \fBgit-blame\fR(1)\&.
  2068. .RE
  2069. .PP
  2070. blame\&.markIgnoredLines
  2071. .RS 4
  2072. Mark lines that were changed by an ignored revision that we attributed to another commit with a
  2073. \fI?\fR
  2074. in the output of
  2075. \fBgit-blame\fR(1)\&.
  2076. .RE
  2077. .PP
  2078. branch\&.autoSetupMerge
  2079. .RS 4
  2080. Tells
  2081. \fIgit branch\fR,
  2082. \fIgit switch\fR
  2083. and
  2084. \fIgit checkout\fR
  2085. to set up new branches so that
  2086. \fBgit-pull\fR(1)
  2087. will appropriately merge from the starting point branch\&. Note that even if this option is not set, this behavior can be chosen per\-branch using the
  2088. \fB\-\-track\fR
  2089. and
  2090. \fB\-\-no\-track\fR
  2091. options\&. The valid settings are:
  2092. \fBfalse\fR \(em no automatic setup is done;
  2093. \fBtrue\fR \(em automatic setup is done when the starting point is a remote\-tracking branch;
  2094. \fBalways\fR \(em automatic setup is done when the starting point is either a local branch or remote\-tracking branch;
  2095. \fBinherit\fR \(em if the starting point has a tracking configuration, it is copied to the new branch;
  2096. \fBsimple\fR \(em automatic setup is done only when the starting point is a remote\-tracking branch and the new branch has the same name as the remote branch\&. This option defaults to true\&.
  2097. .RE
  2098. .PP
  2099. branch\&.autoSetupRebase
  2100. .RS 4
  2101. When a new branch is created with
  2102. \fIgit branch\fR,
  2103. \fIgit switch\fR
  2104. or
  2105. \fIgit checkout\fR
  2106. that tracks another branch, this variable tells Git to set up pull to rebase instead of merge (see "branch\&.<name>\&.rebase")\&. When
  2107. \fBnever\fR, rebase is never automatically set to true\&. When
  2108. \fBlocal\fR, rebase is set to true for tracked branches of other local branches\&. When
  2109. \fBremote\fR, rebase is set to true for tracked branches of remote\-tracking branches\&. When
  2110. \fBalways\fR, rebase will be set to true for all tracking branches\&. See "branch\&.autoSetupMerge" for details on how to set up a branch to track another branch\&. This option defaults to never\&.
  2111. .RE
  2112. .PP
  2113. branch\&.sort
  2114. .RS 4
  2115. This variable controls the sort ordering of branches when displayed by
  2116. \fBgit-branch\fR(1)\&. Without the "\-\-sort=<value>" option provided, the value of this variable will be used as the default\&. See
  2117. \fBgit-for-each-ref\fR(1)
  2118. field names for valid values\&.
  2119. .RE
  2120. .PP
  2121. branch\&.<name>\&.remote
  2122. .RS 4
  2123. When on branch <name>, it tells
  2124. \fIgit fetch\fR
  2125. and
  2126. \fIgit push\fR
  2127. which remote to fetch from or push to\&. The remote to push to may be overridden with
  2128. \fBremote\&.pushDefault\fR
  2129. (for all branches)\&. The remote to push to, for the current branch, may be further overridden by
  2130. \fBbranch\&.\fR\fI<name>\fR\fB\&.pushRemote\fR\&. If no remote is configured, or if you are not on any branch and there is more than one remote defined in the repository, it defaults to
  2131. \fBorigin\fR
  2132. for fetching and
  2133. \fBremote\&.pushDefault\fR
  2134. for pushing\&. Additionally, \&. (a period) is the current local repository (a dot\-repository), see
  2135. \fBbranch\&.\fR\fI<name>\fR\fB\&.merge\fR\*(Aqs final note below\&.
  2136. .RE
  2137. .PP
  2138. branch\&.<name>\&.pushRemote
  2139. .RS 4
  2140. When on branch <name>, it overrides
  2141. \fBbranch\&.\fR\fI<name>\fR\fB\&.remote\fR
  2142. for pushing\&. It also overrides
  2143. \fBremote\&.pushDefault\fR
  2144. for pushing from branch <name>\&. When you pull from one place (e\&.g\&. your upstream) and push to another place (e\&.g\&. your own publishing repository), you would want to set
  2145. \fBremote\&.pushDefault\fR
  2146. to specify the remote to push to for all branches, and use this option to override it for a specific branch\&.
  2147. .RE
  2148. .PP
  2149. branch\&.<name>\&.merge
  2150. .RS 4
  2151. Defines, together with branch\&.<name>\&.remote, the upstream branch for the given branch\&. It tells
  2152. \fIgit fetch\fR/\fIgit pull\fR/\fIgit rebase\fR
  2153. which branch to merge and can also affect
  2154. \fIgit push\fR
  2155. (see push\&.default)\&. When in branch <name>, it tells
  2156. \fIgit fetch\fR
  2157. the default refspec to be marked for merging in FETCH_HEAD\&. The value is handled like the remote part of a refspec, and must match a ref which is fetched from the remote given by "branch\&.<name>\&.remote"\&. The merge information is used by
  2158. \fIgit pull\fR
  2159. (which first calls
  2160. \fIgit fetch\fR) to lookup the default branch for merging\&. Without this option,
  2161. \fIgit pull\fR
  2162. defaults to merge the first refspec fetched\&. Specify multiple values to get an octopus merge\&. If you wish to setup
  2163. \fIgit pull\fR
  2164. so that it merges into <name> from another branch in the local repository, you can point branch\&.<name>\&.merge to the desired branch, and use the relative path setting \&. (a period) for branch\&.<name>\&.remote\&.
  2165. .RE
  2166. .PP
  2167. branch\&.<name>\&.mergeOptions
  2168. .RS 4
  2169. Sets default options for merging into branch <name>\&. The syntax and supported options are the same as those of
  2170. \fBgit-merge\fR(1), but option values containing whitespace characters are currently not supported\&.
  2171. .RE
  2172. .PP
  2173. branch\&.<name>\&.rebase
  2174. .RS 4
  2175. When true, rebase the branch <name> on top of the fetched branch, instead of merging the default branch from the default remote when "git pull" is run\&. See "pull\&.rebase" for doing this in a non branch\-specific manner\&.
  2176. .sp
  2177. When
  2178. \fBmerges\fR
  2179. (or just
  2180. \fIm\fR), pass the
  2181. \fB\-\-rebase\-merges\fR
  2182. option to
  2183. \fIgit rebase\fR
  2184. so that the local merge commits are included in the rebase (see
  2185. \fBgit-rebase\fR(1)
  2186. for details)\&.
  2187. .sp
  2188. When the value is
  2189. \fBinteractive\fR
  2190. (or just
  2191. \fIi\fR), the rebase is run in interactive mode\&.
  2192. .sp
  2193. \fBNOTE\fR: this is a possibly dangerous operation; do
  2194. \fBnot\fR
  2195. use it unless you understand the implications (see
  2196. \fBgit-rebase\fR(1)
  2197. for details)\&.
  2198. .RE
  2199. .PP
  2200. branch\&.<name>\&.description
  2201. .RS 4
  2202. Branch description, can be edited with
  2203. \fBgit\fR
  2204. \fBbranch\fR
  2205. \fB\-\-edit\-description\fR\&. Branch description is automatically added to the format\-patch cover letter or request\-pull summary\&.
  2206. .RE
  2207. .PP
  2208. browser\&.<tool>\&.cmd
  2209. .RS 4
  2210. Specify the command to invoke the specified browser\&. The specified command is evaluated in shell with the URLs passed as arguments\&. (See
  2211. \fBgit-web--browse\fR(1)\&.)
  2212. .RE
  2213. .PP
  2214. browser\&.<tool>\&.path
  2215. .RS 4
  2216. Override the path for the given tool that may be used to browse HTML help (see
  2217. \fB\-w\fR
  2218. option in
  2219. \fBgit-help\fR(1)) or a working repository in gitweb (see
  2220. \fBgit-instaweb\fR(1))\&.
  2221. .RE
  2222. .PP
  2223. bundle\&.*
  2224. .RS 4
  2225. The
  2226. \fBbundle\&.\fR* keys may appear in a bundle list file found via the
  2227. \fBgit\fR
  2228. \fBclone\fR
  2229. \fB\-\-bundle\-uri\fR
  2230. option\&. These keys currently have no effect if placed in a repository config file, though this will change in the future\&. See
  2231. \m[blue]\fBthe bundle URI design document\fR\m[]\&\s-2\u[1]\d\s+2
  2232. for more details\&.
  2233. .RE
  2234. .PP
  2235. bundle\&.version
  2236. .RS 4
  2237. This integer value advertises the version of the bundle list format used by the bundle list\&. Currently, the only accepted value is
  2238. \fB1\fR\&.
  2239. .RE
  2240. .PP
  2241. bundle\&.mode
  2242. .RS 4
  2243. This string value should be either
  2244. \fBall\fR
  2245. or
  2246. \fBany\fR\&. This value describes whether all of the advertised bundles are required to unbundle a complete understanding of the bundled information (\fBall\fR) or if any one of the listed bundle URIs is sufficient (\fBany\fR)\&.
  2247. .RE
  2248. .PP
  2249. bundle\&.heuristic
  2250. .RS 4
  2251. If this string\-valued key exists, then the bundle list is designed to work well with incremental
  2252. \fBgit\fR
  2253. \fBfetch\fR
  2254. commands\&. The heuristic signals that there are additional keys available for each bundle that help determine which subset of bundles the client should download\&. The only value currently understood is
  2255. \fBcreationToken\fR\&.
  2256. .RE
  2257. .PP
  2258. bundle\&.<id>\&.*
  2259. .RS 4
  2260. The
  2261. \fBbundle\&.\fR\fI<id>\fR\&.* keys are used to describe a single item in the bundle list, grouped under
  2262. \fI<id>\fR
  2263. for identification purposes\&.
  2264. .RE
  2265. .PP
  2266. bundle\&.<id>\&.uri
  2267. .RS 4
  2268. This string value defines the URI by which Git can reach the contents of this
  2269. \fI<id>\fR\&. This URI may be a bundle file or another bundle list\&.
  2270. .RE
  2271. .PP
  2272. checkout\&.defaultRemote
  2273. .RS 4
  2274. When you run
  2275. \fBgit\fR
  2276. \fBcheckout\fR
  2277. \fI<something>\fR
  2278. or
  2279. \fBgit\fR
  2280. \fBswitch\fR
  2281. \fI<something>\fR
  2282. and only have one remote, it may implicitly fall back on checking out and tracking e\&.g\&.
  2283. \fBorigin/\fR\fI<something>\fR\&. This stops working as soon as you have more than one remote with a
  2284. \fI<something>\fR
  2285. reference\&. This setting allows for setting the name of a preferred remote that should always win when it comes to disambiguation\&. The typical use\-case is to set this to
  2286. \fBorigin\fR\&.
  2287. .sp
  2288. Currently this is used by
  2289. \fBgit-switch\fR(1)
  2290. and
  2291. \fBgit-checkout\fR(1)
  2292. when
  2293. \fBgit\fR
  2294. \fBcheckout\fR
  2295. \fI<something>\fR
  2296. or
  2297. \fBgit\fR
  2298. \fBswitch\fR
  2299. \fI<something>\fR
  2300. will checkout the
  2301. \fI<something>\fR
  2302. branch on another remote, and by
  2303. \fBgit-worktree\fR(1)
  2304. when
  2305. \fBgit\fR
  2306. \fBworktree\fR
  2307. \fBadd\fR
  2308. refers to a remote branch\&. This setting might be used for other checkout\-like commands or functionality in the future\&.
  2309. .RE
  2310. .PP
  2311. checkout\&.guess
  2312. .RS 4
  2313. Provides the default value for the
  2314. \fB\-\-guess\fR
  2315. or
  2316. \fB\-\-no\-guess\fR
  2317. option in
  2318. \fBgit\fR
  2319. \fBcheckout\fR
  2320. and
  2321. \fBgit\fR
  2322. \fBswitch\fR\&. See
  2323. \fBgit-switch\fR(1)
  2324. and
  2325. \fBgit-checkout\fR(1)\&.
  2326. .RE
  2327. .PP
  2328. checkout\&.workers
  2329. .RS 4
  2330. The number of parallel workers to use when updating the working tree\&. The default is one, i\&.e\&. sequential execution\&. If set to a value less than one, Git will use as many workers as the number of logical cores available\&. This setting and
  2331. \fBcheckout\&.thresholdForParallelism\fR
  2332. affect all commands that perform checkout\&. E\&.g\&. checkout, clone, reset, sparse\-checkout, etc\&.
  2333. .sp
  2334. Note: Parallel checkout usually delivers better performance for repositories located on SSDs or over NFS\&. For repositories on spinning disks and/or machines with a small number of cores, the default sequential checkout often performs better\&. The size and compression level of a repository might also influence how well the parallel version performs\&.
  2335. .RE
  2336. .PP
  2337. checkout\&.thresholdForParallelism
  2338. .RS 4
  2339. When running parallel checkout with a small number of files, the cost of subprocess spawning and inter\-process communication might outweigh the parallelization gains\&. This setting allows you to define the minimum number of files for which parallel checkout should be attempted\&. The default is 100\&.
  2340. .RE
  2341. .PP
  2342. clean\&.requireForce
  2343. .RS 4
  2344. A boolean to make git\-clean refuse to delete files unless \-f is given\&. Defaults to true\&.
  2345. .RE
  2346. .PP
  2347. \fBclone\&.defaultRemoteName\fR
  2348. .RS 4
  2349. The name of the remote to create when cloning a repository\&. Defaults to
  2350. \fBorigin\fR\&. It can be overridden by passing the
  2351. \fB\-\-origin\fR
  2352. command\-line option to
  2353. \fBgit-clone\fR(1)\&.
  2354. .RE
  2355. .PP
  2356. \fBclone\&.rejectShallow\fR
  2357. .RS 4
  2358. Reject cloning a repository if it is a shallow one; this can be overridden by passing the
  2359. \fB\-\-reject\-shallow\fR
  2360. option on the command line\&. See
  2361. \fBgit-clone\fR(1)\&.
  2362. .RE
  2363. .PP
  2364. \fBclone\&.filterSubmodules\fR
  2365. .RS 4
  2366. If a partial clone filter is provided (see
  2367. \fB\-\-filter\fR
  2368. in
  2369. \fBgit-rev-list\fR(1)) and
  2370. \fB\-\-recurse\-submodules\fR
  2371. is used, also apply the filter to submodules\&.
  2372. .RE
  2373. .PP
  2374. color\&.advice
  2375. .RS 4
  2376. A boolean to enable/disable color in hints (e\&.g\&. when a push failed, see
  2377. \fBadvice\&.\fR* for a list)\&. May be set to
  2378. \fBalways\fR,
  2379. \fBfalse\fR
  2380. (or
  2381. \fBnever\fR) or
  2382. \fBauto\fR
  2383. (or
  2384. \fBtrue\fR), in which case colors are used only when the error output goes to a terminal\&. If unset, then the value of
  2385. \fBcolor\&.ui\fR
  2386. is used (\fBauto\fR
  2387. by default)\&.
  2388. .RE
  2389. .PP
  2390. color\&.advice\&.hint
  2391. .RS 4
  2392. Use customized color for hints\&.
  2393. .RE
  2394. .PP
  2395. color\&.blame\&.highlightRecent
  2396. .RS 4
  2397. Specify the line annotation color for
  2398. \fBgit\fR
  2399. \fBblame\fR
  2400. \fB\-\-color\-by\-age\fR
  2401. depending upon the age of the line\&.
  2402. .sp
  2403. This setting should be set to a comma\-separated list of color and date settings, starting and ending with a color, the dates should be set from oldest to newest\&. The metadata will be colored with the specified colors if the line was introduced before the given timestamp, overwriting older timestamped colors\&.
  2404. .sp
  2405. Instead of an absolute timestamp relative timestamps work as well, e\&.g\&.
  2406. \fB2\&.weeks\&.ago\fR
  2407. is valid to address anything older than 2 weeks\&.
  2408. .sp
  2409. It defaults to
  2410. \fBblue,12\fR
  2411. \fBmonth\fR
  2412. \fBago,white,1\fR
  2413. \fBmonth\fR
  2414. \fBago,red\fR, which colors everything older than one year blue, recent changes between one month and one year old are kept white, and lines introduced within the last month are colored red\&.
  2415. .RE
  2416. .PP
  2417. color\&.blame\&.repeatedLines
  2418. .RS 4
  2419. Use the specified color to colorize line annotations for
  2420. \fBgit\fR
  2421. \fBblame\fR
  2422. \fB\-\-color\-lines\fR, if they come from the same commit as the preceding line\&. Defaults to cyan\&.
  2423. .RE
  2424. .PP
  2425. color\&.branch
  2426. .RS 4
  2427. A boolean to enable/disable color in the output of
  2428. \fBgit-branch\fR(1)\&. May be set to
  2429. \fBalways\fR,
  2430. \fBfalse\fR
  2431. (or
  2432. \fBnever\fR) or
  2433. \fBauto\fR
  2434. (or
  2435. \fBtrue\fR), in which case colors are used only when the output is to a terminal\&. If unset, then the value of
  2436. \fBcolor\&.ui\fR
  2437. is used (\fBauto\fR
  2438. by default)\&.
  2439. .RE
  2440. .PP
  2441. color\&.branch\&.<slot>
  2442. .RS 4
  2443. Use customized color for branch coloration\&.
  2444. \fI<slot>\fR
  2445. is one of
  2446. \fBcurrent\fR
  2447. (the current branch),
  2448. \fBlocal\fR
  2449. (a local branch),
  2450. \fBremote\fR
  2451. (a remote\-tracking branch in refs/remotes/),
  2452. \fBupstream\fR
  2453. (upstream tracking branch),
  2454. \fBplain\fR
  2455. (other refs)\&.
  2456. .RE
  2457. .PP
  2458. color\&.diff
  2459. .RS 4
  2460. Whether to use ANSI escape sequences to add color to patches\&. If this is set to
  2461. \fBalways\fR,
  2462. \fBgit-diff\fR(1),
  2463. \fBgit-log\fR(1), and
  2464. \fBgit-show\fR(1)
  2465. will use color for all patches\&. If it is set to
  2466. \fBtrue\fR
  2467. or
  2468. \fBauto\fR, those commands will only use color when output is to the terminal\&. If unset, then the value of
  2469. \fBcolor\&.ui\fR
  2470. is used (\fBauto\fR
  2471. by default)\&.
  2472. .sp
  2473. This does not affect
  2474. \fBgit-format-patch\fR(1)
  2475. or the
  2476. \fIgit\-diff\-*\fR
  2477. plumbing commands\&. Can be overridden on the command line with the
  2478. \fB\-\-color\fR[\fB=\fR\fI<when>\fR] option\&.
  2479. .RE
  2480. .PP
  2481. color\&.diff\&.<slot>
  2482. .RS 4
  2483. Use customized color for diff colorization\&.
  2484. \fI<slot>\fR
  2485. specifies which part of the patch to use the specified color, and is one of
  2486. \fBcontext\fR
  2487. (context text \-
  2488. \fBplain\fR
  2489. is a historical synonym),
  2490. \fBmeta\fR
  2491. (metainformation),
  2492. \fBfrag\fR
  2493. (hunk header),
  2494. \fIfunc\fR
  2495. (function in hunk header),
  2496. \fBold\fR
  2497. (removed lines),
  2498. \fBnew\fR
  2499. (added lines),
  2500. \fBcommit\fR
  2501. (commit headers),
  2502. \fBwhitespace\fR
  2503. (highlighting whitespace errors),
  2504. \fBoldMoved\fR
  2505. (deleted lines),
  2506. \fBnewMoved\fR
  2507. (added lines),
  2508. \fBoldMovedDimmed\fR,
  2509. \fBoldMovedAlternative\fR,
  2510. \fBoldMovedAlternativeDimmed\fR,
  2511. \fBnewMovedDimmed\fR,
  2512. \fBnewMovedAlternative\fR
  2513. \fBnewMovedAlternativeDimmed\fR
  2514. (See the
  2515. \fI<mode>\fR
  2516. setting of
  2517. \fI\-\-color\-moved\fR
  2518. in
  2519. \fBgit-diff\fR(1)
  2520. for details),
  2521. \fBcontextDimmed\fR,
  2522. \fBoldDimmed\fR,
  2523. \fBnewDimmed\fR,
  2524. \fBcontextBold\fR,
  2525. \fBoldBold\fR, and
  2526. \fBnewBold\fR
  2527. (see
  2528. \fBgit-range-diff\fR(1)
  2529. for details)\&.
  2530. .RE
  2531. .PP
  2532. color\&.decorate\&.<slot>
  2533. .RS 4
  2534. Use customized color for
  2535. \fIgit log \-\-decorate\fR
  2536. output\&.
  2537. \fI<slot>\fR
  2538. is one of
  2539. \fBbranch\fR,
  2540. \fBremoteBranch\fR,
  2541. \fBtag\fR,
  2542. \fBstash\fR
  2543. or
  2544. \fBHEAD\fR
  2545. for local branches, remote\-tracking branches, tags, stash and HEAD, respectively and
  2546. \fBgrafted\fR
  2547. for grafted commits\&.
  2548. .RE
  2549. .PP
  2550. color\&.grep
  2551. .RS 4
  2552. When set to
  2553. \fBalways\fR, always highlight matches\&. When
  2554. \fBfalse\fR
  2555. (or
  2556. \fBnever\fR), never\&. When set to
  2557. \fBtrue\fR
  2558. or
  2559. \fBauto\fR, use color only when the output is written to the terminal\&. If unset, then the value of
  2560. \fBcolor\&.ui\fR
  2561. is used (\fBauto\fR
  2562. by default)\&.
  2563. .RE
  2564. .PP
  2565. color\&.grep\&.<slot>
  2566. .RS 4
  2567. Use customized color for grep colorization\&.
  2568. \fI<slot>\fR
  2569. specifies which part of the line to use the specified color, and is one of
  2570. .PP
  2571. \fBcontext\fR
  2572. .RS 4
  2573. non\-matching text in context lines (when using
  2574. \fB\-A\fR,
  2575. \fB\-B\fR, or
  2576. \fB\-C\fR)
  2577. .RE
  2578. .PP
  2579. \fBfilename\fR
  2580. .RS 4
  2581. filename prefix (when not using
  2582. \fB\-h\fR)
  2583. .RE
  2584. .PP
  2585. \fBfunction\fR
  2586. .RS 4
  2587. function name lines (when using
  2588. \fB\-p\fR)
  2589. .RE
  2590. .PP
  2591. \fBlineNumber\fR
  2592. .RS 4
  2593. line number prefix (when using
  2594. \fB\-n\fR)
  2595. .RE
  2596. .PP
  2597. \fBcolumn\fR
  2598. .RS 4
  2599. column number prefix (when using
  2600. \fB\-\-column\fR)
  2601. .RE
  2602. .PP
  2603. \fBmatch\fR
  2604. .RS 4
  2605. matching text (same as setting
  2606. \fBmatchContext\fR
  2607. and
  2608. \fBmatchSelected\fR)
  2609. .RE
  2610. .PP
  2611. \fBmatchContext\fR
  2612. .RS 4
  2613. matching text in context lines
  2614. .RE
  2615. .PP
  2616. \fBmatchSelected\fR
  2617. .RS 4
  2618. matching text in selected lines\&. Also, used to customize the following
  2619. \fBgit-log\fR(1)
  2620. subcommands:
  2621. \fB\-\-grep\fR,
  2622. \fB\-\-author\fR, and
  2623. \fB\-\-committer\fR\&.
  2624. .RE
  2625. .PP
  2626. \fBselected\fR
  2627. .RS 4
  2628. non\-matching text in selected lines\&. Also, used to customize the following
  2629. \fBgit-log\fR(1)
  2630. subcommands:
  2631. \fB\-\-grep\fR,
  2632. \fB\-\-author\fR
  2633. and
  2634. \fB\-\-committer\fR\&.
  2635. .RE
  2636. .PP
  2637. \fBseparator\fR
  2638. .RS 4
  2639. separators between fields on a line (\fB:\fR,
  2640. \fB\-\fR, and
  2641. \fB=\fR) and between hunks (\fB\-\-\fR)
  2642. .RE
  2643. .RE
  2644. .PP
  2645. color\&.interactive
  2646. .RS 4
  2647. When set to
  2648. \fBalways\fR, always use colors for interactive prompts and displays (such as those used by "git\-add \-\-interactive" and "git\-clean \-\-interactive")\&. When false (or
  2649. \fBnever\fR), never\&. When set to
  2650. \fBtrue\fR
  2651. or
  2652. \fBauto\fR, use colors only when the output is to the terminal\&. If unset, then the value of
  2653. \fBcolor\&.ui\fR
  2654. is used (\fBauto\fR
  2655. by default)\&.
  2656. .RE
  2657. .PP
  2658. color\&.interactive\&.<slot>
  2659. .RS 4
  2660. Use customized color for
  2661. \fIgit add \-\-interactive\fR
  2662. and
  2663. \fIgit clean \-\-interactive\fR
  2664. output\&.
  2665. \fI<slot>\fR
  2666. may be
  2667. \fBprompt\fR,
  2668. \fBheader\fR,
  2669. \fBhelp\fR
  2670. or
  2671. \fBerror\fR, for four distinct types of normal output from interactive commands\&.
  2672. .RE
  2673. .PP
  2674. color\&.pager
  2675. .RS 4
  2676. A boolean to specify whether
  2677. \fBauto\fR
  2678. color modes should colorize output going to the pager\&. Defaults to true; set this to false if your pager does not understand ANSI color codes\&.
  2679. .RE
  2680. .PP
  2681. color\&.push
  2682. .RS 4
  2683. A boolean to enable/disable color in push errors\&. May be set to
  2684. \fBalways\fR,
  2685. \fBfalse\fR
  2686. (or
  2687. \fBnever\fR) or
  2688. \fBauto\fR
  2689. (or
  2690. \fBtrue\fR), in which case colors are used only when the error output goes to a terminal\&. If unset, then the value of
  2691. \fBcolor\&.ui\fR
  2692. is used (\fBauto\fR
  2693. by default)\&.
  2694. .RE
  2695. .PP
  2696. color\&.push\&.error
  2697. .RS 4
  2698. Use customized color for push errors\&.
  2699. .RE
  2700. .PP
  2701. color\&.remote
  2702. .RS 4
  2703. If set, keywords at the start of the line are highlighted\&. The keywords are "error", "warning", "hint" and "success", and are matched case\-insensitively\&. May be set to
  2704. \fBalways\fR,
  2705. \fBfalse\fR
  2706. (or
  2707. \fBnever\fR) or
  2708. \fBauto\fR
  2709. (or
  2710. \fBtrue\fR)\&. If unset, then the value of
  2711. \fBcolor\&.ui\fR
  2712. is used (\fBauto\fR
  2713. by default)\&.
  2714. .RE
  2715. .PP
  2716. color\&.remote\&.<slot>
  2717. .RS 4
  2718. Use customized color for each remote keyword\&.
  2719. \fI<slot>\fR
  2720. may be
  2721. \fBhint\fR,
  2722. \fBwarning\fR,
  2723. \fBsuccess\fR
  2724. or
  2725. \fBerror\fR
  2726. which match the corresponding keyword\&.
  2727. .RE
  2728. .PP
  2729. color\&.showBranch
  2730. .RS 4
  2731. A boolean to enable/disable color in the output of
  2732. \fBgit-show-branch\fR(1)\&. May be set to
  2733. \fBalways\fR,
  2734. \fBfalse\fR
  2735. (or
  2736. \fBnever\fR) or
  2737. \fBauto\fR
  2738. (or
  2739. \fBtrue\fR), in which case colors are used only when the output is to a terminal\&. If unset, then the value of
  2740. \fBcolor\&.ui\fR
  2741. is used (\fBauto\fR
  2742. by default)\&.
  2743. .RE
  2744. .PP
  2745. color\&.status
  2746. .RS 4
  2747. A boolean to enable/disable color in the output of
  2748. \fBgit-status\fR(1)\&. May be set to
  2749. \fBalways\fR,
  2750. \fBfalse\fR
  2751. (or
  2752. \fBnever\fR) or
  2753. \fBauto\fR
  2754. (or
  2755. \fBtrue\fR), in which case colors are used only when the output is to a terminal\&. If unset, then the value of
  2756. \fBcolor\&.ui\fR
  2757. is used (\fBauto\fR
  2758. by default)\&.
  2759. .RE
  2760. .PP
  2761. color\&.status\&.<slot>
  2762. .RS 4
  2763. Use customized color for status colorization\&.
  2764. \fI<slot>\fR
  2765. is one of
  2766. \fBheader\fR
  2767. (the header text of the status message),
  2768. \fBadded\fR
  2769. or
  2770. \fBupdated\fR
  2771. (files which are added but not committed),
  2772. \fBchanged\fR
  2773. (files which are changed but not added in the index),
  2774. \fBuntracked\fR
  2775. (files which are not tracked by Git),
  2776. \fBbranch\fR
  2777. (the current branch),
  2778. \fBnobranch\fR
  2779. (the color the
  2780. \fIno branch\fR
  2781. warning is shown in, defaulting to red),
  2782. \fBlocalBranch\fR
  2783. or
  2784. \fBremoteBranch\fR
  2785. (the local and remote branch names, respectively, when branch and tracking information is displayed in the status short\-format), or
  2786. \fBunmerged\fR
  2787. (files which have unmerged changes)\&.
  2788. .RE
  2789. .PP
  2790. color\&.transport
  2791. .RS 4
  2792. A boolean to enable/disable color when pushes are rejected\&. May be set to
  2793. \fBalways\fR,
  2794. \fBfalse\fR
  2795. (or
  2796. \fBnever\fR) or
  2797. \fBauto\fR
  2798. (or
  2799. \fBtrue\fR), in which case colors are used only when the error output goes to a terminal\&. If unset, then the value of
  2800. \fBcolor\&.ui\fR
  2801. is used (\fBauto\fR
  2802. by default)\&.
  2803. .RE
  2804. .PP
  2805. color\&.transport\&.rejected
  2806. .RS 4
  2807. Use customized color when a push was rejected\&.
  2808. .RE
  2809. .PP
  2810. color\&.ui
  2811. .RS 4
  2812. This variable determines the default value for variables such as
  2813. \fBcolor\&.diff\fR
  2814. and
  2815. \fBcolor\&.grep\fR
  2816. that control the use of color per command family\&. Its scope will expand as more commands learn configuration to set a default for the
  2817. \fB\-\-color\fR
  2818. option\&. Set it to
  2819. \fBfalse\fR
  2820. or
  2821. \fBnever\fR
  2822. if you prefer Git commands not to use color unless enabled explicitly with some other configuration or the
  2823. \fB\-\-color\fR
  2824. option\&. Set it to
  2825. \fBalways\fR
  2826. if you want all output not intended for machine consumption to use color, to
  2827. \fBtrue\fR
  2828. or
  2829. \fBauto\fR
  2830. (this is the default since Git 1\&.8\&.4) if you want such output to use color when written to the terminal\&.
  2831. .RE
  2832. .PP
  2833. column\&.ui
  2834. .RS 4
  2835. Specify whether supported commands should output in columns\&. This variable consists of a list of tokens separated by spaces or commas:
  2836. .sp
  2837. These options control when the feature should be enabled (defaults to
  2838. \fInever\fR):
  2839. .PP
  2840. \fBalways\fR
  2841. .RS 4
  2842. always show in columns
  2843. .RE
  2844. .PP
  2845. \fBnever\fR
  2846. .RS 4
  2847. never show in columns
  2848. .RE
  2849. .PP
  2850. \fBauto\fR
  2851. .RS 4
  2852. show in columns if the output is to the terminal
  2853. .RE
  2854. .sp
  2855. These options control layout (defaults to
  2856. \fIcolumn\fR)\&. Setting any of these implies
  2857. \fIalways\fR
  2858. if none of
  2859. \fIalways\fR,
  2860. \fInever\fR, or
  2861. \fIauto\fR
  2862. are specified\&.
  2863. .PP
  2864. \fBcolumn\fR
  2865. .RS 4
  2866. fill columns before rows
  2867. .RE
  2868. .PP
  2869. \fBrow\fR
  2870. .RS 4
  2871. fill rows before columns
  2872. .RE
  2873. .PP
  2874. \fBplain\fR
  2875. .RS 4
  2876. show in one column
  2877. .RE
  2878. .sp
  2879. Finally, these options can be combined with a layout option (defaults to
  2880. \fInodense\fR):
  2881. .PP
  2882. \fBdense\fR
  2883. .RS 4
  2884. make unequal size columns to utilize more space
  2885. .RE
  2886. .PP
  2887. \fBnodense\fR
  2888. .RS 4
  2889. make equal size columns
  2890. .RE
  2891. .RE
  2892. .PP
  2893. column\&.branch
  2894. .RS 4
  2895. Specify whether to output branch listing in
  2896. \fBgit\fR
  2897. \fBbranch\fR
  2898. in columns\&. See
  2899. \fBcolumn\&.ui\fR
  2900. for details\&.
  2901. .RE
  2902. .PP
  2903. column\&.clean
  2904. .RS 4
  2905. Specify the layout when listing items in
  2906. \fBgit\fR
  2907. \fBclean\fR
  2908. \fB\-i\fR, which always shows files and directories in columns\&. See
  2909. \fBcolumn\&.ui\fR
  2910. for details\&.
  2911. .RE
  2912. .PP
  2913. column\&.status
  2914. .RS 4
  2915. Specify whether to output untracked files in
  2916. \fBgit\fR
  2917. \fBstatus\fR
  2918. in columns\&. See
  2919. \fBcolumn\&.ui\fR
  2920. for details\&.
  2921. .RE
  2922. .PP
  2923. column\&.tag
  2924. .RS 4
  2925. Specify whether to output tag listings in
  2926. \fBgit\fR
  2927. \fBtag\fR
  2928. in columns\&. See
  2929. \fBcolumn\&.ui\fR
  2930. for details\&.
  2931. .RE
  2932. .PP
  2933. \fBcommit\&.cleanup\fR
  2934. .RS 4
  2935. This setting overrides the default of the
  2936. \fB\-\-cleanup\fR
  2937. option in
  2938. \fBgit\fR
  2939. \fBcommit\fR\&. See
  2940. \fBgit-commit\fR(1)
  2941. for details\&. Changing the default can be useful when you always want to keep lines that begin with the comment character # in your log message, in which case you would do
  2942. \fBgit\fR
  2943. \fBconfig\fR
  2944. \fBcommit\&.cleanup\fR
  2945. \fBwhitespace\fR
  2946. (note that you will have to remove the help lines that begin with # in the commit log template yourself, if you do this)\&.
  2947. .RE
  2948. .PP
  2949. \fBcommit\&.gpgSign\fR
  2950. .RS 4
  2951. A boolean to specify whether all commits should be GPG signed\&. Use of this option when doing operations such as rebase can result in a large number of commits being signed\&. It may be convenient to use an agent to avoid typing your GPG passphrase several times\&.
  2952. .RE
  2953. .PP
  2954. \fBcommit\&.status\fR
  2955. .RS 4
  2956. A boolean to enable/disable inclusion of status information in the commit message template when using an editor to prepare the commit message\&. Defaults to
  2957. \fBtrue\fR\&.
  2958. .RE
  2959. .PP
  2960. \fBcommit\&.template\fR
  2961. .RS 4
  2962. Specify the pathname of a file to use as the template for new commit messages\&.
  2963. .RE
  2964. .PP
  2965. \fBcommit\&.verbose\fR
  2966. .RS 4
  2967. A boolean or int to specify the level of verbosity with
  2968. \fBgit\fR
  2969. \fBcommit\fR\&. See
  2970. \fBgit-commit\fR(1)
  2971. for details\&.
  2972. .RE
  2973. .PP
  2974. commitGraph\&.generationVersion
  2975. .RS 4
  2976. Specifies the type of generation number version to use when writing or reading the commit\-graph file\&. If version 1 is specified, then the corrected commit dates will not be written or read\&. Defaults to 2\&.
  2977. .RE
  2978. .PP
  2979. commitGraph\&.maxNewFilters
  2980. .RS 4
  2981. Specifies the default value for the
  2982. \fB\-\-max\-new\-filters\fR
  2983. option of
  2984. \fBgit\fR
  2985. \fBcommit\-graph\fR
  2986. \fBwrite\fR
  2987. (c\&.f\&.,
  2988. \fBgit-commit-graph\fR(1))\&.
  2989. .RE
  2990. .PP
  2991. commitGraph\&.readChangedPaths
  2992. .RS 4
  2993. Deprecated\&. Equivalent to commitGraph\&.changedPathsVersion=\-1 if true, and commitGraph\&.changedPathsVersion=0 if false\&. (If commitGraph\&.changedPathVersion is also set, commitGraph\&.changedPathsVersion takes precedence\&.)
  2994. .RE
  2995. .PP
  2996. commitGraph\&.changedPathsVersion
  2997. .RS 4
  2998. Specifies the version of the changed\-path Bloom filters that Git will read and write\&. May be \-1, 0, 1, or 2\&. Note that values greater than 1 may be incompatible with older versions of Git which do not yet understand those versions\&. Use caution when operating in a mixed\-version environment\&.
  2999. .sp
  3000. Defaults to \-1\&.
  3001. .sp
  3002. If \-1, Git will use the version of the changed\-path Bloom filters in the repository, defaulting to 1 if there are none\&.
  3003. .sp
  3004. If 0, Git will not read any Bloom filters, and will write version 1 Bloom filters when instructed to write\&.
  3005. .sp
  3006. If 1, Git will only read version 1 Bloom filters, and will write version 1 Bloom filters\&.
  3007. .sp
  3008. If 2, Git will only read version 2 Bloom filters, and will write version 2 Bloom filters\&.
  3009. .sp
  3010. See
  3011. \fBgit-commit-graph\fR(1)
  3012. for more information\&.
  3013. .RE
  3014. .PP
  3015. completion\&.commands
  3016. .RS 4
  3017. This is only used by git\-completion\&.bash to add or remove commands from the list of completed commands\&. Normally only porcelain commands and a few select others are completed\&. You can add more commands, separated by space, in this variable\&. Prefixing the command with
  3018. \fI\-\fR
  3019. will remove it from the existing list\&.
  3020. .RE
  3021. .PP
  3022. core\&.fileMode
  3023. .RS 4
  3024. Tells Git if the executable bit of files in the working tree is to be honored\&.
  3025. .sp
  3026. Some filesystems lose the executable bit when a file that is marked as executable is checked out, or checks out a non\-executable file with executable bit on\&.
  3027. \fBgit-clone\fR(1)
  3028. or
  3029. \fBgit-init\fR(1)
  3030. probe the filesystem to see if it handles the executable bit correctly and this variable is automatically set as necessary\&.
  3031. .sp
  3032. A repository, however, may be on a filesystem that handles the filemode correctly, and this variable is set to
  3033. \fItrue\fR
  3034. when created, but later may be made accessible from another environment that loses the filemode (e\&.g\&. exporting ext4 via CIFS mount, visiting a Cygwin created repository with Git for Windows or Eclipse)\&. In such a case it may be necessary to set this variable to
  3035. \fIfalse\fR\&. See
  3036. \fBgit-update-index\fR(1)\&.
  3037. .sp
  3038. The default is true (when core\&.filemode is not specified in the config file)\&.
  3039. .RE
  3040. .PP
  3041. core\&.hideDotFiles
  3042. .RS 4
  3043. (Windows\-only) If true, mark newly\-created directories and files whose name starts with a dot as hidden\&. If
  3044. \fIdotGitOnly\fR, only the \&.\fBgit/\fR
  3045. directory is hidden, but no other files starting with a dot\&. The default mode is
  3046. \fIdotGitOnly\fR\&.
  3047. .RE
  3048. .PP
  3049. core\&.ignoreCase
  3050. .RS 4
  3051. Internal variable which enables various workarounds to enable Git to work better on filesystems that are not case sensitive, like APFS, HFS+, FAT, NTFS, etc\&. For example, if a directory listing finds "makefile" when Git expects "Makefile", Git will assume it is really the same file, and continue to remember it as "Makefile"\&.
  3052. .sp
  3053. The default is false, except
  3054. \fBgit-clone\fR(1)
  3055. or
  3056. \fBgit-init\fR(1)
  3057. will probe and set core\&.ignoreCase true if appropriate when the repository is created\&.
  3058. .sp
  3059. Git relies on the proper configuration of this variable for your operating and file system\&. Modifying this value may result in unexpected behavior\&.
  3060. .RE
  3061. .PP
  3062. core\&.precomposeUnicode
  3063. .RS 4
  3064. This option is only used by Mac OS implementation of Git\&. When core\&.precomposeUnicode=true, Git reverts the unicode decomposition of filenames done by Mac OS\&. This is useful when sharing a repository between Mac OS and Linux or Windows\&. (Git for Windows 1\&.7\&.10 or higher is needed, or Git under cygwin 1\&.7)\&. When false, file names are handled fully transparent by Git, which is backward compatible with older versions of Git\&.
  3065. .RE
  3066. .PP
  3067. core\&.protectHFS
  3068. .RS 4
  3069. If set to true, do not allow checkout of paths that would be considered equivalent to \&.\fBgit\fR
  3070. on an HFS+ filesystem\&. Defaults to
  3071. \fBtrue\fR
  3072. on Mac OS, and
  3073. \fBfalse\fR
  3074. elsewhere\&.
  3075. .RE
  3076. .PP
  3077. core\&.protectNTFS
  3078. .RS 4
  3079. If set to true, do not allow checkout of paths that would cause problems with the NTFS filesystem, e\&.g\&. conflict with 8\&.3 "short" names\&. Defaults to
  3080. \fBtrue\fR
  3081. on Windows, and
  3082. \fBfalse\fR
  3083. elsewhere\&.
  3084. .RE
  3085. .PP
  3086. core\&.fsmonitor
  3087. .RS 4
  3088. If set to true, enable the built\-in file system monitor daemon for this working directory (\fBgit-fsmonitor--daemon\fR(1))\&.
  3089. .sp
  3090. Like hook\-based file system monitors, the built\-in file system monitor can speed up Git commands that need to refresh the Git index (e\&.g\&.
  3091. \fBgit\fR
  3092. \fBstatus\fR) in a working directory with many files\&. The built\-in monitor eliminates the need to install and maintain an external third\-party tool\&.
  3093. .sp
  3094. The built\-in file system monitor is currently available only on a limited set of supported platforms\&. Currently, this includes Windows and MacOS\&.
  3095. .sp
  3096. .if n \{\
  3097. .RS 4
  3098. .\}
  3099. .nf
  3100. Otherwise, this variable contains the pathname of the "fsmonitor"
  3101. hook command\&.
  3102. .fi
  3103. .if n \{\
  3104. .RE
  3105. .\}
  3106. .sp
  3107. This hook command is used to identify all files that may have changed since the requested date/time\&. This information is used to speed up git by avoiding unnecessary scanning of files that have not changed\&.
  3108. .sp
  3109. See the "fsmonitor\-watchman" section of
  3110. \fBgithooks\fR(5)\&.
  3111. .sp
  3112. Note that if you concurrently use multiple versions of Git, such as one version on the command line and another version in an IDE tool, that the definition of
  3113. \fBcore\&.fsmonitor\fR
  3114. was extended to allow boolean values in addition to hook pathnames\&. Git versions 2\&.35\&.1 and prior will not understand the boolean values and will consider the "true" or "false" values as hook pathnames to be invoked\&. Git versions 2\&.26 thru 2\&.35\&.1 default to hook protocol V2 and will fall back to no fsmonitor (full scan)\&. Git versions prior to 2\&.26 default to hook protocol V1 and will silently assume there were no changes to report (no scan), so status commands may report incomplete results\&. For this reason, it is best to upgrade all of your Git versions before using the built\-in file system monitor\&.
  3115. .RE
  3116. .PP
  3117. core\&.fsmonitorHookVersion
  3118. .RS 4
  3119. Sets the protocol version to be used when invoking the "fsmonitor" hook\&.
  3120. .sp
  3121. There are currently versions 1 and 2\&. When this is not set, version 2 will be tried first and if it fails then version 1 will be tried\&. Version 1 uses a timestamp as input to determine which files have changes since that time but some monitors like Watchman have race conditions when used with a timestamp\&. Version 2 uses an opaque string so that the monitor can return something that can be used to determine what files have changed without race conditions\&.
  3122. .RE
  3123. .PP
  3124. core\&.trustctime
  3125. .RS 4
  3126. If false, the ctime differences between the index and the working tree are ignored; useful when the inode change time is regularly modified by something outside Git (file system crawlers and some backup systems)\&. See
  3127. \fBgit-update-index\fR(1)\&. True by default\&.
  3128. .RE
  3129. .PP
  3130. core\&.splitIndex
  3131. .RS 4
  3132. If true, the split\-index feature of the index will be used\&. See
  3133. \fBgit-update-index\fR(1)\&. False by default\&.
  3134. .RE
  3135. .PP
  3136. core\&.untrackedCache
  3137. .RS 4
  3138. Determines what to do about the untracked cache feature of the index\&. It will be kept, if this variable is unset or set to
  3139. \fBkeep\fR\&. It will automatically be added if set to
  3140. \fBtrue\fR\&. And it will automatically be removed, if set to
  3141. \fBfalse\fR\&. Before setting it to
  3142. \fBtrue\fR, you should check that mtime is working properly on your system\&. See
  3143. \fBgit-update-index\fR(1)\&.
  3144. \fBkeep\fR
  3145. by default, unless
  3146. \fBfeature\&.manyFiles\fR
  3147. is enabled which sets this setting to
  3148. \fBtrue\fR
  3149. by default\&.
  3150. .RE
  3151. .PP
  3152. core\&.checkStat
  3153. .RS 4
  3154. When missing or is set to
  3155. \fBdefault\fR, many fields in the stat structure are checked to detect if a file has been modified since Git looked at it\&. When this configuration variable is set to
  3156. \fBminimal\fR, sub\-second part of mtime and ctime, the uid and gid of the owner of the file, the inode number (and the device number, if Git was compiled to use it), are excluded from the check among these fields, leaving only the whole\-second part of mtime (and ctime, if
  3157. \fBcore\&.trustCtime\fR
  3158. is set) and the filesize to be checked\&.
  3159. .sp
  3160. There are implementations of Git that do not leave usable values in some fields (e\&.g\&. JGit); by excluding these fields from the comparison, the
  3161. \fBminimal\fR
  3162. mode may help interoperability when the same repository is used by these other systems at the same time\&.
  3163. .RE
  3164. .PP
  3165. core\&.quotePath
  3166. .RS 4
  3167. Commands that output paths (e\&.g\&.
  3168. \fIls\-files\fR,
  3169. \fIdiff\fR), will quote "unusual" characters in the pathname by enclosing the pathname in double\-quotes and escaping those characters with backslashes in the same way C escapes control characters (e\&.g\&. \et for TAB, \en for LF, \e\e for backslash) or bytes with values larger than 0x80 (e\&.g\&. octal \e302\e265 for "micro" in UTF\-8)\&. If this variable is set to false, bytes higher than 0x80 are not considered "unusual" any more\&. Double\-quotes, backslash and control characters are always escaped regardless of the setting of this variable\&. A simple space character is not considered "unusual"\&. Many commands can output pathnames completely verbatim using the
  3170. \fB\-z\fR
  3171. option\&. The default value is true\&.
  3172. .RE
  3173. .PP
  3174. core\&.eol
  3175. .RS 4
  3176. Sets the line ending type to use in the working directory for files that are marked as text (either by having the
  3177. \fBtext\fR
  3178. attribute set, or by having
  3179. \fBtext=auto\fR
  3180. and Git auto\-detecting the contents as text)\&. Alternatives are
  3181. \fIlf\fR,
  3182. \fIcrlf\fR
  3183. and
  3184. \fInative\fR, which uses the platform\(cqs native line ending\&. The default value is
  3185. \fBnative\fR\&. See
  3186. \fBgitattributes\fR(5)
  3187. for more information on end\-of\-line conversion\&. Note that this value is ignored if
  3188. \fBcore\&.autocrlf\fR
  3189. is set to
  3190. \fBtrue\fR
  3191. or
  3192. \fBinput\fR\&.
  3193. .RE
  3194. .PP
  3195. core\&.safecrlf
  3196. .RS 4
  3197. If true, makes Git check if converting
  3198. \fBCRLF\fR
  3199. is reversible when end\-of\-line conversion is active\&. Git will verify if a command modifies a file in the work tree either directly or indirectly\&. For example, committing a file followed by checking out the same file should yield the original file in the work tree\&. If this is not the case for the current setting of
  3200. \fBcore\&.autocrlf\fR, Git will reject the file\&. The variable can be set to "warn", in which case Git will only warn about an irreversible conversion but continue the operation\&.
  3201. .sp
  3202. CRLF conversion bears a slight chance of corrupting data\&. When it is enabled, Git will convert CRLF to LF during commit and LF to CRLF during checkout\&. A file that contains a mixture of LF and CRLF before the commit cannot be recreated by Git\&. For text files this is the right thing to do: it corrects line endings such that we have only LF line endings in the repository\&. But for binary files that are accidentally classified as text the conversion can corrupt data\&.
  3203. .sp
  3204. If you recognize such corruption early you can easily fix it by setting the conversion type explicitly in \&.gitattributes\&. Right after committing you still have the original file in your work tree and this file is not yet corrupted\&. You can explicitly tell Git that this file is binary and Git will handle the file appropriately\&.
  3205. .sp
  3206. Unfortunately, the desired effect of cleaning up text files with mixed line endings and the undesired effect of corrupting binary files cannot be distinguished\&. In both cases CRLFs are removed in an irreversible way\&. For text files this is the right thing to do because CRLFs are line endings, while for binary files converting CRLFs corrupts data\&.
  3207. .sp
  3208. Note, this safety check does not mean that a checkout will generate a file identical to the original file for a different setting of
  3209. \fBcore\&.eol\fR
  3210. and
  3211. \fBcore\&.autocrlf\fR, but only for the current one\&. For example, a text file with
  3212. \fBLF\fR
  3213. would be accepted with
  3214. \fBcore\&.eol=lf\fR
  3215. and could later be checked out with
  3216. \fBcore\&.eol=crlf\fR, in which case the resulting file would contain
  3217. \fBCRLF\fR, although the original file contained
  3218. \fBLF\fR\&. However, in both work trees the line endings would be consistent, that is either all
  3219. \fBLF\fR
  3220. or all
  3221. \fBCRLF\fR, but never mixed\&. A file with mixed line endings would be reported by the
  3222. \fBcore\&.safecrlf\fR
  3223. mechanism\&.
  3224. .RE
  3225. .PP
  3226. core\&.autocrlf
  3227. .RS 4
  3228. Setting this variable to "true" is the same as setting the
  3229. \fBtext\fR
  3230. attribute to "auto" on all files and core\&.eol to "crlf"\&. Set to true if you want to have
  3231. \fBCRLF\fR
  3232. line endings in your working directory and the repository has LF line endings\&. This variable can be set to
  3233. \fIinput\fR, in which case no output conversion is performed\&.
  3234. .RE
  3235. .PP
  3236. core\&.checkRoundtripEncoding
  3237. .RS 4
  3238. A comma and/or whitespace separated list of encodings that Git performs UTF\-8 round trip checks on if they are used in an
  3239. \fBworking\-tree\-encoding\fR
  3240. attribute (see
  3241. \fBgitattributes\fR(5))\&. The default value is
  3242. \fBSHIFT\-JIS\fR\&.
  3243. .RE
  3244. .PP
  3245. core\&.symlinks
  3246. .RS 4
  3247. If false, symbolic links are checked out as small plain files that contain the link text\&.
  3248. \fBgit-update-index\fR(1)
  3249. and
  3250. \fBgit-add\fR(1)
  3251. will not change the recorded type to regular file\&. Useful on filesystems like FAT that do not support symbolic links\&.
  3252. .sp
  3253. The default is true, except
  3254. \fBgit-clone\fR(1)
  3255. or
  3256. \fBgit-init\fR(1)
  3257. will probe and set core\&.symlinks false if appropriate when the repository is created\&.
  3258. .RE
  3259. .PP
  3260. core\&.gitProxy
  3261. .RS 4
  3262. A "proxy command" to execute (as
  3263. \fIcommand host port\fR) instead of establishing direct connection to the remote server when using the Git protocol for fetching\&. If the variable value is in the "COMMAND for DOMAIN" format, the command is applied only on hostnames ending with the specified domain string\&. This variable may be set multiple times and is matched in the given order; the first match wins\&.
  3264. .sp
  3265. Can be overridden by the
  3266. \fBGIT_PROXY_COMMAND\fR
  3267. environment variable (which always applies universally, without the special "for" handling)\&.
  3268. .sp
  3269. The special string
  3270. \fBnone\fR
  3271. can be used as the proxy command to specify that no proxy be used for a given domain pattern\&. This is useful for excluding servers inside a firewall from proxy use, while defaulting to a common proxy for external domains\&.
  3272. .RE
  3273. .PP
  3274. core\&.sshCommand
  3275. .RS 4
  3276. If this variable is set,
  3277. \fBgit\fR
  3278. \fBfetch\fR
  3279. and
  3280. \fBgit\fR
  3281. \fBpush\fR
  3282. will use the specified command instead of
  3283. \fBssh\fR
  3284. when they need to connect to a remote system\&. The command is in the same form as the
  3285. \fBGIT_SSH_COMMAND\fR
  3286. environment variable and is overridden when the environment variable is set\&.
  3287. .RE
  3288. .PP
  3289. core\&.ignoreStat
  3290. .RS 4
  3291. If true, Git will avoid using lstat() calls to detect if files have changed by setting the "assume\-unchanged" bit for those tracked files which it has updated identically in both the index and working tree\&.
  3292. .sp
  3293. When files are modified outside of Git, the user will need to stage the modified files explicitly (e\&.g\&. see
  3294. \fIExamples\fR
  3295. section in
  3296. \fBgit-update-index\fR(1))\&. Git will not normally detect changes to those files\&.
  3297. .sp
  3298. This is useful on systems where lstat() calls are very slow, such as CIFS/Microsoft Windows\&.
  3299. .sp
  3300. False by default\&.
  3301. .RE
  3302. .PP
  3303. core\&.preferSymlinkRefs
  3304. .RS 4
  3305. Instead of the default "symref" format for HEAD and other symbolic reference files, use symbolic links\&. This is sometimes needed to work with old scripts that expect HEAD to be a symbolic link\&.
  3306. .RE
  3307. .PP
  3308. core\&.alternateRefsCommand
  3309. .RS 4
  3310. When advertising tips of available history from an alternate, use the shell to execute the specified command instead of
  3311. \fBgit-for-each-ref\fR(1)\&. The first argument is the absolute path of the alternate\&. Output must contain one hex object id per line (i\&.e\&., the same as produced by
  3312. \fBgit\fR
  3313. \fBfor\-each\-ref\fR
  3314. \fB\-\-format=\fR\*(Aq%(\fBobjectname\fR)\*(Aq)\&.
  3315. .sp
  3316. Note that you cannot generally put
  3317. \fBgit\fR
  3318. \fBfor\-each\-ref\fR
  3319. directly into the config value, as it does not take a repository path as an argument (but you can wrap the command above in a shell script)\&.
  3320. .RE
  3321. .PP
  3322. core\&.alternateRefsPrefixes
  3323. .RS 4
  3324. When listing references from an alternate, list only references that begin with the given prefix\&. Prefixes match as if they were given as arguments to
  3325. \fBgit-for-each-ref\fR(1)\&. To list multiple prefixes, separate them with whitespace\&. If
  3326. \fBcore\&.alternateRefsCommand\fR
  3327. is set, setting
  3328. \fBcore\&.alternateRefsPrefixes\fR
  3329. has no effect\&.
  3330. .RE
  3331. .PP
  3332. core\&.bare
  3333. .RS 4
  3334. If true this repository is assumed to be
  3335. \fIbare\fR
  3336. and has no working directory associated with it\&. If this is the case a number of commands that require a working directory will be disabled, such as
  3337. \fBgit-add\fR(1)
  3338. or
  3339. \fBgit-merge\fR(1)\&.
  3340. .sp
  3341. This setting is automatically guessed by
  3342. \fBgit-clone\fR(1)
  3343. or
  3344. \fBgit-init\fR(1)
  3345. when the repository was created\&. By default a repository that ends in "/\&.git" is assumed to be not bare (bare = false), while all other repositories are assumed to be bare (bare = true)\&.
  3346. .RE
  3347. .PP
  3348. core\&.worktree
  3349. .RS 4
  3350. Set the path to the root of the working tree\&. If
  3351. \fBGIT_COMMON_DIR\fR
  3352. environment variable is set, core\&.worktree is ignored and not used for determining the root of working tree\&. This can be overridden by the
  3353. \fBGIT_WORK_TREE\fR
  3354. environment variable and the
  3355. \fB\-\-work\-tree\fR
  3356. command\-line option\&. The value can be an absolute path or relative to the path to the \&.git directory, which is either specified by \-\-git\-dir or GIT_DIR, or automatically discovered\&. If \-\-git\-dir or GIT_DIR is specified but none of \-\-work\-tree, GIT_WORK_TREE and core\&.worktree is specified, the current working directory is regarded as the top level of your working tree\&.
  3357. .sp
  3358. Note that this variable is honored even when set in a configuration file in a "\&.git" subdirectory of a directory and its value differs from the latter directory (e\&.g\&. "/path/to/\&.git/config" has core\&.worktree set to "/different/path"), which is most likely a misconfiguration\&. Running Git commands in the "/path/to" directory will still use "/different/path" as the root of the work tree and can cause confusion unless you know what you are doing (e\&.g\&. you are creating a read\-only snapshot of the same index to a location different from the repository\(cqs usual working tree)\&.
  3359. .RE
  3360. .PP
  3361. core\&.logAllRefUpdates
  3362. .RS 4
  3363. Enable the reflog\&. Updates to a ref <ref> is logged to the file "\fB$GIT_DIR/logs/\fR\fI<ref>\fR", by appending the new and old SHA\-1, the date/time and the reason of the update, but only when the file exists\&. If this configuration variable is set to
  3364. \fBtrue\fR, missing "\fB$GIT_DIR/logs/\fR\fI<ref>\fR" file is automatically created for branch heads (i\&.e\&. under
  3365. \fBrefs/heads/\fR), remote refs (i\&.e\&. under
  3366. \fBrefs/remotes/\fR), note refs (i\&.e\&. under
  3367. \fBrefs/notes/\fR), and the symbolic ref
  3368. \fBHEAD\fR\&. If it is set to
  3369. \fBalways\fR, then a missing reflog is automatically created for any ref under
  3370. \fBrefs/\fR\&.
  3371. .sp
  3372. This information can be used to determine what commit was the tip of a branch "2 days ago"\&.
  3373. .sp
  3374. This value is true by default in a repository that has a working directory associated with it, and false by default in a bare repository\&.
  3375. .RE
  3376. .PP
  3377. core\&.repositoryFormatVersion
  3378. .RS 4
  3379. Internal variable identifying the repository format and layout version\&. See
  3380. \fBgitrepository-layout\fR(5)\&.
  3381. .RE
  3382. .PP
  3383. core\&.sharedRepository
  3384. .RS 4
  3385. When
  3386. \fIgroup\fR
  3387. (or
  3388. \fItrue\fR), the repository is made shareable between several users in a group (making sure all the files and objects are group\-writable)\&. When
  3389. \fIall\fR
  3390. (or
  3391. \fIworld\fR
  3392. or
  3393. \fIeverybody\fR), the repository will be readable by all users, additionally to being group\-shareable\&. When
  3394. \fIumask\fR
  3395. (or
  3396. \fIfalse\fR), Git will use permissions reported by umask(2)\&. When
  3397. \fI0xxx\fR, where
  3398. \fI0xxx\fR
  3399. is an octal number, files in the repository will have this mode value\&.
  3400. \fI0xxx\fR
  3401. will override user\(cqs umask value (whereas the other options will only override requested parts of the user\(cqs umask value)\&. Examples:
  3402. \fI0660\fR
  3403. will make the repo read/write\-able for the owner and group, but inaccessible to others (equivalent to
  3404. \fIgroup\fR
  3405. unless umask is e\&.g\&.
  3406. \fI0022\fR)\&.
  3407. \fI0640\fR
  3408. is a repository that is group\-readable but not group\-writable\&. See
  3409. \fBgit-init\fR(1)\&. False by default\&.
  3410. .RE
  3411. .PP
  3412. core\&.warnAmbiguousRefs
  3413. .RS 4
  3414. If true, Git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the repository\&. True by default\&.
  3415. .RE
  3416. .PP
  3417. core\&.compression
  3418. .RS 4
  3419. An integer \-1\&.\&.9, indicating a default compression level\&. \-1 is the zlib default\&. 0 means no compression, and 1\&.\&.9 are various speed/size tradeoffs, 9 being slowest\&. If set, this provides a default to other compression variables, such as
  3420. \fBcore\&.looseCompression\fR
  3421. and
  3422. \fBpack\&.compression\fR\&.
  3423. .RE
  3424. .PP
  3425. core\&.looseCompression
  3426. .RS 4
  3427. An integer \-1\&.\&.9, indicating the compression level for objects that are not in a pack file\&. \-1 is the zlib default\&. 0 means no compression, and 1\&.\&.9 are various speed/size tradeoffs, 9 being slowest\&. If not set, defaults to core\&.compression\&. If that is not set, defaults to 1 (best speed)\&.
  3428. .RE
  3429. .PP
  3430. core\&.packedGitWindowSize
  3431. .RS 4
  3432. Number of bytes of a pack file to map into memory in a single mapping operation\&. Larger window sizes may allow your system to process a smaller number of large pack files more quickly\&. Smaller window sizes will negatively affect performance due to increased calls to the operating system\(cqs memory manager, but may improve performance when accessing a large number of large pack files\&.
  3433. .sp
  3434. Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 MiB on 32 bit platforms and 1 GiB on 64 bit platforms\&. This should be reasonable for all users/operating systems\&. You probably do not need to adjust this value\&.
  3435. .sp
  3436. Common unit suffixes of
  3437. \fIk\fR,
  3438. \fIm\fR, or
  3439. \fIg\fR
  3440. are supported\&.
  3441. .RE
  3442. .PP
  3443. core\&.packedGitLimit
  3444. .RS 4
  3445. Maximum number of bytes to map simultaneously into memory from pack files\&. If Git needs to access more than this many bytes at once to complete an operation it will unmap existing regions to reclaim virtual address space within the process\&.
  3446. .sp
  3447. Default is 256 MiB on 32 bit platforms and 32 TiB (effectively unlimited) on 64 bit platforms\&. This should be reasonable for all users/operating systems, except on the largest projects\&. You probably do not need to adjust this value\&.
  3448. .sp
  3449. Common unit suffixes of
  3450. \fIk\fR,
  3451. \fIm\fR, or
  3452. \fIg\fR
  3453. are supported\&.
  3454. .RE
  3455. .PP
  3456. core\&.deltaBaseCacheLimit
  3457. .RS 4
  3458. Maximum number of bytes per thread to reserve for caching base objects that may be referenced by multiple deltified objects\&. By storing the entire decompressed base objects in a cache Git is able to avoid unpacking and decompressing frequently used base objects multiple times\&.
  3459. .sp
  3460. Default is 96 MiB on all platforms\&. This should be reasonable for all users/operating systems, except on the largest projects\&. You probably do not need to adjust this value\&.
  3461. .sp
  3462. Common unit suffixes of
  3463. \fIk\fR,
  3464. \fIm\fR, or
  3465. \fIg\fR
  3466. are supported\&.
  3467. .RE
  3468. .PP
  3469. core\&.bigFileThreshold
  3470. .RS 4
  3471. The size of files considered "big", which as discussed below changes the behavior of numerous git commands, as well as how such files are stored within the repository\&. The default is 512 MiB\&. Common unit suffixes of
  3472. \fIk\fR,
  3473. \fIm\fR, or
  3474. \fIg\fR
  3475. are supported\&.
  3476. .sp
  3477. Files above the configured limit will be:
  3478. .sp
  3479. .RS 4
  3480. .ie n \{\
  3481. \h'-04'\(bu\h'+03'\c
  3482. .\}
  3483. .el \{\
  3484. .sp -1
  3485. .IP \(bu 2.3
  3486. .\}
  3487. Stored deflated in packfiles, without attempting delta compression\&.
  3488. .sp
  3489. The default limit is primarily set with this use\-case in mind\&. With it, most projects will have their source code and other text files delta compressed, but not larger binary media files\&.
  3490. .sp
  3491. Storing large files without delta compression avoids excessive memory usage, at the slight expense of increased disk usage\&.
  3492. .RE
  3493. .sp
  3494. .RS 4
  3495. .ie n \{\
  3496. \h'-04'\(bu\h'+03'\c
  3497. .\}
  3498. .el \{\
  3499. .sp -1
  3500. .IP \(bu 2.3
  3501. .\}
  3502. Will be treated as if they were labeled "binary" (see
  3503. \fBgitattributes\fR(5))\&. e\&.g\&.
  3504. \fBgit-log\fR(1)
  3505. and
  3506. \fBgit-diff\fR(1)
  3507. will not compute diffs for files above this limit\&.
  3508. .RE
  3509. .sp
  3510. .RS 4
  3511. .ie n \{\
  3512. \h'-04'\(bu\h'+03'\c
  3513. .\}
  3514. .el \{\
  3515. .sp -1
  3516. .IP \(bu 2.3
  3517. .\}
  3518. Will generally be streamed when written, which avoids excessive memory usage, at the cost of some fixed overhead\&. Commands that make use of this include
  3519. \fBgit-archive\fR(1),
  3520. \fBgit-fast-import\fR(1),
  3521. \fBgit-index-pack\fR(1),
  3522. \fBgit-unpack-objects\fR(1)
  3523. and
  3524. \fBgit-fsck\fR(1)\&.
  3525. .RE
  3526. .RE
  3527. .PP
  3528. core\&.excludesFile
  3529. .RS 4
  3530. Specifies the pathname to the file that contains patterns to describe paths that are not meant to be tracked, in addition to \&.\fBgitignore\fR
  3531. (per\-directory) and \&.\fBgit/info/exclude\fR\&. Defaults to
  3532. \fB$XDG_CONFIG_HOME/git/ignore\fR\&. If
  3533. \fB$XDG_CONFIG_HOME\fR
  3534. is either not set or empty,
  3535. \fB$HOME/\&.config/git/ignore\fR
  3536. is used instead\&. See
  3537. \fBgitignore\fR(5)\&.
  3538. .RE
  3539. .PP
  3540. core\&.askPass
  3541. .RS 4
  3542. Some commands (e\&.g\&. svn and http interfaces) that interactively ask for a password can be told to use an external program given via the value of this variable\&. Can be overridden by the
  3543. \fBGIT_ASKPASS\fR
  3544. environment variable\&. If not set, fall back to the value of the
  3545. \fBSSH_ASKPASS\fR
  3546. environment variable or, failing that, a simple password prompt\&. The external program shall be given a suitable prompt as command\-line argument and write the password on its STDOUT\&.
  3547. .RE
  3548. .PP
  3549. core\&.attributesFile
  3550. .RS 4
  3551. In addition to \&.\fBgitattributes\fR
  3552. (per\-directory) and \&.\fBgit/info/attributes\fR, Git looks into this file for attributes (see
  3553. \fBgitattributes\fR(5))\&. Path expansions are made the same way as for
  3554. \fBcore\&.excludesFile\fR\&. Its default value is
  3555. \fB$XDG_CONFIG_HOME/git/attributes\fR\&. If
  3556. \fB$XDG_CONFIG_HOME\fR
  3557. is either not set or empty,
  3558. \fB$HOME/\&.config/git/attributes\fR
  3559. is used instead\&.
  3560. .RE
  3561. .PP
  3562. core\&.hooksPath
  3563. .RS 4
  3564. By default Git will look for your hooks in the
  3565. \fB$GIT_DIR/hooks\fR
  3566. directory\&. Set this to different path, e\&.g\&.
  3567. \fB/etc/git/hooks\fR, and Git will try to find your hooks in that directory, e\&.g\&.
  3568. \fB/etc/git/hooks/pre\-receive\fR
  3569. instead of in
  3570. \fB$GIT_DIR/hooks/pre\-receive\fR\&.
  3571. .sp
  3572. The path can be either absolute or relative\&. A relative path is taken as relative to the directory where the hooks are run (see the "DESCRIPTION" section of
  3573. \fBgithooks\fR(5))\&.
  3574. .sp
  3575. This configuration variable is useful in cases where you\(cqd like to centrally configure your Git hooks instead of configuring them on a per\-repository basis, or as a more flexible and centralized alternative to having an
  3576. \fBinit\&.templateDir\fR
  3577. where you\(cqve changed default hooks\&.
  3578. .RE
  3579. .PP
  3580. core\&.editor
  3581. .RS 4
  3582. Commands such as
  3583. \fBcommit\fR
  3584. and
  3585. \fBtag\fR
  3586. that let you edit messages by launching an editor use the value of this variable when it is set, and the environment variable
  3587. \fBGIT_EDITOR\fR
  3588. is not set\&. See
  3589. \fBgit-var\fR(1)\&.
  3590. .RE
  3591. .PP
  3592. core\&.commentChar, core\&.commentString
  3593. .RS 4
  3594. Commands such as
  3595. \fBcommit\fR
  3596. and
  3597. \fBtag\fR
  3598. that let you edit messages consider a line that begins with this character commented, and removes them after the editor returns (default
  3599. \fI#\fR)\&.
  3600. .sp
  3601. If set to "auto",
  3602. \fBgit\-commit\fR
  3603. would select a character that is not the beginning character of any line in existing commit messages\&.
  3604. .sp
  3605. Note that these two variables are aliases of each other, and in modern versions of Git you are free to use a string (e\&.g\&.,
  3606. \fB//\fR
  3607. or ⁑⁕⁑) with
  3608. \fBcommentChar\fR\&. Versions of Git prior to v2\&.45\&.0 will ignore
  3609. \fBcommentString\fR
  3610. but will reject a value of
  3611. \fBcommentChar\fR
  3612. that consists of more than a single ASCII byte\&. If you plan to use your config with older and newer versions of Git, you may want to specify both:
  3613. .sp
  3614. .if n \{\
  3615. .RS 4
  3616. .\}
  3617. .nf
  3618. [core]
  3619. # single character for older versions
  3620. commentChar = "#"
  3621. # string for newer versions (which will override commentChar
  3622. # because it comes later in the file)
  3623. commentString = "//"
  3624. .fi
  3625. .if n \{\
  3626. .RE
  3627. .\}
  3628. .RE
  3629. .PP
  3630. core\&.filesRefLockTimeout
  3631. .RS 4
  3632. The length of time, in milliseconds, to retry when trying to lock an individual reference\&. Value 0 means not to retry at all; \-1 means to try indefinitely\&. Default is 100 (i\&.e\&., retry for 100ms)\&.
  3633. .RE
  3634. .PP
  3635. core\&.packedRefsTimeout
  3636. .RS 4
  3637. The length of time, in milliseconds, to retry when trying to lock the
  3638. \fBpacked\-refs\fR
  3639. file\&. Value 0 means not to retry at all; \-1 means to try indefinitely\&. Default is 1000 (i\&.e\&., retry for 1 second)\&.
  3640. .RE
  3641. .PP
  3642. core\&.pager
  3643. .RS 4
  3644. Text viewer for use by Git commands (e\&.g\&.,
  3645. \fIless\fR)\&. The value is meant to be interpreted by the shell\&. The order of preference is the
  3646. \fB$GIT_PAGER\fR
  3647. environment variable, then
  3648. \fBcore\&.pager\fR
  3649. configuration, then
  3650. \fB$PAGER\fR, and then the default chosen at compile time (usually
  3651. \fIless\fR)\&.
  3652. .sp
  3653. When the
  3654. \fBLESS\fR
  3655. environment variable is unset, Git sets it to
  3656. \fBFRX\fR
  3657. (if
  3658. \fBLESS\fR
  3659. environment variable is set, Git does not change it at all)\&. If you want to selectively override Git\(cqs default setting for
  3660. \fBLESS\fR, you can set
  3661. \fBcore\&.pager\fR
  3662. to e\&.g\&.
  3663. \fBless\fR
  3664. \fB\-S\fR\&. This will be passed to the shell by Git, which will translate the final command to
  3665. \fBLESS=FRX\fR
  3666. \fBless\fR
  3667. \fB\-S\fR\&. The environment does not set the
  3668. \fBS\fR
  3669. option but the command line does, instructing less to truncate long lines\&. Similarly, setting
  3670. \fBcore\&.pager\fR
  3671. to
  3672. \fBless\fR
  3673. \fB\-+F\fR
  3674. will deactivate the
  3675. \fBF\fR
  3676. option specified by the environment from the command\-line, deactivating the "quit if one screen" behavior of
  3677. \fBless\fR\&. One can specifically activate some flags for particular commands: for example, setting
  3678. \fBpager\&.blame\fR
  3679. to
  3680. \fBless\fR
  3681. \fB\-S\fR
  3682. enables line truncation only for
  3683. \fBgit\fR
  3684. \fBblame\fR\&.
  3685. .sp
  3686. Likewise, when the
  3687. \fBLV\fR
  3688. environment variable is unset, Git sets it to
  3689. \fB\-c\fR\&. You can override this setting by exporting
  3690. \fBLV\fR
  3691. with another value or setting
  3692. \fBcore\&.pager\fR
  3693. to
  3694. \fBlv\fR
  3695. \fB+c\fR\&.
  3696. .RE
  3697. .PP
  3698. core\&.whitespace
  3699. .RS 4
  3700. A comma separated list of common whitespace problems to notice\&.
  3701. \fIgit diff\fR
  3702. will use
  3703. \fBcolor\&.diff\&.whitespace\fR
  3704. to highlight them, and
  3705. \fIgit apply \-\-whitespace=error\fR
  3706. will consider them as errors\&. You can prefix
  3707. \fB\-\fR
  3708. to disable any of them (e\&.g\&.
  3709. \fB\-trailing\-space\fR):
  3710. .sp
  3711. .RS 4
  3712. .ie n \{\
  3713. \h'-04'\(bu\h'+03'\c
  3714. .\}
  3715. .el \{\
  3716. .sp -1
  3717. .IP \(bu 2.3
  3718. .\}
  3719. \fBblank\-at\-eol\fR
  3720. treats trailing whitespaces at the end of the line as an error (enabled by default)\&.
  3721. .RE
  3722. .sp
  3723. .RS 4
  3724. .ie n \{\
  3725. \h'-04'\(bu\h'+03'\c
  3726. .\}
  3727. .el \{\
  3728. .sp -1
  3729. .IP \(bu 2.3
  3730. .\}
  3731. \fBspace\-before\-tab\fR
  3732. treats a space character that appears immediately before a tab character in the initial indent part of the line as an error (enabled by default)\&.
  3733. .RE
  3734. .sp
  3735. .RS 4
  3736. .ie n \{\
  3737. \h'-04'\(bu\h'+03'\c
  3738. .\}
  3739. .el \{\
  3740. .sp -1
  3741. .IP \(bu 2.3
  3742. .\}
  3743. \fBindent\-with\-non\-tab\fR
  3744. treats a line that is indented with space characters instead of the equivalent tabs as an error (not enabled by default)\&.
  3745. .RE
  3746. .sp
  3747. .RS 4
  3748. .ie n \{\
  3749. \h'-04'\(bu\h'+03'\c
  3750. .\}
  3751. .el \{\
  3752. .sp -1
  3753. .IP \(bu 2.3
  3754. .\}
  3755. \fBtab\-in\-indent\fR
  3756. treats a tab character in the initial indent part of the line as an error (not enabled by default)\&.
  3757. .RE
  3758. .sp
  3759. .RS 4
  3760. .ie n \{\
  3761. \h'-04'\(bu\h'+03'\c
  3762. .\}
  3763. .el \{\
  3764. .sp -1
  3765. .IP \(bu 2.3
  3766. .\}
  3767. \fBblank\-at\-eof\fR
  3768. treats blank lines added at the end of file as an error (enabled by default)\&.
  3769. .RE
  3770. .sp
  3771. .RS 4
  3772. .ie n \{\
  3773. \h'-04'\(bu\h'+03'\c
  3774. .\}
  3775. .el \{\
  3776. .sp -1
  3777. .IP \(bu 2.3
  3778. .\}
  3779. \fBtrailing\-space\fR
  3780. is a short\-hand to cover both
  3781. \fBblank\-at\-eol\fR
  3782. and
  3783. \fBblank\-at\-eof\fR\&.
  3784. .RE
  3785. .sp
  3786. .RS 4
  3787. .ie n \{\
  3788. \h'-04'\(bu\h'+03'\c
  3789. .\}
  3790. .el \{\
  3791. .sp -1
  3792. .IP \(bu 2.3
  3793. .\}
  3794. \fBcr\-at\-eol\fR
  3795. treats a carriage\-return at the end of line as part of the line terminator, i\&.e\&. with it,
  3796. \fBtrailing\-space\fR
  3797. does not trigger if the character before such a carriage\-return is not a whitespace (not enabled by default)\&.
  3798. .RE
  3799. .sp
  3800. .RS 4
  3801. .ie n \{\
  3802. \h'-04'\(bu\h'+03'\c
  3803. .\}
  3804. .el \{\
  3805. .sp -1
  3806. .IP \(bu 2.3
  3807. .\}
  3808. \fBtabwidth=\fR\fI<n>\fR
  3809. tells how many character positions a tab occupies; this is relevant for
  3810. \fBindent\-with\-non\-tab\fR
  3811. and when Git fixes
  3812. \fBtab\-in\-indent\fR
  3813. errors\&. The default tab width is 8\&. Allowed values are 1 to 63\&.
  3814. .RE
  3815. .RE
  3816. .PP
  3817. core\&.fsync
  3818. .RS 4
  3819. A comma\-separated list of components of the repository that should be hardened via the core\&.fsyncMethod when created or modified\&. You can disable hardening of any component by prefixing it with a
  3820. \fI\-\fR\&. Items that are not hardened may be lost in the event of an unclean system shutdown\&. Unless you have special requirements, it is recommended that you leave this option empty or pick one of
  3821. \fBcommitted\fR,
  3822. \fBadded\fR, or
  3823. \fBall\fR\&.
  3824. .sp
  3825. When this configuration is encountered, the set of components starts with the platform default value, disabled components are removed, and additional components are added\&.
  3826. \fBnone\fR
  3827. resets the state so that the platform default is ignored\&.
  3828. .sp
  3829. The empty string resets the fsync configuration to the platform default\&. The default on most platforms is equivalent to
  3830. \fBcore\&.fsync=committed,\-loose\-object\fR, which has good performance, but risks losing recent work in the event of an unclean system shutdown\&.
  3831. .sp
  3832. .RS 4
  3833. .ie n \{\
  3834. \h'-04'\(bu\h'+03'\c
  3835. .\}
  3836. .el \{\
  3837. .sp -1
  3838. .IP \(bu 2.3
  3839. .\}
  3840. \fBnone\fR
  3841. clears the set of fsynced components\&.
  3842. .RE
  3843. .sp
  3844. .RS 4
  3845. .ie n \{\
  3846. \h'-04'\(bu\h'+03'\c
  3847. .\}
  3848. .el \{\
  3849. .sp -1
  3850. .IP \(bu 2.3
  3851. .\}
  3852. \fBloose\-object\fR
  3853. hardens objects added to the repo in loose\-object form\&.
  3854. .RE
  3855. .sp
  3856. .RS 4
  3857. .ie n \{\
  3858. \h'-04'\(bu\h'+03'\c
  3859. .\}
  3860. .el \{\
  3861. .sp -1
  3862. .IP \(bu 2.3
  3863. .\}
  3864. \fBpack\fR
  3865. hardens objects added to the repo in packfile form\&.
  3866. .RE
  3867. .sp
  3868. .RS 4
  3869. .ie n \{\
  3870. \h'-04'\(bu\h'+03'\c
  3871. .\}
  3872. .el \{\
  3873. .sp -1
  3874. .IP \(bu 2.3
  3875. .\}
  3876. \fBpack\-metadata\fR
  3877. hardens packfile bitmaps and indexes\&.
  3878. .RE
  3879. .sp
  3880. .RS 4
  3881. .ie n \{\
  3882. \h'-04'\(bu\h'+03'\c
  3883. .\}
  3884. .el \{\
  3885. .sp -1
  3886. .IP \(bu 2.3
  3887. .\}
  3888. \fBcommit\-graph\fR
  3889. hardens the commit\-graph file\&.
  3890. .RE
  3891. .sp
  3892. .RS 4
  3893. .ie n \{\
  3894. \h'-04'\(bu\h'+03'\c
  3895. .\}
  3896. .el \{\
  3897. .sp -1
  3898. .IP \(bu 2.3
  3899. .\}
  3900. \fBindex\fR
  3901. hardens the index when it is modified\&.
  3902. .RE
  3903. .sp
  3904. .RS 4
  3905. .ie n \{\
  3906. \h'-04'\(bu\h'+03'\c
  3907. .\}
  3908. .el \{\
  3909. .sp -1
  3910. .IP \(bu 2.3
  3911. .\}
  3912. \fBobjects\fR
  3913. is an aggregate option that is equivalent to
  3914. \fBloose\-object,pack\fR\&.
  3915. .RE
  3916. .sp
  3917. .RS 4
  3918. .ie n \{\
  3919. \h'-04'\(bu\h'+03'\c
  3920. .\}
  3921. .el \{\
  3922. .sp -1
  3923. .IP \(bu 2.3
  3924. .\}
  3925. \fBreference\fR
  3926. hardens references modified in the repo\&.
  3927. .RE
  3928. .sp
  3929. .RS 4
  3930. .ie n \{\
  3931. \h'-04'\(bu\h'+03'\c
  3932. .\}
  3933. .el \{\
  3934. .sp -1
  3935. .IP \(bu 2.3
  3936. .\}
  3937. \fBderived\-metadata\fR
  3938. is an aggregate option that is equivalent to
  3939. \fBpack\-metadata,commit\-graph\fR\&.
  3940. .RE
  3941. .sp
  3942. .RS 4
  3943. .ie n \{\
  3944. \h'-04'\(bu\h'+03'\c
  3945. .\}
  3946. .el \{\
  3947. .sp -1
  3948. .IP \(bu 2.3
  3949. .\}
  3950. \fBcommitted\fR
  3951. is an aggregate option that is currently equivalent to
  3952. \fBobjects\fR\&. This mode sacrifices some performance to ensure that work that is committed to the repository with
  3953. \fBgit\fR
  3954. \fBcommit\fR
  3955. or similar commands is hardened\&.
  3956. .RE
  3957. .sp
  3958. .RS 4
  3959. .ie n \{\
  3960. \h'-04'\(bu\h'+03'\c
  3961. .\}
  3962. .el \{\
  3963. .sp -1
  3964. .IP \(bu 2.3
  3965. .\}
  3966. \fBadded\fR
  3967. is an aggregate option that is currently equivalent to
  3968. \fBcommitted,index\fR\&. This mode sacrifices additional performance to ensure that the results of commands like
  3969. \fBgit\fR
  3970. \fBadd\fR
  3971. and similar operations are hardened\&.
  3972. .RE
  3973. .sp
  3974. .RS 4
  3975. .ie n \{\
  3976. \h'-04'\(bu\h'+03'\c
  3977. .\}
  3978. .el \{\
  3979. .sp -1
  3980. .IP \(bu 2.3
  3981. .\}
  3982. \fBall\fR
  3983. is an aggregate option that syncs all individual components above\&.
  3984. .RE
  3985. .RE
  3986. .PP
  3987. core\&.fsyncMethod
  3988. .RS 4
  3989. A value indicating the strategy Git will use to harden repository data using fsync and related primitives\&.
  3990. .sp
  3991. .RS 4
  3992. .ie n \{\
  3993. \h'-04'\(bu\h'+03'\c
  3994. .\}
  3995. .el \{\
  3996. .sp -1
  3997. .IP \(bu 2.3
  3998. .\}
  3999. \fBfsync\fR
  4000. uses the fsync() system call or platform equivalents\&.
  4001. .RE
  4002. .sp
  4003. .RS 4
  4004. .ie n \{\
  4005. \h'-04'\(bu\h'+03'\c
  4006. .\}
  4007. .el \{\
  4008. .sp -1
  4009. .IP \(bu 2.3
  4010. .\}
  4011. \fBwriteout\-only\fR
  4012. issues pagecache writeback requests, but depending on the filesystem and storage hardware, data added to the repository may not be durable in the event of a system crash\&. This is the default mode on macOS\&.
  4013. .RE
  4014. .sp
  4015. .RS 4
  4016. .ie n \{\
  4017. \h'-04'\(bu\h'+03'\c
  4018. .\}
  4019. .el \{\
  4020. .sp -1
  4021. .IP \(bu 2.3
  4022. .\}
  4023. \fBbatch\fR
  4024. enables a mode that uses writeout\-only flushes to stage multiple updates in the disk writeback cache and then does a single full fsync of a dummy file to trigger the disk cache flush at the end of the operation\&.
  4025. .sp
  4026. Currently
  4027. \fBbatch\fR
  4028. mode only applies to loose\-object files\&. Other repository data is made durable as if
  4029. \fBfsync\fR
  4030. was specified\&. This mode is expected to be as safe as
  4031. \fBfsync\fR
  4032. on macOS for repos stored on HFS+ or APFS filesystems and on Windows for repos stored on NTFS or ReFS filesystems\&.
  4033. .RE
  4034. .RE
  4035. .PP
  4036. core\&.fsyncObjectFiles
  4037. .RS 4
  4038. This boolean will enable
  4039. \fIfsync()\fR
  4040. when writing object files\&. This setting is deprecated\&. Use core\&.fsync instead\&.
  4041. .sp
  4042. This setting affects data added to the Git repository in loose\-object form\&. When set to true, Git will issue an fsync or similar system call to flush caches so that loose\-objects remain consistent in the face of a unclean system shutdown\&.
  4043. .RE
  4044. .PP
  4045. core\&.preloadIndex
  4046. .RS 4
  4047. Enable parallel index preload for operations like
  4048. \fIgit diff\fR
  4049. .sp
  4050. This can speed up operations like
  4051. \fIgit diff\fR
  4052. and
  4053. \fIgit status\fR
  4054. especially on filesystems like NFS that have weak caching semantics and thus relatively high IO latencies\&. When enabled, Git will do the index comparison to the filesystem data in parallel, allowing overlapping IO\(cqs\&. Defaults to true\&.
  4055. .RE
  4056. .PP
  4057. core\&.unsetenvvars
  4058. .RS 4
  4059. Windows\-only: comma\-separated list of environment variables\*(Aq names that need to be unset before spawning any other process\&. Defaults to
  4060. \fBPERL5LIB\fR
  4061. to account for the fact that Git for Windows insists on using its own Perl interpreter\&.
  4062. .RE
  4063. .PP
  4064. core\&.restrictinheritedhandles
  4065. .RS 4
  4066. Windows\-only: override whether spawned processes inherit only standard file handles (\fBstdin\fR,
  4067. \fBstdout\fR
  4068. and
  4069. \fBstderr\fR) or all handles\&. Can be
  4070. \fBauto\fR,
  4071. \fBtrue\fR
  4072. or
  4073. \fBfalse\fR\&. Defaults to
  4074. \fBauto\fR, which means
  4075. \fBtrue\fR
  4076. on Windows 7 and later, and
  4077. \fBfalse\fR
  4078. on older Windows versions\&.
  4079. .RE
  4080. .PP
  4081. core\&.createObject
  4082. .RS 4
  4083. You can set this to
  4084. \fIlink\fR, in which case a hardlink followed by a delete of the source are used to make sure that object creation will not overwrite existing objects\&.
  4085. .sp
  4086. On some file system/operating system combinations, this is unreliable\&. Set this config setting to
  4087. \fIrename\fR
  4088. there; however, this will remove the check that makes sure that existing object files will not get overwritten\&.
  4089. .RE
  4090. .PP
  4091. core\&.notesRef
  4092. .RS 4
  4093. When showing commit messages, also show notes which are stored in the given ref\&. The ref must be fully qualified\&. If the given ref does not exist, it is not an error but means that no notes should be printed\&.
  4094. .sp
  4095. This setting defaults to "refs/notes/commits", and it can be overridden by the
  4096. \fBGIT_NOTES_REF\fR
  4097. environment variable\&. See
  4098. \fBgit-notes\fR(1)\&.
  4099. .RE
  4100. .PP
  4101. core\&.commitGraph
  4102. .RS 4
  4103. If true, then git will read the commit\-graph file (if it exists) to parse the graph structure of commits\&. Defaults to true\&. See
  4104. \fBgit-commit-graph\fR(1)
  4105. for more information\&.
  4106. .RE
  4107. .PP
  4108. core\&.useReplaceRefs
  4109. .RS 4
  4110. If set to
  4111. \fBfalse\fR, behave as if the
  4112. \fB\-\-no\-replace\-objects\fR
  4113. option was given on the command line\&. See
  4114. \fBgit\fR(1)
  4115. and
  4116. \fBgit-replace\fR(1)
  4117. for more information\&.
  4118. .RE
  4119. .PP
  4120. core\&.multiPackIndex
  4121. .RS 4
  4122. Use the multi\-pack\-index file to track multiple packfiles using a single index\&. See
  4123. \fBgit-multi-pack-index\fR(1)
  4124. for more information\&. Defaults to true\&.
  4125. .RE
  4126. .PP
  4127. core\&.sparseCheckout
  4128. .RS 4
  4129. Enable "sparse checkout" feature\&. See
  4130. \fBgit-sparse-checkout\fR(1)
  4131. for more information\&.
  4132. .RE
  4133. .PP
  4134. core\&.sparseCheckoutCone
  4135. .RS 4
  4136. Enables the "cone mode" of the sparse checkout feature\&. When the sparse\-checkout file contains a limited set of patterns, this mode provides significant performance advantages\&. The "non\-cone mode" can be requested to allow specifying more flexible patterns by setting this variable to
  4137. \fIfalse\fR\&. See
  4138. \fBgit-sparse-checkout\fR(1)
  4139. for more information\&.
  4140. .RE
  4141. .PP
  4142. core\&.abbrev
  4143. .RS 4
  4144. Set the length object names are abbreviated to\&. If unspecified or set to "auto", an appropriate value is computed based on the approximate number of packed objects in your repository, which hopefully is enough for abbreviated object names to stay unique for some time\&. If set to "no", no abbreviation is made and the object names are shown in their full length\&. The minimum length is 4\&.
  4145. .RE
  4146. .PP
  4147. core\&.maxTreeDepth
  4148. .RS 4
  4149. The maximum depth Git is willing to recurse while traversing a tree (e\&.g\&., "a/b/cde/f" has a depth of 4)\&. This is a fail\-safe to allow Git to abort cleanly, and should not generally need to be adjusted\&. When Git is compiled with MSVC, the default is 512\&. Otherwise, the default is 2048\&.
  4150. .RE
  4151. .PP
  4152. credential\&.helper
  4153. .RS 4
  4154. Specify an external helper to be called when a username or password credential is needed; the helper may consult external storage to avoid prompting the user for the credentials\&. This is normally the name of a credential helper with possible arguments, but may also be an absolute path with arguments or, if preceded by !, shell commands\&.
  4155. .sp
  4156. Note that multiple helpers may be defined\&. See
  4157. \fBgitcredentials\fR(7)
  4158. for details and examples\&.
  4159. .RE
  4160. .PP
  4161. credential\&.interactive
  4162. .RS 4
  4163. By default, Git and any configured credential helpers will ask for user input when new credentials are required\&. Many of these helpers will succeed based on stored credentials if those credentials are still valid\&. To avoid the possibility of user interactivity from Git, set
  4164. \fBcredential\&.interactive=false\fR\&. Some credential helpers respect this option as well\&.
  4165. .RE
  4166. .PP
  4167. credential\&.useHttpPath
  4168. .RS 4
  4169. When acquiring credentials, consider the "path" component of an http or https URL to be important\&. Defaults to false\&. See
  4170. \fBgitcredentials\fR(7)
  4171. for more information\&.
  4172. .RE
  4173. .PP
  4174. credential\&.sanitizePrompt
  4175. .RS 4
  4176. By default, user names and hosts that are shown as part of the password prompt are not allowed to contain control characters (they will be URL\-encoded by default)\&. Configure this setting to
  4177. \fBfalse\fR
  4178. to override that behavior\&.
  4179. .RE
  4180. .PP
  4181. credential\&.protectProtocol
  4182. .RS 4
  4183. By default, Carriage Return characters are not allowed in the protocol that is used when Git talks to a credential helper\&. This setting allows users to override this default\&.
  4184. .RE
  4185. .PP
  4186. credential\&.username
  4187. .RS 4
  4188. If no username is set for a network authentication, use this username by default\&. See credential\&.<context>\&.* below, and
  4189. \fBgitcredentials\fR(7)\&.
  4190. .RE
  4191. .PP
  4192. credential\&.<url>\&.*
  4193. .RS 4
  4194. Any of the credential\&.* options above can be applied selectively to some credentials\&. For example, "credential\&.https://example\&.com\&.username" would set the default username only for https connections to example\&.com\&. See
  4195. \fBgitcredentials\fR(7)
  4196. for details on how URLs are matched\&.
  4197. .RE
  4198. .PP
  4199. credentialCache\&.ignoreSIGHUP
  4200. .RS 4
  4201. Tell git\-credential\-cache\(em\:daemon to ignore SIGHUP, instead of quitting\&.
  4202. .RE
  4203. .PP
  4204. credentialStore\&.lockTimeoutMS
  4205. .RS 4
  4206. The length of time, in milliseconds, for git\-credential\-store to retry when trying to lock the credentials file\&. A value of 0 means not to retry at all; \-1 means to try indefinitely\&. Default is 1000 (i\&.e\&., retry for 1s)\&.
  4207. .RE
  4208. .PP
  4209. \fBdiff\&.autoRefreshIndex\fR
  4210. .RS 4
  4211. When using
  4212. \fBgit\fR
  4213. \fBdiff\fR
  4214. to compare with work tree files, do not consider stat\-only changes as changed\&. Instead, silently run
  4215. \fBgit\fR
  4216. \fBupdate\-index\fR
  4217. \fB\-\-refresh\fR
  4218. to update the cached stat information for paths whose contents in the work tree match the contents in the index\&. This option defaults to
  4219. \fBtrue\fR\&. Note that this affects only
  4220. \fBgit\fR
  4221. \fBdiff\fR
  4222. Porcelain, and not lower level
  4223. \fBdiff\fR
  4224. commands such as
  4225. \fBgit\fR
  4226. \fBdiff\-files\fR\&.
  4227. .RE
  4228. .PP
  4229. \fBdiff\&.dirstat\fR
  4230. .RS 4
  4231. A comma separated list of
  4232. \fB\-\-dirstat\fR
  4233. parameters specifying the default behavior of the
  4234. \fB\-\-dirstat\fR
  4235. option to
  4236. \fBgit-diff\fR(1)
  4237. and friends\&. The defaults can be overridden on the command line (using
  4238. \fB\-\-dirstat=\fR\fI<param>\fR\fB,\&.\&.\fR\&.)\&. The fallback defaults (when not changed by
  4239. \fBdiff\&.dirstat\fR) are
  4240. \fBchanges,noncumulative,3\fR\&. The following parameters are available:
  4241. .PP
  4242. \fBchanges\fR
  4243. .RS 4
  4244. Compute the dirstat numbers by counting the lines that have been removed from the source, or added to the destination\&. This ignores the amount of pure code movements within a file\&. In other words, rearranging lines in a file is not counted as much as other changes\&. This is the default behavior when no parameter is given\&.
  4245. .RE
  4246. .PP
  4247. \fBlines\fR
  4248. .RS 4
  4249. Compute the dirstat numbers by doing the regular line\-based diff analysis, and summing the removed/added line counts\&. (For binary files, count 64\-byte chunks instead, since binary files have no natural concept of lines)\&. This is a more expensive
  4250. \fB\-\-dirstat\fR
  4251. behavior than the
  4252. \fBchanges\fR
  4253. behavior, but it does count rearranged lines within a file as much as other changes\&. The resulting output is consistent with what you get from the other
  4254. \fB\-\-\fR*stat options\&.
  4255. .RE
  4256. .PP
  4257. \fBfiles\fR
  4258. .RS 4
  4259. Compute the dirstat numbers by counting the number of files changed\&. Each changed file counts equally in the dirstat analysis\&. This is the computationally cheapest
  4260. \fB\-\-dirstat\fR
  4261. behavior, since it does not have to look at the file contents at all\&.
  4262. .RE
  4263. .PP
  4264. \fBcumulative\fR
  4265. .RS 4
  4266. Count changes in a child directory for the parent directory as well\&. Note that when using
  4267. \fBcumulative\fR, the sum of the percentages reported may exceed 100%\&. The default (non\-cumulative) behavior can be specified with the
  4268. \fBnoncumulative\fR
  4269. parameter\&.
  4270. .RE
  4271. .PP
  4272. \fI<limit>\fR
  4273. .RS 4
  4274. An integer parameter specifies a cut\-off percent (3% by default)\&. Directories contributing less than this percentage of the changes are not shown in the output\&.
  4275. .RE
  4276. .sp
  4277. Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories:
  4278. \fBfiles,10,cumulative\fR\&.
  4279. .RE
  4280. .PP
  4281. \fBdiff\&.statNameWidth\fR
  4282. .RS 4
  4283. Limit the width of the filename part in
  4284. \fB\-\-stat\fR
  4285. output\&. If set, applies to all commands generating
  4286. \fB\-\-stat\fR
  4287. output except
  4288. \fBformat\-patch\fR\&.
  4289. .RE
  4290. .PP
  4291. \fBdiff\&.statGraphWidth\fR
  4292. .RS 4
  4293. Limit the width of the graph part in
  4294. \fB\-\-stat\fR
  4295. output\&. If set, applies to all commands generating
  4296. \fB\-\-stat\fR
  4297. output except
  4298. \fBformat\-patch\fR\&.
  4299. .RE
  4300. .PP
  4301. \fBdiff\&.context\fR
  4302. .RS 4
  4303. Generate diffs with
  4304. \fI<n>\fR
  4305. lines of context instead of the default of 3\&. This value is overridden by the
  4306. \fB\-U\fR
  4307. option\&.
  4308. .RE
  4309. .PP
  4310. \fBdiff\&.interHunkContext\fR
  4311. .RS 4
  4312. Show the context between diff hunks, up to the specified number of lines, thereby fusing the hunks that are close to each other\&. This value serves as the default for the
  4313. \fB\-\-inter\-hunk\-context\fR
  4314. command line option\&.
  4315. .RE
  4316. .PP
  4317. \fBdiff\&.external\fR
  4318. .RS 4
  4319. If this config variable is set, diff generation is not performed using the internal diff machinery, but using the given command\&. Can be overridden with the
  4320. \fBGIT_EXTERNAL_DIFF\fR
  4321. environment variable\&. The command is called with parameters as described under "git Diffs" in
  4322. \fBgit\fR(1)\&. Note: if you want to use an external diff program only on a subset of your files, you might want to use
  4323. \fBgitattributes\fR(5)
  4324. instead\&.
  4325. .RE
  4326. .PP
  4327. \fBdiff\&.trustExitCode\fR
  4328. .RS 4
  4329. If this boolean value is set to
  4330. \fBtrue\fR
  4331. then the
  4332. \fBdiff\&.external\fR
  4333. command is expected to return exit code 0 if it considers the input files to be equal or 1 if it considers them to be different, like
  4334. \fBdiff\fR(1)\&. If it is set to
  4335. \fBfalse\fR, which is the default, then the command is expected to return exit code
  4336. \fB0\fR
  4337. regardless of equality\&. Any other exit code causes Git to report a fatal error\&.
  4338. .RE
  4339. .PP
  4340. \fBdiff\&.ignoreSubmodules\fR
  4341. .RS 4
  4342. Sets the default value of
  4343. \fB\-\-ignore\-submodules\fR\&. Note that this affects only
  4344. \fBgit\fR
  4345. \fBdiff\fR
  4346. Porcelain, and not lower level
  4347. \fBdiff\fR
  4348. commands such as
  4349. \fBgit\fR
  4350. \fBdiff\-files\fR\&.
  4351. \fBgit\fR
  4352. \fBcheckout\fR
  4353. and
  4354. \fBgit\fR
  4355. \fBswitch\fR
  4356. also honor this setting when reporting uncommitted changes\&. Setting it to
  4357. \fBall\fR
  4358. disables the submodule summary normally shown by
  4359. \fBgit\fR
  4360. \fBcommit\fR
  4361. and
  4362. \fBgit\fR
  4363. \fBstatus\fR
  4364. when
  4365. \fBstatus\&.submoduleSummary\fR
  4366. is set unless it is overridden by using the
  4367. \fB\-\-ignore\-submodules\fR
  4368. command\-line option\&. The
  4369. \fBgit\fR
  4370. \fBsubmodule\fR
  4371. commands are not affected by this setting\&. By default this is set to untracked so that any untracked submodules are ignored\&.
  4372. .RE
  4373. .PP
  4374. \fBdiff\&.mnemonicPrefix\fR
  4375. .RS 4
  4376. If set,
  4377. \fBgit\fR
  4378. \fBdiff\fR
  4379. uses a prefix pair that is different from the standard
  4380. \fBa/\fR
  4381. and
  4382. \fBb/\fR
  4383. depending on what is being compared\&. When this configuration is in effect, reverse diff output also swaps the order of the prefixes:
  4384. .PP
  4385. \fBgit\fR \fBdiff\fR
  4386. .RS 4
  4387. compares the (i)ndex and the (w)ork tree;
  4388. .RE
  4389. .PP
  4390. \fBgit\fR \fBdiff\fR \fBHEAD\fR
  4391. .RS 4
  4392. compares a (c)ommit and the (w)ork tree;
  4393. .RE
  4394. .PP
  4395. \fBgit\fR \fBdiff\fR \fB\-\-cached\fR
  4396. .RS 4
  4397. compares a (c)ommit and the (i)ndex;
  4398. .RE
  4399. .PP
  4400. \fBgit\fR \fBdiff\fR \fBHEAD:\fR\fI<file1>\fR \fI<file2>\fR
  4401. .RS 4
  4402. compares an (o)bject and a (w)ork tree entity;
  4403. .RE
  4404. .PP
  4405. \fBgit\fR \fBdiff\fR \fB\-\-no\-index\fR \fI<a>\fR \fI<b>\fR
  4406. .RS 4
  4407. compares two non\-git things
  4408. \fI<a>\fR
  4409. and
  4410. \fI<b>\fR\&.
  4411. .RE
  4412. .RE
  4413. .PP
  4414. \fBdiff\&.noPrefix\fR
  4415. .RS 4
  4416. If set,
  4417. \fBgit\fR
  4418. \fBdiff\fR
  4419. does not show any source or destination prefix\&.
  4420. .RE
  4421. .PP
  4422. \fBdiff\&.srcPrefix\fR
  4423. .RS 4
  4424. If set,
  4425. \fBgit\fR
  4426. \fBdiff\fR
  4427. uses this source prefix\&. Defaults to
  4428. \fBa/\fR\&.
  4429. .RE
  4430. .PP
  4431. \fBdiff\&.dstPrefix\fR
  4432. .RS 4
  4433. If set,
  4434. \fBgit\fR
  4435. \fBdiff\fR
  4436. uses this destination prefix\&. Defaults to
  4437. \fBb/\fR\&.
  4438. .RE
  4439. .PP
  4440. \fBdiff\&.relative\fR
  4441. .RS 4
  4442. If set to
  4443. \fBtrue\fR,
  4444. \fBgit\fR
  4445. \fBdiff\fR
  4446. does not show changes outside of the directory and show pathnames relative to the current directory\&.
  4447. .RE
  4448. .PP
  4449. \fBdiff\&.orderFile\fR
  4450. .RS 4
  4451. File indicating how to order files within a diff\&. See the
  4452. \fB\-O\fR
  4453. option to
  4454. \fBgit-diff\fR(1)
  4455. for details\&. If
  4456. \fBdiff\&.orderFile\fR
  4457. is a relative pathname, it is treated as relative to the top of the working tree\&.
  4458. .RE
  4459. .PP
  4460. \fBdiff\&.renameLimit\fR
  4461. .RS 4
  4462. The number of files to consider in the exhaustive portion of copy/rename detection; equivalent to the
  4463. \fBgit\fR
  4464. \fBdiff\fR
  4465. option
  4466. \fB\-l\fR\&. If not set, the default value is currently 1000\&. This setting has no effect if rename detection is turned off\&.
  4467. .RE
  4468. .PP
  4469. \fBdiff\&.renames\fR
  4470. .RS 4
  4471. Whether and how Git detects renames\&. If set to
  4472. \fBfalse\fR, rename detection is disabled\&. If set to
  4473. \fBtrue\fR, basic rename detection is enabled\&. If set to
  4474. \fBcopies\fR
  4475. or
  4476. \fBcopy\fR, Git will detect copies, as well\&. Defaults to
  4477. \fBtrue\fR\&. Note that this affects only
  4478. \fBgit\fR
  4479. \fBdiff\fR
  4480. Porcelain like
  4481. \fBgit-diff\fR(1)
  4482. and
  4483. \fBgit-log\fR(1), and not lower level commands such as
  4484. \fBgit-diff-files\fR(1)\&.
  4485. .RE
  4486. .PP
  4487. \fBdiff\&.suppressBlankEmpty\fR
  4488. .RS 4
  4489. A boolean to inhibit the standard behavior of printing a space before each empty output line\&. Defaults to
  4490. \fBfalse\fR\&.
  4491. .RE
  4492. .PP
  4493. \fBdiff\&.submodule\fR
  4494. .RS 4
  4495. Specify the format in which differences in submodules are shown\&. The
  4496. \fBshort\fR
  4497. format just shows the names of the commits at the beginning and end of the range\&. The
  4498. \fBlog\fR
  4499. format lists the commits in the range like
  4500. \fBgit-submodule\fR(1)
  4501. \fBsummary\fR
  4502. does\&. The
  4503. \fBdiff\fR
  4504. format shows an inline diff of the changed contents of the submodule\&. Defaults to
  4505. \fBshort\fR\&.
  4506. .RE
  4507. .PP
  4508. \fBdiff\&.wordRegex\fR
  4509. .RS 4
  4510. A POSIX Extended Regular Expression used to determine what is a "word" when performing word\-by\-word difference calculations\&. Character sequences that match the regular expression are "words", all other characters are
  4511. \fBignorable\fR
  4512. whitespace\&.
  4513. .RE
  4514. .PP
  4515. \fBdiff\&.\fR\fI<driver>\fR\fB\&.command\fR
  4516. .RS 4
  4517. The custom diff driver command\&. See
  4518. \fBgitattributes\fR(5)
  4519. for details\&.
  4520. .RE
  4521. .PP
  4522. \fBdiff\&.\fR\fI<driver>\fR\fB\&.trustExitCode\fR
  4523. .RS 4
  4524. If this boolean value is set to
  4525. \fBtrue\fR
  4526. then the
  4527. \fBdiff\&.\fR\fI<driver>\fR\fB\&.command\fR
  4528. command is expected to return exit code 0 if it considers the input files to be equal or 1 if it considers them to be different, like
  4529. \fBdiff\fR(1)\&. If it is set to
  4530. \fBfalse\fR, which is the default, then the command is expected to return exit code 0 regardless of equality\&. Any other exit code causes Git to report a fatal error\&.
  4531. .RE
  4532. .PP
  4533. \fBdiff\&.\fR\fI<driver>\fR\fB\&.xfuncname\fR
  4534. .RS 4
  4535. The regular expression that the diff driver should use to recognize the hunk header\&. A built\-in pattern may also be used\&. See
  4536. \fBgitattributes\fR(5)
  4537. for details\&.
  4538. .RE
  4539. .PP
  4540. \fBdiff\&.\fR\fI<driver>\fR\fB\&.binary\fR
  4541. .RS 4
  4542. Set this option to
  4543. \fBtrue\fR
  4544. to make the diff driver treat files as binary\&. See
  4545. \fBgitattributes\fR(5)
  4546. for details\&.
  4547. .RE
  4548. .PP
  4549. \fBdiff\&.\fR\fI<driver>\fR\fB\&.textconv\fR
  4550. .RS 4
  4551. The command that the diff driver should call to generate the text\-converted version of a file\&. The result of the conversion is used to generate a human\-readable diff\&. See
  4552. \fBgitattributes\fR(5)
  4553. for details\&.
  4554. .RE
  4555. .PP
  4556. \fBdiff\&.\fR\fI<driver>\fR\fB\&.wordRegex\fR
  4557. .RS 4
  4558. The regular expression that the diff driver should use to split words in a line\&. See
  4559. \fBgitattributes\fR(5)
  4560. for details\&.
  4561. .RE
  4562. .PP
  4563. \fBdiff\&.\fR\fI<driver>\fR\fB\&.cachetextconv\fR
  4564. .RS 4
  4565. Set this option to
  4566. \fBtrue\fR
  4567. to make the diff driver cache the text conversion outputs\&. See
  4568. \fBgitattributes\fR(5)
  4569. for details\&.
  4570. .RE
  4571. .PP
  4572. \fBdiff\&.indentHeuristic\fR
  4573. .RS 4
  4574. Set this option to
  4575. \fBfalse\fR
  4576. to disable the default heuristics that shift diff hunk boundaries to make patches easier to read\&.
  4577. .RE
  4578. .PP
  4579. \fBdiff\&.algorithm\fR
  4580. .RS 4
  4581. Choose a diff algorithm\&. The variants are as follows:
  4582. .PP
  4583. \fBdefault\fR, \fBmyers\fR
  4584. .RS 4
  4585. The basic greedy diff algorithm\&. Currently, this is the default\&.
  4586. .RE
  4587. .PP
  4588. \fBminimal\fR
  4589. .RS 4
  4590. Spend extra time to make sure the smallest possible diff is produced\&.
  4591. .RE
  4592. .PP
  4593. \fBpatience\fR
  4594. .RS 4
  4595. Use "patience diff" algorithm when generating patches\&.
  4596. .RE
  4597. .PP
  4598. \fBhistogram\fR
  4599. .RS 4
  4600. This algorithm extends the patience algorithm to "support low\-occurrence common elements"\&.
  4601. .RE
  4602. .RE
  4603. .PP
  4604. \fBdiff\&.wsErrorHighlight\fR
  4605. .RS 4
  4606. Highlight whitespace errors in the
  4607. \fBcontext\fR,
  4608. \fBold\fR
  4609. or
  4610. \fBnew\fR
  4611. lines of the diff\&. Multiple values are separated by comma,
  4612. \fBnone\fR
  4613. resets previous values,
  4614. \fBdefault\fR
  4615. reset the list to
  4616. \fBnew\fR
  4617. and
  4618. \fBall\fR
  4619. is a shorthand for
  4620. \fBold,new,context\fR\&. The whitespace errors are colored with
  4621. \fBcolor\&.diff\&.whitespace\fR\&. The command line option
  4622. \fB\-\-ws\-error\-highlight=\fR\fI<kind>\fR
  4623. overrides this setting\&.
  4624. .RE
  4625. .PP
  4626. \fBdiff\&.colorMoved\fR
  4627. .RS 4
  4628. If set to either a valid
  4629. \fI<mode>\fR
  4630. or a
  4631. \fBtrue\fR
  4632. value, moved lines in a diff are colored differently\&. For details of valid modes see
  4633. \fB\-\-color\-moved\fR
  4634. in
  4635. \fBgit-diff\fR(1)\&. If simply set to
  4636. \fBtrue\fR
  4637. the default color mode will be used\&. When set to
  4638. \fBfalse\fR, moved lines are not colored\&.
  4639. .RE
  4640. .PP
  4641. \fBdiff\&.colorMovedWS\fR
  4642. .RS 4
  4643. When moved lines are colored using e\&.g\&. the
  4644. \fBdiff\&.colorMoved\fR
  4645. setting, this option controls the mode how spaces are treated\&. For details of valid modes see
  4646. \fB\-\-color\-moved\-ws\fR
  4647. in
  4648. \fBgit-diff\fR(1)\&.
  4649. .RE
  4650. .PP
  4651. diff\&.tool
  4652. .RS 4
  4653. Controls which diff tool is used by
  4654. \fBgit-difftool\fR(1)\&. This variable overrides the value configured in
  4655. \fBmerge\&.tool\fR\&. The list below shows the valid built\-in values\&. Any other value is treated as a custom diff tool and requires that a corresponding difftool\&.<tool>\&.cmd variable is defined\&.
  4656. .RE
  4657. .PP
  4658. diff\&.guitool
  4659. .RS 4
  4660. Controls which diff tool is used by
  4661. \fBgit-difftool\fR(1)
  4662. when the \-g/\-\-gui flag is specified\&. This variable overrides the value configured in
  4663. \fBmerge\&.guitool\fR\&. The list below shows the valid built\-in values\&. Any other value is treated as a custom diff tool and requires that a corresponding difftool\&.<guitool>\&.cmd variable is defined\&.
  4664. .PP
  4665. \fBaraxis\fR
  4666. .RS 4
  4667. Use Araxis Merge (requires a graphical session)
  4668. .RE
  4669. .PP
  4670. \fBbc\fR
  4671. .RS 4
  4672. Use Beyond Compare (requires a graphical session)
  4673. .RE
  4674. .PP
  4675. \fBbc3\fR
  4676. .RS 4
  4677. Use Beyond Compare (requires a graphical session)
  4678. .RE
  4679. .PP
  4680. \fBbc4\fR
  4681. .RS 4
  4682. Use Beyond Compare (requires a graphical session)
  4683. .RE
  4684. .PP
  4685. \fBcodecompare\fR
  4686. .RS 4
  4687. Use Code Compare (requires a graphical session)
  4688. .RE
  4689. .PP
  4690. \fBdeltawalker\fR
  4691. .RS 4
  4692. Use DeltaWalker (requires a graphical session)
  4693. .RE
  4694. .PP
  4695. \fBdiffmerge\fR
  4696. .RS 4
  4697. Use DiffMerge (requires a graphical session)
  4698. .RE
  4699. .PP
  4700. \fBdiffuse\fR
  4701. .RS 4
  4702. Use Diffuse (requires a graphical session)
  4703. .RE
  4704. .PP
  4705. \fBecmerge\fR
  4706. .RS 4
  4707. Use ECMerge (requires a graphical session)
  4708. .RE
  4709. .PP
  4710. \fBemerge\fR
  4711. .RS 4
  4712. Use Emacs\*(Aq Emerge
  4713. .RE
  4714. .PP
  4715. \fBexamdiff\fR
  4716. .RS 4
  4717. Use ExamDiff Pro (requires a graphical session)
  4718. .RE
  4719. .PP
  4720. \fBguiffy\fR
  4721. .RS 4
  4722. Use Guiffy\(cqs Diff Tool (requires a graphical session)
  4723. .RE
  4724. .PP
  4725. \fBgvimdiff\fR
  4726. .RS 4
  4727. Use gVim (requires a graphical session)
  4728. .RE
  4729. .PP
  4730. \fBkdiff3\fR
  4731. .RS 4
  4732. Use KDiff3 (requires a graphical session)
  4733. .RE
  4734. .PP
  4735. \fBkompare\fR
  4736. .RS 4
  4737. Use Kompare (requires a graphical session)
  4738. .RE
  4739. .PP
  4740. \fBmeld\fR
  4741. .RS 4
  4742. Use Meld (requires a graphical session)
  4743. .RE
  4744. .PP
  4745. \fBnvimdiff\fR
  4746. .RS 4
  4747. Use Neovim
  4748. .RE
  4749. .PP
  4750. \fBopendiff\fR
  4751. .RS 4
  4752. Use FileMerge (requires a graphical session)
  4753. .RE
  4754. .PP
  4755. \fBp4merge\fR
  4756. .RS 4
  4757. Use HelixCore P4Merge (requires a graphical session)
  4758. .RE
  4759. .PP
  4760. \fBsmerge\fR
  4761. .RS 4
  4762. Use Sublime Merge (requires a graphical session)
  4763. .RE
  4764. .PP
  4765. \fBtkdiff\fR
  4766. .RS 4
  4767. Use TkDiff (requires a graphical session)
  4768. .RE
  4769. .PP
  4770. \fBvimdiff\fR
  4771. .RS 4
  4772. Use Vim
  4773. .RE
  4774. .PP
  4775. \fBvscode\fR
  4776. .RS 4
  4777. Use Visual Studio Code (requires a graphical session)
  4778. .RE
  4779. .PP
  4780. \fBwinmerge\fR
  4781. .RS 4
  4782. Use WinMerge (requires a graphical session)
  4783. .RE
  4784. .PP
  4785. \fBxxdiff\fR
  4786. .RS 4
  4787. Use xxdiff (requires a graphical session)
  4788. .RE
  4789. .RE
  4790. .PP
  4791. difftool\&.<tool>\&.cmd
  4792. .RS 4
  4793. Specify the command to invoke the specified diff tool\&. The specified command is evaluated in shell with the following variables available:
  4794. \fILOCAL\fR
  4795. is set to the name of the temporary file containing the contents of the diff pre\-image and
  4796. \fIREMOTE\fR
  4797. is set to the name of the temporary file containing the contents of the diff post\-image\&.
  4798. .sp
  4799. See the
  4800. \fB\-\-tool=\fR\fI<tool>\fR
  4801. option in
  4802. \fBgit-difftool\fR(1)
  4803. for more details\&.
  4804. .RE
  4805. .PP
  4806. difftool\&.<tool>\&.path
  4807. .RS 4
  4808. Override the path for the given tool\&. This is useful in case your tool is not in the PATH\&.
  4809. .RE
  4810. .PP
  4811. difftool\&.trustExitCode
  4812. .RS 4
  4813. Exit difftool if the invoked diff tool returns a non\-zero exit status\&.
  4814. .sp
  4815. See the
  4816. \fB\-\-trust\-exit\-code\fR
  4817. option in
  4818. \fBgit-difftool\fR(1)
  4819. for more details\&.
  4820. .RE
  4821. .PP
  4822. difftool\&.prompt
  4823. .RS 4
  4824. Prompt before each invocation of the diff tool\&.
  4825. .RE
  4826. .PP
  4827. difftool\&.guiDefault
  4828. .RS 4
  4829. Set
  4830. \fBtrue\fR
  4831. to use the
  4832. \fBdiff\&.guitool\fR
  4833. by default (equivalent to specifying the
  4834. \fB\-\-gui\fR
  4835. argument), or
  4836. \fBauto\fR
  4837. to select
  4838. \fBdiff\&.guitool\fR
  4839. or
  4840. \fBdiff\&.tool\fR
  4841. depending on the presence of a
  4842. \fBDISPLAY\fR
  4843. environment variable value\&. The default is
  4844. \fBfalse\fR, where the
  4845. \fB\-\-gui\fR
  4846. argument must be provided explicitly for the
  4847. \fBdiff\&.guitool\fR
  4848. to be used\&.
  4849. .RE
  4850. .PP
  4851. extensions\&.*
  4852. .RS 4
  4853. Unless otherwise stated, is an error to specify an extension if
  4854. \fBcore\&.repositoryFormatVersion\fR
  4855. is not
  4856. \fB1\fR\&. See
  4857. \fBgitrepository-layout\fR(5)\&.
  4858. .PP
  4859. compatObjectFormat
  4860. .RS 4
  4861. Specify a compatibility hash algorithm to use\&. The acceptable values are
  4862. \fBsha1\fR
  4863. and
  4864. \fBsha256\fR\&. The value specified must be different from the value of
  4865. \fBextensions\&.objectFormat\fR\&. This allows client level interoperability between git repositories whose objectFormat matches this compatObjectFormat\&. In particular when fully implemented the pushes and pulls from a repository in whose objectFormat matches compatObjectFormat\&. As well as being able to use oids encoded in compatObjectFormat in addition to oids encoded with objectFormat to locally specify objects\&.
  4866. .RE
  4867. .PP
  4868. noop
  4869. .RS 4
  4870. This extension does not change git\(cqs behavior at all\&. It is useful only for testing format\-1 compatibility\&.
  4871. .sp
  4872. For historical reasons, this extension is respected regardless of the
  4873. \fBcore\&.repositoryFormatVersion\fR
  4874. setting\&.
  4875. .RE
  4876. .PP
  4877. noop\-v1
  4878. .RS 4
  4879. This extension does not change git\(cqs behavior at all\&. It is useful only for testing format\-1 compatibility\&.
  4880. .RE
  4881. .PP
  4882. objectFormat
  4883. .RS 4
  4884. Specify the hash algorithm to use\&. The acceptable values are
  4885. \fBsha1\fR
  4886. and
  4887. \fBsha256\fR\&. If not specified,
  4888. \fBsha1\fR
  4889. is assumed\&.
  4890. .sp
  4891. Note that this setting should only be set by
  4892. \fBgit-init\fR(1)
  4893. or
  4894. \fBgit-clone\fR(1)\&. Trying to change it after initialization will not work and will produce hard\-to\-diagnose issues\&.
  4895. .RE
  4896. .PP
  4897. partialClone
  4898. .RS 4
  4899. When enabled, indicates that the repo was created with a partial clone (or later performed a partial fetch) and that the remote may have omitted sending certain unwanted objects\&. Such a remote is called a "promisor remote" and it promises that all such omitted objects can be fetched from it in the future\&.
  4900. .sp
  4901. The value of this key is the name of the promisor remote\&.
  4902. .sp
  4903. For historical reasons, this extension is respected regardless of the
  4904. \fBcore\&.repositoryFormatVersion\fR
  4905. setting\&.
  4906. .RE
  4907. .PP
  4908. preciousObjects
  4909. .RS 4
  4910. If enabled, indicates that objects in the repository MUST NOT be deleted (e\&.g\&., by
  4911. \fBgit\-prune\fR
  4912. or
  4913. \fBgit\fR
  4914. \fBrepack\fR
  4915. \fB\-d\fR)\&.
  4916. .sp
  4917. For historical reasons, this extension is respected regardless of the
  4918. \fBcore\&.repositoryFormatVersion\fR
  4919. setting\&.
  4920. .RE
  4921. .PP
  4922. refStorage
  4923. .RS 4
  4924. Specify the ref storage format to use\&. The acceptable values are:
  4925. .sp
  4926. .RS 4
  4927. .ie n \{\
  4928. \h'-04'\(bu\h'+03'\c
  4929. .\}
  4930. .el \{\
  4931. .sp -1
  4932. .IP \(bu 2.3
  4933. .\}
  4934. \fBfiles\fR
  4935. for loose files with packed\-refs\&. This is the default\&.
  4936. .RE
  4937. .sp
  4938. .RS 4
  4939. .ie n \{\
  4940. \h'-04'\(bu\h'+03'\c
  4941. .\}
  4942. .el \{\
  4943. .sp -1
  4944. .IP \(bu 2.3
  4945. .\}
  4946. \fBreftable\fR
  4947. for the reftable format\&. This format is experimental and its internals are subject to change\&.
  4948. .RE
  4949. .sp
  4950. Note that this setting should only be set by
  4951. \fBgit-init\fR(1)
  4952. or
  4953. \fBgit-clone\fR(1)\&. Trying to change it after initialization will not work and will produce hard\-to\-diagnose issues\&.
  4954. .RE
  4955. .PP
  4956. relativeWorktrees
  4957. .RS 4
  4958. If enabled, indicates at least one worktree has been linked with relative paths\&. Automatically set if a worktree has been created or repaired with either the
  4959. \fB\-\-relative\-paths\fR
  4960. option or with the
  4961. \fBworktree\&.useRelativePaths\fR
  4962. config set to
  4963. \fBtrue\fR\&.
  4964. .RE
  4965. .PP
  4966. worktreeConfig
  4967. .RS 4
  4968. If enabled, then worktrees will load config settings from the
  4969. \fB$GIT_DIR/config\&.worktree\fR
  4970. file in addition to the
  4971. \fB$GIT_COMMON_DIR/config\fR
  4972. file\&. Note that
  4973. \fB$GIT_COMMON_DIR\fR
  4974. and
  4975. \fB$GIT_DIR\fR
  4976. are the same for the main working tree, while other working trees have
  4977. \fB$GIT_DIR\fR
  4978. equal to
  4979. \fB$GIT_COMMON_DIR/worktrees/\fR\fI<id>\fR\fB/\fR\&. The settings in the
  4980. \fBconfig\&.worktree\fR
  4981. file will override settings from any other config files\&.
  4982. .sp
  4983. When enabling this extension, you must be careful to move certain values from the common config file to the main working tree\(cqs
  4984. \fBconfig\&.worktree\fR
  4985. file, if present:
  4986. .sp
  4987. .RS 4
  4988. .ie n \{\
  4989. \h'-04'\(bu\h'+03'\c
  4990. .\}
  4991. .el \{\
  4992. .sp -1
  4993. .IP \(bu 2.3
  4994. .\}
  4995. \fBcore\&.worktree\fR
  4996. must be moved from
  4997. \fB$GIT_COMMON_DIR/config\fR
  4998. to
  4999. \fB$GIT_COMMON_DIR/config\&.worktree\fR\&.
  5000. .RE
  5001. .sp
  5002. .RS 4
  5003. .ie n \{\
  5004. \h'-04'\(bu\h'+03'\c
  5005. .\}
  5006. .el \{\
  5007. .sp -1
  5008. .IP \(bu 2.3
  5009. .\}
  5010. If
  5011. \fBcore\&.bare\fR
  5012. is true, then it must be moved from
  5013. \fB$GIT_COMMON_DIR/config\fR
  5014. to
  5015. \fB$GIT_COMMON_DIR/config\&.worktree\fR\&.
  5016. .RE
  5017. .sp
  5018. It may also be beneficial to adjust the locations of
  5019. \fBcore\&.sparseCheckout\fR
  5020. and
  5021. \fBcore\&.sparseCheckoutCone\fR
  5022. depending on your desire for customizable sparse\-checkout settings for each worktree\&. By default, the
  5023. \fBgit\fR
  5024. \fBsparse\-checkout\fR
  5025. builtin enables this extension, assigns these config values on a per\-worktree basis, and uses the
  5026. \fB$GIT_DIR/info/sparse\-checkout\fR
  5027. file to specify the sparsity for each worktree independently\&. See
  5028. \fBgit-sparse-checkout\fR(1)
  5029. for more details\&.
  5030. .sp
  5031. + For historical reasons, this extension is respected regardless of the
  5032. \fBcore\&.repositoryFormatVersion\fR
  5033. setting\&.
  5034. .RE
  5035. .RE
  5036. .PP
  5037. fastimport\&.unpackLimit
  5038. .RS 4
  5039. If the number of objects imported by
  5040. \fBgit-fast-import\fR(1)
  5041. is below this limit, then the objects will be unpacked into loose object files\&. However, if the number of imported objects equals or exceeds this limit, then the pack will be stored as a pack\&. Storing the pack from a fast\-import can make the import operation complete faster, especially on slow filesystems\&. If not set, the value of
  5042. \fBtransfer\&.unpackLimit\fR
  5043. is used instead\&.
  5044. .RE
  5045. .PP
  5046. feature\&.*
  5047. .RS 4
  5048. The config settings that start with
  5049. \fBfeature\&.\fR
  5050. modify the defaults of a group of other config settings\&. These groups are created by the Git developer community as recommended defaults and are subject to change\&. In particular, new config options may be added with different defaults\&.
  5051. .RE
  5052. .PP
  5053. feature\&.experimental
  5054. .RS 4
  5055. Enable config options that are new to Git, and are being considered for future defaults\&. Config settings included here may be added or removed with each release, including minor version updates\&. These settings may have unintended interactions since they are so new\&. Please enable this setting if you are interested in providing feedback on experimental features\&. The new default values are:
  5056. .sp
  5057. .RS 4
  5058. .ie n \{\
  5059. \h'-04'\(bu\h'+03'\c
  5060. .\}
  5061. .el \{\
  5062. .sp -1
  5063. .IP \(bu 2.3
  5064. .\}
  5065. \fBfetch\&.negotiationAlgorithm=skipping\fR
  5066. may improve fetch negotiation times by skipping more commits at a time, reducing the number of round trips\&.
  5067. .RE
  5068. .sp
  5069. .RS 4
  5070. .ie n \{\
  5071. \h'-04'\(bu\h'+03'\c
  5072. .\}
  5073. .el \{\
  5074. .sp -1
  5075. .IP \(bu 2.3
  5076. .\}
  5077. \fBpack\&.useBitmapBoundaryTraversal=true\fR
  5078. may improve bitmap traversal times by walking fewer objects\&.
  5079. .RE
  5080. .sp
  5081. .RS 4
  5082. .ie n \{\
  5083. \h'-04'\(bu\h'+03'\c
  5084. .\}
  5085. .el \{\
  5086. .sp -1
  5087. .IP \(bu 2.3
  5088. .\}
  5089. \fBpack\&.allowPackReuse=multi\fR
  5090. may improve the time it takes to create a pack by reusing objects from multiple packs instead of just one\&.
  5091. .RE
  5092. .RE
  5093. .PP
  5094. feature\&.manyFiles
  5095. .RS 4
  5096. Enable config options that optimize for repos with many files in the working directory\&. With many files, commands such as
  5097. \fBgit\fR
  5098. \fBstatus\fR
  5099. and
  5100. \fBgit\fR
  5101. \fBcheckout\fR
  5102. may be slow and these new defaults improve performance:
  5103. .sp
  5104. .RS 4
  5105. .ie n \{\
  5106. \h'-04'\(bu\h'+03'\c
  5107. .\}
  5108. .el \{\
  5109. .sp -1
  5110. .IP \(bu 2.3
  5111. .\}
  5112. \fBindex\&.skipHash=true\fR
  5113. speeds up index writes by not computing a trailing checksum\&. Note that this will cause Git versions earlier than 2\&.13\&.0 to refuse to parse the index and Git versions earlier than 2\&.40\&.0 will report a corrupted index during
  5114. \fBgit\fR
  5115. \fBfsck\fR\&.
  5116. .RE
  5117. .sp
  5118. .RS 4
  5119. .ie n \{\
  5120. \h'-04'\(bu\h'+03'\c
  5121. .\}
  5122. .el \{\
  5123. .sp -1
  5124. .IP \(bu 2.3
  5125. .\}
  5126. \fBindex\&.version=4\fR
  5127. enables path\-prefix compression in the index\&.
  5128. .RE
  5129. .sp
  5130. .RS 4
  5131. .ie n \{\
  5132. \h'-04'\(bu\h'+03'\c
  5133. .\}
  5134. .el \{\
  5135. .sp -1
  5136. .IP \(bu 2.3
  5137. .\}
  5138. \fBcore\&.untrackedCache=true\fR
  5139. enables the untracked cache\&. This setting assumes that mtime is working on your machine\&.
  5140. .RE
  5141. .RE
  5142. .PP
  5143. fetch\&.recurseSubmodules
  5144. .RS 4
  5145. This option controls whether
  5146. \fBgit\fR
  5147. \fBfetch\fR
  5148. (and the underlying fetch in
  5149. \fBgit\fR
  5150. \fBpull\fR) will recursively fetch into populated submodules\&. This option can be set either to a boolean value or to
  5151. \fIon\-demand\fR\&. Setting it to a boolean changes the behavior of fetch and pull to recurse unconditionally into submodules when set to true or to not recurse at all when set to false\&. When set to
  5152. \fIon\-demand\fR, fetch and pull will only recurse into a populated submodule when its superproject retrieves a commit that updates the submodule\(cqs reference\&. Defaults to
  5153. \fIon\-demand\fR, or to the value of
  5154. \fIsubmodule\&.recurse\fR
  5155. if set\&.
  5156. .RE
  5157. .PP
  5158. fetch\&.fsckObjects
  5159. .RS 4
  5160. If it is set to true, git\-fetch\-pack will check all fetched objects\&. See
  5161. \fBtransfer\&.fsckObjects\fR
  5162. for what\(cqs checked\&. Defaults to false\&. If not set, the value of
  5163. \fBtransfer\&.fsckObjects\fR
  5164. is used instead\&.
  5165. .RE
  5166. .PP
  5167. fetch\&.fsck\&.<msg\-id>
  5168. .RS 4
  5169. Acts like
  5170. \fBfsck\&.\fR\fI<msg\-id>\fR, but is used by
  5171. \fBgit-fetch-pack\fR(1)
  5172. instead of
  5173. \fBgit-fsck\fR(1)\&. See the
  5174. \fBfsck\&.\fR\fI<msg\-id>\fR
  5175. documentation for details\&.
  5176. .RE
  5177. .PP
  5178. fetch\&.fsck\&.skipList
  5179. .RS 4
  5180. Acts like
  5181. \fBfsck\&.skipList\fR, but is used by
  5182. \fBgit-fetch-pack\fR(1)
  5183. instead of
  5184. \fBgit-fsck\fR(1)\&. See the
  5185. \fBfsck\&.skipList\fR
  5186. documentation for details\&.
  5187. .RE
  5188. .PP
  5189. fetch\&.unpackLimit
  5190. .RS 4
  5191. If the number of objects fetched over the Git native transfer is below this limit, then the objects will be unpacked into loose object files\&. However if the number of received objects equals or exceeds this limit then the received pack will be stored as a pack, after adding any missing delta bases\&. Storing the pack from a push can make the push operation complete faster, especially on slow filesystems\&. If not set, the value of
  5192. \fBtransfer\&.unpackLimit\fR
  5193. is used instead\&.
  5194. .RE
  5195. .PP
  5196. fetch\&.prune
  5197. .RS 4
  5198. If true, fetch will automatically behave as if the
  5199. \fB\-\-prune\fR
  5200. option was given on the command line\&. See also
  5201. \fBremote\&.\fR\fI<name>\fR\fB\&.prune\fR
  5202. and the PRUNING section of
  5203. \fBgit-fetch\fR(1)\&.
  5204. .RE
  5205. .PP
  5206. fetch\&.pruneTags
  5207. .RS 4
  5208. If true, fetch will automatically behave as if the
  5209. \fBrefs/tags/\fR*:refs/tags/* refspec was provided when pruning, if not set already\&. This allows for setting both this option and
  5210. \fBfetch\&.prune\fR
  5211. to maintain a 1=1 mapping to upstream refs\&. See also
  5212. \fBremote\&.\fR\fI<name>\fR\fB\&.pruneTags\fR
  5213. and the PRUNING section of
  5214. \fBgit-fetch\fR(1)\&.
  5215. .RE
  5216. .PP
  5217. fetch\&.all
  5218. .RS 4
  5219. If true, fetch will attempt to update all available remotes\&. This behavior can be overridden by passing
  5220. \fB\-\-no\-all\fR
  5221. or by explicitly specifying one or more remote(s) to fetch from\&. Defaults to false\&.
  5222. .RE
  5223. .PP
  5224. fetch\&.output
  5225. .RS 4
  5226. Control how ref update status is printed\&. Valid values are
  5227. \fBfull\fR
  5228. and
  5229. \fBcompact\fR\&. Default value is
  5230. \fBfull\fR\&. See the OUTPUT section in
  5231. \fBgit-fetch\fR(1)
  5232. for details\&.
  5233. .RE
  5234. .PP
  5235. fetch\&.negotiationAlgorithm
  5236. .RS 4
  5237. Control how information about the commits in the local repository is sent when negotiating the contents of the packfile to be sent by the server\&. Set to "consecutive" to use an algorithm that walks over consecutive commits checking each one\&. Set to "skipping" to use an algorithm that skips commits in an effort to converge faster, but may result in a larger\-than\-necessary packfile; or set to "noop" to not send any information at all, which will almost certainly result in a larger\-than\-necessary packfile, but will skip the negotiation step\&. Set to "default" to override settings made previously and use the default behaviour\&. The default is normally "consecutive", but if
  5238. \fBfeature\&.experimental\fR
  5239. is true, then the default is "skipping"\&. Unknown values will cause
  5240. \fIgit fetch\fR
  5241. to error out\&.
  5242. .sp
  5243. See also the
  5244. \fB\-\-negotiate\-only\fR
  5245. and
  5246. \fB\-\-negotiation\-tip\fR
  5247. options to
  5248. \fBgit-fetch\fR(1)\&.
  5249. .RE
  5250. .PP
  5251. fetch\&.showForcedUpdates
  5252. .RS 4
  5253. Set to false to enable
  5254. \fB\-\-no\-show\-forced\-updates\fR
  5255. in
  5256. \fBgit-fetch\fR(1)
  5257. and
  5258. \fBgit-pull\fR(1)
  5259. commands\&. Defaults to true\&.
  5260. .RE
  5261. .PP
  5262. fetch\&.parallel
  5263. .RS 4
  5264. Specifies the maximal number of fetch operations to be run in parallel at a time (submodules, or remotes when the
  5265. \fB\-\-multiple\fR
  5266. option of
  5267. \fBgit-fetch\fR(1)
  5268. is in effect)\&.
  5269. .sp
  5270. A value of 0 will give some reasonable default\&. If unset, it defaults to 1\&.
  5271. .sp
  5272. For submodules, this setting can be overridden using the
  5273. \fBsubmodule\&.fetchJobs\fR
  5274. config setting\&.
  5275. .RE
  5276. .PP
  5277. fetch\&.writeCommitGraph
  5278. .RS 4
  5279. Set to true to write a commit\-graph after every
  5280. \fBgit\fR
  5281. \fBfetch\fR
  5282. command that downloads a pack\-file from a remote\&. Using the
  5283. \fB\-\-split\fR
  5284. option, most executions will create a very small commit\-graph file on top of the existing commit\-graph file(s)\&. Occasionally, these files will merge and the write may take longer\&. Having an updated commit\-graph file helps performance of many Git commands, including
  5285. \fBgit\fR
  5286. \fBmerge\-base\fR,
  5287. \fBgit\fR
  5288. \fBpush\fR
  5289. \fB\-f\fR, and
  5290. \fBgit\fR
  5291. \fBlog\fR
  5292. \fB\-\-graph\fR\&. Defaults to false\&.
  5293. .RE
  5294. .PP
  5295. fetch\&.bundleURI
  5296. .RS 4
  5297. This value stores a URI for downloading Git object data from a bundle URI before performing an incremental fetch from the origin Git server\&. This is similar to how the
  5298. \fB\-\-bundle\-uri\fR
  5299. option behaves in
  5300. \fBgit-clone\fR(1)\&.
  5301. \fBgit\fR
  5302. \fBclone\fR
  5303. \fB\-\-bundle\-uri\fR
  5304. will set the
  5305. \fBfetch\&.bundleURI\fR
  5306. value if the supplied bundle URI contains a bundle list that is organized for incremental fetches\&.
  5307. .sp
  5308. If you modify this value and your repository has a
  5309. \fBfetch\&.bundleCreationToken\fR
  5310. value, then remove that
  5311. \fBfetch\&.bundleCreationToken\fR
  5312. value before fetching from the new bundle URI\&.
  5313. .RE
  5314. .PP
  5315. fetch\&.bundleCreationToken
  5316. .RS 4
  5317. When using
  5318. \fBfetch\&.bundleURI\fR
  5319. to fetch incrementally from a bundle list that uses the "creationToken" heuristic, this config value stores the maximum
  5320. \fBcreationToken\fR
  5321. value of the downloaded bundles\&. This value is used to prevent downloading bundles in the future if the advertised
  5322. \fBcreationToken\fR
  5323. is not strictly larger than this value\&.
  5324. .sp
  5325. The creation token values are chosen by the provider serving the specific bundle URI\&. If you modify the URI at
  5326. \fBfetch\&.bundleURI\fR, then be sure to remove the value for the
  5327. \fBfetch\&.bundleCreationToken\fR
  5328. value before fetching\&.
  5329. .RE
  5330. .PP
  5331. filter\&.<driver>\&.clean
  5332. .RS 4
  5333. The command which is used to convert the content of a worktree file to a blob upon checkin\&. See
  5334. \fBgitattributes\fR(5)
  5335. for details\&.
  5336. .RE
  5337. .PP
  5338. filter\&.<driver>\&.smudge
  5339. .RS 4
  5340. The command which is used to convert the content of a blob object to a worktree file upon checkout\&. See
  5341. \fBgitattributes\fR(5)
  5342. for details\&.
  5343. .RE
  5344. .PP
  5345. format\&.attach
  5346. .RS 4
  5347. Enable multipart/mixed attachments as the default for
  5348. \fIformat\-patch\fR\&. The value can also be a double quoted string which will enable attachments as the default and set the value as the boundary\&. See the \-\-attach option in
  5349. \fBgit-format-patch\fR(1)\&. To countermand an earlier value, set it to an empty string\&.
  5350. .RE
  5351. .PP
  5352. format\&.from
  5353. .RS 4
  5354. Provides the default value for the
  5355. \fB\-\-from\fR
  5356. option to format\-patch\&. Accepts a boolean value, or a name and email address\&. If false, format\-patch defaults to
  5357. \fB\-\-no\-from\fR, using commit authors directly in the "From:" field of patch mails\&. If true, format\-patch defaults to
  5358. \fB\-\-from\fR, using your committer identity in the "From:" field of patch mails and including a "From:" field in the body of the patch mail if different\&. If set to a non\-boolean value, format\-patch uses that value instead of your committer identity\&. Defaults to false\&.
  5359. .RE
  5360. .PP
  5361. format\&.forceInBodyFrom
  5362. .RS 4
  5363. Provides the default value for the
  5364. \fB\-\-\fR[\fBno\-\fR]\fBforce\-in\-body\-from\fR
  5365. option to format\-patch\&. Defaults to false\&.
  5366. .RE
  5367. .PP
  5368. format\&.numbered
  5369. .RS 4
  5370. A boolean which can enable or disable sequence numbers in patch subjects\&. It defaults to "auto" which enables it only if there is more than one patch\&. It can be enabled or disabled for all messages by setting it to "true" or "false"\&. See \-\-numbered option in
  5371. \fBgit-format-patch\fR(1)\&.
  5372. .RE
  5373. .PP
  5374. format\&.headers
  5375. .RS 4
  5376. Additional email headers to include in a patch to be submitted by mail\&. See
  5377. \fBgit-format-patch\fR(1)\&.
  5378. .RE
  5379. .PP
  5380. format\&.to, format\&.cc
  5381. .RS 4
  5382. Additional recipients to include in a patch to be submitted by mail\&. See the \-\-to and \-\-cc options in
  5383. \fBgit-format-patch\fR(1)\&.
  5384. .RE
  5385. .PP
  5386. format\&.subjectPrefix
  5387. .RS 4
  5388. The default for format\-patch is to output files with the
  5389. \fI[PATCH]\fR
  5390. subject prefix\&. Use this variable to change that prefix\&.
  5391. .RE
  5392. .PP
  5393. format\&.coverFromDescription
  5394. .RS 4
  5395. The default mode for format\-patch to determine which parts of the cover letter will be populated using the branch\(cqs description\&. See the
  5396. \fB\-\-cover\-from\-description\fR
  5397. option in
  5398. \fBgit-format-patch\fR(1)\&.
  5399. .RE
  5400. .PP
  5401. format\&.signature
  5402. .RS 4
  5403. The default for format\-patch is to output a signature containing the Git version number\&. Use this variable to change that default\&. Set this variable to the empty string ("") to suppress signature generation\&.
  5404. .RE
  5405. .PP
  5406. format\&.signatureFile
  5407. .RS 4
  5408. Works just like format\&.signature except the contents of the file specified by this variable will be used as the signature\&.
  5409. .RE
  5410. .PP
  5411. format\&.suffix
  5412. .RS 4
  5413. The default for format\-patch is to output files with the suffix \&.\fBpatch\fR\&. Use this variable to change that suffix (make sure to include the dot if you want it)\&.
  5414. .RE
  5415. .PP
  5416. format\&.encodeEmailHeaders
  5417. .RS 4
  5418. Encode email headers that have non\-ASCII characters with "Q\-encoding" (described in RFC 2047) for email transmission\&. Defaults to true\&.
  5419. .RE
  5420. .PP
  5421. format\&.pretty
  5422. .RS 4
  5423. The default pretty format for log/show/whatchanged command\&. See
  5424. \fBgit-log\fR(1),
  5425. \fBgit-show\fR(1),
  5426. \fBgit-whatchanged\fR(1)\&.
  5427. .RE
  5428. .PP
  5429. format\&.thread
  5430. .RS 4
  5431. The default threading style for
  5432. \fIgit format\-patch\fR\&. Can be a boolean value, or
  5433. \fBshallow\fR
  5434. or
  5435. \fBdeep\fR\&.
  5436. \fBshallow\fR
  5437. threading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the
  5438. \fB\-\-in\-reply\-to\fR, and the first patch mail, in this order\&.
  5439. \fBdeep\fR
  5440. threading makes every mail a reply to the previous one\&. A true boolean value is the same as
  5441. \fBshallow\fR, and a false value disables threading\&.
  5442. .RE
  5443. .PP
  5444. format\&.signOff
  5445. .RS 4
  5446. A boolean value which lets you enable the
  5447. \fB\-s/\-\-signoff\fR
  5448. option of format\-patch by default\&.
  5449. \fBNote:\fR
  5450. Adding the
  5451. \fBSigned\-off\-by\fR
  5452. trailer to a patch should be a conscious act and means that you certify you have the rights to submit this work under the same open source license\&. Please see the
  5453. \fISubmittingPatches\fR
  5454. document for further discussion\&.
  5455. .RE
  5456. .PP
  5457. format\&.coverLetter
  5458. .RS 4
  5459. A boolean that controls whether to generate a cover\-letter when format\-patch is invoked, but in addition can be set to "auto", to generate a cover\-letter only when there\(cqs more than one patch\&. Default is false\&.
  5460. .RE
  5461. .PP
  5462. format\&.outputDirectory
  5463. .RS 4
  5464. Set a custom directory to store the resulting files instead of the current working directory\&. All directory components will be created\&.
  5465. .RE
  5466. .PP
  5467. format\&.filenameMaxLength
  5468. .RS 4
  5469. The maximum length of the output filenames generated by the
  5470. \fBformat\-patch\fR
  5471. command; defaults to 64\&. Can be overridden by the
  5472. \fB\-\-filename\-max\-length=\fR\fI<n>\fR
  5473. command line option\&.
  5474. .RE
  5475. .PP
  5476. format\&.useAutoBase
  5477. .RS 4
  5478. A boolean value which lets you enable the
  5479. \fB\-\-base=auto\fR
  5480. option of format\-patch by default\&. Can also be set to "whenAble" to allow enabling
  5481. \fB\-\-base=auto\fR
  5482. if a suitable base is available, but to skip adding base info otherwise without the format dying\&.
  5483. .RE
  5484. .PP
  5485. format\&.notes
  5486. .RS 4
  5487. Provides the default value for the
  5488. \fB\-\-notes\fR
  5489. option to format\-patch\&. Accepts a boolean value, or a ref which specifies where to get notes\&. If false, format\-patch defaults to
  5490. \fB\-\-no\-notes\fR\&. If true, format\-patch defaults to
  5491. \fB\-\-notes\fR\&. If set to a non\-boolean value, format\-patch defaults to
  5492. \fB\-\-notes=\fR\fI<ref>\fR, where
  5493. \fBref\fR
  5494. is the non\-boolean value\&. Defaults to false\&.
  5495. .sp
  5496. If one wishes to use the ref
  5497. \fBrefs/notes/true\fR, please use that literal instead\&.
  5498. .sp
  5499. This configuration can be specified multiple times in order to allow multiple notes refs to be included\&. In that case, it will behave similarly to multiple
  5500. \fB\-\-\fR[\fBno\-\fR]\fBnotes\fR[\fB=\fR] options passed in\&. That is, a value of
  5501. \fBtrue\fR
  5502. will show the default notes, a value of
  5503. \fI<ref>\fR
  5504. will also show notes from that notes ref and a value of
  5505. \fBfalse\fR
  5506. will negate previous configurations and not show notes\&.
  5507. .sp
  5508. For example,
  5509. .sp
  5510. .if n \{\
  5511. .RS 4
  5512. .\}
  5513. .nf
  5514. [format]
  5515.         notes = true
  5516.         notes = foo
  5517.         notes = false
  5518.         notes = bar
  5519. .fi
  5520. .if n \{\
  5521. .RE
  5522. .\}
  5523. .sp
  5524. will only show notes from
  5525. \fBrefs/notes/bar\fR\&.
  5526. .RE
  5527. .PP
  5528. format\&.mboxrd
  5529. .RS 4
  5530. A boolean value which enables the robust "mboxrd" format when
  5531. \fB\-\-stdout\fR
  5532. is in use to escape "^>+From " lines\&.
  5533. .RE
  5534. .PP
  5535. format\&.noprefix
  5536. .RS 4
  5537. If set, do not show any source or destination prefix in patches\&. This is equivalent to the
  5538. \fBdiff\&.noprefix\fR
  5539. option used by
  5540. \fBgit\fR
  5541. \fBdiff\fR
  5542. (but which is not respected by
  5543. \fBformat\-patch\fR)\&. Note that by setting this, the receiver of any patches you generate will have to apply them using the
  5544. \fB\-p0\fR
  5545. option\&.
  5546. .RE
  5547. .PP
  5548. fsck\&.<msg\-id>
  5549. .RS 4
  5550. During fsck git may find issues with legacy data which wouldn\(cqt be generated by current versions of git, and which wouldn\(cqt be sent over the wire if
  5551. \fBtransfer\&.fsckObjects\fR
  5552. was set\&. This feature is intended to support working with legacy repositories containing such data\&.
  5553. .sp
  5554. Setting
  5555. \fBfsck\&.\fR\fI<msg\-id>\fR
  5556. will be picked up by
  5557. \fBgit-fsck\fR(1), but to accept pushes of such data set
  5558. \fBreceive\&.fsck\&.\fR\fI<msg\-id>\fR
  5559. instead, or to clone or fetch it set
  5560. \fBfetch\&.fsck\&.\fR\fI<msg\-id>\fR\&.
  5561. .sp
  5562. The rest of the documentation discusses
  5563. \fBfsck\&.\fR* for brevity, but the same applies for the corresponding
  5564. \fBreceive\&.fsck\&.\fR* and
  5565. \fBfetch\&.fsck\&.\fR*\&. variables\&.
  5566. .sp
  5567. Unlike variables like
  5568. \fBcolor\&.ui\fR
  5569. and
  5570. \fBcore\&.editor\fR, the
  5571. \fBreceive\&.fsck\&.\fR\fI<msg\-id>\fR
  5572. and
  5573. \fBfetch\&.fsck\&.\fR\fI<msg\-id>\fR
  5574. variables will not fall back on the
  5575. \fBfsck\&.\fR\fI<msg\-id>\fR
  5576. configuration if they aren\(cqt set\&. To uniformly configure the same fsck settings in different circumstances, all three of them must be set to the same values\&.
  5577. .sp
  5578. When
  5579. \fBfsck\&.\fR\fI<msg\-id>\fR
  5580. is set, errors can be switched to warnings and vice versa by configuring the
  5581. \fBfsck\&.\fR\fI<msg\-id>\fR
  5582. setting where the
  5583. \fI<msg\-id>\fR
  5584. is the fsck message ID and the value is one of
  5585. \fBerror\fR,
  5586. \fBwarn\fR
  5587. or
  5588. \fBignore\fR\&. For convenience, fsck prefixes the error/warning with the message ID, e\&.g\&. "missingEmail: invalid author/committer line \- missing email" means that setting
  5589. \fBfsck\&.missingEmail\fR
  5590. \fB=\fR
  5591. \fBignore\fR
  5592. will hide that issue\&.
  5593. .sp
  5594. In general, it is better to enumerate existing objects with problems with
  5595. \fBfsck\&.skipList\fR, instead of listing the kind of breakages these problematic objects share to be ignored, as doing the latter will allow new instances of the same breakages go unnoticed\&.
  5596. .sp
  5597. Setting an unknown
  5598. \fBfsck\&.\fR\fI<msg\-id>\fR
  5599. value will cause fsck to die, but doing the same for
  5600. \fBreceive\&.fsck\&.\fR\fI<msg\-id>\fR
  5601. and
  5602. \fBfetch\&.fsck\&.\fR\fI<msg\-id>\fR
  5603. will only cause git to warn\&.
  5604. .sp
  5605. See the
  5606. \fBFsck\fR
  5607. \fBMessages\fR
  5608. section of
  5609. \fBgit-fsck\fR(1)
  5610. for supported values of
  5611. \fI<msg\-id>\fR\&.
  5612. .RE
  5613. .PP
  5614. fsck\&.skipList
  5615. .RS 4
  5616. The path to a list of object names (i\&.e\&. one unabbreviated SHA\-1 per line) that are known to be broken in a non\-fatal way and should be ignored\&. On versions of Git 2\&.20 and later, comments (\fI#\fR), empty lines, and any leading and trailing whitespace are ignored\&. Everything but a SHA\-1 per line will error out on older versions\&.
  5617. .sp
  5618. This feature is useful when an established project should be accepted despite early commits containing errors that can be safely ignored, such as invalid committer email addresses\&. Note: corrupt objects cannot be skipped with this setting\&.
  5619. .sp
  5620. Like
  5621. \fBfsck\&.\fR\fI<msg\-id>\fR
  5622. this variable has corresponding
  5623. \fBreceive\&.fsck\&.skipList\fR
  5624. and
  5625. \fBfetch\&.fsck\&.skipList\fR
  5626. variants\&.
  5627. .sp
  5628. Unlike variables like
  5629. \fBcolor\&.ui\fR
  5630. and
  5631. \fBcore\&.editor\fR
  5632. the
  5633. \fBreceive\&.fsck\&.skipList\fR
  5634. and
  5635. \fBfetch\&.fsck\&.skipList\fR
  5636. variables will not fall back on the
  5637. \fBfsck\&.skipList\fR
  5638. configuration if they aren\(cqt set\&. To uniformly configure the same fsck settings in different circumstances, all three of them must be set to the same values\&.
  5639. .sp
  5640. Older versions of Git (before 2\&.20) documented that the object names list should be sorted\&. This was never a requirement; the object names could appear in any order, but when reading the list we tracked whether the list was sorted for the purposes of an internal binary search implementation, which could save itself some work with an already sorted list\&. Unless you had a humongous list there was no reason to go out of your way to pre\-sort the list\&. After Git version 2\&.20 a hash implementation is used instead, so there\(cqs now no reason to pre\-sort the list\&.
  5641. .RE
  5642. .PP
  5643. fsmonitor\&.allowRemote
  5644. .RS 4
  5645. By default, the fsmonitor daemon refuses to work with network\-mounted repositories\&. Setting
  5646. \fBfsmonitor\&.allowRemote\fR
  5647. to
  5648. \fBtrue\fR
  5649. overrides this behavior\&. Only respected when
  5650. \fBcore\&.fsmonitor\fR
  5651. is set to
  5652. \fBtrue\fR\&.
  5653. .RE
  5654. .PP
  5655. fsmonitor\&.socketDir
  5656. .RS 4
  5657. This Mac OS\-specific option, if set, specifies the directory in which to create the Unix domain socket used for communication between the fsmonitor daemon and various Git commands\&. The directory must reside on a native Mac OS filesystem\&. Only respected when
  5658. \fBcore\&.fsmonitor\fR
  5659. is set to
  5660. \fBtrue\fR\&.
  5661. .RE
  5662. .PP
  5663. gc\&.aggressiveDepth
  5664. .RS 4
  5665. The depth parameter used in the delta compression algorithm used by
  5666. \fIgit gc \-\-aggressive\fR\&. This defaults to 50, which is the default for the
  5667. \fB\-\-depth\fR
  5668. option when
  5669. \fB\-\-aggressive\fR
  5670. isn\(cqt in use\&.
  5671. .sp
  5672. See the documentation for the
  5673. \fB\-\-depth\fR
  5674. option in
  5675. \fBgit-repack\fR(1)
  5676. for more details\&.
  5677. .RE
  5678. .PP
  5679. gc\&.aggressiveWindow
  5680. .RS 4
  5681. The window size parameter used in the delta compression algorithm used by
  5682. \fIgit gc \-\-aggressive\fR\&. This defaults to 250, which is a much more aggressive window size than the default
  5683. \fB\-\-window\fR
  5684. of 10\&.
  5685. .sp
  5686. See the documentation for the
  5687. \fB\-\-window\fR
  5688. option in
  5689. \fBgit-repack\fR(1)
  5690. for more details\&.
  5691. .RE
  5692. .PP
  5693. gc\&.auto
  5694. .RS 4
  5695. When there are approximately more than this many loose objects in the repository,
  5696. \fBgit\fR
  5697. \fBgc\fR
  5698. \fB\-\-auto\fR
  5699. will pack them\&. Some Porcelain commands use this command to perform a light\-weight garbage collection from time to time\&. The default value is 6700\&.
  5700. .sp
  5701. Setting this to 0 disables not only automatic packing based on the number of loose objects, but also any other heuristic
  5702. \fBgit\fR
  5703. \fBgc\fR
  5704. \fB\-\-auto\fR
  5705. will otherwise use to determine if there\(cqs work to do, such as
  5706. \fBgc\&.autoPackLimit\fR\&.
  5707. .RE
  5708. .PP
  5709. gc\&.autoPackLimit
  5710. .RS 4
  5711. When there are more than this many packs that are not marked with *\&.\fBkeep\fR
  5712. file in the repository,
  5713. \fBgit\fR
  5714. \fBgc\fR
  5715. \fB\-\-auto\fR
  5716. consolidates them into one larger pack\&. The default value is 50\&. Setting this to 0 disables it\&. Setting
  5717. \fBgc\&.auto\fR
  5718. to 0 will also disable this\&.
  5719. .sp
  5720. See the
  5721. \fBgc\&.bigPackThreshold\fR
  5722. configuration variable below\&. When in use, it\(cqll affect how the auto pack limit works\&.
  5723. .RE
  5724. .PP
  5725. gc\&.autoDetach
  5726. .RS 4
  5727. Make
  5728. \fBgit\fR
  5729. \fBgc\fR
  5730. \fB\-\-auto\fR
  5731. return immediately and run in the background if the system supports it\&. Default is true\&. This config variable acts as a fallback in case
  5732. \fBmaintenance\&.autoDetach\fR
  5733. is not set\&.
  5734. .RE
  5735. .PP
  5736. gc\&.bigPackThreshold
  5737. .RS 4
  5738. If non\-zero, all non\-cruft packs larger than this limit are kept when
  5739. \fBgit\fR
  5740. \fBgc\fR
  5741. is run\&. This is very similar to
  5742. \fB\-\-keep\-largest\-pack\fR
  5743. except that all non\-cruft packs that meet the threshold are kept, not just the largest pack\&. Defaults to zero\&. Common unit suffixes of
  5744. \fIk\fR,
  5745. \fIm\fR, or
  5746. \fIg\fR
  5747. are supported\&.
  5748. .sp
  5749. Note that if the number of kept packs is more than gc\&.autoPackLimit, this configuration variable is ignored, all packs except the base pack will be repacked\&. After this the number of packs should go below gc\&.autoPackLimit and gc\&.bigPackThreshold should be respected again\&.
  5750. .sp
  5751. If the amount of memory estimated for
  5752. \fBgit\fR
  5753. \fBrepack\fR
  5754. to run smoothly is not available and
  5755. \fBgc\&.bigPackThreshold\fR
  5756. is not set, the largest pack will also be excluded (this is the equivalent of running
  5757. \fBgit\fR
  5758. \fBgc\fR
  5759. with
  5760. \fB\-\-keep\-largest\-pack\fR)\&.
  5761. .RE
  5762. .PP
  5763. gc\&.writeCommitGraph
  5764. .RS 4
  5765. If true, then gc will rewrite the commit\-graph file when
  5766. \fBgit-gc\fR(1)
  5767. is run\&. When using
  5768. \fBgit\fR
  5769. \fBgc\fR
  5770. \fB\-\-auto\fR
  5771. the commit\-graph will be updated if housekeeping is required\&. Default is true\&. See
  5772. \fBgit-commit-graph\fR(1)
  5773. for details\&.
  5774. .RE
  5775. .PP
  5776. gc\&.logExpiry
  5777. .RS 4
  5778. If the file gc\&.log exists, then
  5779. \fBgit\fR
  5780. \fBgc\fR
  5781. \fB\-\-auto\fR
  5782. will print its content and exit with status zero instead of running unless that file is more than
  5783. \fIgc\&.logExpiry\fR
  5784. old\&. Default is "1\&.day"\&. See
  5785. \fBgc\&.pruneExpire\fR
  5786. for more ways to specify its value\&.
  5787. .RE
  5788. .PP
  5789. gc\&.packRefs
  5790. .RS 4
  5791. Running
  5792. \fBgit\fR
  5793. \fBpack\-refs\fR
  5794. in a repository renders it unclonable by Git versions prior to 1\&.5\&.1\&.2 over dumb transports such as HTTP\&. This variable determines whether
  5795. \fIgit gc\fR
  5796. runs
  5797. \fBgit\fR
  5798. \fBpack\-refs\fR\&. This can be set to
  5799. \fBnotbare\fR
  5800. to enable it within all non\-bare repos or it can be set to a boolean value\&. The default is
  5801. \fBtrue\fR\&.
  5802. .RE
  5803. .PP
  5804. gc\&.cruftPacks
  5805. .RS 4
  5806. Store unreachable objects in a cruft pack (see
  5807. \fBgit-repack\fR(1)) instead of as loose objects\&. The default is
  5808. \fBtrue\fR\&.
  5809. .RE
  5810. .PP
  5811. gc\&.maxCruftSize
  5812. .RS 4
  5813. Limit the size of new cruft packs when repacking\&. When specified in addition to
  5814. \fB\-\-max\-cruft\-size\fR, the command line option takes priority\&. See the
  5815. \fB\-\-max\-cruft\-size\fR
  5816. option of
  5817. \fBgit-repack\fR(1)\&.
  5818. .RE
  5819. .PP
  5820. gc\&.pruneExpire
  5821. .RS 4
  5822. When
  5823. \fIgit gc\fR
  5824. is run, it will call
  5825. \fIprune \-\-expire 2\&.weeks\&.ago\fR
  5826. (and
  5827. \fIrepack \-\-cruft \-\-cruft\-expiration 2\&.weeks\&.ago\fR
  5828. if using cruft packs via
  5829. \fBgc\&.cruftPacks\fR
  5830. or
  5831. \fB\-\-cruft\fR)\&. Override the grace period with this config variable\&. The value "now" may be used to disable this grace period and always prune unreachable objects immediately, or "never" may be used to suppress pruning\&. This feature helps prevent corruption when
  5832. \fIgit gc\fR
  5833. runs concurrently with another process writing to the repository; see the "NOTES" section of
  5834. \fBgit-gc\fR(1)\&.
  5835. .RE
  5836. .PP
  5837. gc\&.worktreePruneExpire
  5838. .RS 4
  5839. When
  5840. \fIgit gc\fR
  5841. is run, it calls
  5842. \fIgit worktree prune \-\-expire 3\&.months\&.ago\fR\&. This config variable can be used to set a different grace period\&. The value "now" may be used to disable the grace period and prune
  5843. \fB$GIT_DIR/worktrees\fR
  5844. immediately, or "never" may be used to suppress pruning\&.
  5845. .RE
  5846. .PP
  5847. gc\&.reflogExpire, gc\&.<pattern>\&.reflogExpire
  5848. .RS 4
  5849. \fIgit reflog expire\fR
  5850. removes reflog entries older than this time; defaults to 90 days\&. The value "now" expires all entries immediately, and "never" suppresses expiration altogether\&. With "<pattern>" (e\&.g\&. "refs/stash") in the middle the setting applies only to the refs that match the <pattern>\&.
  5851. .RE
  5852. .PP
  5853. gc\&.reflogExpireUnreachable, gc\&.<pattern>\&.reflogExpireUnreachable
  5854. .RS 4
  5855. \fIgit reflog expire\fR
  5856. removes reflog entries older than this time and are not reachable from the current tip; defaults to 30 days\&. The value "now" expires all entries immediately, and "never" suppresses expiration altogether\&. With "<pattern>" (e\&.g\&. "refs/stash") in the middle, the setting applies only to the refs that match the <pattern>\&.
  5857. .sp
  5858. These types of entries are generally created as a result of using
  5859. \fBgit\fR
  5860. \fBcommit\fR
  5861. \fB\-\-amend\fR
  5862. or
  5863. \fBgit\fR
  5864. \fBrebase\fR
  5865. and are the commits prior to the amend or rebase occurring\&. Since these changes are not part of the current project most users will want to expire them sooner, which is why the default is more aggressive than
  5866. \fBgc\&.reflogExpire\fR\&.
  5867. .RE
  5868. .PP
  5869. gc\&.recentObjectsHook
  5870. .RS 4
  5871. When considering whether or not to remove an object (either when generating a cruft pack or storing unreachable objects as loose), use the shell to execute the specified command(s)\&. Interpret their output as object IDs which Git will consider as "recent", regardless of their age\&. By treating their mtimes as "now", any objects (and their descendants) mentioned in the output will be kept regardless of their true age\&.
  5872. .sp
  5873. Output must contain exactly one hex object ID per line, and nothing else\&. Objects which cannot be found in the repository are ignored\&. Multiple hooks are supported, but all must exit successfully, else the operation (either generating a cruft pack or unpacking unreachable objects) will be halted\&.
  5874. .RE
  5875. .PP
  5876. gc\&.repackFilter
  5877. .RS 4
  5878. When repacking, use the specified filter to move certain objects into a separate packfile\&. See the
  5879. \fB\-\-filter=\fR\fI<filter\-spec>\fR
  5880. option of
  5881. \fBgit-repack\fR(1)\&.
  5882. .RE
  5883. .PP
  5884. gc\&.repackFilterTo
  5885. .RS 4
  5886. When repacking and using a filter, see
  5887. \fBgc\&.repackFilter\fR, the specified location will be used to create the packfile containing the filtered out objects\&.
  5888. \fBWARNING:\fR
  5889. The specified location should be accessible, using for example the Git alternates mechanism, otherwise the repo could be considered corrupt by Git as it might not be able to access the objects in that packfile\&. See the
  5890. \fB\-\-filter\-to=\fR\fI<dir>\fR
  5891. option of
  5892. \fBgit-repack\fR(1)
  5893. and the
  5894. \fBobjects/info/alternates\fR
  5895. section of
  5896. \fBgitrepository-layout\fR(5)\&.
  5897. .RE
  5898. .PP
  5899. gc\&.rerereResolved
  5900. .RS 4
  5901. Records of conflicted merge you resolved earlier are kept for this many days when
  5902. \fIgit rerere gc\fR
  5903. is run\&. You can also use more human\-readable "1\&.month\&.ago", etc\&. The default is 60 days\&. See
  5904. \fBgit-rerere\fR(1)\&.
  5905. .RE
  5906. .PP
  5907. gc\&.rerereUnresolved
  5908. .RS 4
  5909. Records of conflicted merge you have not resolved are kept for this many days when
  5910. \fIgit rerere gc\fR
  5911. is run\&. You can also use more human\-readable "1\&.month\&.ago", etc\&. The default is 15 days\&. See
  5912. \fBgit-rerere\fR(1)\&.
  5913. .RE
  5914. .PP
  5915. gitcvs\&.commitMsgAnnotation
  5916. .RS 4
  5917. Append this string to each commit message\&. Set to empty string to disable this feature\&. Defaults to "via git\-CVS emulator"\&.
  5918. .RE
  5919. .PP
  5920. gitcvs\&.enabled
  5921. .RS 4
  5922. Whether the CVS server interface is enabled for this repository\&. See
  5923. \fBgit-cvsserver\fR(1)\&.
  5924. .RE
  5925. .PP
  5926. gitcvs\&.logFile
  5927. .RS 4
  5928. Path to a log file where the CVS server interface well\&...\: logs various stuff\&. See
  5929. \fBgit-cvsserver\fR(1)\&.
  5930. .RE
  5931. .PP
  5932. gitcvs\&.usecrlfattr
  5933. .RS 4
  5934. If true, the server will look up the end\-of\-line conversion attributes for files to determine the
  5935. \fB\-k\fR
  5936. modes to use\&. If the attributes force Git to treat a file as text, the
  5937. \fB\-k\fR
  5938. mode will be left blank so CVS clients will treat it as text\&. If they suppress text conversion, the file will be set with
  5939. \fI\-kb\fR
  5940. mode, which suppresses any newline munging the client might otherwise do\&. If the attributes do not allow the file type to be determined, then
  5941. \fBgitcvs\&.allBinary\fR
  5942. is used\&. See
  5943. \fBgitattributes\fR(5)\&.
  5944. .RE
  5945. .PP
  5946. gitcvs\&.allBinary
  5947. .RS 4
  5948. This is used if
  5949. \fBgitcvs\&.usecrlfattr\fR
  5950. does not resolve the correct
  5951. \fI\-kb\fR
  5952. mode to use\&. If true, all unresolved files are sent to the client in mode
  5953. \fI\-kb\fR\&. This causes the client to treat them as binary files, which suppresses any newline munging it otherwise might do\&. Alternatively, if it is set to "guess", then the contents of the file are examined to decide if it is binary, similar to
  5954. \fBcore\&.autocrlf\fR\&.
  5955. .RE
  5956. .PP
  5957. gitcvs\&.dbName
  5958. .RS 4
  5959. Database used by git\-cvsserver to cache revision information derived from the Git repository\&. The exact meaning depends on the used database driver, for SQLite (which is the default driver) this is a filename\&. Supports variable substitution (see
  5960. \fBgit-cvsserver\fR(1)
  5961. for details)\&. May not contain semicolons (;)\&. Default:
  5962. \fI%Ggitcvs\&.%m\&.sqlite\fR
  5963. .RE
  5964. .PP
  5965. gitcvs\&.dbDriver
  5966. .RS 4
  5967. Used Perl DBI driver\&. You can specify any available driver for this here, but it might not work\&. git\-cvsserver is tested with
  5968. \fIDBD::SQLite\fR, reported to work with
  5969. \fIDBD::Pg\fR, and reported
  5970. \fBnot\fR
  5971. to work with
  5972. \fIDBD::mysql\fR\&. Experimental feature\&. May not contain double colons (\fB:\fR)\&. Default:
  5973. \fISQLite\fR\&. See
  5974. \fBgit-cvsserver\fR(1)\&.
  5975. .RE
  5976. .PP
  5977. gitcvs\&.dbUser, gitcvs\&.dbPass
  5978. .RS 4
  5979. Database user and password\&. Only useful if setting
  5980. \fBgitcvs\&.dbDriver\fR, since SQLite has no concept of database users and/or passwords\&.
  5981. \fIgitcvs\&.dbUser\fR
  5982. supports variable substitution (see
  5983. \fBgit-cvsserver\fR(1)
  5984. for details)\&.
  5985. .RE
  5986. .PP
  5987. gitcvs\&.dbTableNamePrefix
  5988. .RS 4
  5989. Database table name prefix\&. Prepended to the names of any database tables used, allowing a single database to be used for several repositories\&. Supports variable substitution (see
  5990. \fBgit-cvsserver\fR(1)
  5991. for details)\&. Any non\-alphabetic characters will be replaced with underscores\&.
  5992. .RE
  5993. .sp
  5994. All gitcvs variables except for \fBgitcvs\&.usecrlfattr\fR and \fBgitcvs\&.allBinary\fR can also be specified as \fIgitcvs\&.<access_method>\&.<varname>\fR (where \fIaccess_method\fR is one of "ext" and "pserver") to make them apply only for the given access method\&.
  5995. .PP
  5996. gitweb\&.category, gitweb\&.description, gitweb\&.owner, gitweb\&.url
  5997. .RS 4
  5998. See
  5999. \fBgitweb\fR(1)
  6000. for description\&.
  6001. .RE
  6002. .PP
  6003. gitweb\&.avatar, gitweb\&.blame, gitweb\&.grep, gitweb\&.highlight, gitweb\&.patches, gitweb\&.pickaxe, gitweb\&.remote_heads, gitweb\&.showSizes, gitweb\&.snapshot
  6004. .RS 4
  6005. See
  6006. \fBgitweb.conf\fR(5)
  6007. for description\&.
  6008. .RE
  6009. .PP
  6010. gpg\&.program
  6011. .RS 4
  6012. Use this custom program instead of "\fBgpg\fR" found on
  6013. \fB$PATH\fR
  6014. when making or verifying a PGP signature\&. The program must support the same command\-line interface as GPG, namely, to verify a detached signature, "\fBgpg\fR
  6015. \fB\-\-verify\fR
  6016. \fB$signature\fR
  6017. \fB\-\fR
  6018. <$file" is run, and the program is expected to signal a good signature by exiting with code 0\&. To generate an ASCII\-armored detached signature, the standard input of "\fBgpg\fR
  6019. \fB\-bsau\fR
  6020. \fB$key\fR" is fed with the contents to be signed, and the program is expected to send the result to its standard output\&.
  6021. .RE
  6022. .PP
  6023. gpg\&.format
  6024. .RS 4
  6025. Specifies which key format to use when signing with
  6026. \fB\-\-gpg\-sign\fR\&. Default is "openpgp"\&. Other possible values are "x509", "ssh"\&.
  6027. .sp
  6028. See
  6029. \fBgitformat-signature\fR(5)
  6030. for the signature format, which differs based on the selected
  6031. \fBgpg\&.format\fR\&.
  6032. .RE
  6033. .PP
  6034. gpg\&.<format>\&.program
  6035. .RS 4
  6036. Use this to customize the program used for the signing format you chose\&. (see
  6037. \fBgpg\&.program\fR
  6038. and
  6039. \fBgpg\&.format\fR)
  6040. \fBgpg\&.program\fR
  6041. can still be used as a legacy synonym for
  6042. \fBgpg\&.openpgp\&.program\fR\&. The default value for
  6043. \fBgpg\&.x509\&.program\fR
  6044. is "gpgsm" and
  6045. \fBgpg\&.ssh\&.program\fR
  6046. is "ssh\-keygen"\&.
  6047. .RE
  6048. .PP
  6049. gpg\&.minTrustLevel
  6050. .RS 4
  6051. Specifies a minimum trust level for signature verification\&. If this option is unset, then signature verification for merge operations requires a key with at least
  6052. \fBmarginal\fR
  6053. trust\&. Other operations that perform signature verification require a key with at least
  6054. \fBundefined\fR
  6055. trust\&. Setting this option overrides the required trust\-level for all operations\&. Supported values, in increasing order of significance:
  6056. .sp
  6057. .RS 4
  6058. .ie n \{\
  6059. \h'-04'\(bu\h'+03'\c
  6060. .\}
  6061. .el \{\
  6062. .sp -1
  6063. .IP \(bu 2.3
  6064. .\}
  6065. \fBundefined\fR
  6066. .RE
  6067. .sp
  6068. .RS 4
  6069. .ie n \{\
  6070. \h'-04'\(bu\h'+03'\c
  6071. .\}
  6072. .el \{\
  6073. .sp -1
  6074. .IP \(bu 2.3
  6075. .\}
  6076. \fBnever\fR
  6077. .RE
  6078. .sp
  6079. .RS 4
  6080. .ie n \{\
  6081. \h'-04'\(bu\h'+03'\c
  6082. .\}
  6083. .el \{\
  6084. .sp -1
  6085. .IP \(bu 2.3
  6086. .\}
  6087. \fBmarginal\fR
  6088. .RE
  6089. .sp
  6090. .RS 4
  6091. .ie n \{\
  6092. \h'-04'\(bu\h'+03'\c
  6093. .\}
  6094. .el \{\
  6095. .sp -1
  6096. .IP \(bu 2.3
  6097. .\}
  6098. \fBfully\fR
  6099. .RE
  6100. .sp
  6101. .RS 4
  6102. .ie n \{\
  6103. \h'-04'\(bu\h'+03'\c
  6104. .\}
  6105. .el \{\
  6106. .sp -1
  6107. .IP \(bu 2.3
  6108. .\}
  6109. \fBultimate\fR
  6110. .RE
  6111. .RE
  6112. .PP
  6113. gpg\&.ssh\&.defaultKeyCommand
  6114. .RS 4
  6115. This command will be run when user\&.signingkey is not set and a ssh signature is requested\&. On successful exit a valid ssh public key prefixed with
  6116. \fBkey::\fR
  6117. is expected in the first line of its output\&. This allows for a script doing a dynamic lookup of the correct public key when it is impractical to statically configure
  6118. \fBuser\&.signingKey\fR\&. For example when keys or SSH Certificates are rotated frequently or selection of the right key depends on external factors unknown to git\&.
  6119. .RE
  6120. .PP
  6121. gpg\&.ssh\&.allowedSignersFile
  6122. .RS 4
  6123. A file containing ssh public keys which you are willing to trust\&. The file consists of one or more lines of principals followed by an ssh public key\&. e\&.g\&.:
  6124. \fBuser1@example\&.com,user2@example\&.com\fR
  6125. \fBssh\-rsa\fR
  6126. \fBAAAAX1\&.\&.\fR\&. See ssh\-keygen(1) "ALLOWED SIGNERS" for details\&. The principal is only used to identify the key and is available when verifying a signature\&.
  6127. .sp
  6128. SSH has no concept of trust levels like gpg does\&. To be able to differentiate between valid signatures and trusted signatures the trust level of a signature verification is set to
  6129. \fBfully\fR
  6130. when the public key is present in the allowedSignersFile\&. Otherwise the trust level is
  6131. \fBundefined\fR
  6132. and git verify\-commit/tag will fail\&.
  6133. .sp
  6134. This file can be set to a location outside of the repository and every developer maintains their own trust store\&. A central repository server could generate this file automatically from ssh keys with push access to verify the code against\&. In a corporate setting this file is probably generated at a global location from automation that already handles developer ssh keys\&.
  6135. .sp
  6136. A repository that only allows signed commits can store the file in the repository itself using a path relative to the top\-level of the working tree\&. This way only committers with an already valid key can add or change keys in the keyring\&.
  6137. .sp
  6138. Since OpensSSH 8\&.8 this file allows specifying a key lifetime using valid\-after & valid\-before options\&. Git will mark signatures as valid if the signing key was valid at the time of the signature\(cqs creation\&. This allows users to change a signing key without invalidating all previously made signatures\&.
  6139. .sp
  6140. Using a SSH CA key with the cert\-authority option (see ssh\-keygen(1) "CERTIFICATES") is also valid\&.
  6141. .RE
  6142. .PP
  6143. gpg\&.ssh\&.revocationFile
  6144. .RS 4
  6145. Either a SSH KRL or a list of revoked public keys (without the principal prefix)\&. See ssh\-keygen(1) for details\&. If a public key is found in this file then it will always be treated as having trust level "never" and signatures will show as invalid\&.
  6146. .RE
  6147. .PP
  6148. grep\&.lineNumber
  6149. .RS 4
  6150. If set to true, enable
  6151. \fB\-n\fR
  6152. option by default\&.
  6153. .RE
  6154. .PP
  6155. grep\&.column
  6156. .RS 4
  6157. If set to true, enable the
  6158. \fB\-\-column\fR
  6159. option by default\&.
  6160. .RE
  6161. .PP
  6162. grep\&.patternType
  6163. .RS 4
  6164. Set the default matching behavior\&. Using a value of
  6165. \fIbasic\fR,
  6166. \fIextended\fR,
  6167. \fIfixed\fR, or
  6168. \fIperl\fR
  6169. will enable the
  6170. \fB\-\-basic\-regexp\fR,
  6171. \fB\-\-extended\-regexp\fR,
  6172. \fB\-\-fixed\-strings\fR, or
  6173. \fB\-\-perl\-regexp\fR
  6174. option accordingly, while the value
  6175. \fIdefault\fR
  6176. will use the
  6177. \fBgrep\&.extendedRegexp\fR
  6178. option to choose between
  6179. \fIbasic\fR
  6180. and
  6181. \fIextended\fR\&.
  6182. .RE
  6183. .PP
  6184. grep\&.extendedRegexp
  6185. .RS 4
  6186. If set to true, enable
  6187. \fB\-\-extended\-regexp\fR
  6188. option by default\&. This option is ignored when the
  6189. \fBgrep\&.patternType\fR
  6190. option is set to a value other than
  6191. \fIdefault\fR\&.
  6192. .RE
  6193. .PP
  6194. grep\&.threads
  6195. .RS 4
  6196. Number of grep worker threads to use\&. If unset (or set to 0), Git will use as many threads as the number of logical cores available\&.
  6197. .RE
  6198. .PP
  6199. grep\&.fullName
  6200. .RS 4
  6201. If set to true, enable
  6202. \fB\-\-full\-name\fR
  6203. option by default\&.
  6204. .RE
  6205. .PP
  6206. grep\&.fallbackToNoIndex
  6207. .RS 4
  6208. If set to true, fall back to
  6209. \fBgit\fR
  6210. \fBgrep\fR
  6211. \fB\-\-no\-index\fR
  6212. if
  6213. \fBgit\fR
  6214. \fBgrep\fR
  6215. is executed outside of a git repository\&. Defaults to false\&.
  6216. .RE
  6217. .PP
  6218. gui\&.commitMsgWidth
  6219. .RS 4
  6220. Defines how wide the commit message window is in the
  6221. \fBgit-gui\fR(1)\&. "75" is the default\&.
  6222. .RE
  6223. .PP
  6224. gui\&.diffContext
  6225. .RS 4
  6226. Specifies how many context lines should be used in calls to diff made by the
  6227. \fBgit-gui\fR(1)\&. The default is "5"\&.
  6228. .RE
  6229. .PP
  6230. gui\&.displayUntracked
  6231. .RS 4
  6232. Determines if
  6233. \fBgit-gui\fR(1)
  6234. shows untracked files in the file list\&. The default is "true"\&.
  6235. .RE
  6236. .PP
  6237. gui\&.encoding
  6238. .RS 4
  6239. Specifies the default character encoding to use for displaying of file contents in
  6240. \fBgit-gui\fR(1)
  6241. and
  6242. \fBgitk\fR(1)\&. It can be overridden by setting the
  6243. \fIencoding\fR
  6244. attribute for relevant files (see
  6245. \fBgitattributes\fR(5))\&. If this option is not set, the tools default to the locale encoding\&.
  6246. .RE
  6247. .PP
  6248. gui\&.matchTrackingBranch
  6249. .RS 4
  6250. Determines if new branches created with
  6251. \fBgit-gui\fR(1)
  6252. should default to tracking remote branches with matching names or not\&. Default: "false"\&.
  6253. .RE
  6254. .PP
  6255. gui\&.newBranchTemplate
  6256. .RS 4
  6257. Is used as a suggested name when creating new branches using the
  6258. \fBgit-gui\fR(1)\&.
  6259. .RE
  6260. .PP
  6261. gui\&.pruneDuringFetch
  6262. .RS 4
  6263. "true" if
  6264. \fBgit-gui\fR(1)
  6265. should prune remote\-tracking branches when performing a fetch\&. The default value is "false"\&.
  6266. .RE
  6267. .PP
  6268. gui\&.trustmtime
  6269. .RS 4
  6270. Determines if
  6271. \fBgit-gui\fR(1)
  6272. should trust the file modification timestamp or not\&. By default the timestamps are not trusted\&.
  6273. .RE
  6274. .PP
  6275. gui\&.spellingDictionary
  6276. .RS 4
  6277. Specifies the dictionary used for spell checking commit messages in the
  6278. \fBgit-gui\fR(1)\&. When set to "none" spell checking is turned off\&.
  6279. .RE
  6280. .PP
  6281. gui\&.fastCopyBlame
  6282. .RS 4
  6283. If true,
  6284. \fIgit gui blame\fR
  6285. uses
  6286. \fB\-C\fR
  6287. instead of
  6288. \fB\-C\fR
  6289. \fB\-C\fR
  6290. for original location detection\&. It makes blame significantly faster on huge repositories at the expense of less thorough copy detection\&.
  6291. .RE
  6292. .PP
  6293. gui\&.copyBlameThreshold
  6294. .RS 4
  6295. Specifies the threshold to use in
  6296. \fIgit gui blame\fR
  6297. original location detection, measured in alphanumeric characters\&. See the
  6298. \fBgit-blame\fR(1)
  6299. manual for more information on copy detection\&.
  6300. .RE
  6301. .PP
  6302. gui\&.blamehistoryctx
  6303. .RS 4
  6304. Specifies the radius of history context in days to show in
  6305. \fBgitk\fR(1)
  6306. for the selected commit, when the
  6307. \fBShow\fR
  6308. \fBHistory\fR
  6309. \fBContext\fR
  6310. menu item is invoked from
  6311. \fIgit gui blame\fR\&. If this variable is set to zero, the whole history is shown\&.
  6312. .RE
  6313. .PP
  6314. guitool\&.<name>\&.cmd
  6315. .RS 4
  6316. Specifies the shell command line to execute when the corresponding item of the
  6317. \fBgit-gui\fR(1)
  6318. \fBTools\fR
  6319. menu is invoked\&. This option is mandatory for every tool\&. The command is executed from the root of the working directory, and in the environment it receives the name of the tool as
  6320. \fBGIT_GUITOOL\fR, the name of the currently selected file as
  6321. \fIFILENAME\fR, and the name of the current branch as
  6322. \fICUR_BRANCH\fR
  6323. (if the head is detached,
  6324. \fICUR_BRANCH\fR
  6325. is empty)\&.
  6326. .RE
  6327. .PP
  6328. guitool\&.<name>\&.needsFile
  6329. .RS 4
  6330. Run the tool only if a diff is selected in the GUI\&. It guarantees that
  6331. \fIFILENAME\fR
  6332. is not empty\&.
  6333. .RE
  6334. .PP
  6335. guitool\&.<name>\&.noConsole
  6336. .RS 4
  6337. Run the command silently, without creating a window to display its output\&.
  6338. .RE
  6339. .PP
  6340. guitool\&.<name>\&.noRescan
  6341. .RS 4
  6342. Don\(cqt rescan the working directory for changes after the tool finishes execution\&.
  6343. .RE
  6344. .PP
  6345. guitool\&.<name>\&.confirm
  6346. .RS 4
  6347. Show a confirmation dialog before actually running the tool\&.
  6348. .RE
  6349. .PP
  6350. guitool\&.<name>\&.argPrompt
  6351. .RS 4
  6352. Request a string argument from the user, and pass it to the tool through the
  6353. \fBARGS\fR
  6354. environment variable\&. Since requesting an argument implies confirmation, the
  6355. \fIconfirm\fR
  6356. option has no effect if this is enabled\&. If the option is set to
  6357. \fItrue\fR,
  6358. \fIyes\fR, or
  6359. \fI1\fR, the dialog uses a built\-in generic prompt; otherwise the exact value of the variable is used\&.
  6360. .RE
  6361. .PP
  6362. guitool\&.<name>\&.revPrompt
  6363. .RS 4
  6364. Request a single valid revision from the user, and set the
  6365. \fBREVISION\fR
  6366. environment variable\&. In other aspects this option is similar to
  6367. \fIargPrompt\fR, and can be used together with it\&.
  6368. .RE
  6369. .PP
  6370. guitool\&.<name>\&.revUnmerged
  6371. .RS 4
  6372. Show only unmerged branches in the
  6373. \fIrevPrompt\fR
  6374. subdialog\&. This is useful for tools similar to merge or rebase, but not for things like checkout or reset\&.
  6375. .RE
  6376. .PP
  6377. guitool\&.<name>\&.title
  6378. .RS 4
  6379. Specifies the title to use for the prompt dialog\&. The default is the tool name\&.
  6380. .RE
  6381. .PP
  6382. guitool\&.<name>\&.prompt
  6383. .RS 4
  6384. Specifies the general prompt string to display at the top of the dialog, before subsections for
  6385. \fIargPrompt\fR
  6386. and
  6387. \fIrevPrompt\fR\&. The default value includes the actual command\&.
  6388. .RE
  6389. .PP
  6390. help\&.browser
  6391. .RS 4
  6392. Specify the browser that will be used to display help in the
  6393. \fIweb\fR
  6394. format\&. See
  6395. \fBgit-help\fR(1)\&.
  6396. .RE
  6397. .PP
  6398. help\&.format
  6399. .RS 4
  6400. Override the default help format used by
  6401. \fBgit-help\fR(1)\&. Values
  6402. \fIman\fR,
  6403. \fIinfo\fR,
  6404. \fIweb\fR
  6405. and
  6406. \fIhtml\fR
  6407. are supported\&.
  6408. \fIman\fR
  6409. is the default\&.
  6410. \fIweb\fR
  6411. and
  6412. \fIhtml\fR
  6413. are the same\&.
  6414. .RE
  6415. .PP
  6416. help\&.autoCorrect
  6417. .RS 4
  6418. If git detects typos and can identify exactly one valid command similar to the error, git will try to suggest the correct command or even run the suggestion automatically\&. Possible config values are:
  6419. .sp
  6420. .RS 4
  6421. .ie n \{\
  6422. \h'-04'\(bu\h'+03'\c
  6423. .\}
  6424. .el \{\
  6425. .sp -1
  6426. .IP \(bu 2.3
  6427. .\}
  6428. 0, "false", "off", "no", "show": show the suggested command (default)\&.
  6429. .RE
  6430. .sp
  6431. .RS 4
  6432. .ie n \{\
  6433. \h'-04'\(bu\h'+03'\c
  6434. .\}
  6435. .el \{\
  6436. .sp -1
  6437. .IP \(bu 2.3
  6438. .\}
  6439. 1, "true", "on", "yes", "immediate": run the suggested command immediately\&.
  6440. .RE
  6441. .sp
  6442. .RS 4
  6443. .ie n \{\
  6444. \h'-04'\(bu\h'+03'\c
  6445. .\}
  6446. .el \{\
  6447. .sp -1
  6448. .IP \(bu 2.3
  6449. .\}
  6450. positive number > 1: run the suggested command after specified deciseconds (0\&.1 sec)\&.
  6451. .RE
  6452. .sp
  6453. .RS 4
  6454. .ie n \{\
  6455. \h'-04'\(bu\h'+03'\c
  6456. .\}
  6457. .el \{\
  6458. .sp -1
  6459. .IP \(bu 2.3
  6460. .\}
  6461. "never": don\(cqt run or show any suggested command\&.
  6462. .RE
  6463. .sp
  6464. .RS 4
  6465. .ie n \{\
  6466. \h'-04'\(bu\h'+03'\c
  6467. .\}
  6468. .el \{\
  6469. .sp -1
  6470. .IP \(bu 2.3
  6471. .\}
  6472. "prompt": show the suggestion and prompt for confirmation to run the command\&.
  6473. .RE
  6474. .RE
  6475. .PP
  6476. help\&.htmlPath
  6477. .RS 4
  6478. Specify the path where the HTML documentation resides\&. File system paths and URLs are supported\&. HTML pages will be prefixed with this path when help is displayed in the
  6479. \fIweb\fR
  6480. format\&. This defaults to the documentation path of your Git installation\&.
  6481. .RE
  6482. .PP
  6483. http\&.proxy
  6484. .RS 4
  6485. Override the HTTP proxy, normally configured using the
  6486. \fIhttp_proxy\fR,
  6487. \fIhttps_proxy\fR, and
  6488. \fIall_proxy\fR
  6489. environment variables (see
  6490. \fBcurl\fR(\fB1\fR))\&. In addition to the syntax understood by curl, it is possible to specify a proxy string with a user name but no password, in which case git will attempt to acquire one in the same way it does for other credentials\&. See
  6491. \fBgitcredentials\fR(7)
  6492. for more information\&. The syntax thus is
  6493. \fI[protocol://][user[:password]@]proxyhost[:port][/path]\fR\&. This can be overridden on a per\-remote basis; see remote\&.<name>\&.proxy
  6494. .sp
  6495. Any proxy, however configured, must be completely transparent and must not modify, transform, or buffer the request or response in any way\&. Proxies which are not completely transparent are known to cause various forms of breakage with Git\&.
  6496. .RE
  6497. .PP
  6498. http\&.proxyAuthMethod
  6499. .RS 4
  6500. Set the method with which to authenticate against the HTTP proxy\&. This only takes effect if the configured proxy string contains a user name part (i\&.e\&. is of the form
  6501. \fIuser@host\fR
  6502. or
  6503. \fIuser@host:port\fR)\&. This can be overridden on a per\-remote basis; see
  6504. \fBremote\&.\fR\fI<name>\fR\fB\&.proxyAuthMethod\fR\&. Both can be overridden by the
  6505. \fBGIT_HTTP_PROXY_AUTHMETHOD\fR
  6506. environment variable\&. Possible values are:
  6507. .sp
  6508. .RS 4
  6509. .ie n \{\
  6510. \h'-04'\(bu\h'+03'\c
  6511. .\}
  6512. .el \{\
  6513. .sp -1
  6514. .IP \(bu 2.3
  6515. .\}
  6516. \fBanyauth\fR
  6517. \- Automatically pick a suitable authentication method\&. It is assumed that the proxy answers an unauthenticated request with a 407 status code and one or more Proxy\-authenticate headers with supported authentication methods\&. This is the default\&.
  6518. .RE
  6519. .sp
  6520. .RS 4
  6521. .ie n \{\
  6522. \h'-04'\(bu\h'+03'\c
  6523. .\}
  6524. .el \{\
  6525. .sp -1
  6526. .IP \(bu 2.3
  6527. .\}
  6528. \fBbasic\fR
  6529. \- HTTP Basic authentication
  6530. .RE
  6531. .sp
  6532. .RS 4
  6533. .ie n \{\
  6534. \h'-04'\(bu\h'+03'\c
  6535. .\}
  6536. .el \{\
  6537. .sp -1
  6538. .IP \(bu 2.3
  6539. .\}
  6540. \fBdigest\fR
  6541. \- HTTP Digest authentication; this prevents the password from being transmitted to the proxy in clear text
  6542. .RE
  6543. .sp
  6544. .RS 4
  6545. .ie n \{\
  6546. \h'-04'\(bu\h'+03'\c
  6547. .\}
  6548. .el \{\
  6549. .sp -1
  6550. .IP \(bu 2.3
  6551. .\}
  6552. \fBnegotiate\fR
  6553. \- GSS\-Negotiate authentication (compare the \-\-negotiate option of
  6554. \fBcurl\fR(\fB1\fR))
  6555. .RE
  6556. .sp
  6557. .RS 4
  6558. .ie n \{\
  6559. \h'-04'\(bu\h'+03'\c
  6560. .\}
  6561. .el \{\
  6562. .sp -1
  6563. .IP \(bu 2.3
  6564. .\}
  6565. \fBntlm\fR
  6566. \- NTLM authentication (compare the \-\-ntlm option of
  6567. \fBcurl\fR(\fB1\fR))
  6568. .RE
  6569. .RE
  6570. .PP
  6571. http\&.proxySSLCert
  6572. .RS 4
  6573. The pathname of a file that stores a client certificate to use to authenticate with an HTTPS proxy\&. Can be overridden by the
  6574. \fBGIT_PROXY_SSL_CERT\fR
  6575. environment variable\&.
  6576. .RE
  6577. .PP
  6578. http\&.proxySSLKey
  6579. .RS 4
  6580. The pathname of a file that stores a private key to use to authenticate with an HTTPS proxy\&. Can be overridden by the
  6581. \fBGIT_PROXY_SSL_KEY\fR
  6582. environment variable\&.
  6583. .RE
  6584. .PP
  6585. http\&.proxySSLCertPasswordProtected
  6586. .RS 4
  6587. Enable Git\(cqs password prompt for the proxy SSL certificate\&. Otherwise OpenSSL will prompt the user, possibly many times, if the certificate or private key is encrypted\&. Can be overridden by the
  6588. \fBGIT_PROXY_SSL_CERT_PASSWORD_PROTECTED\fR
  6589. environment variable\&.
  6590. .RE
  6591. .PP
  6592. http\&.proxySSLCAInfo
  6593. .RS 4
  6594. Pathname to the file containing the certificate bundle that should be used to verify the proxy with when using an HTTPS proxy\&. Can be overridden by the
  6595. \fBGIT_PROXY_SSL_CAINFO\fR
  6596. environment variable\&.
  6597. .RE
  6598. .PP
  6599. http\&.emptyAuth
  6600. .RS 4
  6601. Attempt authentication without seeking a username or password\&. This can be used to attempt GSS\-Negotiate authentication without specifying a username in the URL, as libcurl normally requires a username for authentication\&.
  6602. .RE
  6603. .PP
  6604. http\&.proactiveAuth
  6605. .RS 4
  6606. Attempt authentication without first making an unauthenticated attempt and receiving a 401 response\&. This can be used to ensure that all requests are authenticated\&. If
  6607. \fBhttp\&.emptyAuth\fR
  6608. is set to true, this value has no effect\&.
  6609. .sp
  6610. If the credential helper used specifies an authentication scheme (i\&.e\&., via the
  6611. \fBauthtype\fR
  6612. field), that value will be used; if a username and password is provided without a scheme, then Basic authentication is used\&. The value of the option determines the scheme requested from the helper\&. Possible values are:
  6613. .sp
  6614. .RS 4
  6615. .ie n \{\
  6616. \h'-04'\(bu\h'+03'\c
  6617. .\}
  6618. .el \{\
  6619. .sp -1
  6620. .IP \(bu 2.3
  6621. .\}
  6622. \fBbasic\fR
  6623. \- Request Basic authentication from the helper\&.
  6624. .RE
  6625. .sp
  6626. .RS 4
  6627. .ie n \{\
  6628. \h'-04'\(bu\h'+03'\c
  6629. .\}
  6630. .el \{\
  6631. .sp -1
  6632. .IP \(bu 2.3
  6633. .\}
  6634. \fBauto\fR
  6635. \- Allow the helper to pick an appropriate scheme\&.
  6636. .RE
  6637. .sp
  6638. .RS 4
  6639. .ie n \{\
  6640. \h'-04'\(bu\h'+03'\c
  6641. .\}
  6642. .el \{\
  6643. .sp -1
  6644. .IP \(bu 2.3
  6645. .\}
  6646. \fBnone\fR
  6647. \- Disable proactive authentication\&.
  6648. .RE
  6649. .sp
  6650. Note that TLS should always be used with this configuration, since otherwise it is easy to accidentally expose plaintext credentials if Basic authentication is selected\&.
  6651. .RE
  6652. .PP
  6653. http\&.delegation
  6654. .RS 4
  6655. Control GSSAPI credential delegation\&. The delegation is disabled by default in libcurl since version 7\&.21\&.7\&. Set parameter to tell the server what it is allowed to delegate when it comes to user credentials\&. Used with GSS/kerberos\&. Possible values are:
  6656. .sp
  6657. .RS 4
  6658. .ie n \{\
  6659. \h'-04'\(bu\h'+03'\c
  6660. .\}
  6661. .el \{\
  6662. .sp -1
  6663. .IP \(bu 2.3
  6664. .\}
  6665. \fBnone\fR
  6666. \- Don\(cqt allow any delegation\&.
  6667. .RE
  6668. .sp
  6669. .RS 4
  6670. .ie n \{\
  6671. \h'-04'\(bu\h'+03'\c
  6672. .\}
  6673. .el \{\
  6674. .sp -1
  6675. .IP \(bu 2.3
  6676. .\}
  6677. \fBpolicy\fR
  6678. \- Delegates if and only if the OK\-AS\-DELEGATE flag is set in the Kerberos service ticket, which is a matter of realm policy\&.
  6679. .RE
  6680. .sp
  6681. .RS 4
  6682. .ie n \{\
  6683. \h'-04'\(bu\h'+03'\c
  6684. .\}
  6685. .el \{\
  6686. .sp -1
  6687. .IP \(bu 2.3
  6688. .\}
  6689. \fBalways\fR
  6690. \- Unconditionally allow the server to delegate\&.
  6691. .RE
  6692. .RE
  6693. .PP
  6694. http\&.extraHeader
  6695. .RS 4
  6696. Pass an additional HTTP header when communicating with a server\&. If more than one such entry exists, all of them are added as extra headers\&. To allow overriding the settings inherited from the system config, an empty value will reset the extra headers to the empty list\&.
  6697. .RE
  6698. .PP
  6699. http\&.cookieFile
  6700. .RS 4
  6701. The pathname of a file containing previously stored cookie lines, which should be used in the Git http session, if they match the server\&. The file format of the file to read cookies from should be plain HTTP headers or the Netscape/Mozilla cookie file format (see
  6702. \fBcurl\fR(\fB1\fR))\&. Set it to an empty string, to accept only new cookies from the server and send them back in successive requests within same connection\&. NOTE that the file specified with http\&.cookieFile is used only as input unless http\&.saveCookies is set\&.
  6703. .RE
  6704. .PP
  6705. http\&.saveCookies
  6706. .RS 4
  6707. If set, store cookies received during requests to the file specified by http\&.cookieFile\&. Has no effect if http\&.cookieFile is unset, or set to an empty string\&.
  6708. .RE
  6709. .PP
  6710. http\&.version
  6711. .RS 4
  6712. Use the specified HTTP protocol version when communicating with a server\&. If you want to force the default\&. The available and default version depend on libcurl\&. Currently the possible values of this option are:
  6713. .sp
  6714. .RS 4
  6715. .ie n \{\
  6716. \h'-04'\(bu\h'+03'\c
  6717. .\}
  6718. .el \{\
  6719. .sp -1
  6720. .IP \(bu 2.3
  6721. .\}
  6722. HTTP/2
  6723. .RE
  6724. .sp
  6725. .RS 4
  6726. .ie n \{\
  6727. \h'-04'\(bu\h'+03'\c
  6728. .\}
  6729. .el \{\
  6730. .sp -1
  6731. .IP \(bu 2.3
  6732. .\}
  6733. HTTP/1\&.1
  6734. .RE
  6735. .RE
  6736. .PP
  6737. http\&.curloptResolve
  6738. .RS 4
  6739. Hostname resolution information that will be used first by libcurl when sending HTTP requests\&. This information should be in one of the following formats:
  6740. .sp
  6741. .RS 4
  6742. .ie n \{\
  6743. \h'-04'\(bu\h'+03'\c
  6744. .\}
  6745. .el \{\
  6746. .sp -1
  6747. .IP \(bu 2.3
  6748. .\}
  6749. [+]HOST:PORT:ADDRESS[,ADDRESS]
  6750. .RE
  6751. .sp
  6752. .RS 4
  6753. .ie n \{\
  6754. \h'-04'\(bu\h'+03'\c
  6755. .\}
  6756. .el \{\
  6757. .sp -1
  6758. .IP \(bu 2.3
  6759. .\}
  6760. \-HOST:PORT
  6761. .RE
  6762. .sp
  6763. The first format redirects all requests to the given
  6764. \fBHOST:PORT\fR
  6765. to the provided
  6766. \fBADDRESS\fR(s)\&. The second format clears all previous config values for that
  6767. \fBHOST:PORT\fR
  6768. combination\&. To allow easy overriding of all the settings inherited from the system config, an empty value will reset all resolution information to the empty list\&.
  6769. .RE
  6770. .PP
  6771. http\&.sslVersion
  6772. .RS 4
  6773. The SSL version to use when negotiating an SSL connection, if you want to force the default\&. The available and default version depend on whether libcurl was built against NSS or OpenSSL and the particular configuration of the crypto library in use\&. Internally this sets the
  6774. \fICURLOPT_SSL_VERSION\fR
  6775. option; see the libcurl documentation for more details on the format of this option and for the ssl version supported\&. Currently the possible values of this option are:
  6776. .sp
  6777. .RS 4
  6778. .ie n \{\
  6779. \h'-04'\(bu\h'+03'\c
  6780. .\}
  6781. .el \{\
  6782. .sp -1
  6783. .IP \(bu 2.3
  6784. .\}
  6785. sslv2
  6786. .RE
  6787. .sp
  6788. .RS 4
  6789. .ie n \{\
  6790. \h'-04'\(bu\h'+03'\c
  6791. .\}
  6792. .el \{\
  6793. .sp -1
  6794. .IP \(bu 2.3
  6795. .\}
  6796. sslv3
  6797. .RE
  6798. .sp
  6799. .RS 4
  6800. .ie n \{\
  6801. \h'-04'\(bu\h'+03'\c
  6802. .\}
  6803. .el \{\
  6804. .sp -1
  6805. .IP \(bu 2.3
  6806. .\}
  6807. tlsv1
  6808. .RE
  6809. .sp
  6810. .RS 4
  6811. .ie n \{\
  6812. \h'-04'\(bu\h'+03'\c
  6813. .\}
  6814. .el \{\
  6815. .sp -1
  6816. .IP \(bu 2.3
  6817. .\}
  6818. tlsv1\&.0
  6819. .RE
  6820. .sp
  6821. .RS 4
  6822. .ie n \{\
  6823. \h'-04'\(bu\h'+03'\c
  6824. .\}
  6825. .el \{\
  6826. .sp -1
  6827. .IP \(bu 2.3
  6828. .\}
  6829. tlsv1\&.1
  6830. .RE
  6831. .sp
  6832. .RS 4
  6833. .ie n \{\
  6834. \h'-04'\(bu\h'+03'\c
  6835. .\}
  6836. .el \{\
  6837. .sp -1
  6838. .IP \(bu 2.3
  6839. .\}
  6840. tlsv1\&.2
  6841. .RE
  6842. .sp
  6843. .RS 4
  6844. .ie n \{\
  6845. \h'-04'\(bu\h'+03'\c
  6846. .\}
  6847. .el \{\
  6848. .sp -1
  6849. .IP \(bu 2.3
  6850. .\}
  6851. tlsv1\&.3
  6852. .RE
  6853. .sp
  6854. Can be overridden by the
  6855. \fBGIT_SSL_VERSION\fR
  6856. environment variable\&. To force git to use libcurl\(cqs default ssl version and ignore any explicit http\&.sslversion option, set
  6857. \fBGIT_SSL_VERSION\fR
  6858. to the empty string\&.
  6859. .RE
  6860. .PP
  6861. http\&.sslCipherList
  6862. .RS 4
  6863. A list of SSL ciphers to use when negotiating an SSL connection\&. The available ciphers depend on whether libcurl was built against NSS or OpenSSL and the particular configuration of the crypto library in use\&. Internally this sets the
  6864. \fICURLOPT_SSL_CIPHER_LIST\fR
  6865. option; see the libcurl documentation for more details on the format of this list\&.
  6866. .sp
  6867. Can be overridden by the
  6868. \fBGIT_SSL_CIPHER_LIST\fR
  6869. environment variable\&. To force git to use libcurl\(cqs default cipher list and ignore any explicit http\&.sslCipherList option, set
  6870. \fBGIT_SSL_CIPHER_LIST\fR
  6871. to the empty string\&.
  6872. .RE
  6873. .PP
  6874. http\&.sslVerify
  6875. .RS 4
  6876. Whether to verify the SSL certificate when fetching or pushing over HTTPS\&. Defaults to true\&. Can be overridden by the
  6877. \fBGIT_SSL_NO_VERIFY\fR
  6878. environment variable\&.
  6879. .RE
  6880. .PP
  6881. http\&.sslCert
  6882. .RS 4
  6883. File containing the SSL certificate when fetching or pushing over HTTPS\&. Can be overridden by the
  6884. \fBGIT_SSL_CERT\fR
  6885. environment variable\&.
  6886. .RE
  6887. .PP
  6888. http\&.sslKey
  6889. .RS 4
  6890. File containing the SSL private key when fetching or pushing over HTTPS\&. Can be overridden by the
  6891. \fBGIT_SSL_KEY\fR
  6892. environment variable\&.
  6893. .RE
  6894. .PP
  6895. http\&.sslCertPasswordProtected
  6896. .RS 4
  6897. Enable Git\(cqs password prompt for the SSL certificate\&. Otherwise OpenSSL will prompt the user, possibly many times, if the certificate or private key is encrypted\&. Can be overridden by the
  6898. \fBGIT_SSL_CERT_PASSWORD_PROTECTED\fR
  6899. environment variable\&.
  6900. .RE
  6901. .PP
  6902. http\&.sslCAInfo
  6903. .RS 4
  6904. File containing the certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overridden by the
  6905. \fBGIT_SSL_CAINFO\fR
  6906. environment variable\&.
  6907. .RE
  6908. .PP
  6909. http\&.sslCAPath
  6910. .RS 4
  6911. Path containing files with the CA certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overridden by the
  6912. \fBGIT_SSL_CAPATH\fR
  6913. environment variable\&.
  6914. .RE
  6915. .PP
  6916. http\&.sslBackend
  6917. .RS 4
  6918. Name of the SSL backend to use (e\&.g\&. "openssl" or "schannel")\&. This option is ignored if cURL lacks support for choosing the SSL backend at runtime\&.
  6919. .RE
  6920. .PP
  6921. http\&.sslCertType
  6922. .RS 4
  6923. Type of client certificate used when fetching or pushing over HTTPS\&. "PEM", "DER" are supported when using openssl or gnutls backends\&. "P12" is supported on "openssl", "schannel", "securetransport", and gnutls 8\&.11+\&. See also libcurl
  6924. \fBCURLOPT_SSLCERTTYPE\fR\&. Can be overridden by the
  6925. \fBGIT_SSL_CERT_TYPE\fR
  6926. environment variable\&.
  6927. .RE
  6928. .PP
  6929. http\&.sslKeyType
  6930. .RS 4
  6931. Type of client private key used when fetching or pushing over HTTPS\&. (e\&.g\&. "PEM", "DER", or "ENG")\&. Only applicable when using "openssl" backend\&. "DER" is not supported with openssl\&. Particularly useful when set to "ENG" for authenticating with PKCS#11 tokens, with a PKCS#11 URL in sslCert option\&. See also libcurl
  6932. \fBCURLOPT_SSLKEYTYPE\fR\&. Can be overridden by the
  6933. \fBGIT_SSL_KEY_TYPE\fR
  6934. environment variable\&.
  6935. .RE
  6936. .PP
  6937. http\&.schannelCheckRevoke
  6938. .RS 4
  6939. Used to enforce or disable certificate revocation checks in cURL when http\&.sslBackend is set to "schannel"\&. Defaults to
  6940. \fBtrue\fR
  6941. if unset\&. Only necessary to disable this if Git consistently errors and the message is about checking the revocation status of a certificate\&. This option is ignored if cURL lacks support for setting the relevant SSL option at runtime\&.
  6942. .RE
  6943. .PP
  6944. http\&.schannelUseSSLCAInfo
  6945. .RS 4
  6946. As of cURL v7\&.60\&.0, the Secure Channel backend can use the certificate bundle provided via
  6947. \fBhttp\&.sslCAInfo\fR, but that would override the Windows Certificate Store\&. Since this is not desirable by default, Git will tell cURL not to use that bundle by default when the
  6948. \fBschannel\fR
  6949. backend was configured via
  6950. \fBhttp\&.sslBackend\fR, unless
  6951. \fBhttp\&.schannelUseSSLCAInfo\fR
  6952. overrides this behavior\&.
  6953. .RE
  6954. .PP
  6955. http\&.pinnedPubkey
  6956. .RS 4
  6957. Public key of the https service\&. It may either be the filename of a PEM or DER encoded public key file or a string starting with
  6958. \fIsha256//\fR
  6959. followed by the base64 encoded sha256 hash of the public key\&. See also libcurl
  6960. \fICURLOPT_PINNEDPUBLICKEY\fR\&. git will exit with an error if this option is set but not supported by cURL\&.
  6961. .RE
  6962. .PP
  6963. http\&.sslTry
  6964. .RS 4
  6965. Attempt to use AUTH SSL/TLS and encrypted data transfers when connecting via regular FTP protocol\&. This might be needed if the FTP server requires it for security reasons or you wish to connect securely whenever remote FTP server supports it\&. Default is false since it might trigger certificate verification errors on misconfigured servers\&.
  6966. .RE
  6967. .PP
  6968. http\&.maxRequests
  6969. .RS 4
  6970. How many HTTP requests to launch in parallel\&. Can be overridden by the
  6971. \fBGIT_HTTP_MAX_REQUESTS\fR
  6972. environment variable\&. Default is 5\&.
  6973. .RE
  6974. .PP
  6975. http\&.minSessions
  6976. .RS 4
  6977. The number of curl sessions (counted across slots) to be kept across requests\&. They will not be ended with curl_easy_cleanup() until http_cleanup() is invoked\&. If USE_CURL_MULTI is not defined, this value will be capped at 1\&. Defaults to 1\&.
  6978. .RE
  6979. .PP
  6980. http\&.postBuffer
  6981. .RS 4
  6982. Maximum size in bytes of the buffer used by smart HTTP transports when POSTing data to the remote system\&. For requests larger than this buffer size, HTTP/1\&.1 and Transfer\-Encoding: chunked is used to avoid creating a massive pack file locally\&. Default is 1 MiB, which is sufficient for most requests\&.
  6983. .sp
  6984. Note that raising this limit is only effective for disabling chunked transfer encoding and therefore should be used only where the remote server or a proxy only supports HTTP/1\&.0 or is noncompliant with the HTTP standard\&. Raising this is not, in general, an effective solution for most push problems, but can increase memory consumption significantly since the entire buffer is allocated even for small pushes\&.
  6985. .RE
  6986. .PP
  6987. http\&.lowSpeedLimit, http\&.lowSpeedTime
  6988. .RS 4
  6989. If the HTTP transfer speed, in bytes per second, is less than
  6990. \fIhttp\&.lowSpeedLimit\fR
  6991. for longer than
  6992. \fIhttp\&.lowSpeedTime\fR
  6993. seconds, the transfer is aborted\&. Can be overridden by the
  6994. \fBGIT_HTTP_LOW_SPEED_LIMIT\fR
  6995. and
  6996. \fBGIT_HTTP_LOW_SPEED_TIME\fR
  6997. environment variables\&.
  6998. .RE
  6999. .PP
  7000. http\&.noEPSV
  7001. .RS 4
  7002. A boolean which disables using of EPSV ftp command by curl\&. This can be helpful with some "poor" ftp servers which don\(cqt support EPSV mode\&. Can be overridden by the
  7003. \fBGIT_CURL_FTP_NO_EPSV\fR
  7004. environment variable\&. Default is false (curl will use EPSV)\&.
  7005. .RE
  7006. .PP
  7007. http\&.userAgent
  7008. .RS 4
  7009. The HTTP USER_AGENT string presented to an HTTP server\&. The default value represents the version of the Git client such as git/1\&.7\&.1\&. This option allows you to override this value to a more common value such as Mozilla/4\&.0\&. This may be necessary, for instance, if connecting through a firewall that restricts HTTP connections to a set of common USER_AGENT strings (but not including those like git/1\&.7\&.1)\&. Can be overridden by the
  7010. \fBGIT_HTTP_USER_AGENT\fR
  7011. environment variable\&.
  7012. .RE
  7013. .PP
  7014. http\&.followRedirects
  7015. .RS 4
  7016. Whether git should follow HTTP redirects\&. If set to
  7017. \fBtrue\fR, git will transparently follow any redirect issued by a server it encounters\&. If set to
  7018. \fBfalse\fR, git will treat all redirects as errors\&. If set to
  7019. \fBinitial\fR, git will follow redirects only for the initial request to a remote, but not for subsequent follow\-up HTTP requests\&. Since git uses the redirected URL as the base for the follow\-up requests, this is generally sufficient\&. The default is
  7020. \fBinitial\fR\&.
  7021. .RE
  7022. .PP
  7023. http\&.<url>\&.*
  7024. .RS 4
  7025. Any of the http\&.* options above can be applied selectively to some URLs\&. For a config key to match a URL, each element of the config key is compared to that of the URL, in the following order:
  7026. .sp
  7027. .RS 4
  7028. .ie n \{\
  7029. \h'-04' 1.\h'+01'\c
  7030. .\}
  7031. .el \{\
  7032. .sp -1
  7033. .IP "  1." 4.2
  7034. .\}
  7035. Scheme (e\&.g\&.,
  7036. \fBhttps\fR
  7037. in
  7038. \fBhttps://example\&.com/\fR)\&. This field must match exactly between the config key and the URL\&.
  7039. .RE
  7040. .sp
  7041. .RS 4
  7042. .ie n \{\
  7043. \h'-04' 2.\h'+01'\c
  7044. .\}
  7045. .el \{\
  7046. .sp -1
  7047. .IP "  2." 4.2
  7048. .\}
  7049. Host/domain name (e\&.g\&.,
  7050. \fBexample\&.com\fR
  7051. in
  7052. \fBhttps://example\&.com/\fR)\&. This field must match between the config key and the URL\&. It is possible to specify a * as part of the host name to match all subdomains at this level\&.
  7053. \fBhttps://\fR*\&.\fBexample\&.com/\fR
  7054. for example would match
  7055. \fBhttps://foo\&.example\&.com/\fR, but not
  7056. \fBhttps://foo\&.bar\&.example\&.com/\fR\&.
  7057. .RE
  7058. .sp
  7059. .RS 4
  7060. .ie n \{\
  7061. \h'-04' 3.\h'+01'\c
  7062. .\}
  7063. .el \{\
  7064. .sp -1
  7065. .IP "  3." 4.2
  7066. .\}
  7067. Port number (e\&.g\&.,
  7068. \fB8080\fR
  7069. in
  7070. \fBhttp://example\&.com:8080/\fR)\&. This field must match exactly between the config key and the URL\&. Omitted port numbers are automatically converted to the correct default for the scheme before matching\&.
  7071. .RE
  7072. .sp
  7073. .RS 4
  7074. .ie n \{\
  7075. \h'-04' 4.\h'+01'\c
  7076. .\}
  7077. .el \{\
  7078. .sp -1
  7079. .IP "  4." 4.2
  7080. .\}
  7081. Path (e\&.g\&.,
  7082. \fBrepo\&.git\fR
  7083. in
  7084. \fBhttps://example\&.com/repo\&.git\fR)\&. The path field of the config key must match the path field of the URL either exactly or as a prefix of slash\-delimited path elements\&. This means a config key with path
  7085. \fBfoo/\fR
  7086. matches URL path
  7087. \fBfoo/bar\fR\&. A prefix can only match on a slash (\fB/\fR) boundary\&. Longer matches take precedence (so a config key with path
  7088. \fBfoo/bar\fR
  7089. is a better match to URL path
  7090. \fBfoo/bar\fR
  7091. than a config key with just path
  7092. \fBfoo/\fR)\&.
  7093. .RE
  7094. .sp
  7095. .RS 4
  7096. .ie n \{\
  7097. \h'-04' 5.\h'+01'\c
  7098. .\}
  7099. .el \{\
  7100. .sp -1
  7101. .IP "  5." 4.2
  7102. .\}
  7103. User name (e\&.g\&.,
  7104. \fBuser\fR
  7105. in
  7106. \fBhttps://user@example\&.com/repo\&.git\fR)\&. If the config key has a user name it must match the user name in the URL exactly\&. If the config key does not have a user name, that config key will match a URL with any user name (including none), but at a lower precedence than a config key with a user name\&.
  7107. .RE
  7108. .sp
  7109. The list above is ordered by decreasing precedence; a URL that matches a config key\(cqs path is preferred to one that matches its user name\&. For example, if the URL is
  7110. \fBhttps://user@example\&.com/foo/bar\fR
  7111. a config key match of
  7112. \fBhttps://example\&.com/foo\fR
  7113. will be preferred over a config key match of
  7114. \fBhttps://user@example\&.com\fR\&.
  7115. .sp
  7116. All URLs are normalized before attempting any matching (the password part, if embedded in the URL, is always ignored for matching purposes) so that equivalent URLs that are simply spelled differently will match properly\&. Environment variable settings always override any matches\&. The URLs that are matched against are those given directly to Git commands\&. This means any URLs visited as a result of a redirection do not participate in matching\&.
  7117. .RE
  7118. .PP
  7119. i18n\&.commitEncoding
  7120. .RS 4
  7121. Character encoding the commit messages are stored in; Git itself does not care per se, but this information is necessary e\&.g\&. when importing commits from emails or in the gitk graphical history browser (and possibly in other places in the future or in other porcelains)\&. See e\&.g\&.
  7122. \fBgit-mailinfo\fR(1)\&. Defaults to
  7123. \fIutf\-8\fR\&.
  7124. .RE
  7125. .PP
  7126. i18n\&.logOutputEncoding
  7127. .RS 4
  7128. Character encoding the commit messages are converted to when running
  7129. \fIgit log\fR
  7130. and friends\&.
  7131. .RE
  7132. .PP
  7133. imap\&.folder
  7134. .RS 4
  7135. The folder to drop the mails into, which is typically the Drafts folder\&. For example: "INBOX\&.Drafts", "INBOX/Drafts" or "[Gmail]/Drafts"\&. Required\&.
  7136. .RE
  7137. .PP
  7138. imap\&.tunnel
  7139. .RS 4
  7140. Command used to set up a tunnel to the IMAP server through which commands will be piped instead of using a direct network connection to the server\&. Required when imap\&.host is not set\&.
  7141. .RE
  7142. .PP
  7143. imap\&.host
  7144. .RS 4
  7145. A URL identifying the server\&. Use an
  7146. \fBimap://\fR
  7147. prefix for non\-secure connections and an
  7148. \fBimaps://\fR
  7149. prefix for secure connections\&. Ignored when imap\&.tunnel is set, but required otherwise\&.
  7150. .RE
  7151. .PP
  7152. imap\&.user
  7153. .RS 4
  7154. The username to use when logging in to the server\&.
  7155. .RE
  7156. .PP
  7157. imap\&.pass
  7158. .RS 4
  7159. The password to use when logging in to the server\&.
  7160. .RE
  7161. .PP
  7162. imap\&.port
  7163. .RS 4
  7164. An integer port number to connect to on the server\&. Defaults to 143 for imap:// hosts and 993 for imaps:// hosts\&. Ignored when imap\&.tunnel is set\&.
  7165. .RE
  7166. .PP
  7167. imap\&.sslverify
  7168. .RS 4
  7169. A boolean to enable/disable verification of the server certificate used by the SSL/TLS connection\&. Default is
  7170. \fBtrue\fR\&. Ignored when imap\&.tunnel is set\&.
  7171. .RE
  7172. .PP
  7173. imap\&.preformattedHTML
  7174. .RS 4
  7175. A boolean to enable/disable the use of html encoding when sending a patch\&. An html encoded patch will be bracketed with <pre> and have a content type of text/html\&. Ironically, enabling this option causes Thunderbird to send the patch as a plain/text, format=fixed email\&. Default is
  7176. \fBfalse\fR\&.
  7177. .RE
  7178. .PP
  7179. imap\&.authMethod
  7180. .RS 4
  7181. Specify the authentication method for authenticating with the IMAP server\&. If Git was built with the NO_CURL option, or if your curl version is older than 7\&.34\&.0, or if you\(cqre running git\-imap\-send with the
  7182. \fB\-\-no\-curl\fR
  7183. option, the only supported method is
  7184. \fICRAM\-MD5\fR\&. If this is not set then
  7185. \fIgit imap\-send\fR
  7186. uses the basic IMAP plaintext LOGIN command\&.
  7187. .RE
  7188. .PP
  7189. include\&.path, includeIf\&.<condition>\&.path
  7190. .RS 4
  7191. Special variables to include other configuration files\&. See the "CONFIGURATION FILE" section in the main
  7192. \fBgit-config\fR(1)
  7193. documentation, specifically the "Includes" and "Conditional Includes" subsections\&.
  7194. .RE
  7195. .PP
  7196. index\&.recordEndOfIndexEntries
  7197. .RS 4
  7198. Specifies whether the index file should include an "End Of Index Entry" section\&. This reduces index load time on multiprocessor machines but produces a message "ignoring EOIE extension" when reading the index using Git versions before 2\&.20\&. Defaults to
  7199. \fItrue\fR
  7200. if index\&.threads has been explicitly enabled,
  7201. \fIfalse\fR
  7202. otherwise\&.
  7203. .RE
  7204. .PP
  7205. index\&.recordOffsetTable
  7206. .RS 4
  7207. Specifies whether the index file should include an "Index Entry Offset Table" section\&. This reduces index load time on multiprocessor machines but produces a message "ignoring IEOT extension" when reading the index using Git versions before 2\&.20\&. Defaults to
  7208. \fItrue\fR
  7209. if index\&.threads has been explicitly enabled,
  7210. \fIfalse\fR
  7211. otherwise\&.
  7212. .RE
  7213. .PP
  7214. index\&.sparse
  7215. .RS 4
  7216. When enabled, write the index using sparse\-directory entries\&. This has no effect unless
  7217. \fBcore\&.sparseCheckout\fR
  7218. and
  7219. \fBcore\&.sparseCheckoutCone\fR
  7220. are both enabled\&. Defaults to
  7221. \fIfalse\fR\&.
  7222. .RE
  7223. .PP
  7224. index\&.threads
  7225. .RS 4
  7226. Specifies the number of threads to spawn when loading the index\&. This is meant to reduce index load time on multiprocessor machines\&. Specifying 0 or
  7227. \fItrue\fR
  7228. will cause Git to auto\-detect the number of CPUs and set the number of threads accordingly\&. Specifying 1 or
  7229. \fIfalse\fR
  7230. will disable multithreading\&. Defaults to
  7231. \fItrue\fR\&.
  7232. .RE
  7233. .PP
  7234. index\&.version
  7235. .RS 4
  7236. Specify the version with which new index files should be initialized\&. This does not affect existing repositories\&. If
  7237. \fBfeature\&.manyFiles\fR
  7238. is enabled, then the default is 4\&.
  7239. .RE
  7240. .PP
  7241. index\&.skipHash
  7242. .RS 4
  7243. When enabled, do not compute the trailing hash for the index file\&. This accelerates Git commands that manipulate the index, such as
  7244. \fBgit\fR
  7245. \fBadd\fR,
  7246. \fBgit\fR
  7247. \fBcommit\fR, or
  7248. \fBgit\fR
  7249. \fBstatus\fR\&. Instead of storing the checksum, write a trailing set of bytes with value zero, indicating that the computation was skipped\&.
  7250. .sp
  7251. If you enable
  7252. \fBindex\&.skipHash\fR, then Git clients older than 2\&.13\&.0 will refuse to parse the index and Git clients older than 2\&.40\&.0 will report an error during
  7253. \fBgit\fR
  7254. \fBfsck\fR\&.
  7255. .RE
  7256. .PP
  7257. \fBinit\&.templateDir\fR
  7258. .RS 4
  7259. Specify the directory from which templates will be copied\&. (See the "TEMPLATE DIRECTORY" section of
  7260. \fBgit-init\fR(1)\&.)
  7261. .RE
  7262. .PP
  7263. \fBinit\&.defaultBranch\fR
  7264. .RS 4
  7265. Allows overriding the default branch name e\&.g\&. when initializing a new repository\&.
  7266. .RE
  7267. .PP
  7268. \fBinit\&.defaultObjectFormat\fR
  7269. .RS 4
  7270. Allows overriding the default object format for new repositories\&. See
  7271. \fB\-\-object\-format=\fR
  7272. in
  7273. \fBgit-init\fR(1)\&. Both the command line option and the
  7274. \fBGIT_DEFAULT_HASH\fR
  7275. environment variable take precedence over this config\&.
  7276. .RE
  7277. .PP
  7278. \fBinit\&.defaultRefFormat\fR
  7279. .RS 4
  7280. Allows overriding the default ref storage format for new repositories\&. See
  7281. \fB\-\-ref\-format=\fR
  7282. in
  7283. \fBgit-init\fR(1)\&. Both the command line option and the
  7284. \fBGIT_DEFAULT_REF_FORMAT\fR
  7285. environment variable take precedence over this config\&.
  7286. .RE
  7287. .PP
  7288. instaweb\&.browser
  7289. .RS 4
  7290. Specify the program that will be used to browse your working repository in gitweb\&. See
  7291. \fBgit-instaweb\fR(1)\&.
  7292. .RE
  7293. .PP
  7294. instaweb\&.httpd
  7295. .RS 4
  7296. The HTTP daemon command\-line to start gitweb on your working repository\&. See
  7297. \fBgit-instaweb\fR(1)\&.
  7298. .RE
  7299. .PP
  7300. instaweb\&.local
  7301. .RS 4
  7302. If true the web server started by
  7303. \fBgit-instaweb\fR(1)
  7304. will be bound to the local IP (127\&.0\&.0\&.1)\&.
  7305. .RE
  7306. .PP
  7307. instaweb\&.modulePath
  7308. .RS 4
  7309. The default module path for
  7310. \fBgit-instaweb\fR(1)
  7311. to use instead of /usr/lib/apache2/modules\&. Only used if httpd is Apache\&.
  7312. .RE
  7313. .PP
  7314. instaweb\&.port
  7315. .RS 4
  7316. The port number to bind the gitweb httpd to\&. See
  7317. \fBgit-instaweb\fR(1)\&.
  7318. .RE
  7319. .PP
  7320. interactive\&.singleKey
  7321. .RS 4
  7322. When set to true, allow the user to provide one\-letter input with a single key (i\&.e\&., without hitting the Enter key) in interactive commands\&. This is currently used by the
  7323. \fB\-\-patch\fR
  7324. mode of
  7325. \fBgit-add\fR(1),
  7326. \fBgit-checkout\fR(1),
  7327. \fBgit-restore\fR(1),
  7328. \fBgit-commit\fR(1),
  7329. \fBgit-reset\fR(1), and
  7330. \fBgit-stash\fR(1)\&.
  7331. .RE
  7332. .PP
  7333. interactive\&.diffFilter
  7334. .RS 4
  7335. When an interactive command (such as
  7336. \fBgit\fR
  7337. \fBadd\fR
  7338. \fB\-\-patch\fR) shows a colorized diff, git will pipe the diff through the shell command defined by this configuration variable\&. The command may mark up the diff further for human consumption, provided that it retains a one\-to\-one correspondence with the lines in the original diff\&. Defaults to disabled (no filtering)\&.
  7339. .RE
  7340. .PP
  7341. log\&.abbrevCommit
  7342. .RS 4
  7343. If true, makes
  7344. \fBgit-log\fR(1),
  7345. \fBgit-show\fR(1), and
  7346. \fBgit-whatchanged\fR(1)
  7347. assume
  7348. \fB\-\-abbrev\-commit\fR\&. You may override this option with
  7349. \fB\-\-no\-abbrev\-commit\fR\&.
  7350. .RE
  7351. .PP
  7352. log\&.date
  7353. .RS 4
  7354. Set the default date\-time mode for the
  7355. \fIlog\fR
  7356. command\&. Setting a value for log\&.date is similar to using
  7357. \fIgit log\fR\*(Aqs
  7358. \fB\-\-date\fR
  7359. option\&. See
  7360. \fBgit-log\fR(1)
  7361. for details\&.
  7362. .sp
  7363. If the format is set to "auto:foo" and the pager is in use, format "foo" will be used for the date format\&. Otherwise, "default" will be used\&.
  7364. .RE
  7365. .PP
  7366. log\&.decorate
  7367. .RS 4
  7368. Print out the ref names of any commits that are shown by the log command\&. If
  7369. \fIshort\fR
  7370. is specified, the ref name prefixes
  7371. \fIrefs/heads/\fR,
  7372. \fIrefs/tags/\fR
  7373. and
  7374. \fIrefs/remotes/\fR
  7375. will not be printed\&. If
  7376. \fIfull\fR
  7377. is specified, the full ref name (including prefix) will be printed\&. If
  7378. \fIauto\fR
  7379. is specified, then if the output is going to a terminal, the ref names are shown as if
  7380. \fIshort\fR
  7381. were given, otherwise no ref names are shown\&. This is the same as the
  7382. \fB\-\-decorate\fR
  7383. option of the
  7384. \fBgit\fR
  7385. \fBlog\fR\&.
  7386. .RE
  7387. .PP
  7388. log\&.initialDecorationSet
  7389. .RS 4
  7390. By default,
  7391. \fBgit\fR
  7392. \fBlog\fR
  7393. only shows decorations for certain known ref namespaces\&. If
  7394. \fIall\fR
  7395. is specified, then show all refs as decorations\&.
  7396. .RE
  7397. .PP
  7398. log\&.excludeDecoration
  7399. .RS 4
  7400. Exclude the specified patterns from the log decorations\&. This is similar to the
  7401. \fB\-\-decorate\-refs\-exclude\fR
  7402. command\-line option, but the config option can be overridden by the
  7403. \fB\-\-decorate\-refs\fR
  7404. option\&.
  7405. .RE
  7406. .PP
  7407. log\&.diffMerges
  7408. .RS 4
  7409. Set diff format to be used when
  7410. \fB\-\-diff\-merges=on\fR
  7411. is specified, see
  7412. \fB\-\-diff\-merges\fR
  7413. in
  7414. \fBgit-log\fR(1)
  7415. for details\&. Defaults to
  7416. \fBseparate\fR\&.
  7417. .RE
  7418. .PP
  7419. log\&.follow
  7420. .RS 4
  7421. If
  7422. \fBtrue\fR,
  7423. \fBgit\fR
  7424. \fBlog\fR
  7425. will act as if the
  7426. \fB\-\-follow\fR
  7427. option was used when a single <path> is given\&. This has the same limitations as
  7428. \fB\-\-follow\fR, i\&.e\&. it cannot be used to follow multiple files and does not work well on non\-linear history\&.
  7429. .RE
  7430. .PP
  7431. log\&.graphColors
  7432. .RS 4
  7433. A list of colors, separated by commas, that can be used to draw history lines in
  7434. \fBgit\fR
  7435. \fBlog\fR
  7436. \fB\-\-graph\fR\&.
  7437. .RE
  7438. .PP
  7439. log\&.showRoot
  7440. .RS 4
  7441. If true, the initial commit will be shown as a big creation event\&. This is equivalent to a diff against an empty tree\&. Tools like
  7442. \fBgit-log\fR(1)
  7443. or
  7444. \fBgit-whatchanged\fR(1), which normally hide the root commit will now show it\&. True by default\&.
  7445. .RE
  7446. .PP
  7447. log\&.showSignature
  7448. .RS 4
  7449. If true, makes
  7450. \fBgit-log\fR(1),
  7451. \fBgit-show\fR(1), and
  7452. \fBgit-whatchanged\fR(1)
  7453. assume
  7454. \fB\-\-show\-signature\fR\&.
  7455. .RE
  7456. .PP
  7457. log\&.mailmap
  7458. .RS 4
  7459. If true, makes
  7460. \fBgit-log\fR(1),
  7461. \fBgit-show\fR(1), and
  7462. \fBgit-whatchanged\fR(1)
  7463. assume
  7464. \fB\-\-use\-mailmap\fR, otherwise assume
  7465. \fB\-\-no\-use\-mailmap\fR\&. True by default\&.
  7466. .RE
  7467. .PP
  7468. lsrefs\&.unborn
  7469. .RS 4
  7470. May be "advertise" (the default), "allow", or "ignore"\&. If "advertise", the server will respond to the client sending "unborn" (as described in
  7471. \fBgitprotocol-v2\fR(5)) and will advertise support for this feature during the protocol v2 capability advertisement\&. "allow" is the same as "advertise" except that the server will not advertise support for this feature; this is useful for load\-balanced servers that cannot be updated atomically (for example), since the administrator could configure "allow", then after a delay, configure "advertise"\&.
  7472. .RE
  7473. .PP
  7474. mailinfo\&.scissors
  7475. .RS 4
  7476. If true, makes
  7477. \fBgit-mailinfo\fR(1)
  7478. (and therefore
  7479. \fBgit-am\fR(1)) act by default as if the \-\-scissors option was provided on the command\-line\&. When active, this feature removes everything from the message body before a scissors line (i\&.e\&. consisting mainly of ">8", "8<" and "\-")\&.
  7480. .RE
  7481. .PP
  7482. mailmap\&.file
  7483. .RS 4
  7484. The location of an augmenting mailmap file\&. The default mailmap, located in the root of the repository, is loaded first, then the mailmap file pointed to by this variable\&. The location of the mailmap file may be in a repository subdirectory, or somewhere outside of the repository itself\&. See
  7485. \fBgit-shortlog\fR(1)
  7486. and
  7487. \fBgit-blame\fR(1)\&.
  7488. .RE
  7489. .PP
  7490. mailmap\&.blob
  7491. .RS 4
  7492. Like
  7493. \fBmailmap\&.file\fR, but consider the value as a reference to a blob in the repository\&. If both
  7494. \fBmailmap\&.file\fR
  7495. and
  7496. \fBmailmap\&.blob\fR
  7497. are given, both are parsed, with entries from
  7498. \fBmailmap\&.file\fR
  7499. taking precedence\&. In a bare repository, this defaults to
  7500. \fBHEAD:\&.mailmap\fR\&. In a non\-bare repository, it defaults to empty\&.
  7501. .RE
  7502. .PP
  7503. maintenance\&.auto
  7504. .RS 4
  7505. This boolean config option controls whether some commands run
  7506. \fBgit\fR
  7507. \fBmaintenance\fR
  7508. \fBrun\fR
  7509. \fB\-\-auto\fR
  7510. after doing their normal work\&. Defaults to true\&.
  7511. .RE
  7512. .PP
  7513. maintenance\&.autoDetach
  7514. .RS 4
  7515. Many Git commands trigger automatic maintenance after they have written data into the repository\&. This boolean config option controls whether this automatic maintenance shall happen in the foreground or whether the maintenance process shall detach and continue to run in the background\&.
  7516. .sp
  7517. If unset, the value of
  7518. \fBgc\&.autoDetach\fR
  7519. is used as a fallback\&. Defaults to true if both are unset, meaning that the maintenance process will detach\&.
  7520. .RE
  7521. .PP
  7522. maintenance\&.strategy
  7523. .RS 4
  7524. This string config option provides a way to specify one of a few recommended schedules for background maintenance\&. This only affects which tasks are run during
  7525. \fBgit\fR
  7526. \fBmaintenance\fR
  7527. \fBrun\fR
  7528. \fB\-\-schedule=X\fR
  7529. commands, provided no
  7530. \fB\-\-task=\fR\fI<task>\fR
  7531. arguments are provided\&. Further, if a
  7532. \fBmaintenance\&.\fR\fI<task>\fR\fB\&.schedule\fR
  7533. config value is set, then that value is used instead of the one provided by
  7534. \fBmaintenance\&.strategy\fR\&. The possible strategy strings are:
  7535. .sp
  7536. .RS 4
  7537. .ie n \{\
  7538. \h'-04'\(bu\h'+03'\c
  7539. .\}
  7540. .el \{\
  7541. .sp -1
  7542. .IP \(bu 2.3
  7543. .\}
  7544. \fBnone\fR: This default setting implies no tasks are run at any schedule\&.
  7545. .RE
  7546. .sp
  7547. .RS 4
  7548. .ie n \{\
  7549. \h'-04'\(bu\h'+03'\c
  7550. .\}
  7551. .el \{\
  7552. .sp -1
  7553. .IP \(bu 2.3
  7554. .\}
  7555. \fBincremental\fR: This setting optimizes for performing small maintenance activities that do not delete any data\&. This does not schedule the
  7556. \fBgc\fR
  7557. task, but runs the
  7558. \fBprefetch\fR
  7559. and
  7560. \fBcommit\-graph\fR
  7561. tasks hourly, the
  7562. \fBloose\-objects\fR
  7563. and
  7564. \fBincremental\-repack\fR
  7565. tasks daily, and the
  7566. \fBpack\-refs\fR
  7567. task weekly\&.
  7568. .RE
  7569. .RE
  7570. .PP
  7571. maintenance\&.<task>\&.enabled
  7572. .RS 4
  7573. This boolean config option controls whether the maintenance task with name
  7574. \fI<task>\fR
  7575. is run when no
  7576. \fB\-\-task\fR
  7577. option is specified to
  7578. \fBgit\fR
  7579. \fBmaintenance\fR
  7580. \fBrun\fR\&. These config values are ignored if a
  7581. \fB\-\-task\fR
  7582. option exists\&. By default, only
  7583. \fBmaintenance\&.gc\&.enabled\fR
  7584. is true\&.
  7585. .RE
  7586. .PP
  7587. maintenance\&.<task>\&.schedule
  7588. .RS 4
  7589. This config option controls whether or not the given
  7590. \fI<task>\fR
  7591. runs during a
  7592. \fBgit\fR
  7593. \fBmaintenance\fR
  7594. \fBrun\fR
  7595. \fB\-\-schedule=\fR\fI<frequency>\fR
  7596. command\&. The value must be one of "hourly", "daily", or "weekly"\&.
  7597. .RE
  7598. .PP
  7599. maintenance\&.commit\-graph\&.auto
  7600. .RS 4
  7601. This integer config option controls how often the
  7602. \fBcommit\-graph\fR
  7603. task should be run as part of
  7604. \fBgit\fR
  7605. \fBmaintenance\fR
  7606. \fBrun\fR
  7607. \fB\-\-auto\fR\&. If zero, then the
  7608. \fBcommit\-graph\fR
  7609. task will not run with the
  7610. \fB\-\-auto\fR
  7611. option\&. A negative value will force the task to run every time\&. Otherwise, a positive value implies the command should run when the number of reachable commits that are not in the commit\-graph file is at least the value of
  7612. \fBmaintenance\&.commit\-graph\&.auto\fR\&. The default value is 100\&.
  7613. .RE
  7614. .PP
  7615. maintenance\&.loose\-objects\&.auto
  7616. .RS 4
  7617. This integer config option controls how often the
  7618. \fBloose\-objects\fR
  7619. task should be run as part of
  7620. \fBgit\fR
  7621. \fBmaintenance\fR
  7622. \fBrun\fR
  7623. \fB\-\-auto\fR\&. If zero, then the
  7624. \fBloose\-objects\fR
  7625. task will not run with the
  7626. \fB\-\-auto\fR
  7627. option\&. A negative value will force the task to run every time\&. Otherwise, a positive value implies the command should run when the number of loose objects is at least the value of
  7628. \fBmaintenance\&.loose\-objects\&.auto\fR\&. The default value is 100\&.
  7629. .RE
  7630. .PP
  7631. maintenance\&.incremental\-repack\&.auto
  7632. .RS 4
  7633. This integer config option controls how often the
  7634. \fBincremental\-repack\fR
  7635. task should be run as part of
  7636. \fBgit\fR
  7637. \fBmaintenance\fR
  7638. \fBrun\fR
  7639. \fB\-\-auto\fR\&. If zero, then the
  7640. \fBincremental\-repack\fR
  7641. task will not run with the
  7642. \fB\-\-auto\fR
  7643. option\&. A negative value will force the task to run every time\&. Otherwise, a positive value implies the command should run when the number of pack\-files not in the multi\-pack\-index is at least the value of
  7644. \fBmaintenance\&.incremental\-repack\&.auto\fR\&. The default value is 10\&.
  7645. .RE
  7646. .PP
  7647. man\&.viewer
  7648. .RS 4
  7649. Specify the programs that may be used to display help in the
  7650. \fIman\fR
  7651. format\&. See
  7652. \fBgit-help\fR(1)\&.
  7653. .RE
  7654. .PP
  7655. man\&.<tool>\&.cmd
  7656. .RS 4
  7657. Specify the command to invoke the specified man viewer\&. The specified command is evaluated in shell with the man page passed as an argument\&. (See
  7658. \fBgit-help\fR(1)\&.)
  7659. .RE
  7660. .PP
  7661. man\&.<tool>\&.path
  7662. .RS 4
  7663. Override the path for the given tool that may be used to display help in the
  7664. \fIman\fR
  7665. format\&. See
  7666. \fBgit-help\fR(1)\&.
  7667. .RE
  7668. .PP
  7669. merge\&.conflictStyle
  7670. .RS 4
  7671. Specify the style in which conflicted hunks are written out to working tree files upon merge\&. The default is "merge", which shows a <<<<<<< conflict marker, changes made by one side, a
  7672. \fB=======\fR
  7673. marker, changes made by the other side, and then a >>>>>>> marker\&. An alternate style, "diff3", adds a ||||||| marker and the original text before the
  7674. \fB=======\fR
  7675. marker\&. The "merge" style tends to produce smaller conflict regions than diff3, both because of the exclusion of the original text, and because when a subset of lines match on the two sides, they are just pulled out of the conflict region\&. Another alternate style, "zdiff3", is similar to diff3 but removes matching lines on the two sides from the conflict region when those matching lines appear near either the beginning or end of a conflict region\&.
  7676. .RE
  7677. .PP
  7678. merge\&.defaultToUpstream
  7679. .RS 4
  7680. If merge is called without any commit argument, merge the upstream branches configured for the current branch by using their last observed values stored in their remote\-tracking branches\&. The values of the
  7681. \fBbranch\&.\fR<current
  7682. \fBbranch\fR>\fB\&.merge\fR
  7683. that name the branches at the remote named by
  7684. \fBbranch\&.\fR<current
  7685. \fBbranch\fR>\fB\&.remote\fR
  7686. are consulted, and then they are mapped via
  7687. \fBremote\&.\fR\fI<remote>\fR\fB\&.fetch\fR
  7688. to their corresponding remote\-tracking branches, and the tips of these tracking branches are merged\&. Defaults to true\&.
  7689. .RE
  7690. .PP
  7691. merge\&.ff
  7692. .RS 4
  7693. By default, Git does not create an extra merge commit when merging a commit that is a descendant of the current commit\&. Instead, the tip of the current branch is fast\-forwarded\&. When set to
  7694. \fBfalse\fR, this variable tells Git to create an extra merge commit in such a case (equivalent to giving the
  7695. \fB\-\-no\-ff\fR
  7696. option from the command line)\&. When set to
  7697. \fBonly\fR, only such fast\-forward merges are allowed (equivalent to giving the
  7698. \fB\-\-ff\-only\fR
  7699. option from the command line)\&.
  7700. .RE
  7701. .PP
  7702. merge\&.verifySignatures
  7703. .RS 4
  7704. If true, this is equivalent to the \-\-verify\-signatures command line option\&. See
  7705. \fBgit-merge\fR(1)
  7706. for details\&.
  7707. .RE
  7708. .PP
  7709. merge\&.branchdesc
  7710. .RS 4
  7711. In addition to branch names, populate the log message with the branch description text associated with them\&. Defaults to false\&.
  7712. .RE
  7713. .PP
  7714. merge\&.log
  7715. .RS 4
  7716. In addition to branch names, populate the log message with at most the specified number of one\-line descriptions from the actual commits that are being merged\&. Defaults to false, and true is a synonym for 20\&.
  7717. .RE
  7718. .PP
  7719. merge\&.suppressDest
  7720. .RS 4
  7721. By adding a glob that matches the names of integration branches to this multi\-valued configuration variable, the default merge message computed for merges into these integration branches will omit "into <branch name>" from its title\&.
  7722. .sp
  7723. An element with an empty value can be used to clear the list of globs accumulated from previous configuration entries\&. When there is no
  7724. \fBmerge\&.suppressDest\fR
  7725. variable defined, the default value of
  7726. \fBmaster\fR
  7727. is used for backward compatibility\&.
  7728. .RE
  7729. .PP
  7730. merge\&.renameLimit
  7731. .RS 4
  7732. The number of files to consider in the exhaustive portion of rename detection during a merge\&. If not specified, defaults to the value of diff\&.renameLimit\&. If neither merge\&.renameLimit nor diff\&.renameLimit are specified, currently defaults to 7000\&. This setting has no effect if rename detection is turned off\&.
  7733. .RE
  7734. .PP
  7735. merge\&.renames
  7736. .RS 4
  7737. Whether Git detects renames\&. If set to "false", rename detection is disabled\&. If set to "true", basic rename detection is enabled\&. Defaults to the value of diff\&.renames\&.
  7738. .RE
  7739. .PP
  7740. merge\&.directoryRenames
  7741. .RS 4
  7742. Whether Git detects directory renames, affecting what happens at merge time to new files added to a directory on one side of history when that directory was renamed on the other side of history\&. If merge\&.directoryRenames is set to "false", directory rename detection is disabled, meaning that such new files will be left behind in the old directory\&. If set to "true", directory rename detection is enabled, meaning that such new files will be moved into the new directory\&. If set to "conflict", a conflict will be reported for such paths\&. If merge\&.renames is false, merge\&.directoryRenames is ignored and treated as false\&. Defaults to "conflict"\&.
  7743. .RE
  7744. .PP
  7745. merge\&.renormalize
  7746. .RS 4
  7747. Tell Git that canonical representation of files in the repository has changed over time (e\&.g\&. earlier commits record text files with CRLF line endings, but recent ones use LF line endings)\&. In such a repository, for each file where a three\-way content merge is needed, Git can convert the data recorded in commits to a canonical form before performing a merge to reduce unnecessary conflicts\&. For more information, see section "Merging branches with differing checkin/checkout attributes" in
  7748. \fBgitattributes\fR(5)\&.
  7749. .RE
  7750. .PP
  7751. merge\&.stat
  7752. .RS 4
  7753. Whether to print the diffstat between ORIG_HEAD and the merge result at the end of the merge\&. True by default\&.
  7754. .RE
  7755. .PP
  7756. merge\&.autoStash
  7757. .RS 4
  7758. When set to true, automatically create a temporary stash entry before the operation begins, and apply it after the operation ends\&. This means that you can run merge on a dirty worktree\&. However, use with care: the final stash application after a successful merge might result in non\-trivial conflicts\&. This option can be overridden by the
  7759. \fB\-\-no\-autostash\fR
  7760. and
  7761. \fB\-\-autostash\fR
  7762. options of
  7763. \fBgit-merge\fR(1)\&. Defaults to false\&.
  7764. .RE
  7765. .PP
  7766. merge\&.tool
  7767. .RS 4
  7768. Controls which merge tool is used by
  7769. \fBgit-mergetool\fR(1)\&. The list below shows the valid built\-in values\&. Any other value is treated as a custom merge tool and requires that a corresponding mergetool\&.<tool>\&.cmd variable is defined\&.
  7770. .RE
  7771. .PP
  7772. merge\&.guitool
  7773. .RS 4
  7774. Controls which merge tool is used by
  7775. \fBgit-mergetool\fR(1)
  7776. when the \-g/\-\-gui flag is specified\&. The list below shows the valid built\-in values\&. Any other value is treated as a custom merge tool and requires that a corresponding mergetool\&.<guitool>\&.cmd variable is defined\&.
  7777. .PP
  7778. \fBaraxis\fR
  7779. .RS 4
  7780. Use Araxis Merge (requires a graphical session)
  7781. .RE
  7782. .PP
  7783. \fBbc\fR
  7784. .RS 4
  7785. Use Beyond Compare (requires a graphical session)
  7786. .RE
  7787. .PP
  7788. \fBbc3\fR
  7789. .RS 4
  7790. Use Beyond Compare (requires a graphical session)
  7791. .RE
  7792. .PP
  7793. \fBbc4\fR
  7794. .RS 4
  7795. Use Beyond Compare (requires a graphical session)
  7796. .RE
  7797. .PP
  7798. \fBcodecompare\fR
  7799. .RS 4
  7800. Use Code Compare (requires a graphical session)
  7801. .RE
  7802. .PP
  7803. \fBdeltawalker\fR
  7804. .RS 4
  7805. Use DeltaWalker (requires a graphical session)
  7806. .RE
  7807. .PP
  7808. \fBdiffmerge\fR
  7809. .RS 4
  7810. Use DiffMerge (requires a graphical session)
  7811. .RE
  7812. .PP
  7813. \fBdiffuse\fR
  7814. .RS 4
  7815. Use Diffuse (requires a graphical session)
  7816. .RE
  7817. .PP
  7818. \fBecmerge\fR
  7819. .RS 4
  7820. Use ECMerge (requires a graphical session)
  7821. .RE
  7822. .PP
  7823. \fBemerge\fR
  7824. .RS 4
  7825. Use Emacs\*(Aq Emerge
  7826. .RE
  7827. .PP
  7828. \fBexamdiff\fR
  7829. .RS 4
  7830. Use ExamDiff Pro (requires a graphical session)
  7831. .RE
  7832. .PP
  7833. \fBguiffy\fR
  7834. .RS 4
  7835. Use Guiffy\(cqs Diff Tool (requires a graphical session)
  7836. .RE
  7837. .PP
  7838. \fBgvimdiff\fR
  7839. .RS 4
  7840. Use gVim (requires a graphical session) with a custom layout (see
  7841. \fBgit\fR
  7842. \fBhelp\fR
  7843. \fBmergetool\fR\*(Aqs
  7844. \fBBACKEND\fR
  7845. \fBSPECIFIC\fR
  7846. \fBHINTS\fR
  7847. section)
  7848. .RE
  7849. .PP
  7850. \fBgvimdiff1\fR
  7851. .RS 4
  7852. Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
  7853. .RE
  7854. .PP
  7855. \fBgvimdiff2\fR
  7856. .RS 4
  7857. Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
  7858. .RE
  7859. .PP
  7860. \fBgvimdiff3\fR
  7861. .RS 4
  7862. Use gVim (requires a graphical session) where only the MERGED file is shown
  7863. .RE
  7864. .PP
  7865. \fBkdiff3\fR
  7866. .RS 4
  7867. Use KDiff3 (requires a graphical session)
  7868. .RE
  7869. .PP
  7870. \fBmeld\fR
  7871. .RS 4
  7872. Use Meld (requires a graphical session) with optional
  7873. \fBauto\fR
  7874. \fBmerge\fR
  7875. (see
  7876. \fBgit\fR
  7877. \fBhelp\fR
  7878. \fBmergetool\fR\*(Aqs
  7879. \fBCONFIGURATION\fR
  7880. section)
  7881. .RE
  7882. .PP
  7883. \fBnvimdiff\fR
  7884. .RS 4
  7885. Use Neovim with a custom layout (see
  7886. \fBgit\fR
  7887. \fBhelp\fR
  7888. \fBmergetool\fR\*(Aqs
  7889. \fBBACKEND\fR
  7890. \fBSPECIFIC\fR
  7891. \fBHINTS\fR
  7892. section)
  7893. .RE
  7894. .PP
  7895. \fBnvimdiff1\fR
  7896. .RS 4
  7897. Use Neovim with a 2 panes layout (LOCAL and REMOTE)
  7898. .RE
  7899. .PP
  7900. \fBnvimdiff2\fR
  7901. .RS 4
  7902. Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
  7903. .RE
  7904. .PP
  7905. \fBnvimdiff3\fR
  7906. .RS 4
  7907. Use Neovim where only the MERGED file is shown
  7908. .RE
  7909. .PP
  7910. \fBopendiff\fR
  7911. .RS 4
  7912. Use FileMerge (requires a graphical session)
  7913. .RE
  7914. .PP
  7915. \fBp4merge\fR
  7916. .RS 4
  7917. Use HelixCore P4Merge (requires a graphical session)
  7918. .RE
  7919. .PP
  7920. \fBsmerge\fR
  7921. .RS 4
  7922. Use Sublime Merge (requires a graphical session)
  7923. .RE
  7924. .PP
  7925. \fBtkdiff\fR
  7926. .RS 4
  7927. Use TkDiff (requires a graphical session)
  7928. .RE
  7929. .PP
  7930. \fBtortoisemerge\fR
  7931. .RS 4
  7932. Use TortoiseMerge (requires a graphical session)
  7933. .RE
  7934. .PP
  7935. \fBvimdiff\fR
  7936. .RS 4
  7937. Use Vim with a custom layout (see
  7938. \fBgit\fR
  7939. \fBhelp\fR
  7940. \fBmergetool\fR\*(Aqs
  7941. \fBBACKEND\fR
  7942. \fBSPECIFIC\fR
  7943. \fBHINTS\fR
  7944. section)
  7945. .RE
  7946. .PP
  7947. \fBvimdiff1\fR
  7948. .RS 4
  7949. Use Vim with a 2 panes layout (LOCAL and REMOTE)
  7950. .RE
  7951. .PP
  7952. \fBvimdiff2\fR
  7953. .RS 4
  7954. Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
  7955. .RE
  7956. .PP
  7957. \fBvimdiff3\fR
  7958. .RS 4
  7959. Use Vim where only the MERGED file is shown
  7960. .RE
  7961. .PP
  7962. \fBvscode\fR
  7963. .RS 4
  7964. Use Visual Studio Code (requires a graphical session)
  7965. .RE
  7966. .PP
  7967. \fBwinmerge\fR
  7968. .RS 4
  7969. Use WinMerge (requires a graphical session)
  7970. .RE
  7971. .PP
  7972. \fBxxdiff\fR
  7973. .RS 4
  7974. Use xxdiff (requires a graphical session)
  7975. .RE
  7976. .RE
  7977. .PP
  7978. merge\&.verbosity
  7979. .RS 4
  7980. Controls the amount of output shown by the recursive merge strategy\&. Level 0 outputs nothing except a final error message if conflicts were detected\&. Level 1 outputs only conflicts, 2 outputs conflicts and file changes\&. Level 5 and above outputs debugging information\&. The default is level 2\&. Can be overridden by the
  7981. \fBGIT_MERGE_VERBOSITY\fR
  7982. environment variable\&.
  7983. .RE
  7984. .PP
  7985. merge\&.<driver>\&.name
  7986. .RS 4
  7987. Defines a human\-readable name for a custom low\-level merge driver\&. See
  7988. \fBgitattributes\fR(5)
  7989. for details\&.
  7990. .RE
  7991. .PP
  7992. merge\&.<driver>\&.driver
  7993. .RS 4
  7994. Defines the command that implements a custom low\-level merge driver\&. See
  7995. \fBgitattributes\fR(5)
  7996. for details\&.
  7997. .RE
  7998. .PP
  7999. merge\&.<driver>\&.recursive
  8000. .RS 4
  8001. Names a low\-level merge driver to be used when performing an internal merge between common ancestors\&. See
  8002. \fBgitattributes\fR(5)
  8003. for details\&.
  8004. .RE
  8005. .PP
  8006. mergetool\&.<tool>\&.path
  8007. .RS 4
  8008. Override the path for the given tool\&. This is useful in case your tool is not in the PATH\&.
  8009. .RE
  8010. .PP
  8011. mergetool\&.<tool>\&.cmd
  8012. .RS 4
  8013. Specify the command to invoke the specified merge tool\&. The specified command is evaluated in shell with the following variables available:
  8014. \fIBASE\fR
  8015. is the name of a temporary file containing the common base of the files to be merged, if available;
  8016. \fILOCAL\fR
  8017. is the name of a temporary file containing the contents of the file on the current branch;
  8018. \fIREMOTE\fR
  8019. is the name of a temporary file containing the contents of the file from the branch being merged;
  8020. \fIMERGED\fR
  8021. contains the name of the file to which the merge tool should write the results of a successful merge\&.
  8022. .RE
  8023. .PP
  8024. mergetool\&.<tool>\&.hideResolved
  8025. .RS 4
  8026. Allows the user to override the global
  8027. \fBmergetool\&.hideResolved\fR
  8028. value for a specific tool\&. See
  8029. \fBmergetool\&.hideResolved\fR
  8030. for the full description\&.
  8031. .RE
  8032. .PP
  8033. mergetool\&.<tool>\&.trustExitCode
  8034. .RS 4
  8035. For a custom merge command, specify whether the exit code of the merge command can be used to determine whether the merge was successful\&. If this is not set to true then the merge target file timestamp is checked, and the merge is assumed to have been successful if the file has been updated; otherwise, the user is prompted to indicate the success of the merge\&.
  8036. .RE
  8037. .PP
  8038. mergetool\&.meld\&.hasOutput
  8039. .RS 4
  8040. Older versions of
  8041. \fBmeld\fR
  8042. do not support the
  8043. \fB\-\-output\fR
  8044. option\&. Git will attempt to detect whether
  8045. \fBmeld\fR
  8046. supports
  8047. \fB\-\-output\fR
  8048. by inspecting the output of
  8049. \fBmeld\fR
  8050. \fB\-\-help\fR\&. Configuring
  8051. \fBmergetool\&.meld\&.hasOutput\fR
  8052. will make Git skip these checks and use the configured value instead\&. Setting
  8053. \fBmergetool\&.meld\&.hasOutput\fR
  8054. to
  8055. \fBtrue\fR
  8056. tells Git to unconditionally use the
  8057. \fB\-\-output\fR
  8058. option, and
  8059. \fBfalse\fR
  8060. avoids using
  8061. \fB\-\-output\fR\&.
  8062. .RE
  8063. .PP
  8064. mergetool\&.meld\&.useAutoMerge
  8065. .RS 4
  8066. When the
  8067. \fB\-\-auto\-merge\fR
  8068. is given, meld will merge all non\-conflicting parts automatically, highlight the conflicting parts, and wait for user decision\&. Setting
  8069. \fBmergetool\&.meld\&.useAutoMerge\fR
  8070. to
  8071. \fBtrue\fR
  8072. tells Git to unconditionally use the
  8073. \fB\-\-auto\-merge\fR
  8074. option with
  8075. \fBmeld\fR\&. Setting this value to
  8076. \fBauto\fR
  8077. makes git detect whether
  8078. \fB\-\-auto\-merge\fR
  8079. is supported and will only use
  8080. \fB\-\-auto\-merge\fR
  8081. when available\&. A value of
  8082. \fBfalse\fR
  8083. avoids using
  8084. \fB\-\-auto\-merge\fR
  8085. altogether, and is the default value\&.
  8086. .RE
  8087. .PP
  8088. mergetool\&.<vimdiff variant>\&.layout
  8089. .RS 4
  8090. Configure the split window layout for vimdiff\(cqs
  8091. \fI<variant>\fR, which is any of
  8092. \fBvimdiff\fR,
  8093. \fBnvimdiff\fR,
  8094. \fBgvimdiff\fR\&. Upon launching
  8095. \fBgit\fR
  8096. \fBmergetool\fR
  8097. with
  8098. \fB\-\-tool=\fR\fI<variant>\fR
  8099. (or without
  8100. \fB\-\-tool\fR
  8101. if
  8102. \fBmerge\&.tool\fR
  8103. is configured as
  8104. \fI<variant>\fR), Git will consult
  8105. \fBmergetool\&.\fR\fI<variant>\fR\fB\&.layout\fR
  8106. to determine the tool\(cqs layout\&. If the variant\-specific configuration is not available,
  8107. \fBvimdiff\fR\*(Aqs is used as fallback\&. If that too is not available, a default layout with 4 windows will be used\&. To configure the layout, see the
  8108. \fBBACKEND\fR
  8109. \fBSPECIFIC\fR
  8110. \fBHINTS\fR
  8111. section in
  8112. \fBgit-mergetool\fR(1)\&.
  8113. .RE
  8114. .PP
  8115. mergetool\&.hideResolved
  8116. .RS 4
  8117. During a merge, Git will automatically resolve as many conflicts as possible and write the
  8118. \fIMERGED\fR
  8119. file containing conflict markers around any conflicts that it cannot resolve;
  8120. \fILOCAL\fR
  8121. and
  8122. \fIREMOTE\fR
  8123. normally represent the versions of the file from before Git\(cqs conflict resolution\&. This flag causes
  8124. \fILOCAL\fR
  8125. and
  8126. \fIREMOTE\fR
  8127. to be overwritten so that only the unresolved conflicts are presented to the merge tool\&. Can be configured per\-tool via the
  8128. \fBmergetool\&.\fR\fI<tool>\fR\fB\&.hideResolved\fR
  8129. configuration variable\&. Defaults to
  8130. \fBfalse\fR\&.
  8131. .RE
  8132. .PP
  8133. mergetool\&.keepBackup
  8134. .RS 4
  8135. After performing a merge, the original file with conflict markers can be saved as a file with a \&.\fBorig\fR
  8136. extension\&. If this variable is set to
  8137. \fBfalse\fR
  8138. then this file is not preserved\&. Defaults to
  8139. \fBtrue\fR
  8140. (i\&.e\&. keep the backup files)\&.
  8141. .RE
  8142. .PP
  8143. mergetool\&.keepTemporaries
  8144. .RS 4
  8145. When invoking a custom merge tool, Git uses a set of temporary files to pass to the tool\&. If the tool returns an error and this variable is set to
  8146. \fBtrue\fR, then these temporary files will be preserved; otherwise, they will be removed after the tool has exited\&. Defaults to
  8147. \fBfalse\fR\&.
  8148. .RE
  8149. .PP
  8150. mergetool\&.writeToTemp
  8151. .RS 4
  8152. Git writes temporary
  8153. \fIBASE\fR,
  8154. \fILOCAL\fR, and
  8155. \fIREMOTE\fR
  8156. versions of conflicting files in the worktree by default\&. Git will attempt to use a temporary directory for these files when set
  8157. \fBtrue\fR\&. Defaults to
  8158. \fBfalse\fR\&.
  8159. .RE
  8160. .PP
  8161. mergetool\&.prompt
  8162. .RS 4
  8163. Prompt before each invocation of the merge resolution program\&.
  8164. .RE
  8165. .PP
  8166. mergetool\&.guiDefault
  8167. .RS 4
  8168. Set
  8169. \fBtrue\fR
  8170. to use the
  8171. \fBmerge\&.guitool\fR
  8172. by default (equivalent to specifying the
  8173. \fB\-\-gui\fR
  8174. argument), or
  8175. \fBauto\fR
  8176. to select
  8177. \fBmerge\&.guitool\fR
  8178. or
  8179. \fBmerge\&.tool\fR
  8180. depending on the presence of a
  8181. \fBDISPLAY\fR
  8182. environment variable value\&. The default is
  8183. \fBfalse\fR, where the
  8184. \fB\-\-gui\fR
  8185. argument must be provided explicitly for the
  8186. \fBmerge\&.guitool\fR
  8187. to be used\&.
  8188. .RE
  8189. .PP
  8190. \fBnotes\&.mergeStrategy\fR
  8191. .RS 4
  8192. Which merge strategy to choose by default when resolving notes conflicts\&. Must be one of
  8193. \fBmanual\fR,
  8194. \fBours\fR,
  8195. \fBtheirs\fR,
  8196. \fBunion\fR, or
  8197. \fBcat_sort_uniq\fR\&. Defaults to
  8198. \fBmanual\fR\&. See the "NOTES MERGE STRATEGIES" section of
  8199. \fBgit-notes\fR(1)
  8200. for more information on each strategy\&.
  8201. .sp
  8202. This setting can be overridden by passing the
  8203. \fB\-\-strategy\fR
  8204. option to
  8205. \fBgit-notes\fR(1)\&.
  8206. .RE
  8207. .PP
  8208. \fBnotes\&.\fR\fI<name>\fR\fB\&.mergeStrategy\fR
  8209. .RS 4
  8210. Which merge strategy to choose when doing a notes merge into
  8211. \fBrefs/notes/\fR\fI<name>\fR\&. This overrides the more general
  8212. \fBnotes\&.mergeStrategy\fR\&. See the "NOTES MERGE STRATEGIES" section in
  8213. \fBgit-notes\fR(1)
  8214. for more information on the available strategies\&.
  8215. .RE
  8216. .PP
  8217. \fBnotes\&.displayRef\fR
  8218. .RS 4
  8219. Which ref (or refs, if a glob or specified more than once), in addition to the default set by
  8220. \fBcore\&.notesRef\fR
  8221. or
  8222. \fBGIT_NOTES_REF\fR, to read notes from when showing commit messages with the
  8223. \fBgit\fR
  8224. \fBlog\fR
  8225. family of commands\&.
  8226. .sp
  8227. This setting can be overridden with the
  8228. \fBGIT_NOTES_DISPLAY_REF\fR
  8229. environment variable, which must be a colon separated list of refs or globs\&.
  8230. .sp
  8231. A warning will be issued for refs that do not exist, but a glob that does not match any refs is silently ignored\&.
  8232. .sp
  8233. This setting can be disabled by the
  8234. \fB\-\-no\-notes\fR
  8235. option to the
  8236. \fBgit-log\fR(1)
  8237. family of commands, or by the
  8238. \fB\-\-notes=\fR\fI<ref>\fR
  8239. option accepted by those commands\&.
  8240. .sp
  8241. The effective value of
  8242. \fBcore\&.notesRef\fR
  8243. (possibly overridden by
  8244. \fBGIT_NOTES_REF\fR) is also implicitly added to the list of refs to be displayed\&.
  8245. .RE
  8246. .PP
  8247. \fBnotes\&.rewrite\&.\fR\fI<command>\fR
  8248. .RS 4
  8249. When rewriting commits with
  8250. \fI<command>\fR
  8251. (currently
  8252. \fBamend\fR
  8253. or
  8254. \fBrebase\fR), if this variable is
  8255. \fBfalse\fR, git will not copy notes from the original to the rewritten commit\&. Defaults to
  8256. \fBtrue\fR\&. See also
  8257. \fBnotes\&.rewriteRef\fR
  8258. below\&.
  8259. .sp
  8260. This setting can be overridden with the
  8261. \fBGIT_NOTES_REWRITE_REF\fR
  8262. environment variable, which must be a colon separated list of refs or globs\&.
  8263. .RE
  8264. .PP
  8265. \fBnotes\&.rewriteMode\fR
  8266. .RS 4
  8267. When copying notes during a rewrite (see the
  8268. \fBnotes\&.rewrite\&.\fR\fI<command>\fR
  8269. option), determines what to do if the target commit already has a note\&. Must be one of
  8270. \fBoverwrite\fR,
  8271. \fBconcatenate\fR,
  8272. \fBcat_sort_uniq\fR, or
  8273. \fBignore\fR\&. Defaults to
  8274. \fBconcatenate\fR\&.
  8275. .sp
  8276. This setting can be overridden with the
  8277. \fBGIT_NOTES_REWRITE_MODE\fR
  8278. environment variable\&.
  8279. .RE
  8280. .PP
  8281. \fBnotes\&.rewriteRef\fR
  8282. .RS 4
  8283. When copying notes during a rewrite, specifies the (fully qualified) ref whose notes should be copied\&. May be a glob, in which case notes in all matching refs will be copied\&. You may also specify this configuration several times\&.
  8284. .sp
  8285. Does not have a default value; you must configure this variable to enable note rewriting\&. Set it to
  8286. \fBrefs/notes/commits\fR
  8287. to enable rewriting for the default commit notes\&.
  8288. .sp
  8289. Can be overridden with the
  8290. \fBGIT_NOTES_REWRITE_REF\fR
  8291. environment variable\&. See
  8292. \fBnotes\&.rewrite\&.\fR\fI<command>\fR
  8293. above for a further description of its format\&.
  8294. .RE
  8295. .PP
  8296. pack\&.window
  8297. .RS 4
  8298. The size of the window used by
  8299. \fBgit-pack-objects\fR(1)
  8300. when no window size is given on the command line\&. Defaults to 10\&.
  8301. .RE
  8302. .PP
  8303. pack\&.depth
  8304. .RS 4
  8305. The maximum delta depth used by
  8306. \fBgit-pack-objects\fR(1)
  8307. when no maximum depth is given on the command line\&. Defaults to 50\&. Maximum value is 4095\&.
  8308. .RE
  8309. .PP
  8310. pack\&.windowMemory
  8311. .RS 4
  8312. The maximum size of memory that is consumed by each thread in
  8313. \fBgit-pack-objects\fR(1)
  8314. for pack window memory when no limit is given on the command line\&. The value can be suffixed with "k", "m", or "g"\&. When left unconfigured (or set explicitly to 0), there will be no limit\&.
  8315. .RE
  8316. .PP
  8317. pack\&.compression
  8318. .RS 4
  8319. An integer \-1\&.\&.9, indicating the compression level for objects in a pack file\&. \-1 is the zlib default\&. 0 means no compression, and 1\&.\&.9 are various speed/size tradeoffs, 9 being slowest\&. If not set, defaults to core\&.compression\&. If that is not set, defaults to \-1, the zlib default, which is "a default compromise between speed and compression (currently equivalent to level 6)\&."
  8320. .sp
  8321. Note that changing the compression level will not automatically recompress all existing objects\&. You can force recompression by passing the \-F option to
  8322. \fBgit-repack\fR(1)\&.
  8323. .RE
  8324. .PP
  8325. pack\&.allowPackReuse
  8326. .RS 4
  8327. When true or "single", and when reachability bitmaps are enabled, pack\-objects will try to send parts of the bitmapped packfile verbatim\&. When "multi", and when a multi\-pack reachability bitmap is available, pack\-objects will try to send parts of all packs in the MIDX\&.
  8328. .sp
  8329. If only a single pack bitmap is available, and
  8330. \fBpack\&.allowPackReuse\fR
  8331. is set to "multi", reuse parts of just the bitmapped packfile\&. This can reduce memory and CPU usage to serve fetches, but might result in sending a slightly larger pack\&. Defaults to true\&.
  8332. .RE
  8333. .PP
  8334. pack\&.island
  8335. .RS 4
  8336. An extended regular expression configuring a set of delta islands\&. See "DELTA ISLANDS" in
  8337. \fBgit-pack-objects\fR(1)
  8338. for details\&.
  8339. .RE
  8340. .PP
  8341. pack\&.islandCore
  8342. .RS 4
  8343. Specify an island name which gets to have its objects be packed first\&. This creates a kind of pseudo\-pack at the front of one pack, so that the objects from the specified island are hopefully faster to copy into any pack that should be served to a user requesting these objects\&. In practice this means that the island specified should likely correspond to what is the most commonly cloned in the repo\&. See also "DELTA ISLANDS" in
  8344. \fBgit-pack-objects\fR(1)\&.
  8345. .RE
  8346. .PP
  8347. pack\&.deltaCacheSize
  8348. .RS 4
  8349. The maximum memory in bytes used for caching deltas in
  8350. \fBgit-pack-objects\fR(1)
  8351. before writing them out to a pack\&. This cache is used to speed up the writing object phase by not having to recompute the final delta result once the best match for all objects is found\&. Repacking large repositories on machines which are tight with memory might be badly impacted by this though, especially if this cache pushes the system into swapping\&. A value of 0 means no limit\&. The smallest size of 1 byte may be used to virtually disable this cache\&. Defaults to 256 MiB\&.
  8352. .RE
  8353. .PP
  8354. pack\&.deltaCacheLimit
  8355. .RS 4
  8356. The maximum size of a delta, that is cached in
  8357. \fBgit-pack-objects\fR(1)\&. This cache is used to speed up the writing object phase by not having to recompute the final delta result once the best match for all objects is found\&. Defaults to 1000\&. Maximum value is 65535\&.
  8358. .RE
  8359. .PP
  8360. pack\&.threads
  8361. .RS 4
  8362. Specifies the number of threads to spawn when searching for best delta matches\&. This requires that
  8363. \fBgit-pack-objects\fR(1)
  8364. be compiled with pthreads otherwise this option is ignored with a warning\&. This is meant to reduce packing time on multiprocessor machines\&. The required amount of memory for the delta search window is however multiplied by the number of threads\&. Specifying 0 will cause Git to auto\-detect the number of CPUs and set the number of threads accordingly\&.
  8365. .RE
  8366. .PP
  8367. pack\&.indexVersion
  8368. .RS 4
  8369. Specify the default pack index version\&. Valid values are 1 for legacy pack index used by Git versions prior to 1\&.5\&.2, and 2 for the new pack index with capabilities for packs larger than 4 GB as well as proper protection against the repacking of corrupted packs\&. Version 2 is the default\&. Note that version 2 is enforced and this config option is ignored whenever the corresponding pack is larger than 2 GB\&.
  8370. .sp
  8371. If you have an old Git that does not understand the version 2 *\&.\fBidx\fR
  8372. file, cloning or fetching over a non\-native protocol (e\&.g\&. "http") that will copy both *\&.\fBpack\fR
  8373. file and corresponding *\&.\fBidx\fR
  8374. file from the other side may give you a repository that cannot be accessed with your older version of Git\&. If the *\&.\fBpack\fR
  8375. file is smaller than 2 GB, however, you can use
  8376. \fBgit-index-pack\fR(1)
  8377. on the *\&.pack file to regenerate the *\&.\fBidx\fR
  8378. file\&.
  8379. .RE
  8380. .PP
  8381. pack\&.packSizeLimit
  8382. .RS 4
  8383. The maximum size of a pack\&. This setting only affects packing to a file when repacking, i\&.e\&. the git:// protocol is unaffected\&. It can be overridden by the
  8384. \fB\-\-max\-pack\-size\fR
  8385. option of
  8386. \fBgit-repack\fR(1)\&. Reaching this limit results in the creation of multiple packfiles\&.
  8387. .sp
  8388. Note that this option is rarely useful, and may result in a larger total on\-disk size (because Git will not store deltas between packs) and worse runtime performance (object lookup within multiple packs is slower than a single pack, and optimizations like reachability bitmaps cannot cope with multiple packs)\&.
  8389. .sp
  8390. If you need to actively run Git using smaller packfiles (e\&.g\&., because your filesystem does not support large files), this option may help\&. But if your goal is to transmit a packfile over a medium that supports limited sizes (e\&.g\&., removable media that cannot store the whole repository), you are likely better off creating a single large packfile and splitting it using a generic multi\-volume archive tool (e\&.g\&., Unix
  8391. \fBsplit\fR)\&.
  8392. .sp
  8393. The minimum size allowed is limited to 1 MiB\&. The default is unlimited\&. Common unit suffixes of
  8394. \fIk\fR,
  8395. \fIm\fR, or
  8396. \fIg\fR
  8397. are supported\&.
  8398. .RE
  8399. .PP
  8400. pack\&.useBitmaps
  8401. .RS 4
  8402. When true, git will use pack bitmaps (if available) when packing to stdout (e\&.g\&., during the server side of a fetch)\&. Defaults to true\&. You should not generally need to turn this off unless you are debugging pack bitmaps\&.
  8403. .RE
  8404. .PP
  8405. pack\&.useBitmapBoundaryTraversal
  8406. .RS 4
  8407. When true, Git will use an experimental algorithm for computing reachability queries with bitmaps\&. Instead of building up complete bitmaps for all of the negated tips and then OR\-ing them together, consider negated tips with existing bitmaps as additive (i\&.e\&. OR\-ing them into the result if they exist, ignoring them otherwise), and build up a bitmap at the boundary instead\&.
  8408. .sp
  8409. When using this algorithm, Git may include too many objects as a result of not opening up trees belonging to certain UNINTERESTING commits\&. This inexactness matches the non\-bitmap traversal algorithm\&.
  8410. .sp
  8411. In many cases, this can provide a speed\-up over the exact algorithm, particularly when there is poor bitmap coverage of the negated side of the query\&.
  8412. .RE
  8413. .PP
  8414. pack\&.useSparse
  8415. .RS 4
  8416. When true, git will default to using the
  8417. \fI\-\-sparse\fR
  8418. option in
  8419. \fIgit pack\-objects\fR
  8420. when the
  8421. \fI\-\-revs\fR
  8422. option is present\&. This algorithm only walks trees that appear in paths that introduce new objects\&. This can have significant performance benefits when computing a pack to send a small change\&. However, it is possible that extra objects are added to the pack\-file if the included commits contain certain types of direct renames\&. Default is
  8423. \fBtrue\fR\&.
  8424. .RE
  8425. .PP
  8426. pack\&.preferBitmapTips
  8427. .RS 4
  8428. When selecting which commits will receive bitmaps, prefer a commit at the tip of any reference that is a suffix of any value of this configuration over any other commits in the "selection window"\&.
  8429. .sp
  8430. Note that setting this configuration to
  8431. \fBrefs/foo\fR
  8432. does not mean that the commits at the tips of
  8433. \fBrefs/foo/bar\fR
  8434. and
  8435. \fBrefs/foo/baz\fR
  8436. will necessarily be selected\&. This is because commits are selected for bitmaps from within a series of windows of variable length\&.
  8437. .sp
  8438. If a commit at the tip of any reference which is a suffix of any value of this configuration is seen in a window, it is immediately given preference over any other commit in that window\&.
  8439. .RE
  8440. .PP
  8441. pack\&.writeBitmaps (deprecated)
  8442. .RS 4
  8443. This is a deprecated synonym for
  8444. \fBrepack\&.writeBitmaps\fR\&.
  8445. .RE
  8446. .PP
  8447. pack\&.writeBitmapHashCache
  8448. .RS 4
  8449. When true, git will include a "hash cache" section in the bitmap index (if one is written)\&. This cache can be used to feed git\(cqs delta heuristics, potentially leading to better deltas between bitmapped and non\-bitmapped objects (e\&.g\&., when serving a fetch between an older, bitmapped pack and objects that have been pushed since the last gc)\&. The downside is that it consumes 4 bytes per object of disk space\&. Defaults to true\&.
  8450. .sp
  8451. When writing a multi\-pack reachability bitmap, no new namehashes are computed; instead, any namehashes stored in an existing bitmap are permuted into their appropriate location when writing a new bitmap\&.
  8452. .RE
  8453. .PP
  8454. pack\&.writeBitmapLookupTable
  8455. .RS 4
  8456. When true, Git will include a "lookup table" section in the bitmap index (if one is written)\&. This table is used to defer loading individual bitmaps as late as possible\&. This can be beneficial in repositories that have relatively large bitmap indexes\&. Defaults to false\&.
  8457. .RE
  8458. .PP
  8459. pack\&.readReverseIndex
  8460. .RS 4
  8461. When true, git will read any \&.rev file(s) that may be available (see:
  8462. \fBgitformat-pack\fR(5))\&. When false, the reverse index will be generated from scratch and stored in memory\&. Defaults to true\&.
  8463. .RE
  8464. .PP
  8465. pack\&.writeReverseIndex
  8466. .RS 4
  8467. When true, git will write a corresponding \&.rev file (see:
  8468. \fBgitformat-pack\fR(5)) for each new packfile that it writes in all places except for
  8469. \fBgit-fast-import\fR(1)
  8470. and in the bulk checkin mechanism\&. Defaults to true\&.
  8471. .RE
  8472. .PP
  8473. pager\&.<cmd>
  8474. .RS 4
  8475. If the value is boolean, turns on or off pagination of the output of a particular Git subcommand when writing to a tty\&. Otherwise, turns on pagination for the subcommand using the pager specified by the value of
  8476. \fBpager\&.\fR\fI<cmd>\fR\&. If
  8477. \fB\-\-paginate\fR
  8478. or
  8479. \fB\-\-no\-pager\fR
  8480. is specified on the command line, it takes precedence over this option\&. To disable pagination for all commands, set
  8481. \fBcore\&.pager\fR
  8482. or
  8483. \fBGIT_PAGER\fR
  8484. to
  8485. \fBcat\fR\&.
  8486. .RE
  8487. .PP
  8488. pretty\&.<name>
  8489. .RS 4
  8490. Alias for a \-\-pretty= format string, as specified in
  8491. \fBgit-log\fR(1)\&. Any aliases defined here can be used just as the built\-in pretty formats could\&. For example, running
  8492. \fBgit\fR
  8493. \fBconfig\fR
  8494. \fBpretty\&.changelog\fR
  8495. "format:* %H %s" would cause the invocation
  8496. \fBgit\fR
  8497. \fBlog\fR
  8498. \fB\-\-pretty=changelog\fR
  8499. to be equivalent to running
  8500. \fBgit\fR
  8501. \fBlog\fR
  8502. "\-\-pretty=format:* %H %s"\&. Note that an alias with the same name as a built\-in format will be silently ignored\&.
  8503. .RE
  8504. .PP
  8505. promisor\&.quiet
  8506. .RS 4
  8507. If set to "true" assume
  8508. \fB\-\-quiet\fR
  8509. when fetching additional objects for a partial clone\&.
  8510. .RE
  8511. .PP
  8512. promisor\&.advertise
  8513. .RS 4
  8514. If set to "true", a server will use the "promisor\-remote" capability, see
  8515. \fBgitprotocol-v2\fR(5), to advertise the promisor remotes it is using, if it uses some\&. Default is "false", which means the "promisor\-remote" capability is not advertised\&.
  8516. .RE
  8517. .PP
  8518. promisor\&.acceptFromServer
  8519. .RS 4
  8520. If set to "all", a client will accept all the promisor remotes a server might advertise using the "promisor\-remote" capability\&. If set to "knownName" the client will accept promisor remotes which are already configured on the client and have the same name as those advertised by the client\&. This is not very secure, but could be used in a corporate setup where servers and clients are trusted to not switch name and URLs\&. If set to "knownUrl", the client will accept promisor remotes which have both the same name and the same URL configured on the client as the name and URL advertised by the server\&. This is more secure than "all" or "knownName", so it should be used if possible instead of those options\&. Default is "none", which means no promisor remote advertised by a server will be accepted\&. By accepting a promisor remote, the client agrees that the server might omit objects that are lazily fetchable from this promisor remote from its responses to "fetch" and "clone" requests from the client\&. See
  8521. \fBgitprotocol-v2\fR(5)\&.
  8522. .RE
  8523. .PP
  8524. protocol\&.allow
  8525. .RS 4
  8526. If set, provide a user defined default policy for all protocols which don\(cqt explicitly have a policy (\fBprotocol\&.\fR\fI<name>\fR\fB\&.allow\fR)\&. By default, if unset, known\-safe protocols (http, https, git, ssh) have a default policy of
  8527. \fBalways\fR, known\-dangerous protocols (ext) have a default policy of
  8528. \fBnever\fR, and all other protocols (including file) have a default policy of
  8529. \fBuser\fR\&. Supported policies:
  8530. .sp
  8531. .RS 4
  8532. .ie n \{\
  8533. \h'-04'\(bu\h'+03'\c
  8534. .\}
  8535. .el \{\
  8536. .sp -1
  8537. .IP \(bu 2.3
  8538. .\}
  8539. \fBalways\fR
  8540. \- protocol is always able to be used\&.
  8541. .RE
  8542. .sp
  8543. .RS 4
  8544. .ie n \{\
  8545. \h'-04'\(bu\h'+03'\c
  8546. .\}
  8547. .el \{\
  8548. .sp -1
  8549. .IP \(bu 2.3
  8550. .\}
  8551. \fBnever\fR
  8552. \- protocol is never able to be used\&.
  8553. .RE
  8554. .sp
  8555. .RS 4
  8556. .ie n \{\
  8557. \h'-04'\(bu\h'+03'\c
  8558. .\}
  8559. .el \{\
  8560. .sp -1
  8561. .IP \(bu 2.3
  8562. .\}
  8563. \fBuser\fR
  8564. \- protocol is only able to be used when
  8565. \fBGIT_PROTOCOL_FROM_USER\fR
  8566. is either unset or has a value of 1\&. This policy should be used when you want a protocol to be directly usable by the user but don\(cqt want it used by commands which execute clone/fetch/push commands without user input, e\&.g\&. recursive submodule initialization\&.
  8567. .RE
  8568. .RE
  8569. .PP
  8570. protocol\&.<name>\&.allow
  8571. .RS 4
  8572. Set a policy to be used by protocol
  8573. \fI<name>\fR
  8574. with clone/fetch/push commands\&. See
  8575. \fBprotocol\&.allow\fR
  8576. above for the available policies\&.
  8577. .sp
  8578. The protocol names currently used by git are:
  8579. .sp
  8580. .RS 4
  8581. .ie n \{\
  8582. \h'-04'\(bu\h'+03'\c
  8583. .\}
  8584. .el \{\
  8585. .sp -1
  8586. .IP \(bu 2.3
  8587. .\}
  8588. \fBfile\fR: any local file\-based path (including
  8589. \fBfile://\fR
  8590. URLs, or local paths)
  8591. .RE
  8592. .sp
  8593. .RS 4
  8594. .ie n \{\
  8595. \h'-04'\(bu\h'+03'\c
  8596. .\}
  8597. .el \{\
  8598. .sp -1
  8599. .IP \(bu 2.3
  8600. .\}
  8601. \fBgit\fR: the anonymous git protocol over a direct TCP connection (or proxy, if configured)
  8602. .RE
  8603. .sp
  8604. .RS 4
  8605. .ie n \{\
  8606. \h'-04'\(bu\h'+03'\c
  8607. .\}
  8608. .el \{\
  8609. .sp -1
  8610. .IP \(bu 2.3
  8611. .\}
  8612. \fBssh\fR: git over ssh (including
  8613. \fBhost:path\fR
  8614. syntax,
  8615. \fBssh://\fR, etc)\&.
  8616. .RE
  8617. .sp
  8618. .RS 4
  8619. .ie n \{\
  8620. \h'-04'\(bu\h'+03'\c
  8621. .\}
  8622. .el \{\
  8623. .sp -1
  8624. .IP \(bu 2.3
  8625. .\}
  8626. \fBhttp\fR: git over http, both "smart http" and "dumb http"\&. Note that this does
  8627. \fInot\fR
  8628. include
  8629. \fBhttps\fR; if you want to configure both, you must do so individually\&.
  8630. .RE
  8631. .sp
  8632. .RS 4
  8633. .ie n \{\
  8634. \h'-04'\(bu\h'+03'\c
  8635. .\}
  8636. .el \{\
  8637. .sp -1
  8638. .IP \(bu 2.3
  8639. .\}
  8640. any external helpers are named by their protocol (e\&.g\&., use
  8641. \fBhg\fR
  8642. to allow the
  8643. \fBgit\-remote\-hg\fR
  8644. helper)
  8645. .RE
  8646. .RE
  8647. .PP
  8648. protocol\&.version
  8649. .RS 4
  8650. If set, clients will attempt to communicate with a server using the specified protocol version\&. If the server does not support it, communication falls back to version 0\&. If unset, the default is
  8651. \fB2\fR\&. Supported versions:
  8652. .sp
  8653. .RS 4
  8654. .ie n \{\
  8655. \h'-04'\(bu\h'+03'\c
  8656. .\}
  8657. .el \{\
  8658. .sp -1
  8659. .IP \(bu 2.3
  8660. .\}
  8661. \fB0\fR
  8662. \- the original wire protocol\&.
  8663. .RE
  8664. .sp
  8665. .RS 4
  8666. .ie n \{\
  8667. \h'-04'\(bu\h'+03'\c
  8668. .\}
  8669. .el \{\
  8670. .sp -1
  8671. .IP \(bu 2.3
  8672. .\}
  8673. \fB1\fR
  8674. \- the original wire protocol with the addition of a version string in the initial response from the server\&.
  8675. .RE
  8676. .sp
  8677. .RS 4
  8678. .ie n \{\
  8679. \h'-04'\(bu\h'+03'\c
  8680. .\}
  8681. .el \{\
  8682. .sp -1
  8683. .IP \(bu 2.3
  8684. .\}
  8685. \fB2\fR
  8686. \- Wire protocol version 2, see
  8687. \fBgitprotocol-v2\fR(5)\&.
  8688. .RE
  8689. .RE
  8690. .PP
  8691. pull\&.ff
  8692. .RS 4
  8693. By default, Git does not create an extra merge commit when merging a commit that is a descendant of the current commit\&. Instead, the tip of the current branch is fast\-forwarded\&. When set to
  8694. \fBfalse\fR, this variable tells Git to create an extra merge commit in such a case (equivalent to giving the
  8695. \fB\-\-no\-ff\fR
  8696. option from the command line)\&. When set to
  8697. \fBonly\fR, only such fast\-forward merges are allowed (equivalent to giving the
  8698. \fB\-\-ff\-only\fR
  8699. option from the command line)\&. This setting overrides
  8700. \fBmerge\&.ff\fR
  8701. when pulling\&.
  8702. .RE
  8703. .PP
  8704. pull\&.rebase
  8705. .RS 4
  8706. When true, rebase branches on top of the fetched branch, instead of merging the default branch from the default remote when "git pull" is run\&. See "branch\&.<name>\&.rebase" for setting this on a per\-branch basis\&.
  8707. .sp
  8708. When
  8709. \fBmerges\fR
  8710. (or just
  8711. \fIm\fR), pass the
  8712. \fB\-\-rebase\-merges\fR
  8713. option to
  8714. \fIgit rebase\fR
  8715. so that the local merge commits are included in the rebase (see
  8716. \fBgit-rebase\fR(1)
  8717. for details)\&.
  8718. .sp
  8719. When the value is
  8720. \fBinteractive\fR
  8721. (or just
  8722. \fIi\fR), the rebase is run in interactive mode\&.
  8723. .sp
  8724. \fBNOTE\fR: this is a possibly dangerous operation; do
  8725. \fBnot\fR
  8726. use it unless you understand the implications (see
  8727. \fBgit-rebase\fR(1)
  8728. for details)\&.
  8729. .RE
  8730. .PP
  8731. pull\&.octopus
  8732. .RS 4
  8733. The default merge strategy to use when pulling multiple branches at once\&.
  8734. .RE
  8735. .PP
  8736. pull\&.twohead
  8737. .RS 4
  8738. The default merge strategy to use when pulling a single branch\&.
  8739. .RE
  8740. .PP
  8741. push\&.autoSetupRemote
  8742. .RS 4
  8743. If set to "true" assume
  8744. \fB\-\-set\-upstream\fR
  8745. on default push when no upstream tracking exists for the current branch; this option takes effect with push\&.default options
  8746. \fIsimple\fR,
  8747. \fIupstream\fR, and
  8748. \fIcurrent\fR\&. It is useful if by default you want new branches to be pushed to the default remote (like the behavior of
  8749. \fIpush\&.default=current\fR) and you also want the upstream tracking to be set\&. Workflows most likely to benefit from this option are
  8750. \fIsimple\fR
  8751. central workflows where all branches are expected to have the same name on the remote\&.
  8752. .RE
  8753. .PP
  8754. push\&.default
  8755. .RS 4
  8756. Defines the action
  8757. \fBgit\fR
  8758. \fBpush\fR
  8759. should take if no refspec is given (whether from the command\-line, config, or elsewhere)\&. Different values are well\-suited for specific workflows; for instance, in a purely central workflow (i\&.e\&. the fetch source is equal to the push destination),
  8760. \fBupstream\fR
  8761. is probably what you want\&. Possible values are:
  8762. .sp
  8763. .RS 4
  8764. .ie n \{\
  8765. \h'-04'\(bu\h'+03'\c
  8766. .\}
  8767. .el \{\
  8768. .sp -1
  8769. .IP \(bu 2.3
  8770. .\}
  8771. \fBnothing\fR
  8772. \- do not push anything (error out) unless a refspec is given\&. This is primarily meant for people who want to avoid mistakes by always being explicit\&.
  8773. .RE
  8774. .sp
  8775. .RS 4
  8776. .ie n \{\
  8777. \h'-04'\(bu\h'+03'\c
  8778. .\}
  8779. .el \{\
  8780. .sp -1
  8781. .IP \(bu 2.3
  8782. .\}
  8783. \fBcurrent\fR
  8784. \- push the current branch to update a branch with the same name on the receiving end\&. Works in both central and non\-central workflows\&.
  8785. .RE
  8786. .sp
  8787. .RS 4
  8788. .ie n \{\
  8789. \h'-04'\(bu\h'+03'\c
  8790. .\}
  8791. .el \{\
  8792. .sp -1
  8793. .IP \(bu 2.3
  8794. .\}
  8795. \fBupstream\fR
  8796. \- push the current branch back to the branch whose changes are usually integrated into the current branch (which is called
  8797. \fB@\fR{upstream})\&. This mode only makes sense if you are pushing to the same repository you would normally pull from (i\&.e\&. central workflow)\&.
  8798. .RE
  8799. .sp
  8800. .RS 4
  8801. .ie n \{\
  8802. \h'-04'\(bu\h'+03'\c
  8803. .\}
  8804. .el \{\
  8805. .sp -1
  8806. .IP \(bu 2.3
  8807. .\}
  8808. \fBtracking\fR
  8809. \- This is a deprecated synonym for
  8810. \fBupstream\fR\&.
  8811. .RE
  8812. .sp
  8813. .RS 4
  8814. .ie n \{\
  8815. \h'-04'\(bu\h'+03'\c
  8816. .\}
  8817. .el \{\
  8818. .sp -1
  8819. .IP \(bu 2.3
  8820. .\}
  8821. \fBsimple\fR
  8822. \- push the current branch with the same name on the remote\&.
  8823. .sp
  8824. If you are working on a centralized workflow (pushing to the same repository you pull from, which is typically
  8825. \fBorigin\fR), then you need to configure an upstream branch with the same name\&.
  8826. .sp
  8827. This mode is the default since Git 2\&.0, and is the safest option suited for beginners\&.
  8828. .RE
  8829. .sp
  8830. .RS 4
  8831. .ie n \{\
  8832. \h'-04'\(bu\h'+03'\c
  8833. .\}
  8834. .el \{\
  8835. .sp -1
  8836. .IP \(bu 2.3
  8837. .\}
  8838. \fBmatching\fR
  8839. \- push all branches having the same name on both ends\&. This makes the repository you are pushing to remember the set of branches that will be pushed out (e\&.g\&. if you always push
  8840. \fImaint\fR
  8841. and
  8842. \fImaster\fR
  8843. there and no other branches, the repository you push to will have these two branches, and your local
  8844. \fImaint\fR
  8845. and
  8846. \fImaster\fR
  8847. will be pushed there)\&.
  8848. .sp
  8849. To use this mode effectively, you have to make sure
  8850. \fIall\fR
  8851. the branches you would push out are ready to be pushed out before running
  8852. \fIgit push\fR, as the whole point of this mode is to allow you to push all of the branches in one go\&. If you usually finish work on only one branch and push out the result, while other branches are unfinished, this mode is not for you\&. Also this mode is not suitable for pushing into a shared central repository, as other people may add new branches there, or update the tip of existing branches outside your control\&.
  8853. .sp
  8854. This used to be the default, but not since Git 2\&.0 (\fBsimple\fR
  8855. is the new default)\&.
  8856. .RE
  8857. .RE
  8858. .PP
  8859. push\&.followTags
  8860. .RS 4
  8861. If set to true, enable
  8862. \fB\-\-follow\-tags\fR
  8863. option by default\&. You may override this configuration at time of push by specifying
  8864. \fB\-\-no\-follow\-tags\fR\&.
  8865. .RE
  8866. .PP
  8867. push\&.gpgSign
  8868. .RS 4
  8869. May be set to a boolean value, or the string
  8870. \fIif\-asked\fR\&. A true value causes all pushes to be GPG signed, as if
  8871. \fB\-\-signed\fR
  8872. is passed to
  8873. \fBgit-push\fR(1)\&. The string
  8874. \fIif\-asked\fR
  8875. causes pushes to be signed if the server supports it, as if
  8876. \fB\-\-signed=if\-asked\fR
  8877. is passed to
  8878. \fIgit push\fR\&. A false value may override a value from a lower\-priority config file\&. An explicit command\-line flag always overrides this config option\&.
  8879. .RE
  8880. .PP
  8881. push\&.pushOption
  8882. .RS 4
  8883. When no
  8884. \fB\-\-push\-option=\fR\fI<option>\fR
  8885. argument is given from the command line,
  8886. \fBgit\fR
  8887. \fBpush\fR
  8888. behaves as if each <value> of this variable is given as
  8889. \fB\-\-push\-option=\fR\fI<value>\fR\&.
  8890. .sp
  8891. This is a multi\-valued variable, and an empty value can be used in a higher priority configuration file (e\&.g\&. \&.\fBgit/config\fR
  8892. in a repository) to clear the values inherited from a lower priority configuration files (e\&.g\&.
  8893. \fB$HOME/\&.gitconfig\fR)\&.
  8894. .sp
  8895. .if n \{\
  8896. .RS 4
  8897. .\}
  8898. .nf
  8899. Example:
  8901. /etc/gitconfig
  8902.   push\&.pushoption = a
  8903.   push\&.pushoption = b
  8905. ~/\&.gitconfig
  8906.   push\&.pushoption = c
  8908. repo/\&.git/config
  8909.   push\&.pushoption =
  8910.   push\&.pushoption = b
  8912. This will result in only b (a and c are cleared)\&.
  8913. .fi
  8914. .if n \{\
  8915. .RE
  8916. .\}
  8917. .RE
  8918. .PP
  8919. push\&.recurseSubmodules
  8920. .RS 4
  8921. May be "check", "on\-demand", "only", or "no", with the same behavior as that of "push \-\-recurse\-submodules"\&. If not set,
  8922. \fIno\fR
  8923. is used by default, unless
  8924. \fIsubmodule\&.recurse\fR
  8925. is set (in which case a
  8926. \fItrue\fR
  8927. value means
  8928. \fIon\-demand\fR)\&.
  8929. .RE
  8930. .PP
  8931. push\&.useForceIfIncludes
  8932. .RS 4
  8933. If set to "true", it is equivalent to specifying
  8934. \fB\-\-force\-if\-includes\fR
  8935. as an option to
  8936. \fBgit-push\fR(1)
  8937. in the command line\&. Adding
  8938. \fB\-\-no\-force\-if\-includes\fR
  8939. at the time of push overrides this configuration setting\&.
  8940. .RE
  8941. .PP
  8942. push\&.negotiate
  8943. .RS 4
  8944. If set to "true", attempt to reduce the size of the packfile sent by rounds of negotiation in which the client and the server attempt to find commits in common\&. If "false", Git will rely solely on the server\(cqs ref advertisement to find commits in common\&.
  8945. .RE
  8946. .PP
  8947. push\&.useBitmaps
  8948. .RS 4
  8949. If set to "false", disable use of bitmaps for "git push" even if
  8950. \fBpack\&.useBitmaps\fR
  8951. is "true", without preventing other git operations from using bitmaps\&. Default is true\&.
  8952. .RE
  8953. .PP
  8954. rebase\&.backend
  8955. .RS 4
  8956. Default backend to use for rebasing\&. Possible choices are
  8957. \fIapply\fR
  8958. or
  8959. \fImerge\fR\&. In the future, if the merge backend gains all remaining capabilities of the apply backend, this setting may become unused\&.
  8960. .RE
  8961. .PP
  8962. rebase\&.stat
  8963. .RS 4
  8964. Whether to show a diffstat of what changed upstream since the last rebase\&. False by default\&.
  8965. .RE
  8966. .PP
  8967. rebase\&.autoSquash
  8968. .RS 4
  8969. If set to true, enable the
  8970. \fB\-\-autosquash\fR
  8971. option of
  8972. \fBgit-rebase\fR(1)
  8973. by default for interactive mode\&. This can be overridden with the
  8974. \fB\-\-no\-autosquash\fR
  8975. option\&.
  8976. .RE
  8977. .PP
  8978. rebase\&.autoStash
  8979. .RS 4
  8980. When set to true, automatically create a temporary stash entry before the operation begins, and apply it after the operation ends\&. This means that you can run rebase on a dirty worktree\&. However, use with care: the final stash application after a successful rebase might result in non\-trivial conflicts\&. This option can be overridden by the
  8981. \fB\-\-no\-autostash\fR
  8982. and
  8983. \fB\-\-autostash\fR
  8984. options of
  8985. \fBgit-rebase\fR(1)\&. Defaults to false\&.
  8986. .RE
  8987. .PP
  8988. rebase\&.updateRefs
  8989. .RS 4
  8990. If set to true enable
  8991. \fB\-\-update\-refs\fR
  8992. option by default\&.
  8993. .RE
  8994. .PP
  8995. rebase\&.missingCommitsCheck
  8996. .RS 4
  8997. If set to "warn", git rebase \-i will print a warning if some commits are removed (e\&.g\&. a line was deleted), however the rebase will still proceed\&. If set to "error", it will print the previous warning and stop the rebase,
  8998. \fIgit rebase \-\-edit\-todo\fR
  8999. can then be used to correct the error\&. If set to "ignore", no checking is done\&. To drop a commit without warning or error, use the
  9000. \fBdrop\fR
  9001. command in the todo list\&. Defaults to "ignore"\&.
  9002. .RE
  9003. .PP
  9004. rebase\&.instructionFormat
  9005. .RS 4
  9006. A format string, as specified in
  9007. \fBgit-log\fR(1), to be used for the todo list during an interactive rebase\&. The format will automatically have the commit hash prepended to the format\&.
  9008. .RE
  9009. .PP
  9010. rebase\&.abbreviateCommands
  9011. .RS 4
  9012. If set to true,
  9013. \fBgit\fR
  9014. \fBrebase\fR
  9015. will use abbreviated command names in the todo list resulting in something like this:
  9016. .sp
  9017. .if n \{\
  9018. .RS 4
  9019. .\}
  9020. .nf
  9021.         p deadbee The oneline of the commit
  9022.         p fa1afe1 The oneline of the next commit
  9023.         \&.\&.\&.
  9024. .fi
  9025. .if n \{\
  9026. .RE
  9027. .\}
  9028. .sp
  9029. instead of:
  9030. .sp
  9031. .if n \{\
  9032. .RS 4
  9033. .\}
  9034. .nf
  9035.         pick deadbee The oneline of the commit
  9036.         pick fa1afe1 The oneline of the next commit
  9037.         \&.\&.\&.
  9038. .fi
  9039. .if n \{\
  9040. .RE
  9041. .\}
  9042. .sp
  9043. Defaults to false\&.
  9044. .RE
  9045. .PP
  9046. rebase\&.rescheduleFailedExec
  9047. .RS 4
  9048. Automatically reschedule
  9049. \fBexec\fR
  9050. commands that failed\&. This only makes sense in interactive mode (or when an
  9051. \fB\-\-exec\fR
  9052. option was provided)\&. This is the same as specifying the
  9053. \fB\-\-reschedule\-failed\-exec\fR
  9054. option\&.
  9055. .RE
  9056. .PP
  9057. rebase\&.forkPoint
  9058. .RS 4
  9059. If set to false set
  9060. \fB\-\-no\-fork\-point\fR
  9061. option by default\&.
  9062. .RE
  9063. .PP
  9064. rebase\&.rebaseMerges
  9065. .RS 4
  9066. Whether and how to set the
  9067. \fB\-\-rebase\-merges\fR
  9068. option by default\&. Can be
  9069. \fBrebase\-cousins\fR,
  9070. \fBno\-rebase\-cousins\fR, or a boolean\&. Setting to true or to
  9071. \fBno\-rebase\-cousins\fR
  9072. is equivalent to
  9073. \fB\-\-rebase\-merges=no\-rebase\-cousins\fR, setting to
  9074. \fBrebase\-cousins\fR
  9075. is equivalent to
  9076. \fB\-\-rebase\-merges=rebase\-cousins\fR, and setting to false is equivalent to
  9077. \fB\-\-no\-rebase\-merges\fR\&. Passing
  9078. \fB\-\-rebase\-merges\fR
  9079. on the command line, with or without an argument, overrides any
  9080. \fBrebase\&.rebaseMerges\fR
  9081. configuration\&.
  9082. .RE
  9083. .PP
  9084. rebase\&.maxLabelLength
  9085. .RS 4
  9086. When generating label names from commit subjects, truncate the names to this length\&. By default, the names are truncated to a little less than
  9087. \fBNAME_MAX\fR
  9088. (to allow e\&.g\&. \&.\fBlock\fR
  9089. files to be written for the corresponding loose refs)\&.
  9090. .RE
  9091. .PP
  9092. receive\&.advertiseAtomic
  9093. .RS 4
  9094. By default, git\-receive\-pack will advertise the atomic push capability to its clients\&. If you don\(cqt want to advertise this capability, set this variable to false\&.
  9095. .RE
  9096. .PP
  9097. receive\&.advertisePushOptions
  9098. .RS 4
  9099. When set to true, git\-receive\-pack will advertise the push options capability to its clients\&. False by default\&.
  9100. .RE
  9101. .PP
  9102. receive\&.autogc
  9103. .RS 4
  9104. By default, git\-receive\-pack will run "git maintenance run \-\-auto" after receiving data from git\-push and updating refs\&. You can stop it by setting this variable to false\&.
  9105. .RE
  9106. .PP
  9107. receive\&.certNonceSeed
  9108. .RS 4
  9109. By setting this variable to a string,
  9110. \fBgit\fR
  9111. \fBreceive\-pack\fR
  9112. will accept a
  9113. \fBgit\fR
  9114. \fBpush\fR
  9115. \fB\-\-signed\fR
  9116. and verify it by using a "nonce" protected by HMAC using this string as a secret key\&.
  9117. .RE
  9118. .PP
  9119. receive\&.certNonceSlop
  9120. .RS 4
  9121. When a
  9122. \fBgit\fR
  9123. \fBpush\fR
  9124. \fB\-\-signed\fR
  9125. sends a push certificate with a "nonce" that was issued by a receive\-pack serving the same repository within this many seconds, export the "nonce" found in the certificate to
  9126. \fBGIT_PUSH_CERT_NONCE\fR
  9127. to the hooks (instead of what the receive\-pack asked the sending side to include)\&. This may allow writing checks in
  9128. \fBpre\-receive\fR
  9129. and
  9130. \fBpost\-receive\fR
  9131. a bit easier\&. Instead of checking
  9132. \fBGIT_PUSH_CERT_NONCE_SLOP\fR
  9133. environment variable that records by how many seconds the nonce is stale to decide if they want to accept the certificate, they only can check
  9134. \fBGIT_PUSH_CERT_NONCE_STATUS\fR
  9135. is
  9136. \fBOK\fR\&.
  9137. .RE
  9138. .PP
  9139. receive\&.fsckObjects
  9140. .RS 4
  9141. If it is set to true, git\-receive\-pack will check all received objects\&. See
  9142. \fBtransfer\&.fsckObjects\fR
  9143. for what\(cqs checked\&. Defaults to false\&. If not set, the value of
  9144. \fBtransfer\&.fsckObjects\fR
  9145. is used instead\&.
  9146. .RE
  9147. .PP
  9148. receive\&.fsck\&.<msg\-id>
  9149. .RS 4
  9150. Acts like
  9151. \fBfsck\&.\fR\fI<msg\-id>\fR, but is used by
  9152. \fBgit-receive-pack\fR(1)
  9153. instead of
  9154. \fBgit-fsck\fR(1)\&. See the
  9155. \fBfsck\&.\fR\fI<msg\-id>\fR
  9156. documentation for details\&.
  9157. .RE
  9158. .PP
  9159. receive\&.fsck\&.skipList
  9160. .RS 4
  9161. Acts like
  9162. \fBfsck\&.skipList\fR, but is used by
  9163. \fBgit-receive-pack\fR(1)
  9164. instead of
  9165. \fBgit-fsck\fR(1)\&. See the
  9166. \fBfsck\&.skipList\fR
  9167. documentation for details\&.
  9168. .RE
  9169. .PP
  9170. receive\&.keepAlive
  9171. .RS 4
  9172. After receiving the pack from the client,
  9173. \fBreceive\-pack\fR
  9174. may produce no output (if
  9175. \fB\-\-quiet\fR
  9176. was specified) while processing the pack, causing some networks to drop the TCP connection\&. With this option set, if
  9177. \fBreceive\-pack\fR
  9178. does not transmit any data in this phase for
  9179. \fBreceive\&.keepAlive\fR
  9180. seconds, it will send a short keepalive packet\&. The default is 5 seconds; set to 0 to disable keepalives entirely\&.
  9181. .RE
  9182. .PP
  9183. receive\&.unpackLimit
  9184. .RS 4
  9185. If the number of objects received in a push is below this limit then the objects will be unpacked into loose object files\&. However if the number of received objects equals or exceeds this limit then the received pack will be stored as a pack, after adding any missing delta bases\&. Storing the pack from a push can make the push operation complete faster, especially on slow filesystems\&. If not set, the value of
  9186. \fBtransfer\&.unpackLimit\fR
  9187. is used instead\&.
  9188. .RE
  9189. .PP
  9190. receive\&.maxInputSize
  9191. .RS 4
  9192. If the size of the incoming pack stream is larger than this limit, then git\-receive\-pack will error out, instead of accepting the pack file\&. If not set or set to 0, then the size is unlimited\&.
  9193. .RE
  9194. .PP
  9195. receive\&.denyDeletes
  9196. .RS 4
  9197. If set to true, git\-receive\-pack will deny a ref update that deletes the ref\&. Use this to prevent such a ref deletion via a push\&.
  9198. .RE
  9199. .PP
  9200. receive\&.denyDeleteCurrent
  9201. .RS 4
  9202. If set to true, git\-receive\-pack will deny a ref update that deletes the currently checked out branch of a non\-bare repository\&.
  9203. .RE
  9204. .PP
  9205. receive\&.denyCurrentBranch
  9206. .RS 4
  9207. If set to true or "refuse", git\-receive\-pack will deny a ref update to the currently checked out branch of a non\-bare repository\&. Such a push is potentially dangerous because it brings the HEAD out of sync with the index and working tree\&. If set to "warn", print a warning of such a push to stderr, but allow the push to proceed\&. If set to false or "ignore", allow such pushes with no message\&. Defaults to "refuse"\&.
  9208. .sp
  9209. Another option is "updateInstead" which will update the working tree if pushing into the current branch\&. This option is intended for synchronizing working directories when one side is not easily accessible via interactive ssh (e\&.g\&. a live web site, hence the requirement that the working directory be clean)\&. This mode also comes in handy when developing inside a VM to test and fix code on different Operating Systems\&.
  9210. .sp
  9211. By default, "updateInstead" will refuse the push if the working tree or the index have any difference from the HEAD, but the
  9212. \fBpush\-to\-checkout\fR
  9213. hook can be used to customize this\&. See
  9214. \fBgithooks\fR(5)\&.
  9215. .RE
  9216. .PP
  9217. receive\&.denyNonFastForwards
  9218. .RS 4
  9219. If set to true, git\-receive\-pack will deny a ref update which is not a fast\-forward\&. Use this to prevent such an update via a push, even if that push is forced\&. This configuration variable is set when initializing a shared repository\&.
  9220. .RE
  9221. .PP
  9222. receive\&.hideRefs
  9223. .RS 4
  9224. This variable is the same as
  9225. \fBtransfer\&.hideRefs\fR, but applies only to
  9226. \fBreceive\-pack\fR
  9227. (and so affects pushes, but not fetches)\&. An attempt to update or delete a hidden ref by
  9228. \fBgit\fR
  9229. \fBpush\fR
  9230. is rejected\&.
  9231. .RE
  9232. .PP
  9233. receive\&.procReceiveRefs
  9234. .RS 4
  9235. This is a multi\-valued variable that defines reference prefixes to match the commands in
  9236. \fBreceive\-pack\fR\&. Commands matching the prefixes will be executed by an external hook "proc\-receive", instead of the internal
  9237. \fBexecute_commands\fR
  9238. function\&. If this variable is not defined, the "proc\-receive" hook will never be used, and all commands will be executed by the internal
  9239. \fBexecute_commands\fR
  9240. function\&.
  9241. .sp
  9242. For example, if this variable is set to "refs/for", pushing to reference such as "refs/for/master" will not create or update a reference named "refs/for/master", but may create or update a pull request directly by running the hook "proc\-receive"\&.
  9243. .sp
  9244. Optional modifiers can be provided in the beginning of the value to filter commands for specific actions: create (a), modify (m), delete (d)\&. A ! can be included in the modifiers to negate the reference prefix entry\&. E\&.g\&.:
  9245. .sp
  9246. .if n \{\
  9247. .RS 4
  9248. .\}
  9249. .nf
  9250. git config \-\-system \-\-add receive\&.procReceiveRefs ad:refs/heads
  9251. git config \-\-system \-\-add receive\&.procReceiveRefs !:refs/heads
  9252. .fi
  9253. .if n \{\
  9254. .RE
  9255. .\}
  9256. .RE
  9257. .PP
  9258. receive\&.updateServerInfo
  9259. .RS 4
  9260. If set to true, git\-receive\-pack will run git\-update\-server\-info after receiving data from git\-push and updating refs\&.
  9261. .RE
  9262. .PP
  9263. receive\&.shallowUpdate
  9264. .RS 4
  9265. If set to true, \&.git/shallow can be updated when new refs require new shallow roots\&. Otherwise those refs are rejected\&.
  9266. .RE
  9267. .PP
  9268. reftable\&.blockSize
  9269. .RS 4
  9270. The size in bytes used by the reftable backend when writing blocks\&. The block size is determined by the writer, and does not have to be a power of 2\&. The block size must be larger than the longest reference name or log entry used in the repository, as references cannot span blocks\&.
  9271. .sp
  9272. Powers of two that are friendly to the virtual memory system or filesystem (such as 4kB or 8kB) are recommended\&. Larger sizes (64kB) can yield better compression, with a possible increased cost incurred by readers during access\&.
  9273. .sp
  9274. The largest block size is
  9275. \fB16777215\fR
  9276. bytes (15\&.99 MiB)\&. The default value is
  9277. \fB4096\fR
  9278. bytes (4kB)\&. A value of
  9279. \fB0\fR
  9280. will use the default value\&.
  9281. .RE
  9282. .PP
  9283. reftable\&.restartInterval
  9284. .RS 4
  9285. The interval at which to create restart points\&. The reftable backend determines the restart points at file creation\&. Every 16 may be more suitable for smaller block sizes (4k or 8k), every 64 for larger block sizes (64k)\&.
  9286. .sp
  9287. More frequent restart points reduces prefix compression and increases space consumed by the restart table, both of which increase file size\&.
  9288. .sp
  9289. Less frequent restart points makes prefix compression more effective, decreasing overall file size, with increased penalties for readers walking through more records after the binary search step\&.
  9290. .sp
  9291. A maximum of
  9292. \fB65535\fR
  9293. restart points per block is supported\&.
  9294. .sp
  9295. The default value is to create restart points every 16 records\&. A value of
  9296. \fB0\fR
  9297. will use the default value\&.
  9298. .RE
  9299. .PP
  9300. reftable\&.indexObjects
  9301. .RS 4
  9302. Whether the reftable backend shall write object blocks\&. Object blocks are a reverse mapping of object ID to the references pointing to them\&.
  9303. .sp
  9304. The default value is
  9305. \fBtrue\fR\&.
  9306. .RE
  9307. .PP
  9308. reftable\&.geometricFactor
  9309. .RS 4
  9310. Whenever the reftable backend appends a new table to the stack, it performs auto compaction to ensure that there is only a handful of tables\&. The backend does this by ensuring that tables form a geometric sequence regarding the respective sizes of each table\&.
  9311. .sp
  9312. By default, the geometric sequence uses a factor of 2, meaning that for any table, the next\-biggest table must at least be twice as big\&. A maximum factor of 256 is supported\&.
  9313. .RE
  9314. .PP
  9315. reftable\&.lockTimeout
  9316. .RS 4
  9317. Whenever the reftable backend appends a new table to the stack, it has to lock the central "tables\&.list" file before updating it\&. This config controls how long the process will wait to acquire the lock in case another process has already acquired it\&. Value 0 means not to retry at all; \-1 means to try indefinitely\&. Default is 100 (i\&.e\&., retry for 100ms)\&.
  9318. .RE
  9319. .PP
  9320. remote\&.pushDefault
  9321. .RS 4
  9322. The remote to push to by default\&. Overrides
  9323. \fBbranch\&.\fR\fI<name>\fR\fB\&.remote\fR
  9324. for all branches, and is overridden by
  9325. \fBbranch\&.\fR\fI<name>\fR\fB\&.pushRemote\fR
  9326. for specific branches\&.
  9327. .RE
  9328. .PP
  9329. remote\&.<name>\&.url
  9330. .RS 4
  9331. The URL of a remote repository\&. See
  9332. \fBgit-fetch\fR(1)
  9333. or
  9334. \fBgit-push\fR(1)\&. A configured remote can have multiple URLs; in this case the first is used for fetching, and all are used for pushing (assuming no
  9335. \fBremote\&.\fR\fI<name>\fR\fB\&.pushurl\fR
  9336. is defined)\&. Setting this key to the empty string clears the list of urls, allowing you to override earlier config\&.
  9337. .RE
  9338. .PP
  9339. remote\&.<name>\&.pushurl
  9340. .RS 4
  9341. The push URL of a remote repository\&. See
  9342. \fBgit-push\fR(1)\&. If a
  9343. \fBpushurl\fR
  9344. option is present in a configured remote, it is used for pushing instead of
  9345. \fBremote\&.\fR\fI<name>\fR\fB\&.url\fR\&. A configured remote can have multiple push URLs; in this case a push goes to all of them\&. Setting this key to the empty string clears the list of urls, allowing you to override earlier config\&.
  9346. .RE
  9347. .PP
  9348. remote\&.<name>\&.proxy
  9349. .RS 4
  9350. For remotes that require curl (http, https and ftp), the URL to the proxy to use for that remote\&. Set to the empty string to disable proxying for that remote\&.
  9351. .RE
  9352. .PP
  9353. remote\&.<name>\&.proxyAuthMethod
  9354. .RS 4
  9355. For remotes that require curl (http, https and ftp), the method to use for authenticating against the proxy in use (probably set in
  9356. \fBremote\&.\fR\fI<name>\fR\fB\&.proxy\fR)\&. See
  9357. \fBhttp\&.proxyAuthMethod\fR\&.
  9358. .RE
  9359. .PP
  9360. remote\&.<name>\&.fetch
  9361. .RS 4
  9362. The default set of "refspec" for
  9363. \fBgit-fetch\fR(1)\&. See
  9364. \fBgit-fetch\fR(1)\&.
  9365. .RE
  9366. .PP
  9367. remote\&.<name>\&.push
  9368. .RS 4
  9369. The default set of "refspec" for
  9370. \fBgit-push\fR(1)\&. See
  9371. \fBgit-push\fR(1)\&.
  9372. .RE
  9373. .PP
  9374. remote\&.<name>\&.mirror
  9375. .RS 4
  9376. If true, pushing to this remote will automatically behave as if the
  9377. \fB\-\-mirror\fR
  9378. option was given on the command line\&.
  9379. .RE
  9380. .PP
  9381. remote\&.<name>\&.skipDefaultUpdate
  9382. .RS 4
  9383. A deprecated synonym to
  9384. \fBremote\&.\fR\fI<name>\fR\fB\&.skipFetchAll\fR
  9385. (if both are set in the configuration files with different values, the value of the last occurrence will be used)\&.
  9386. .RE
  9387. .PP
  9388. remote\&.<name>\&.skipFetchAll
  9389. .RS 4
  9390. If true, this remote will be skipped when updating using
  9391. \fBgit-fetch\fR(1), the
  9392. \fBupdate\fR
  9393. subcommand of
  9394. \fBgit-remote\fR(1), and ignored by the prefetch task of
  9395. \fBgit\fR
  9396. \fBmaintenance\fR\&.
  9397. .RE
  9398. .PP
  9399. remote\&.<name>\&.receivepack
  9400. .RS 4
  9401. The default program to execute on the remote side when pushing\&. See option \-\-receive\-pack of
  9402. \fBgit-push\fR(1)\&.
  9403. .RE
  9404. .PP
  9405. remote\&.<name>\&.uploadpack
  9406. .RS 4
  9407. The default program to execute on the remote side when fetching\&. See option \-\-upload\-pack of
  9408. \fBgit-fetch-pack\fR(1)\&.
  9409. .RE
  9410. .PP
  9411. remote\&.<name>\&.tagOpt
  9412. .RS 4
  9413. Setting this value to \-\-no\-tags disables automatic tag following when fetching from remote <name>\&. Setting it to \-\-tags will fetch every tag from remote <name>, even if they are not reachable from remote branch heads\&. Passing these flags directly to
  9414. \fBgit-fetch\fR(1)
  9415. can override this setting\&. See options \-\-tags and \-\-no\-tags of
  9416. \fBgit-fetch\fR(1)\&.
  9417. .RE
  9418. .PP
  9419. remote\&.<name>\&.vcs
  9420. .RS 4
  9421. Setting this to a value <vcs> will cause Git to interact with the remote with the git\-remote\-<vcs> helper\&.
  9422. .RE
  9423. .PP
  9424. remote\&.<name>\&.prune
  9425. .RS 4
  9426. When set to true, fetching from this remote by default will also remove any remote\-tracking references that no longer exist on the remote (as if the
  9427. \fB\-\-prune\fR
  9428. option was given on the command line)\&. Overrides
  9429. \fBfetch\&.prune\fR
  9430. settings, if any\&.
  9431. .RE
  9432. .PP
  9433. remote\&.<name>\&.pruneTags
  9434. .RS 4
  9435. When set to true, fetching from this remote by default will also remove any local tags that no longer exist on the remote if pruning is activated in general via
  9436. \fBremote\&.\fR\fI<name>\fR\fB\&.prune\fR,
  9437. \fBfetch\&.prune\fR
  9438. or
  9439. \fB\-\-prune\fR\&. Overrides
  9440. \fBfetch\&.pruneTags\fR
  9441. settings, if any\&.
  9442. .sp
  9443. See also
  9444. \fBremote\&.\fR\fI<name>\fR\fB\&.prune\fR
  9445. and the PRUNING section of
  9446. \fBgit-fetch\fR(1)\&.
  9447. .RE
  9448. .PP
  9449. remote\&.<name>\&.promisor
  9450. .RS 4
  9451. When set to true, this remote will be used to fetch promisor objects\&.
  9452. .RE
  9453. .PP
  9454. remote\&.<name>\&.partialclonefilter
  9455. .RS 4
  9456. The filter that will be applied when fetching from this promisor remote\&. Changing or clearing this value will only affect fetches for new commits\&. To fetch associated objects for commits already present in the local object database, use the
  9457. \fB\-\-refetch\fR
  9458. option of
  9459. \fBgit-fetch\fR(1)\&.
  9460. .RE
  9461. .PP
  9462. remote\&.<name>\&.serverOption
  9463. .RS 4
  9464. The default set of server options used when fetching from this remote\&. These server options can be overridden by the
  9465. \fB\-\-server\-option=\fR
  9466. command line arguments\&.
  9467. .sp
  9468. This is a multi\-valued variable, and an empty value can be used in a higher priority configuration file (e\&.g\&. \&.\fBgit/config\fR
  9469. in a repository) to clear the values inherited from a lower priority configuration files (e\&.g\&.
  9470. \fB$HOME/\&.gitconfig\fR)\&.
  9471. .RE
  9472. .PP
  9473. remote\&.<name>\&.followRemoteHEAD
  9474. .RS 4
  9475. How
  9476. \fBgit-fetch\fR(1)
  9477. should handle updates to
  9478. \fBremotes/\fR\fI<name>\fR\fB/HEAD\fR\&. The default value is "create", which will create
  9479. \fBremotes/\fR\fI<name>\fR\fB/HEAD\fR
  9480. if it exists on the remote, but not locally; this will not touch an already existing local reference\&. Setting it to "warn" will print a message if the remote has a different value than the local one; in case there is no local reference, it behaves like "create"\&. A variant on "warn" is "warn\-if\-not\-$branch", which behaves like "warn", but if
  9481. \fBHEAD\fR
  9482. on the remote is
  9483. \fB$branch\fR
  9484. it will be silent\&. Setting it to "always" will silently update
  9485. \fBremotes/\fR\fI<name>\fR\fB/HEAD\fR
  9486. to the value on the remote\&. Finally, setting it to "never" will never change or create the local reference\&.
  9487. .RE
  9488. .PP
  9489. remotes\&.<group>
  9490. .RS 4
  9491. The list of remotes which are fetched by "git remote update <group>"\&. See
  9492. \fBgit-remote\fR(1)\&.
  9493. .RE
  9494. .PP
  9495. repack\&.useDeltaBaseOffset
  9496. .RS 4
  9497. By default,
  9498. \fBgit-repack\fR(1)
  9499. creates packs that use delta\-base offset\&. If you need to share your repository with Git older than version 1\&.4\&.4, either directly or via a dumb protocol such as http, then you need to set this option to "false" and repack\&. Access from old Git versions over the native protocol are unaffected by this option\&.
  9500. .RE
  9501. .PP
  9502. repack\&.packKeptObjects
  9503. .RS 4
  9504. If set to true, makes
  9505. \fBgit\fR
  9506. \fBrepack\fR
  9507. act as if
  9508. \fB\-\-pack\-kept\-objects\fR
  9509. was passed\&. See
  9510. \fBgit-repack\fR(1)
  9511. for details\&. Defaults to
  9512. \fBfalse\fR
  9513. normally, but
  9514. \fBtrue\fR
  9515. if a bitmap index is being written (either via
  9516. \fB\-\-write\-bitmap\-index\fR
  9517. or
  9518. \fBrepack\&.writeBitmaps\fR)\&.
  9519. .RE
  9520. .PP
  9521. repack\&.useDeltaIslands
  9522. .RS 4
  9523. If set to true, makes
  9524. \fBgit\fR
  9525. \fBrepack\fR
  9526. act as if
  9527. \fB\-\-delta\-islands\fR
  9528. was passed\&. Defaults to
  9529. \fBfalse\fR\&.
  9530. .RE
  9531. .PP
  9532. repack\&.writeBitmaps
  9533. .RS 4
  9534. When true, git will write a bitmap index when packing all objects to disk (e\&.g\&., when
  9535. \fBgit\fR
  9536. \fBrepack\fR
  9537. \fB\-a\fR
  9538. is run)\&. This index can speed up the "counting objects" phase of subsequent packs created for clones and fetches, at the cost of some disk space and extra time spent on the initial repack\&. This has no effect if multiple packfiles are created\&. Defaults to true on bare repos, false otherwise\&.
  9539. .RE
  9540. .PP
  9541. repack\&.updateServerInfo
  9542. .RS 4
  9543. If set to false,
  9544. \fBgit-repack\fR(1)
  9545. will not run
  9546. \fBgit-update-server-info\fR(1)\&. Defaults to true\&. Can be overridden when true by the
  9547. \fB\-n\fR
  9548. option of
  9549. \fBgit-repack\fR(1)\&.
  9550. .RE
  9551. .PP
  9552. repack\&.cruftWindow, repack\&.cruftWindowMemory, repack\&.cruftDepth, repack\&.cruftThreads
  9553. .RS 4
  9554. Parameters used by
  9555. \fBgit-pack-objects\fR(1)
  9556. when generating a cruft pack and the respective parameters are not given over the command line\&. See similarly named
  9557. \fBpack\&.\fR* configuration variables for defaults and meaning\&.
  9558. .RE
  9559. .PP
  9560. rerere\&.autoUpdate
  9561. .RS 4
  9562. When set to true,
  9563. \fBgit\-rerere\fR
  9564. updates the index with the resulting contents after it cleanly resolves conflicts using previously recorded resolutions\&. Defaults to false\&.
  9565. .RE
  9566. .PP
  9567. rerere\&.enabled
  9568. .RS 4
  9569. Activate recording of resolved conflicts, so that identical conflict hunks can be resolved automatically, should they be encountered again\&. By default,
  9570. \fBgit-rerere\fR(1)
  9571. is enabled if there is an
  9572. \fBrr\-cache\fR
  9573. directory under the
  9574. \fB$GIT_DIR\fR, e\&.g\&. if "rerere" was previously used in the repository\&.
  9575. .RE
  9576. .PP
  9577. revert\&.reference
  9578. .RS 4
  9579. Setting this variable to true makes
  9580. \fBgit\fR
  9581. \fBrevert\fR
  9582. behave as if the
  9583. \fB\-\-reference\fR
  9584. option is given\&.
  9585. .RE
  9586. .PP
  9587. safe\&.bareRepository
  9588. .RS 4
  9589. Specifies which bare repositories Git will work with\&. The currently supported values are:
  9590. .sp
  9591. .RS 4
  9592. .ie n \{\
  9593. \h'-04'\(bu\h'+03'\c
  9594. .\}
  9595. .el \{\
  9596. .sp -1
  9597. .IP \(bu 2.3
  9598. .\}
  9599. \fBall\fR: Git works with all bare repositories\&. This is the default\&.
  9600. .RE
  9601. .sp
  9602. .RS 4
  9603. .ie n \{\
  9604. \h'-04'\(bu\h'+03'\c
  9605. .\}
  9606. .el \{\
  9607. .sp -1
  9608. .IP \(bu 2.3
  9609. .\}
  9610. \fBexplicit\fR: Git only works with bare repositories specified via the top\-level
  9611. \fB\-\-git\-dir\fR
  9612. command\-line option, or the
  9613. \fBGIT_DIR\fR
  9614. environment variable (see
  9615. \fBgit\fR(1))\&.
  9616. .sp
  9617. If you do not use bare repositories in your workflow, then it may be beneficial to set
  9618. \fBsafe\&.bareRepository\fR
  9619. to
  9620. \fBexplicit\fR
  9621. in your global config\&. This will protect you from attacks that involve cloning a repository that contains a bare repository and running a Git command within that directory\&.
  9622. .sp
  9623. This config setting is only respected in protected configuration (see
  9624. the section called \(lqSCOPES\(rq)\&. This prevents untrusted repositories from tampering with this value\&.
  9625. .RE
  9626. .RE
  9627. .PP
  9628. safe\&.directory
  9629. .RS 4
  9630. These config entries specify Git\-tracked directories that are considered safe even if they are owned by someone other than the current user\&. By default, Git will refuse to even parse a Git config of a repository owned by someone else, let alone run its hooks, and this config setting allows users to specify exceptions, e\&.g\&. for intentionally shared repositories (see the
  9631. \fB\-\-shared\fR
  9632. option in
  9633. \fBgit-init\fR(1))\&.
  9634. .sp
  9635. This is a multi\-valued setting, i\&.e\&. you can add more than one directory via
  9636. \fBgit\fR
  9637. \fBconfig\fR
  9638. \fB\-\-add\fR\&. To reset the list of safe directories (e\&.g\&. to override any such directories specified in the system config), add a
  9639. \fBsafe\&.directory\fR
  9640. entry with an empty value\&.
  9641. .sp
  9642. This config setting is only respected in protected configuration (see
  9643. the section called \(lqSCOPES\(rq)\&. This prevents untrusted repositories from tampering with this value\&.
  9644. .sp
  9645. The value of this setting is interpolated, i\&.e\&.
  9646. \fB~/\fR\fI<path>\fR
  9647. expands to a path relative to the home directory and %(\fBprefix\fR)\fB/\fR\fI<path>\fR
  9648. expands to a path relative to Git\(cqs (runtime) prefix\&.
  9649. .sp
  9650. To completely opt\-out of this security check, set
  9651. \fBsafe\&.directory\fR
  9652. to the string *\&. This will allow all repositories to be treated as if their directory was listed in the
  9653. \fBsafe\&.directory\fR
  9654. list\&. If
  9655. \fBsafe\&.directory=\fR* is set in system config and you want to re\-enable this protection, then initialize your list with an empty value before listing the repositories that you deem safe\&. Giving a directory with
  9656. \fB/\fR* appended to it will allow access to all repositories under the named directory\&.
  9657. .sp
  9658. As explained, Git only allows you to access repositories owned by yourself, i\&.e\&. the user who is running Git, by default\&. When Git is running as
  9659. \fIroot\fR
  9660. in a non Windows platform that provides sudo, however, git checks the SUDO_UID environment variable that sudo creates and will allow access to the uid recorded as its value in addition to the id from
  9661. \fIroot\fR\&. This is to make it easy to perform a common sequence during installation "make && sudo make install"\&. A git process running under
  9662. \fIsudo\fR
  9663. runs as
  9664. \fIroot\fR
  9665. but the
  9666. \fIsudo\fR
  9667. command exports the environment variable to record which id the original user has\&. If that is not what you would prefer and want git to only trust repositories that are owned by root instead, then you can remove the
  9668. \fBSUDO_UID\fR
  9669. variable from root\(cqs environment before invoking git\&.
  9670. .RE
  9671. .PP
  9672. sendemail\&.identity
  9673. .RS 4
  9674. A configuration identity\&. When given, causes values in the
  9675. \fIsendemail\&.<identity>\fR
  9676. subsection to take precedence over values in the
  9677. \fIsendemail\fR
  9678. section\&. The default identity is the value of
  9679. \fBsendemail\&.identity\fR\&.
  9680. .RE
  9681. .PP
  9682. sendemail\&.smtpEncryption
  9683. .RS 4
  9684. See
  9685. \fBgit-send-email\fR(1)
  9686. for description\&. Note that this setting is not subject to the
  9687. \fIidentity\fR
  9688. mechanism\&.
  9689. .RE
  9690. .PP
  9691. sendemail\&.smtpSSLCertPath
  9692. .RS 4
  9693. Path to ca\-certificates (either a directory or a single file)\&. Set it to an empty string to disable certificate verification\&.
  9694. .RE
  9695. .PP
  9696. sendemail\&.<identity>\&.*
  9697. .RS 4
  9698. Identity\-specific versions of the
  9699. \fIsendemail\&.*\fR
  9700. parameters found below, taking precedence over those when this identity is selected, through either the command\-line or
  9701. \fBsendemail\&.identity\fR\&.
  9702. .RE
  9703. .PP
  9704. sendemail\&.multiEdit
  9705. .RS 4
  9706. If true (default), a single editor instance will be spawned to edit files you have to edit (patches when
  9707. \fB\-\-annotate\fR
  9708. is used, and the summary when
  9709. \fB\-\-compose\fR
  9710. is used)\&. If false, files will be edited one after the other, spawning a new editor each time\&.
  9711. .RE
  9712. .PP
  9713. sendemail\&.confirm
  9714. .RS 4
  9715. Sets the default for whether to confirm before sending\&. Must be one of
  9716. \fIalways\fR,
  9717. \fInever\fR,
  9718. \fIcc\fR,
  9719. \fIcompose\fR, or
  9720. \fIauto\fR\&. See
  9721. \fB\-\-confirm\fR
  9722. in the
  9723. \fBgit-send-email\fR(1)
  9724. documentation for the meaning of these values\&.
  9725. .RE
  9726. .PP
  9727. sendemail\&.mailmap
  9728. .RS 4
  9729. If true, makes
  9730. \fBgit-send-email\fR(1)
  9731. assume
  9732. \fB\-\-mailmap\fR, otherwise assume
  9733. \fB\-\-no\-mailmap\fR\&. False by default\&.
  9734. .RE
  9735. .PP
  9736. sendemail\&.mailmap\&.file
  9737. .RS 4
  9738. The location of a
  9739. \fBgit-send-email\fR(1)
  9740. specific augmenting mailmap file\&. The default mailmap and
  9741. \fBmailmap\&.file\fR
  9742. are loaded first\&. Thus, entries in this file take precedence over entries in the default mailmap locations\&. See
  9743. \fBgitmailmap\fR(5)\&.
  9744. .RE
  9745. .PP
  9746. sendemail\&.mailmap\&.blob
  9747. .RS 4
  9748. Like
  9749. \fBsendemail\&.mailmap\&.file\fR, but consider the value as a reference to a blob in the repository\&. Entries in
  9750. \fBsendemail\&.mailmap\&.file\fR
  9751. take precedence over entries here\&. See
  9752. \fBgitmailmap\fR(5)\&.
  9753. .RE
  9754. .PP
  9755. sendemail\&.aliasesFile
  9756. .RS 4
  9757. To avoid typing long email addresses, point this to one or more email aliases files\&. You must also supply
  9758. \fBsendemail\&.aliasFileType\fR\&.
  9759. .RE
  9760. .PP
  9761. sendemail\&.aliasFileType
  9762. .RS 4
  9763. Format of the file(s) specified in sendemail\&.aliasesFile\&. Must be one of
  9764. \fImutt\fR,
  9765. \fImailrc\fR,
  9766. \fIpine\fR,
  9767. \fIelm\fR,
  9768. \fIgnus\fR, or
  9769. \fIsendmail\fR\&.
  9770. .sp
  9771. What an alias file in each format looks like can be found in the documentation of the email program of the same name\&. The differences and limitations from the standard formats are described below:
  9772. .PP
  9773. sendmail
  9774. .RS 4
  9775. .sp
  9776. .RS 4
  9777. .ie n \{\
  9778. \h'-04'\(bu\h'+03'\c
  9779. .\}
  9780. .el \{\
  9781. .sp -1
  9782. .IP \(bu 2.3
  9783. .\}
  9784. Quoted aliases and quoted addresses are not supported: lines that contain a " symbol are ignored\&.
  9785. .RE
  9786. .sp
  9787. .RS 4
  9788. .ie n \{\
  9789. \h'-04'\(bu\h'+03'\c
  9790. .\}
  9791. .el \{\
  9792. .sp -1
  9793. .IP \(bu 2.3
  9794. .\}
  9795. Redirection to a file (\fB/path/name\fR) or pipe (|\fBcommand\fR) is not supported\&.
  9796. .RE
  9797. .sp
  9798. .RS 4
  9799. .ie n \{\
  9800. \h'-04'\(bu\h'+03'\c
  9801. .\}
  9802. .el \{\
  9803. .sp -1
  9804. .IP \(bu 2.3
  9805. .\}
  9806. File inclusion (\fB:include:\fR
  9807. \fB/path/name\fR) is not supported\&.
  9808. .RE
  9809. .sp
  9810. .RS 4
  9811. .ie n \{\
  9812. \h'-04'\(bu\h'+03'\c
  9813. .\}
  9814. .el \{\
  9815. .sp -1
  9816. .IP \(bu 2.3
  9817. .\}
  9818. Warnings are printed on the standard error output for any explicitly unsupported constructs, and any other lines that are not recognized by the parser\&.
  9819. .RE
  9820. .RE
  9821. .RE
  9822. .PP
  9823. sendemail\&.annotate, sendemail\&.bcc, sendemail\&.cc, sendemail\&.ccCmd, sendemail\&.chainReplyTo, sendemail\&.envelopeSender, sendemail\&.from, sendemail\&.headerCmd, sendemail\&.signedOffByCc, sendemail\&.smtpPass, sendemail\&.suppressCc, sendemail\&.suppressFrom, sendemail\&.to, sendemail\&.toCmd, sendemail\&.smtpDomain, sendemail\&.smtpServer, sendemail\&.smtpServerPort, sendemail\&.smtpServerOption, sendemail\&.smtpUser, sendemail\&.thread, sendemail\&.transferEncoding, sendemail\&.validate, sendemail\&.xmailer
  9824. .RS 4
  9825. These configuration variables all provide a default for
  9826. \fBgit-send-email\fR(1)
  9827. command\-line options\&. See its documentation for details\&.
  9828. .RE
  9829. .PP
  9830. sendemail\&.signedOffCc (deprecated)
  9831. .RS 4
  9832. Deprecated alias for
  9833. \fBsendemail\&.signedOffByCc\fR\&.
  9834. .RE
  9835. .PP
  9836. sendemail\&.smtpBatchSize
  9837. .RS 4
  9838. Number of messages to be sent per connection, after that a relogin will happen\&. If the value is 0 or undefined, send all messages in one connection\&. See also the
  9839. \fB\-\-batch\-size\fR
  9840. option of
  9841. \fBgit-send-email\fR(1)\&.
  9842. .RE
  9843. .PP
  9844. sendemail\&.smtpReloginDelay
  9845. .RS 4
  9846. Seconds to wait before reconnecting to the smtp server\&. See also the
  9847. \fB\-\-relogin\-delay\fR
  9848. option of
  9849. \fBgit-send-email\fR(1)\&.
  9850. .RE
  9851. .PP
  9852. sendemail\&.forbidSendmailVariables
  9853. .RS 4
  9854. To avoid common misconfiguration mistakes,
  9855. \fBgit-send-email\fR(1)
  9856. will abort with a warning if any configuration options for "sendmail" exist\&. Set this variable to bypass the check\&.
  9857. .RE
  9858. .PP
  9859. sequence\&.editor
  9860. .RS 4
  9861. Text editor used by
  9862. \fBgit\fR
  9863. \fBrebase\fR
  9864. \fB\-i\fR
  9865. for editing the rebase instruction file\&. The value is meant to be interpreted by the shell when it is used\&. It can be overridden by the
  9866. \fBGIT_SEQUENCE_EDITOR\fR
  9867. environment variable\&. When not configured, the default commit message editor is used instead\&.
  9868. .RE
  9869. .PP
  9870. showBranch\&.default
  9871. .RS 4
  9872. The default set of branches for
  9873. \fBgit-show-branch\fR(1)\&. See
  9874. \fBgit-show-branch\fR(1)\&.
  9875. .RE
  9876. .PP
  9877. sparse\&.expectFilesOutsideOfPatterns
  9878. .RS 4
  9879. Typically with sparse checkouts, files not matching any sparsity patterns are marked with a SKIP_WORKTREE bit in the index and are missing from the working tree\&. Accordingly, Git will ordinarily check whether files with the SKIP_WORKTREE bit are in fact present in the working tree contrary to expectations\&. If Git finds any, it marks those paths as present by clearing the relevant SKIP_WORKTREE bits\&. This option can be used to tell Git that such present\-despite\-skipped files are expected and to stop checking for them\&.
  9880. .sp
  9881. The default is
  9882. \fBfalse\fR, which allows Git to automatically recover from the list of files in the index and working tree falling out of sync\&.
  9883. .sp
  9884. Set this to
  9885. \fBtrue\fR
  9886. if you are in a setup where some external factor relieves Git of the responsibility for maintaining the consistency between the presence of working tree files and sparsity patterns\&. For example, if you have a Git\-aware virtual file system that has a robust mechanism for keeping the working tree and the sparsity patterns up to date based on access patterns\&.
  9887. .sp
  9888. Regardless of this setting, Git does not check for present\-despite\-skipped files unless sparse checkout is enabled, so this config option has no effect unless
  9889. \fBcore\&.sparseCheckout\fR
  9890. is
  9891. \fBtrue\fR\&.
  9892. .RE
  9893. .PP
  9894. splitIndex\&.maxPercentChange
  9895. .RS 4
  9896. When the split index feature is used, this specifies the percent of entries the split index can contain compared to the total number of entries in both the split index and the shared index before a new shared index is written\&. The value should be between 0 and 100\&. If the value is 0, then a new shared index is always written; if it is 100, a new shared index is never written\&. By default, the value is 20, so a new shared index is written if the number of entries in the split index would be greater than 20 percent of the total number of entries\&. See
  9897. \fBgit-update-index\fR(1)\&.
  9898. .RE
  9899. .PP
  9900. splitIndex\&.sharedIndexExpire
  9901. .RS 4
  9902. When the split index feature is used, shared index files that were not modified since the time this variable specifies will be removed when a new shared index file is created\&. The value "now" expires all entries immediately, and "never" suppresses expiration altogether\&. The default value is "2\&.weeks\&.ago"\&. Note that a shared index file is considered modified (for the purpose of expiration) each time a new split\-index file is either created based on it or read from it\&. See
  9903. \fBgit-update-index\fR(1)\&.
  9904. .RE
  9905. .PP
  9906. ssh\&.variant
  9907. .RS 4
  9908. By default, Git determines the command line arguments to use based on the basename of the configured SSH command (configured using the environment variable
  9909. \fBGIT_SSH\fR
  9910. or
  9911. \fBGIT_SSH_COMMAND\fR
  9912. or the config setting
  9913. \fBcore\&.sshCommand\fR)\&. If the basename is unrecognized, Git will attempt to detect support of OpenSSH options by first invoking the configured SSH command with the
  9914. \fB\-G\fR
  9915. (print configuration) option and will subsequently use OpenSSH options (if that is successful) or no options besides the host and remote command (if it fails)\&.
  9916. .sp
  9917. The config variable
  9918. \fBssh\&.variant\fR
  9919. can be set to override this detection\&. Valid values are
  9920. \fBssh\fR
  9921. (to use OpenSSH options),
  9922. \fBplink\fR,
  9923. \fBputty\fR,
  9924. \fBtortoiseplink\fR,
  9925. \fBsimple\fR
  9926. (no options except the host and remote command)\&. The default auto\-detection can be explicitly requested using the value
  9927. \fBauto\fR\&. Any other value is treated as
  9928. \fBssh\fR\&. This setting can also be overridden via the environment variable
  9929. \fBGIT_SSH_VARIANT\fR\&.
  9930. .sp
  9931. The current command\-line parameters used for each variant are as follows:
  9932. .sp
  9933. .RS 4
  9934. .ie n \{\
  9935. \h'-04'\(bu\h'+03'\c
  9936. .\}
  9937. .el \{\
  9938. .sp -1
  9939. .IP \(bu 2.3
  9940. .\}
  9941. \fBssh\fR
  9942. \- [\-p port] [\-4] [\-6] [\-o option] [username@]host command
  9943. .RE
  9944. .sp
  9945. .RS 4
  9946. .ie n \{\
  9947. \h'-04'\(bu\h'+03'\c
  9948. .\}
  9949. .el \{\
  9950. .sp -1
  9951. .IP \(bu 2.3
  9952. .\}
  9953. \fBsimple\fR
  9954. \- [username@]host command
  9955. .RE
  9956. .sp
  9957. .RS 4
  9958. .ie n \{\
  9959. \h'-04'\(bu\h'+03'\c
  9960. .\}
  9961. .el \{\
  9962. .sp -1
  9963. .IP \(bu 2.3
  9964. .\}
  9965. \fBplink\fR
  9966. or
  9967. \fBputty\fR
  9968. \- [\-P port] [\-4] [\-6] [username@]host command
  9969. .RE
  9970. .sp
  9971. .RS 4
  9972. .ie n \{\
  9973. \h'-04'\(bu\h'+03'\c
  9974. .\}
  9975. .el \{\
  9976. .sp -1
  9977. .IP \(bu 2.3
  9978. .\}
  9979. \fBtortoiseplink\fR
  9980. \- [\-P port] [\-4] [\-6] \-batch [username@]host command
  9981. .RE
  9982. .sp
  9983. Except for the
  9984. \fBsimple\fR
  9985. variant, command\-line parameters are likely to change as git gains new features\&.
  9986. .RE
  9987. .PP
  9988. stash\&.showIncludeUntracked
  9989. .RS 4
  9990. If this is set to true, the
  9991. \fBgit\fR
  9992. \fBstash\fR
  9993. \fBshow\fR
  9994. command will show the untracked files of a stash entry\&. Defaults to false\&. See the description of the
  9995. \fIshow\fR
  9996. command in
  9997. \fBgit-stash\fR(1)\&.
  9998. .RE
  9999. .PP
  10000. stash\&.showPatch
  10001. .RS 4
  10002. If this is set to true, the
  10003. \fBgit\fR
  10004. \fBstash\fR
  10005. \fBshow\fR
  10006. command without an option will show the stash entry in patch form\&. Defaults to false\&. See the description of the
  10007. \fIshow\fR
  10008. command in
  10009. \fBgit-stash\fR(1)\&.
  10010. .RE
  10011. .PP
  10012. stash\&.showStat
  10013. .RS 4
  10014. If this is set to true, the
  10015. \fBgit\fR
  10016. \fBstash\fR
  10017. \fBshow\fR
  10018. command without an option will show a diffstat of the stash entry\&. Defaults to true\&. See the description of the
  10019. \fIshow\fR
  10020. command in
  10021. \fBgit-stash\fR(1)\&.
  10022. .RE
  10023. .PP
  10024. status\&.relativePaths
  10025. .RS 4
  10026. By default,
  10027. \fBgit-status\fR(1)
  10028. shows paths relative to the current directory\&. Setting this variable to
  10029. \fBfalse\fR
  10030. shows paths relative to the repository root (this was the default for Git prior to v1\&.5\&.4)\&.
  10031. .RE
  10032. .PP
  10033. status\&.short
  10034. .RS 4
  10035. Set to true to enable \-\-short by default in
  10036. \fBgit-status\fR(1)\&. The option \-\-no\-short takes precedence over this variable\&.
  10037. .RE
  10038. .PP
  10039. status\&.branch
  10040. .RS 4
  10041. Set to true to enable \-\-branch by default in
  10042. \fBgit-status\fR(1)\&. The option \-\-no\-branch takes precedence over this variable\&.
  10043. .RE
  10044. .PP
  10045. status\&.aheadBehind
  10046. .RS 4
  10047. Set to true to enable
  10048. \fB\-\-ahead\-behind\fR
  10049. and false to enable
  10050. \fB\-\-no\-ahead\-behind\fR
  10051. by default in
  10052. \fBgit-status\fR(1)
  10053. for non\-porcelain status formats\&. Defaults to true\&.
  10054. .RE
  10055. .PP
  10056. status\&.displayCommentPrefix
  10057. .RS 4
  10058. If set to true,
  10059. \fBgit-status\fR(1)
  10060. will insert a comment prefix before each output line (starting with
  10061. \fBcore\&.commentChar\fR, i\&.e\&. # by default)\&. This was the behavior of
  10062. \fBgit-status\fR(1)
  10063. in Git 1\&.8\&.4 and previous\&. Defaults to false\&.
  10064. .RE
  10065. .PP
  10066. status\&.renameLimit
  10067. .RS 4
  10068. The number of files to consider when performing rename detection in
  10069. \fBgit-status\fR(1)
  10070. and
  10071. \fBgit-commit\fR(1)\&. Defaults to the value of diff\&.renameLimit\&.
  10072. .RE
  10073. .PP
  10074. status\&.renames
  10075. .RS 4
  10076. Whether and how Git detects renames in
  10077. \fBgit-status\fR(1)
  10078. and
  10079. \fBgit-commit\fR(1)
  10080. \&. If set to "false", rename detection is disabled\&. If set to "true", basic rename detection is enabled\&. If set to "copies" or "copy", Git will detect copies, as well\&. Defaults to the value of diff\&.renames\&.
  10081. .RE
  10082. .PP
  10083. status\&.showStash
  10084. .RS 4
  10085. If set to true,
  10086. \fBgit-status\fR(1)
  10087. will display the number of entries currently stashed away\&. Defaults to false\&.
  10088. .RE
  10089. .PP
  10090. status\&.showUntrackedFiles
  10091. .RS 4
  10092. By default,
  10093. \fBgit-status\fR(1)
  10094. and
  10095. \fBgit-commit\fR(1)
  10096. show files which are not currently tracked by Git\&. Directories which contain only untracked files, are shown with the directory name only\&. Showing untracked files means that Git needs to lstat() all the files in the whole repository, which might be slow on some systems\&. So, this variable controls how the commands display the untracked files\&. Possible values are:
  10097. .sp
  10098. .RS 4
  10099. .ie n \{\
  10100. \h'-04'\(bu\h'+03'\c
  10101. .\}
  10102. .el \{\
  10103. .sp -1
  10104. .IP \(bu 2.3
  10105. .\}
  10106. \fBno\fR
  10107. \- Show no untracked files\&.
  10108. .RE
  10109. .sp
  10110. .RS 4
  10111. .ie n \{\
  10112. \h'-04'\(bu\h'+03'\c
  10113. .\}
  10114. .el \{\
  10115. .sp -1
  10116. .IP \(bu 2.3
  10117. .\}
  10118. \fBnormal\fR
  10119. \- Show untracked files and directories\&.
  10120. .RE
  10121. .sp
  10122. .RS 4
  10123. .ie n \{\
  10124. \h'-04'\(bu\h'+03'\c
  10125. .\}
  10126. .el \{\
  10127. .sp -1
  10128. .IP \(bu 2.3
  10129. .\}
  10130. \fBall\fR
  10131. \- Show also individual files in untracked directories\&.
  10132. .RE
  10133. .sp
  10134. If this variable is not specified, it defaults to
  10135. \fInormal\fR\&. All usual spellings for Boolean value
  10136. \fBtrue\fR
  10137. are taken as
  10138. \fBnormal\fR
  10139. and
  10140. \fBfalse\fR
  10141. as
  10142. \fBno\fR\&. This variable can be overridden with the \-u|\-\-untracked\-files option of
  10143. \fBgit-status\fR(1)
  10144. and
  10145. \fBgit-commit\fR(1)\&.
  10146. .RE
  10147. .PP
  10148. status\&.submoduleSummary
  10149. .RS 4
  10150. Defaults to false\&. If this is set to a non\-zero number or true (identical to \-1 or an unlimited number), the submodule summary will be enabled and a summary of commits for modified submodules will be shown (see \-\-summary\-limit option of
  10151. \fBgit-submodule\fR(1))\&. Please note that the summary output command will be suppressed for all submodules when
  10152. \fBdiff\&.ignoreSubmodules\fR
  10153. is set to
  10154. \fIall\fR
  10155. or only for those submodules where
  10156. \fBsubmodule\&.\fR\fI<name>\fR\fB\&.ignore=all\fR\&. The only exception to that rule is that status and commit will show staged submodule changes\&. To also view the summary for ignored submodules you can either use the \-\-ignore\-submodules=dirty command\-line option or the
  10157. \fIgit submodule summary\fR
  10158. command, which shows a similar output but does not honor these settings\&.
  10159. .RE
  10160. .PP
  10161. submodule\&.<name>\&.url
  10162. .RS 4
  10163. The URL for a submodule\&. This variable is copied from the \&.gitmodules file to the git config via
  10164. \fIgit submodule init\fR\&. The user can change the configured URL before obtaining the submodule via
  10165. \fIgit submodule update\fR\&. If neither submodule\&.<name>\&.active nor submodule\&.active are set, the presence of this variable is used as a fallback to indicate whether the submodule is of interest to git commands\&. See
  10166. \fBgit-submodule\fR(1)
  10167. and
  10168. \fBgitmodules\fR(5)
  10169. for details\&.
  10170. .RE
  10171. .PP
  10172. submodule\&.<name>\&.update
  10173. .RS 4
  10174. The method by which a submodule is updated by
  10175. \fIgit submodule update\fR, which is the only affected command, others such as
  10176. \fIgit checkout \-\-recurse\-submodules\fR
  10177. are unaffected\&. It exists for historical reasons, when
  10178. \fIgit submodule\fR
  10179. was the only command to interact with submodules; settings like
  10180. \fBsubmodule\&.active\fR
  10181. and
  10182. \fBpull\&.rebase\fR
  10183. are more specific\&. It is populated by
  10184. \fBgit\fR
  10185. \fBsubmodule\fR
  10186. \fBinit\fR
  10187. from the
  10188. \fBgitmodules\fR(5)
  10189. file\&. See description of
  10190. \fIupdate\fR
  10191. command in
  10192. \fBgit-submodule\fR(1)\&.
  10193. .RE
  10194. .PP
  10195. submodule\&.<name>\&.branch
  10196. .RS 4
  10197. The remote branch name for a submodule, used by
  10198. \fBgit\fR
  10199. \fBsubmodule\fR
  10200. \fBupdate\fR
  10201. \fB\-\-remote\fR\&. Set this option to override the value found in the \&.\fBgitmodules\fR
  10202. file\&. See
  10203. \fBgit-submodule\fR(1)
  10204. and
  10205. \fBgitmodules\fR(5)
  10206. for details\&.
  10207. .RE
  10208. .PP
  10209. submodule\&.<name>\&.fetchRecurseSubmodules
  10210. .RS 4
  10211. This option can be used to control recursive fetching of this submodule\&. It can be overridden by using the \-\-[no\-]recurse\-submodules command\-line option to "git fetch" and "git pull"\&. This setting will override that from in the
  10212. \fBgitmodules\fR(5)
  10213. file\&.
  10214. .RE
  10215. .PP
  10216. submodule\&.<name>\&.ignore
  10217. .RS 4
  10218. Defines under what circumstances "git status" and the diff family show a submodule as modified\&. When set to "all", it will never be considered modified (but it will nonetheless show up in the output of status and commit when it has been staged), "dirty" will ignore all changes to the submodule\(cqs work tree and takes only differences between the HEAD of the submodule and the commit recorded in the superproject into account\&. "untracked" will additionally let submodules with modified tracked files in their work tree show up\&. Using "none" (the default when this option is not set) also shows submodules that have untracked files in their work tree as changed\&. This setting overrides any setting made in \&.gitmodules for this submodule, both settings can be overridden on the command line by using the "\-\-ignore\-submodules" option\&. The
  10219. \fIgit submodule\fR
  10220. commands are not affected by this setting\&.
  10221. .RE
  10222. .PP
  10223. submodule\&.<name>\&.active
  10224. .RS 4
  10225. Boolean value indicating if the submodule is of interest to git commands\&. This config option takes precedence over the submodule\&.active config option\&. See
  10226. \fBgitsubmodules\fR(7)
  10227. for details\&.
  10228. .RE
  10229. .PP
  10230. submodule\&.active
  10231. .RS 4
  10232. A repeated field which contains a pathspec used to match against a submodule\(cqs path to determine if the submodule is of interest to git commands\&. See
  10233. \fBgitsubmodules\fR(7)
  10234. for details\&.
  10235. .RE
  10236. .PP
  10237. submodule\&.recurse
  10238. .RS 4
  10239. A boolean indicating if commands should enable the
  10240. \fB\-\-recurse\-submodules\fR
  10241. option by default\&. Defaults to false\&.
  10242. .sp
  10243. When set to true, it can be deactivated via the
  10244. \fB\-\-no\-recurse\-submodules\fR
  10245. option\&. Note that some Git commands lacking this option may call some of the above commands affected by
  10246. \fBsubmodule\&.recurse\fR; for instance
  10247. \fBgit\fR
  10248. \fBremote\fR
  10249. \fBupdate\fR
  10250. will call
  10251. \fBgit\fR
  10252. \fBfetch\fR
  10253. but does not have a
  10254. \fB\-\-no\-recurse\-submodules\fR
  10255. option\&. For these commands a workaround is to temporarily change the configuration value by using
  10256. \fBgit\fR
  10257. \fB\-c\fR
  10258. \fBsubmodule\&.recurse=0\fR\&.
  10259. .sp
  10260. The following list shows the commands that accept
  10261. \fB\-\-recurse\-submodules\fR
  10262. and whether they are supported by this setting\&.
  10263. .sp
  10264. .RS 4
  10265. .ie n \{\
  10266. \h'-04'\(bu\h'+03'\c
  10267. .\}
  10268. .el \{\
  10269. .sp -1
  10270. .IP \(bu 2.3
  10271. .\}
  10272. \fBcheckout\fR,
  10273. \fBfetch\fR,
  10274. \fBgrep\fR,
  10275. \fBpull\fR,
  10276. \fBpush\fR,
  10277. \fBread\-tree\fR,
  10278. \fBreset\fR,
  10279. \fBrestore\fR
  10280. and
  10281. \fBswitch\fR
  10282. are always supported\&.
  10283. .RE
  10284. .sp
  10285. .RS 4
  10286. .ie n \{\
  10287. \h'-04'\(bu\h'+03'\c
  10288. .\}
  10289. .el \{\
  10290. .sp -1
  10291. .IP \(bu 2.3
  10292. .\}
  10293. \fBclone\fR
  10294. and
  10295. \fBls\-files\fR
  10296. are not supported\&.
  10297. .RE
  10298. .sp
  10299. .RS 4
  10300. .ie n \{\
  10301. \h'-04'\(bu\h'+03'\c
  10302. .\}
  10303. .el \{\
  10304. .sp -1
  10305. .IP \(bu 2.3
  10306. .\}
  10307. \fBbranch\fR
  10308. is supported only if
  10309. \fBsubmodule\&.propagateBranches\fR
  10310. is enabled
  10311. .RE
  10312. .RE
  10313. .PP
  10314. submodule\&.propagateBranches
  10315. .RS 4
  10316. [EXPERIMENTAL] A boolean that enables branching support when using
  10317. \fB\-\-recurse\-submodules\fR
  10318. or
  10319. \fBsubmodule\&.recurse=true\fR\&. Enabling this will allow certain commands to accept
  10320. \fB\-\-recurse\-submodules\fR
  10321. and certain commands that already accept
  10322. \fB\-\-recurse\-submodules\fR
  10323. will now consider branches\&. Defaults to false\&.
  10324. .RE
  10325. .PP
  10326. submodule\&.fetchJobs
  10327. .RS 4
  10328. Specifies how many submodules are fetched/cloned at the same time\&. A positive integer allows up to that number of submodules fetched in parallel\&. A value of 0 will give some reasonable default\&. If unset, it defaults to 1\&.
  10329. .RE
  10330. .PP
  10331. submodule\&.alternateLocation
  10332. .RS 4
  10333. Specifies how the submodules obtain alternates when submodules are cloned\&. Possible values are
  10334. \fBno\fR,
  10335. \fBsuperproject\fR\&. By default
  10336. \fBno\fR
  10337. is assumed, which doesn\(cqt add references\&. When the value is set to
  10338. \fBsuperproject\fR
  10339. the submodule to be cloned computes its alternates location relative to the superprojects alternate\&.
  10340. .RE
  10341. .PP
  10342. submodule\&.alternateErrorStrategy
  10343. .RS 4
  10344. Specifies how to treat errors with the alternates for a submodule as computed via
  10345. \fBsubmodule\&.alternateLocation\fR\&. Possible values are
  10346. \fBignore\fR,
  10347. \fBinfo\fR,
  10348. \fBdie\fR\&. Default is
  10349. \fBdie\fR\&. Note that if set to
  10350. \fBignore\fR
  10351. or
  10352. \fBinfo\fR, and if there is an error with the computed alternate, the clone proceeds as if no alternate was specified\&.
  10353. .RE
  10354. .PP
  10355. tag\&.forceSignAnnotated
  10356. .RS 4
  10357. A boolean to specify whether annotated tags created should be GPG signed\&. If
  10358. \fB\-\-annotate\fR
  10359. is specified on the command line, it takes precedence over this option\&.
  10360. .RE
  10361. .PP
  10362. tag\&.sort
  10363. .RS 4
  10364. This variable controls the sort ordering of tags when displayed by
  10365. \fBgit-tag\fR(1)\&. Without the "\-\-sort=<value>" option provided, the value of this variable will be used as the default\&.
  10366. .RE
  10367. .PP
  10368. tag\&.gpgSign
  10369. .RS 4
  10370. A boolean to specify whether all tags should be GPG signed\&. Use of this option when running in an automated script can result in a large number of tags being signed\&. It is therefore convenient to use an agent to avoid typing your gpg passphrase several times\&. Note that this option doesn\(cqt affect tag signing behavior enabled by "\-u <keyid>" or "\-\-local\-user=<keyid>" options\&.
  10371. .RE
  10372. .PP
  10373. tar\&.umask
  10374. .RS 4
  10375. This variable can be used to restrict the permission bits of tar archive entries\&. The default is 0002, which turns off the world write bit\&. The special value "user" indicates that the archiving user\(cqs umask will be used instead\&. See umask(2) and
  10376. \fBgit-archive\fR(1)\&.
  10377. .RE
  10378. .sp
  10379. Trace2 config settings are only read from the system and global config files; repository local and worktree config files and \fB\-c\fR command line arguments are not respected\&.
  10380. .PP
  10381. trace2\&.normalTarget
  10382. .RS 4
  10383. This variable controls the normal target destination\&. It may be overridden by the
  10384. \fBGIT_TRACE2\fR
  10385. environment variable\&. The following table shows possible values\&.
  10386. .RE
  10387. .PP
  10388. trace2\&.perfTarget
  10389. .RS 4
  10390. This variable controls the performance target destination\&. It may be overridden by the
  10391. \fBGIT_TRACE2_PERF\fR
  10392. environment variable\&. The following table shows possible values\&.
  10393. .RE
  10394. .PP
  10395. trace2\&.eventTarget
  10396. .RS 4
  10397. This variable controls the event target destination\&. It may be overridden by the
  10398. \fBGIT_TRACE2_EVENT\fR
  10399. environment variable\&. The following table shows possible values\&.
  10400. .sp
  10401. .RS 4
  10402. .ie n \{\
  10403. \h'-04'\(bu\h'+03'\c
  10404. .\}
  10405. .el \{\
  10406. .sp -1
  10407. .IP \(bu 2.3
  10408. .\}
  10409. \fB0\fR
  10410. or
  10411. \fBfalse\fR
  10412. \- Disables the target\&.
  10413. .RE
  10414. .sp
  10415. .RS 4
  10416. .ie n \{\
  10417. \h'-04'\(bu\h'+03'\c
  10418. .\}
  10419. .el \{\
  10420. .sp -1
  10421. .IP \(bu 2.3
  10422. .\}
  10423. \fB1\fR
  10424. or
  10425. \fBtrue\fR
  10426. \- Writes to
  10427. \fBSTDERR\fR\&.
  10428. .RE
  10429. .sp
  10430. .RS 4
  10431. .ie n \{\
  10432. \h'-04'\(bu\h'+03'\c
  10433. .\}
  10434. .el \{\
  10435. .sp -1
  10436. .IP \(bu 2.3
  10437. .\}
  10438. [\fB2\-9\fR] \- Writes to the already opened file descriptor\&.
  10439. .RE
  10440. .sp
  10441. .RS 4
  10442. .ie n \{\
  10443. \h'-04'\(bu\h'+03'\c
  10444. .\}
  10445. .el \{\
  10446. .sp -1
  10447. .IP \(bu 2.3
  10448. .\}
  10449. \fI<absolute\-pathname>\fR
  10450. \- Writes to the file in append mode\&. If the target already exists and is a directory, the traces will be written to files (one per process) underneath the given directory\&.
  10451. .RE
  10452. .sp
  10453. .RS 4
  10454. .ie n \{\
  10455. \h'-04'\(bu\h'+03'\c
  10456. .\}
  10457. .el \{\
  10458. .sp -1
  10459. .IP \(bu 2.3
  10460. .\}
  10461. \fBaf_unix:\fR[\fI<socket\-type>\fR\fB:\fR]\fI<absolute\-pathname>\fR
  10462. \- Write to a Unix DomainSocket (on platforms that support them)\&. Socket type can be either
  10463. \fBstream\fR
  10464. or
  10465. \fBdgram\fR; if omitted Git will try both\&.
  10466. .RE
  10467. .RE
  10468. .PP
  10469. trace2\&.normalBrief
  10470. .RS 4
  10471. Boolean\&. When true
  10472. \fBtime\fR,
  10473. \fBfilename\fR, and
  10474. \fBline\fR
  10475. fields are omitted from normal output\&. May be overridden by the
  10476. \fBGIT_TRACE2_BRIEF\fR
  10477. environment variable\&. Defaults to false\&.
  10478. .RE
  10479. .PP
  10480. trace2\&.perfBrief
  10481. .RS 4
  10482. Boolean\&. When true
  10483. \fBtime\fR,
  10484. \fBfilename\fR, and
  10485. \fBline\fR
  10486. fields are omitted from PERF output\&. May be overridden by the
  10487. \fBGIT_TRACE2_PERF_BRIEF\fR
  10488. environment variable\&. Defaults to false\&.
  10489. .RE
  10490. .PP
  10491. trace2\&.eventBrief
  10492. .RS 4
  10493. Boolean\&. When true
  10494. \fBtime\fR,
  10495. \fBfilename\fR, and
  10496. \fBline\fR
  10497. fields are omitted from event output\&. May be overridden by the
  10498. \fBGIT_TRACE2_EVENT_BRIEF\fR
  10499. environment variable\&. Defaults to false\&.
  10500. .RE
  10501. .PP
  10502. trace2\&.eventNesting
  10503. .RS 4
  10504. Integer\&. Specifies desired depth of nested regions in the event output\&. Regions deeper than this value will be omitted\&. May be overridden by the
  10505. \fBGIT_TRACE2_EVENT_NESTING\fR
  10506. environment variable\&. Defaults to 2\&.
  10507. .RE
  10508. .PP
  10509. trace2\&.configParams
  10510. .RS 4
  10511. A comma\-separated list of patterns of "important" config settings that should be recorded in the trace2 output\&. For example,
  10512. \fBcore\&.\fR*,remote\&.*\&.\fBurl\fR
  10513. would cause the trace2 output to contain events listing each configured remote\&. May be overridden by the
  10514. \fBGIT_TRACE2_CONFIG_PARAMS\fR
  10515. environment variable\&. Unset by default\&.
  10516. .RE
  10517. .PP
  10518. trace2\&.envVars
  10519. .RS 4
  10520. A comma\-separated list of "important" environment variables that should be recorded in the trace2 output\&. For example,
  10521. \fBGIT_HTTP_USER_AGENT,GIT_CONFIG\fR
  10522. would cause the trace2 output to contain events listing the overrides for HTTP user agent and the location of the Git configuration file (assuming any are set)\&. May be overridden by the
  10523. \fBGIT_TRACE2_ENV_VARS\fR
  10524. environment variable\&. Unset by default\&.
  10525. .RE
  10526. .PP
  10527. trace2\&.destinationDebug
  10528. .RS 4
  10529. Boolean\&. When true Git will print error messages when a trace target destination cannot be opened for writing\&. By default, these errors are suppressed and tracing is silently disabled\&. May be overridden by the
  10530. \fBGIT_TRACE2_DST_DEBUG\fR
  10531. environment variable\&.
  10532. .RE
  10533. .PP
  10534. trace2\&.maxFiles
  10535. .RS 4
  10536. Integer\&. When writing trace files to a target directory, do not write additional traces if doing so would exceed this many files\&. Instead, write a sentinel file that will block further tracing to this directory\&. Defaults to 0, which disables this check\&.
  10537. .RE
  10538. .PP
  10539. trailer\&.separators
  10540. .RS 4
  10541. This option tells which characters are recognized as trailer separators\&. By default only
  10542. \fI:\fR
  10543. is recognized as a trailer separator, except that
  10544. \fI=\fR
  10545. is always accepted on the command line for compatibility with other git commands\&.
  10546. .sp
  10547. The first character given by this option will be the default character used when another separator is not specified in the config for this trailer\&.
  10548. .sp
  10549. For example, if the value for this option is "%=$", then only lines using the format
  10550. \fI<key><sep><value>\fR
  10551. with <sep> containing
  10552. \fI%\fR,
  10553. \fI=\fR
  10554. or
  10555. \fI$\fR
  10556. and then spaces will be considered trailers\&. And
  10557. \fI%\fR
  10558. will be the default separator used, so by default trailers will appear like:
  10559. \fI<key>% <value>\fR
  10560. (one percent sign and one space will appear between the key and the value)\&.
  10561. .RE
  10562. .PP
  10563. trailer\&.where
  10564. .RS 4
  10565. This option tells where a new trailer will be added\&.
  10566. .sp
  10567. This can be
  10568. \fBend\fR, which is the default,
  10569. \fBstart\fR,
  10570. \fBafter\fR
  10571. or
  10572. \fBbefore\fR\&.
  10573. .sp
  10574. If it is
  10575. \fBend\fR, then each new trailer will appear at the end of the existing trailers\&.
  10576. .sp
  10577. If it is
  10578. \fBstart\fR, then each new trailer will appear at the start, instead of the end, of the existing trailers\&.
  10579. .sp
  10580. If it is
  10581. \fBafter\fR, then each new trailer will appear just after the last trailer with the same <key>\&.
  10582. .sp
  10583. If it is
  10584. \fBbefore\fR, then each new trailer will appear just before the first trailer with the same <key>\&.
  10585. .RE
  10586. .PP
  10587. trailer\&.ifexists
  10588. .RS 4
  10589. This option makes it possible to choose what action will be performed when there is already at least one trailer with the same <key> in the input\&.
  10590. .sp
  10591. The valid values for this option are:
  10592. \fBaddIfDifferentNeighbor\fR
  10593. (this is the default),
  10594. \fBaddIfDifferent\fR,
  10595. \fBadd\fR,
  10596. \fBreplace\fR
  10597. or
  10598. \fBdoNothing\fR\&.
  10599. .sp
  10600. With
  10601. \fBaddIfDifferentNeighbor\fR, a new trailer will be added only if no trailer with the same (<key>, <value>) pair is above or below the line where the new trailer will be added\&.
  10602. .sp
  10603. With
  10604. \fBaddIfDifferent\fR, a new trailer will be added only if no trailer with the same (<key>, <value>) pair is already in the input\&.
  10605. .sp
  10606. With
  10607. \fBadd\fR, a new trailer will be added, even if some trailers with the same (<key>, <value>) pair are already in the input\&.
  10608. .sp
  10609. With
  10610. \fBreplace\fR, an existing trailer with the same <key> will be deleted and the new trailer will be added\&. The deleted trailer will be the closest one (with the same <key>) to the place where the new one will be added\&.
  10611. .sp
  10612. With
  10613. \fBdoNothing\fR, nothing will be done; that is no new trailer will be added if there is already one with the same <key> in the input\&.
  10614. .RE
  10615. .PP
  10616. trailer\&.ifmissing
  10617. .RS 4
  10618. This option makes it possible to choose what action will be performed when there is not yet any trailer with the same <key> in the input\&.
  10619. .sp
  10620. The valid values for this option are:
  10621. \fBadd\fR
  10622. (this is the default) and
  10623. \fBdoNothing\fR\&.
  10624. .sp
  10625. With
  10626. \fBadd\fR, a new trailer will be added\&.
  10627. .sp
  10628. With
  10629. \fBdoNothing\fR, nothing will be done\&.
  10630. .RE
  10631. .PP
  10632. trailer\&.<keyAlias>\&.key
  10633. .RS 4
  10634. Defines a <keyAlias> for the <key>\&. The <keyAlias> must be a prefix (case does not matter) of the <key>\&. For example, in
  10635. \fBgit\fR
  10636. \fBconfig\fR
  10637. \fBtrailer\&.ack\&.key\fR
  10638. "Acked\-by" the "Acked\-by" is the <key> and the "ack" is the <keyAlias>\&. This configuration allows the shorter
  10639. \fB\-\-trailer\fR
  10640. "ack:\fB\&.\&.\&.\fR" invocation on the command line using the "ack" <keyAlias> instead of the longer
  10641. \fB\-\-trailer\fR
  10642. "Acked\-by:\fB\&.\&.\&.\fR"\&.
  10643. .sp
  10644. At the end of the <key>, a separator can appear and then some space characters\&. By default the only valid separator is
  10645. \fI:\fR, but this can be changed using the
  10646. \fBtrailer\&.separators\fR
  10647. config variable\&.
  10648. .sp
  10649. If there is a separator in the key, then it overrides the default separator when adding the trailer\&.
  10650. .RE
  10651. .PP
  10652. trailer\&.<keyAlias>\&.where
  10653. .RS 4
  10654. This option takes the same values as the
  10655. \fItrailer\&.where\fR
  10656. configuration variable and it overrides what is specified by that option for trailers with the specified <keyAlias>\&.
  10657. .RE
  10658. .PP
  10659. trailer\&.<keyAlias>\&.ifexists
  10660. .RS 4
  10661. This option takes the same values as the
  10662. \fItrailer\&.ifexists\fR
  10663. configuration variable and it overrides what is specified by that option for trailers with the specified <keyAlias>\&.
  10664. .RE
  10665. .PP
  10666. trailer\&.<keyAlias>\&.ifmissing
  10667. .RS 4
  10668. This option takes the same values as the
  10669. \fItrailer\&.ifmissing\fR
  10670. configuration variable and it overrides what is specified by that option for trailers with the specified <keyAlias>\&.
  10671. .RE
  10672. .PP
  10673. trailer\&.<keyAlias>\&.command
  10674. .RS 4
  10675. Deprecated in favor of
  10676. \fItrailer\&.<keyAlias>\&.cmd\fR\&. This option behaves in the same way as
  10677. \fItrailer\&.<keyAlias>\&.cmd\fR, except that it doesn\(cqt pass anything as argument to the specified command\&. Instead the first occurrence of substring $ARG is replaced by the <value> that would be passed as argument\&.
  10678. .sp
  10679. Note that $ARG in the user\(cqs command is only replaced once and that the original way of replacing $ARG is not safe\&.
  10680. .sp
  10681. When both
  10682. \fItrailer\&.<keyAlias>\&.cmd\fR
  10683. and
  10684. \fItrailer\&.<keyAlias>\&.command\fR
  10685. are given for the same <keyAlias>,
  10686. \fItrailer\&.<keyAlias>\&.cmd\fR
  10687. is used and
  10688. \fItrailer\&.<keyAlias>\&.command\fR
  10689. is ignored\&.
  10690. .RE
  10691. .PP
  10692. trailer\&.<keyAlias>\&.cmd
  10693. .RS 4
  10694. This option can be used to specify a shell command that will be called once to automatically add a trailer with the specified <keyAlias>, and then called each time a
  10695. \fI\-\-trailer <keyAlias>=<value>\fR
  10696. argument is specified to modify the <value> of the trailer that this option would produce\&.
  10697. .sp
  10698. When the specified command is first called to add a trailer with the specified <keyAlias>, the behavior is as if a special
  10699. \fI\-\-trailer <keyAlias>=<value>\fR
  10700. argument was added at the beginning of the "git interpret\-trailers" command, where <value> is taken to be the standard output of the command with any leading and trailing whitespace trimmed off\&.
  10701. .sp
  10702. If some
  10703. \fI\-\-trailer <keyAlias>=<value>\fR
  10704. arguments are also passed on the command line, the command is called again once for each of these arguments with the same <keyAlias>\&. And the <value> part of these arguments, if any, will be passed to the command as its first argument\&. This way the command can produce a <value> computed from the <value> passed in the
  10705. \fI\-\-trailer <keyAlias>=<value>\fR
  10706. argument\&.
  10707. .RE
  10708. .PP
  10709. transfer\&.credentialsInUrl
  10710. .RS 4
  10711. A configured URL can contain plaintext credentials in the form
  10712. \fI<protocol>\fR\fB://\fR\fI<user>\fR\fB:\fR\fI<password>\fR\fB@\fR\fI<domain>\fR\fB/\fR\fI<path>\fR\&. You may want to warn or forbid the use of such configuration (in favor of using
  10713. \fBgit-credential\fR(1))\&. This will be used on
  10714. \fBgit-clone\fR(1),
  10715. \fBgit-fetch\fR(1),
  10716. \fBgit-push\fR(1), and any other direct use of the configured URL\&.
  10717. .sp
  10718. Note that this is currently limited to detecting credentials in
  10719. \fBremote\&.\fR\fI<name>\fR\fB\&.url\fR
  10720. configuration; it won\(cqt detect credentials in
  10721. \fBremote\&.\fR\fI<name>\fR\fB\&.pushurl\fR
  10722. configuration\&.
  10723. .sp
  10724. You might want to enable this to prevent inadvertent credentials exposure, e\&.g\&. because:
  10725. .sp
  10726. .RS 4
  10727. .ie n \{\
  10728. \h'-04'\(bu\h'+03'\c
  10729. .\}
  10730. .el \{\
  10731. .sp -1
  10732. .IP \(bu 2.3
  10733. .\}
  10734. The OS or system where you\(cqre running git may not provide a way or otherwise allow you to configure the permissions of the configuration file where the username and/or password are stored\&.
  10735. .RE
  10736. .sp
  10737. .RS 4
  10738. .ie n \{\
  10739. \h'-04'\(bu\h'+03'\c
  10740. .\}
  10741. .el \{\
  10742. .sp -1
  10743. .IP \(bu 2.3
  10744. .\}
  10745. Even if it does, having such data stored "at rest" might expose you in other ways, e\&.g\&. a backup process might copy the data to another system\&.
  10746. .RE
  10747. .sp
  10748. .RS 4
  10749. .ie n \{\
  10750. \h'-04'\(bu\h'+03'\c
  10751. .\}
  10752. .el \{\
  10753. .sp -1
  10754. .IP \(bu 2.3
  10755. .\}
  10756. The git programs will pass the full URL to one another as arguments on the command\-line, meaning the credentials will be exposed to other unprivileged users on systems that allow them to see the full process list of other users\&. On linux the "hidepid" setting documented in procfs(5) allows for configuring this behavior\&.
  10757. .sp
  10758. If such concerns don\(cqt apply to you then you probably don\(cqt need to be concerned about credentials exposure due to storing sensitive data in git\(cqs configuration files\&. If you do want to use this, set
  10759. \fBtransfer\&.credentialsInUrl\fR
  10760. to one of these values:
  10761. .RE
  10762. .sp
  10763. .RS 4
  10764. .ie n \{\
  10765. \h'-04'\(bu\h'+03'\c
  10766. .\}
  10767. .el \{\
  10768. .sp -1
  10769. .IP \(bu 2.3
  10770. .\}
  10771. \fBallow\fR
  10772. (default): Git will proceed with its activity without warning\&.
  10773. .RE
  10774. .sp
  10775. .RS 4
  10776. .ie n \{\
  10777. \h'-04'\(bu\h'+03'\c
  10778. .\}
  10779. .el \{\
  10780. .sp -1
  10781. .IP \(bu 2.3
  10782. .\}
  10783. \fBwarn\fR: Git will write a warning message to
  10784. \fBstderr\fR
  10785. when parsing a URL with a plaintext credential\&.
  10786. .RE
  10787. .sp
  10788. .RS 4
  10789. .ie n \{\
  10790. \h'-04'\(bu\h'+03'\c
  10791. .\}
  10792. .el \{\
  10793. .sp -1
  10794. .IP \(bu 2.3
  10795. .\}
  10796. \fBdie\fR: Git will write a failure message to
  10797. \fBstderr\fR
  10798. when parsing a URL with a plaintext credential\&.
  10799. .RE
  10800. .RE
  10801. .PP
  10802. transfer\&.fsckObjects
  10803. .RS 4
  10804. When
  10805. \fBfetch\&.fsckObjects\fR
  10806. or
  10807. \fBreceive\&.fsckObjects\fR
  10808. are not set, the value of this variable is used instead\&. Defaults to false\&.
  10809. .sp
  10810. When set, the fetch or receive will abort in the case of a malformed object or a link to a nonexistent object\&. In addition, various other issues are checked for, including legacy issues (see
  10811. \fBfsck\&.\fR\fI<msg\-id>\fR), and potential security issues like the existence of a \&.\fBGIT\fR
  10812. directory or a malicious \&.\fBgitmodules\fR
  10813. file (see the release notes for v2\&.2\&.1 and v2\&.17\&.1 for details)\&. Other sanity and security checks may be added in future releases\&.
  10814. .sp
  10815. On the receiving side, failing fsckObjects will make those objects unreachable, see "QUARANTINE ENVIRONMENT" in
  10816. \fBgit-receive-pack\fR(1)\&. On the fetch side, malformed objects will instead be left unreferenced in the repository\&.
  10817. .sp
  10818. Due to the non\-quarantine nature of the
  10819. \fBfetch\&.fsckObjects\fR
  10820. implementation it cannot be relied upon to leave the object store clean like
  10821. \fBreceive\&.fsckObjects\fR
  10822. can\&.
  10823. .sp
  10824. As objects are unpacked they\(cqre written to the object store, so there can be cases where malicious objects get introduced even though the "fetch" failed, only to have a subsequent "fetch" succeed because only new incoming objects are checked, not those that have already been written to the object store\&. That difference in behavior should not be relied upon\&. In the future, such objects may be quarantined for "fetch" as well\&.
  10825. .sp
  10826. For now, the paranoid need to find some way to emulate the quarantine environment if they\(cqd like the same protection as "push"\&. E\&.g\&. in the case of an internal mirror do the mirroring in two steps, one to fetch the untrusted objects, and then do a second "push" (which will use the quarantine) to another internal repo, and have internal clients consume this pushed\-to repository, or embargo internal fetches and only allow them once a full "fsck" has run (and no new fetches have happened in the meantime)\&.
  10827. .RE
  10828. .PP
  10829. transfer\&.hideRefs
  10830. .RS 4
  10831. String(s)
  10832. \fBreceive\-pack\fR
  10833. and
  10834. \fBupload\-pack\fR
  10835. use to decide which refs to omit from their initial advertisements\&. Use more than one definition to specify multiple prefix strings\&. A ref that is under the hierarchies listed in the value of this variable is excluded, and is hidden when responding to
  10836. \fBgit\fR
  10837. \fBpush\fR
  10838. or
  10839. \fBgit\fR
  10840. \fBfetch\fR\&. See
  10841. \fBreceive\&.hideRefs\fR
  10842. and
  10843. \fBuploadpack\&.hideRefs\fR
  10844. for program\-specific versions of this config\&.
  10845. .sp
  10846. You may also include a ! in front of the ref name to negate the entry, explicitly exposing it, even if an earlier entry marked it as hidden\&. If you have multiple hideRefs values, later entries override earlier ones (and entries in more\-specific config files override less\-specific ones)\&.
  10847. .sp
  10848. If a namespace is in use, the namespace prefix is stripped from each reference before it is matched against
  10849. \fBtransfer\&.hiderefs\fR
  10850. patterns\&. In order to match refs before stripping, add a
  10851. \fB^\fR
  10852. in front of the ref name\&. If you combine ! and
  10853. \fB^\fR, ! must be specified first\&.
  10854. .sp
  10855. For example, if
  10856. \fBrefs/heads/master\fR
  10857. is specified in
  10858. \fBtransfer\&.hideRefs\fR
  10859. and the current namespace is
  10860. \fBfoo\fR, then
  10861. \fBrefs/namespaces/foo/refs/heads/master\fR
  10862. is omitted from the advertisements\&. If
  10863. \fBuploadpack\&.allowRefInWant\fR
  10864. is set,
  10865. \fBupload\-pack\fR
  10866. will treat
  10867. \fBwant\-ref\fR
  10868. \fBrefs/heads/master\fR
  10869. in a protocol v2
  10870. \fBfetch\fR
  10871. command as if
  10872. \fBrefs/namespaces/foo/refs/heads/master\fR
  10873. did not exist\&.
  10874. \fBreceive\-pack\fR, on the other hand, will still advertise the object id the ref is pointing to without mentioning its name (a so\-called "\&.have" line)\&.
  10875. .sp
  10876. Even if you hide refs, a client may still be able to steal the target objects via the techniques described in the "SECURITY" section of the
  10877. \fBgitnamespaces\fR(7)
  10878. man page; it\(cqs best to keep private data in a separate repository\&.
  10879. .RE
  10880. .PP
  10881. transfer\&.unpackLimit
  10882. .RS 4
  10883. When
  10884. \fBfetch\&.unpackLimit\fR
  10885. or
  10886. \fBreceive\&.unpackLimit\fR
  10887. are not set, the value of this variable is used instead\&. The default value is 100\&.
  10888. .RE
  10889. .PP
  10890. transfer\&.advertiseSID
  10891. .RS 4
  10892. Boolean\&. When true, client and server processes will advertise their unique session IDs to their remote counterpart\&. Defaults to false\&.
  10893. .RE
  10894. .PP
  10895. transfer\&.bundleURI
  10896. .RS 4
  10897. When
  10898. \fBtrue\fR, local
  10899. \fBgit\fR
  10900. \fBclone\fR
  10901. commands will request bundle information from the remote server (if advertised) and download bundles before continuing the clone through the Git protocol\&. Defaults to
  10902. \fBfalse\fR\&.
  10903. .RE
  10904. .PP
  10905. transfer\&.advertiseObjectInfo
  10906. .RS 4
  10907. When
  10908. \fBtrue\fR, the
  10909. \fBobject\-info\fR
  10910. capability is advertised by servers\&. Defaults to false\&.
  10911. .RE
  10912. .PP
  10913. uploadarchive\&.allowUnreachable
  10914. .RS 4
  10915. If true, allow clients to use
  10916. \fBgit\fR
  10917. \fBarchive\fR
  10918. \fB\-\-remote\fR
  10919. to request any tree, whether reachable from the ref tips or not\&. See the discussion in the "SECURITY" section of
  10920. \fBgit-upload-archive\fR(1)
  10921. for more details\&. Defaults to
  10922. \fBfalse\fR\&.
  10923. .RE
  10924. .PP
  10925. uploadpack\&.hideRefs
  10926. .RS 4
  10927. This variable is the same as
  10928. \fBtransfer\&.hideRefs\fR, but applies only to
  10929. \fBupload\-pack\fR
  10930. (and so affects only fetches, not pushes)\&. An attempt to fetch a hidden ref by
  10931. \fBgit\fR
  10932. \fBfetch\fR
  10933. will fail\&. See also
  10934. \fBuploadpack\&.allowTipSHA1InWant\fR\&.
  10935. .RE
  10936. .PP
  10937. uploadpack\&.allowTipSHA1InWant
  10938. .RS 4
  10939. When
  10940. \fBuploadpack\&.hideRefs\fR
  10941. is in effect, allow
  10942. \fBupload\-pack\fR
  10943. to accept a fetch request that asks for an object at the tip of a hidden ref (by default, such a request is rejected)\&. See also
  10944. \fBuploadpack\&.hideRefs\fR\&. Even if this is false, a client may be able to steal objects via the techniques described in the "SECURITY" section of the
  10945. \fBgitnamespaces\fR(7)
  10946. man page; it\(cqs best to keep private data in a separate repository\&.
  10947. .RE
  10948. .PP
  10949. uploadpack\&.allowReachableSHA1InWant
  10950. .RS 4
  10951. Allow
  10952. \fBupload\-pack\fR
  10953. to accept a fetch request that asks for an object that is reachable from any ref tip\&. However, note that calculating object reachability is computationally expensive\&. Defaults to
  10954. \fBfalse\fR\&. Even if this is false, a client may be able to steal objects via the techniques described in the "SECURITY" section of the
  10955. \fBgitnamespaces\fR(7)
  10956. man page; it\(cqs best to keep private data in a separate repository\&.
  10957. .RE
  10958. .PP
  10959. uploadpack\&.allowAnySHA1InWant
  10960. .RS 4
  10961. Allow
  10962. \fBupload\-pack\fR
  10963. to accept a fetch request that asks for any object at all\&. It implies
  10964. \fBuploadpack\&.allowTipSHA1InWant\fR
  10965. and
  10966. \fBuploadpack\&.allowReachableSHA1InWant\fR\&. If set to
  10967. \fBtrue\fR
  10968. it will enable both of them, it set to
  10969. \fBfalse\fR
  10970. it will disable both of them\&. By default not set\&.
  10971. .RE
  10972. .PP
  10973. uploadpack\&.keepAlive
  10974. .RS 4
  10975. When
  10976. \fBupload\-pack\fR
  10977. has started
  10978. \fBpack\-objects\fR, there may be a quiet period while
  10979. \fBpack\-objects\fR
  10980. prepares the pack\&. Normally it would output progress information, but if
  10981. \fB\-\-quiet\fR
  10982. was used for the fetch,
  10983. \fBpack\-objects\fR
  10984. will output nothing at all until the pack data begins\&. Some clients and networks may consider the server to be hung and give up\&. Setting this option instructs
  10985. \fBupload\-pack\fR
  10986. to send an empty keepalive packet every
  10987. \fBuploadpack\&.keepAlive\fR
  10988. seconds\&. Setting this option to 0 disables keepalive packets entirely\&. The default is 5 seconds\&.
  10989. .RE
  10990. .PP
  10991. uploadpack\&.packObjectsHook
  10992. .RS 4
  10993. If this option is set, when
  10994. \fBupload\-pack\fR
  10995. would run
  10996. \fBgit\fR
  10997. \fBpack\-objects\fR
  10998. to create a packfile for a client, it will run this shell command instead\&. The
  10999. \fBpack\-objects\fR
  11000. command and arguments it
  11001. \fIwould\fR
  11002. have run (including the
  11003. \fBgit\fR
  11004. \fBpack\-objects\fR
  11005. at the beginning) are appended to the shell command\&. The stdin and stdout of the hook are treated as if
  11006. \fBpack\-objects\fR
  11007. itself was run\&. I\&.e\&.,
  11008. \fBupload\-pack\fR
  11009. will feed input intended for
  11010. \fBpack\-objects\fR
  11011. to the hook, and expects a completed packfile on stdout\&.
  11012. .sp
  11013. Note that this configuration variable is only respected when it is specified in protected configuration (see
  11014. the section called \(lqSCOPES\(rq)\&. This is a safety measure against fetching from untrusted repositories\&.
  11015. .RE
  11016. .PP
  11017. uploadpack\&.allowFilter
  11018. .RS 4
  11019. If this option is set,
  11020. \fBupload\-pack\fR
  11021. will support partial clone and partial fetch object filtering\&.
  11022. .RE
  11023. .PP
  11024. uploadpackfilter\&.allow
  11025. .RS 4
  11026. Provides a default value for unspecified object filters (see: the below configuration variable)\&. If set to
  11027. \fBtrue\fR, this will also enable all filters which get added in the future\&. Defaults to
  11028. \fBtrue\fR\&.
  11029. .RE
  11030. .PP
  11031. uploadpackfilter\&.<filter>\&.allow
  11032. .RS 4
  11033. Explicitly allow or ban the object filter corresponding to
  11034. \fI<filter>\fR, where
  11035. \fI<filter>\fR
  11036. may be one of:
  11037. \fBblob:none\fR,
  11038. \fBblob:limit\fR,
  11039. \fBobject:type\fR,
  11040. \fBtree\fR,
  11041. \fBsparse:oid\fR, or
  11042. \fBcombine\fR\&. If using combined filters, both
  11043. \fBcombine\fR
  11044. and all of the nested filter kinds must be allowed\&. Defaults to
  11045. \fBuploadpackfilter\&.allow\fR\&.
  11046. .RE
  11047. .PP
  11048. uploadpackfilter\&.tree\&.maxDepth
  11049. .RS 4
  11050. Only allow
  11051. \fB\-\-filter=tree:\fR\fI<n>\fR
  11052. when
  11053. \fI<n>\fR
  11054. is no more than the value of
  11055. \fBuploadpackfilter\&.tree\&.maxDepth\fR\&. If set, this also implies
  11056. \fBuploadpackfilter\&.tree\&.allow=true\fR, unless this configuration variable had already been set\&. Has no effect if unset\&.
  11057. .RE
  11058. .PP
  11059. uploadpack\&.allowRefInWant
  11060. .RS 4
  11061. If this option is set,
  11062. \fBupload\-pack\fR
  11063. will support the
  11064. \fBref\-in\-want\fR
  11065. feature of the protocol version 2
  11066. \fBfetch\fR
  11067. command\&. This feature is intended for the benefit of load\-balanced servers which may not have the same view of what OIDs their refs point to due to replication delay\&.
  11068. .RE
  11069. .PP
  11070. url\&.<base>\&.insteadOf
  11071. .RS 4
  11072. Any URL that starts with this value will be rewritten to start, instead, with <base>\&. In cases where some site serves a large number of repositories, and serves them with multiple access methods, and some users need to use different access methods, this feature allows people to specify any of the equivalent URLs and have Git automatically rewrite the URL to the best alternative for the particular user, even for a never\-before\-seen repository on the site\&. When more than one insteadOf strings match a given URL, the longest match is used\&.
  11073. .sp
  11074. Note that any protocol restrictions will be applied to the rewritten URL\&. If the rewrite changes the URL to use a custom protocol or remote helper, you may need to adjust the
  11075. \fBprotocol\&.\fR*\&.\fBallow\fR
  11076. config to permit the request\&. In particular, protocols you expect to use for submodules must be set to
  11077. \fBalways\fR
  11078. rather than the default of
  11079. \fBuser\fR\&. See the description of
  11080. \fBprotocol\&.allow\fR
  11081. above\&.
  11082. .RE
  11083. .PP
  11084. url\&.<base>\&.pushInsteadOf
  11085. .RS 4
  11086. Any URL that starts with this value will not be pushed to; instead, it will be rewritten to start with <base>, and the resulting URL will be pushed to\&. In cases where some site serves a large number of repositories, and serves them with multiple access methods, some of which do not allow push, this feature allows people to specify a pull\-only URL and have Git automatically use an appropriate URL to push, even for a never\-before\-seen repository on the site\&. When more than one pushInsteadOf strings match a given URL, the longest match is used\&. If a remote has an explicit pushurl, Git will ignore this setting for that remote\&.
  11087. .RE
  11088. .PP
  11089. user\&.name, user\&.email, author\&.name, author\&.email, committer\&.name, committer\&.email
  11090. .RS 4
  11091. The
  11092. \fBuser\&.name\fR
  11093. and
  11094. \fBuser\&.email\fR
  11095. variables determine what ends up in the
  11096. \fBauthor\fR
  11097. and
  11098. \fBcommitter\fR
  11099. fields of commit objects\&. If you need the
  11100. \fBauthor\fR
  11101. or
  11102. \fBcommitter\fR
  11103. to be different, the
  11104. \fBauthor\&.name\fR,
  11105. \fBauthor\&.email\fR,
  11106. \fBcommitter\&.name\fR, or
  11107. \fBcommitter\&.email\fR
  11108. variables can be set\&. All of these can be overridden by the
  11109. \fBGIT_AUTHOR_NAME\fR,
  11110. \fBGIT_AUTHOR_EMAIL\fR,
  11111. \fBGIT_COMMITTER_NAME\fR,
  11112. \fBGIT_COMMITTER_EMAIL\fR, and
  11113. \fBEMAIL\fR
  11114. environment variables\&.
  11115. .sp
  11116. Note that the
  11117. \fBname\fR
  11118. forms of these variables conventionally refer to some form of a personal name\&. See
  11119. \fBgit-commit\fR(1)
  11120. and the environment variables section of
  11121. \fBgit\fR(1)
  11122. for more information on these settings and the
  11123. \fBcredential\&.username\fR
  11124. option if you\(cqre looking for authentication credentials instead\&.
  11125. .RE
  11126. .PP
  11127. user\&.useConfigOnly
  11128. .RS 4
  11129. Instruct Git to avoid trying to guess defaults for
  11130. \fBuser\&.email\fR
  11131. and
  11132. \fBuser\&.name\fR, and instead retrieve the values only from the configuration\&. For example, if you have multiple email addresses and would like to use a different one for each repository, then with this configuration option set to
  11133. \fBtrue\fR
  11134. in the global config along with a name, Git will prompt you to set up an email before making new commits in a newly cloned repository\&. Defaults to
  11135. \fBfalse\fR\&.
  11136. .RE
  11137. .PP
  11138. user\&.signingKey
  11139. .RS 4
  11140. If
  11141. \fBgit-tag\fR(1)
  11142. or
  11143. \fBgit-commit\fR(1)
  11144. is not selecting the key you want it to automatically when creating a signed tag or commit, you can override the default selection with this variable\&. This option is passed unchanged to gpg\(cqs \-\-local\-user parameter, so you may specify a key using any method that gpg supports\&. If gpg\&.format is set to
  11145. \fBssh\fR
  11146. this can contain the path to either your private ssh key or the public key when ssh\-agent is used\&. Alternatively it can contain a public key prefixed with
  11147. \fBkey::\fR
  11148. directly (e\&.g\&.: "key::ssh\-rsa XXXXXX identifier")\&. The private key needs to be available via ssh\-agent\&. If not set Git will call gpg\&.ssh\&.defaultKeyCommand (e\&.g\&.: "ssh\-add \-L") and try to use the first key available\&. For backward compatibility, a raw key which begins with "ssh\-", such as "ssh\-rsa XXXXXX identifier", is treated as "key::ssh\-rsa XXXXXX identifier", but this form is deprecated; use the
  11149. \fBkey::\fR
  11150. form instead\&.
  11151. .RE
  11152. .PP
  11153. versionsort\&.prereleaseSuffix (deprecated)
  11154. .RS 4
  11155. Deprecated alias for
  11156. \fBversionsort\&.suffix\fR\&. Ignored if
  11157. \fBversionsort\&.suffix\fR
  11158. is set\&.
  11159. .RE
  11160. .PP
  11161. versionsort\&.suffix
  11162. .RS 4
  11163. Even when version sort is used in
  11164. \fBgit-tag\fR(1), tagnames with the same base version but different suffixes are still sorted lexicographically, resulting e\&.g\&. in prerelease tags appearing after the main release (e\&.g\&. "1\&.0\-rc1" after "1\&.0")\&. This variable can be specified to determine the sorting order of tags with different suffixes\&.
  11165. .sp
  11166. By specifying a single suffix in this variable, any tagname containing that suffix will appear before the corresponding main release\&. E\&.g\&. if the variable is set to "\-rc", then all "1\&.0\-rcX" tags will appear before "1\&.0"\&. If specified multiple times, once per suffix, then the order of suffixes in the configuration will determine the sorting order of tagnames with those suffixes\&. E\&.g\&. if "\-pre" appears before "\-rc" in the configuration, then all "1\&.0\-preX" tags will be listed before any "1\&.0\-rcX" tags\&. The placement of the main release tag relative to tags with various suffixes can be determined by specifying the empty suffix among those other suffixes\&. E\&.g\&. if the suffixes "\-rc", "", "\-ck", and "\-bfs" appear in the configuration in this order, then all "v4\&.8\-rcX" tags are listed first, followed by "v4\&.8", then "v4\&.8\-ckX" and finally "v4\&.8\-bfsX"\&.
  11167. .sp
  11168. If more than one suffix matches the same tagname, then that tagname will be sorted according to the suffix which starts at the earliest position in the tagname\&. If more than one different matching suffix starts at that earliest position, then that tagname will be sorted according to the longest of those suffixes\&. The sorting order between different suffixes is undefined if they are in multiple config files\&.
  11169. .RE
  11170. .PP
  11171. web\&.browser
  11172. .RS 4
  11173. Specify a web browser that may be used by some commands\&. Currently only
  11174. \fBgit-instaweb\fR(1)
  11175. and
  11176. \fBgit-help\fR(1)
  11177. may use it\&.
  11178. .RE
  11179. .PP
  11180. worktree\&.guessRemote
  11181. .RS 4
  11182. If no branch is specified and neither
  11183. \fB\-b\fR
  11184. nor
  11185. \fB\-B\fR
  11186. nor
  11187. \fB\-\-detach\fR
  11188. is used, then
  11189. \fBgit\fR
  11190. \fBworktree\fR
  11191. \fBadd\fR
  11192. defaults to creating a new branch from HEAD\&. If
  11193. \fBworktree\&.guessRemote\fR
  11194. is set to true,
  11195. \fBworktree\fR
  11196. \fBadd\fR
  11197. tries to find a remote\-tracking branch whose name uniquely matches the new branch name\&. If such a branch exists, it is checked out and set as "upstream" for the new branch\&. If no such match can be found, it falls back to creating a new branch from the current HEAD\&.
  11198. .RE
  11199. .PP
  11200. worktree\&.useRelativePaths
  11201. .RS 4
  11202. Link worktrees using relative paths (when "true") or absolute paths (when "false")\&. This is particularly useful for setups where the repository and worktrees may be moved between different locations or environments\&. Defaults to "false"\&.
  11203. .sp
  11204. Note that setting
  11205. \fBworktree\&.useRelativePaths\fR
  11206. to "true" implies enabling the
  11207. \fBextension\&.relativeWorktrees\fR
  11208. config (see
  11209. \fBgit-config\fR(1)), thus making it incompatible with older versions of Git\&.
  11210. .RE
  11211. .SH "BUGS"
  11212. .sp
  11213. When using the deprecated [\fBsection\&.subsection\fR] syntax, changing a value will result in adding a multi\-line key instead of a change, if the subsection is given with at least one uppercase character\&. For example when the config looks like
  11214. .sp
  11215. .if n \{\
  11216. .RS 4
  11217. .\}
  11218. .nf
  11219.   [section\&.subsection]
  11220.     key = value1
  11221. .fi
  11222. .if n \{\
  11223. .RE
  11224. .\}
  11225. .sp
  11226. and running \fBgit\fR \fBconfig\fR \fBsection\&.Subsection\&.key\fR \fBvalue2\fR will result in
  11227. .sp
  11228. .if n \{\
  11229. .RS 4
  11230. .\}
  11231. .nf
  11232.   [section\&.subsection]
  11233.     key = value1
  11234.     key = value2
  11235. .fi
  11236. .if n \{\
  11237. .RE
  11238. .\}
  11239. .SH "GIT"
  11240. .sp
  11241. Part of the \fBgit\fR(1) suite
  11242. .SH "NOTES"
  11243. .IP " 1." 4
  11244. the bundle URI design document
  11245. .RS 4
  11246. \%git-htmldocs/technical/bundle-uri.html
  11247. .RE