]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git.txt
Git 1.7.1.2
[thirdparty/git.git] / Documentation / git.txt
CommitLineData
9e1f0a85 1git(1)
2cf565c5 2======
2cf565c5
DG
3
4NAME
5----
6git - the stupid content tracker
7
8
9SYNOPSIS
10--------
8b70004b 11[verse]
89a56bfb 12'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
b0fa7ab5 13 [-p|--paginate|--no-pager] [--no-replace-objects]
892c41b9
ML
14 [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
15 [--help] COMMAND [ARGS]
2cf565c5
DG
16
17DESCRIPTION
18-----------
23091e95
BF
19Git is a fast, scalable, distributed revision control system with an
20unusually rich command set that provides both high-level operations
21and full access to internals.
22
6998e4db 23See linkgit:gittutorial[7] to get started, then see
23091e95
BF
24link:everyday.html[Everyday Git] for a useful minimum set of commands, and
25"man git-commandname" for documentation of each command. CVS users may
6998e4db
JN
26also want to read linkgit:gitcvs-migration[7]. See
27the link:user-manual.html[Git User's Manual] for a more in-depth
a1dc34fa 28introduction.
cb22bc44 29
4514ad4f 30The COMMAND is either a name of a Git command (see below) or an alias
5162e697 31as defined in the configuration file (see linkgit:git-config[1]).
4514ad4f 32
34b604af
JA
33Formatted and hyperlinked version of the latest git
34documentation can be viewed at
35`http://www.kernel.org/pub/software/scm/git/docs/`.
36
26cfcfbf
JH
37ifdef::stalenotes[]
38[NOTE]
39============
26cfcfbf 40
2ff3f61a
JH
41You are reading the documentation for the latest (possibly
42unreleased) version of git, that is available from 'master'
43branch of the `git.git` repository.
44Documentation for older releases are available here:
43a8e4fe 45
e5498e8a 46
245b10ca 47* link:v1.7.1.2/git.html[documentation for release 1.7.1.2]
d599e048
JH
48
49* release notes for
245b10ca
JH
50 link:RelNotes-1.7.1.2.txt[1.7.1.2],
51 link:RelNotes-1.7.1.1.txt[1.7.1.1],
d599e048
JH
52 link:RelNotes-1.7.1.txt[1.7.1].
53
593ce2be 54* link:v1.7.0.7/git.html[documentation for release 1.7.0.7]
e923eaeb
JH
55
56* release notes for
593ce2be 57 link:RelNotes-1.7.0.7.txt[1.7.0.7],
66cfd102 58 link:RelNotes-1.7.0.6.txt[1.7.0.6],
fcd42401 59 link:RelNotes-1.7.0.5.txt[1.7.0.5],
2be10bb5 60 link:RelNotes-1.7.0.4.txt[1.7.0.4],
0b3dcfe7 61 link:RelNotes-1.7.0.3.txt[1.7.0.3],
97222d96 62 link:RelNotes-1.7.0.2.txt[1.7.0.2],
c5e5f603 63 link:RelNotes-1.7.0.1.txt[1.7.0.1],
e923eaeb
JH
64 link:RelNotes-1.7.0.txt[1.7.0].
65
4133fd25 66* link:v1.6.6.2/git.html[documentation for release 1.6.6.2]
902f2353
JH
67
68* release notes for
4133fd25 69 link:RelNotes-1.6.6.2.txt[1.6.6.2],
9504f3d3 70 link:RelNotes-1.6.6.1.txt[1.6.6.1],
902f2353
JH
71 link:RelNotes-1.6.6.txt[1.6.6].
72
35eabd15 73* link:v1.6.5.8/git.html[documentation for release 1.6.5.8]
78d553b7
JH
74
75* release notes for
35eabd15 76 link:RelNotes-1.6.5.8.txt[1.6.5.8],
527b9d70 77 link:RelNotes-1.6.5.7.txt[1.6.5.7],
9861b644 78 link:RelNotes-1.6.5.6.txt[1.6.5.6],
aa031314 79 link:RelNotes-1.6.5.5.txt[1.6.5.5],
eefe19fb 80 link:RelNotes-1.6.5.4.txt[1.6.5.4],
080cbc12 81 link:RelNotes-1.6.5.3.txt[1.6.5.3],
6c0efa2a 82 link:RelNotes-1.6.5.2.txt[1.6.5.2],
b142da2a 83 link:RelNotes-1.6.5.1.txt[1.6.5.1],
78d553b7
JH
84 link:RelNotes-1.6.5.txt[1.6.5].
85
cb572206 86* link:v1.6.4.4/git.html[documentation for release 1.6.4.4]
0a53e9dd
JH
87
88* release notes for
cb572206 89 link:RelNotes-1.6.4.4.txt[1.6.4.4],
7fb6bcff 90 link:RelNotes-1.6.4.3.txt[1.6.4.3],
82c3e210 91 link:RelNotes-1.6.4.2.txt[1.6.4.2],
d9b9784f 92 link:RelNotes-1.6.4.1.txt[1.6.4.1],
0a53e9dd
JH
93 link:RelNotes-1.6.4.txt[1.6.4].
94
441b40d8 95* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
6096d759
JH
96
97* release notes for
441b40d8 98 link:RelNotes-1.6.3.4.txt[1.6.3.4],
e16a4779 99 link:RelNotes-1.6.3.3.txt[1.6.3.3],
6096d759
JH
100 link:RelNotes-1.6.3.2.txt[1.6.3.2],
101 link:RelNotes-1.6.3.1.txt[1.6.3.1],
102 link:RelNotes-1.6.3.txt[1.6.3].
a95148de
JH
103
104* release notes for
f01f1099
JH
105 link:RelNotes-1.6.2.5.txt[1.6.2.5],
106 link:RelNotes-1.6.2.4.txt[1.6.2.4],
c965c029 107 link:RelNotes-1.6.2.3.txt[1.6.2.3],
54a47493 108 link:RelNotes-1.6.2.2.txt[1.6.2.2],
de769780 109 link:RelNotes-1.6.2.1.txt[1.6.2.1],
a95148de
JH
110 link:RelNotes-1.6.2.txt[1.6.2].
111
621f1b4b 112* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
8104ebfe
JH
113
114* release notes for
621f1b4b
JH
115 link:RelNotes-1.6.1.3.txt[1.6.1.3],
116 link:RelNotes-1.6.1.2.txt[1.6.1.2],
c42b1ad9 117 link:RelNotes-1.6.1.1.txt[1.6.1.1],
8104ebfe
JH
118 link:RelNotes-1.6.1.txt[1.6.1].
119
efe05b01 120* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
ea02eef0
JH
121
122* release notes for
efe05b01 123 link:RelNotes-1.6.0.6.txt[1.6.0.6],
f371d3ea 124 link:RelNotes-1.6.0.5.txt[1.6.0.5],
171d7661
JH
125 link:RelNotes-1.6.0.4.txt[1.6.0.4],
126 link:RelNotes-1.6.0.3.txt[1.6.0.3],
97a7a82f
JH
127 link:RelNotes-1.6.0.2.txt[1.6.0.2],
128 link:RelNotes-1.6.0.1.txt[1.6.0.1],
ea02eef0
JH
129 link:RelNotes-1.6.0.txt[1.6.0].
130
efe05b01 131* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
e449f105
JH
132
133* release notes for
efe05b01 134 link:RelNotes-1.5.6.6.txt[1.5.6.6],
781c1834 135 link:RelNotes-1.5.6.5.txt[1.5.6.5],
09651dd8
JH
136 link:RelNotes-1.5.6.4.txt[1.5.6.4],
137 link:RelNotes-1.5.6.3.txt[1.5.6.3],
138 link:RelNotes-1.5.6.2.txt[1.5.6.2],
139 link:RelNotes-1.5.6.1.txt[1.5.6.1],
e636106c 140 link:RelNotes-1.5.6.txt[1.5.6].
e449f105 141
efe05b01 142* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
1d2375dd
JH
143
144* release notes for
efe05b01
JH
145 link:RelNotes-1.5.5.6.txt[1.5.5.6],
146 link:RelNotes-1.5.5.5.txt[1.5.5.5],
7064ca51 147 link:RelNotes-1.5.5.4.txt[1.5.5.4],
28bc3022 148 link:RelNotes-1.5.5.3.txt[1.5.5.3],
2d3922dc 149 link:RelNotes-1.5.5.2.txt[1.5.5.2],
66aaa2fc 150 link:RelNotes-1.5.5.1.txt[1.5.5.1],
1d2375dd
JH
151 link:RelNotes-1.5.5.txt[1.5.5].
152
efe05b01 153* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
6ce8e44a
JH
154
155* release notes for
efe05b01
JH
156 link:RelNotes-1.5.4.7.txt[1.5.4.7],
157 link:RelNotes-1.5.4.6.txt[1.5.4.6],
803d5158 158 link:RelNotes-1.5.4.5.txt[1.5.4.5],
ad416ed4 159 link:RelNotes-1.5.4.4.txt[1.5.4.4],
923d44ae 160 link:RelNotes-1.5.4.3.txt[1.5.4.3],
cf5c51ef 161 link:RelNotes-1.5.4.2.txt[1.5.4.2],
ecb879f8 162 link:RelNotes-1.5.4.1.txt[1.5.4.1],
6ce8e44a
JH
163 link:RelNotes-1.5.4.txt[1.5.4].
164
e708af6e 165* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
5587cac2
JH
166
167* release notes for
e708af6e 168 link:RelNotes-1.5.3.8.txt[1.5.3.8],
b52e985a 169 link:RelNotes-1.5.3.7.txt[1.5.3.7],
4a44b9ea 170 link:RelNotes-1.5.3.6.txt[1.5.3.6],
afc05f9f 171 link:RelNotes-1.5.3.5.txt[1.5.3.5],
58ba4f6a 172 link:RelNotes-1.5.3.4.txt[1.5.3.4],
326df26d 173 link:RelNotes-1.5.3.3.txt[1.5.3.3],
077d6f72 174 link:RelNotes-1.5.3.2.txt[1.5.3.2],
8d863c98
JH
175 link:RelNotes-1.5.3.1.txt[1.5.3.1],
176 link:RelNotes-1.5.3.txt[1.5.3].
b6e4db6a 177
e636106c
JH
178* link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
179
aba170cd 180* release notes for
da899deb 181 link:RelNotes-1.5.2.5.txt[1.5.2.5],
baafd6e7 182 link:RelNotes-1.5.2.4.txt[1.5.2.4],
444649e5 183 link:RelNotes-1.5.2.3.txt[1.5.2.3],
3e48af38
JH
184 link:RelNotes-1.5.2.2.txt[1.5.2.2],
185 link:RelNotes-1.5.2.1.txt[1.5.2.1],
aba170cd
JH
186 link:RelNotes-1.5.2.txt[1.5.2].
187
188* link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
189
190* release notes for
191 link:RelNotes-1.5.1.6.txt[1.5.1.6],
192 link:RelNotes-1.5.1.5.txt[1.5.1.5],
2ff3f61a
JH
193 link:RelNotes-1.5.1.4.txt[1.5.1.4],
194 link:RelNotes-1.5.1.3.txt[1.5.1.3],
195 link:RelNotes-1.5.1.2.txt[1.5.1.2],
196 link:RelNotes-1.5.1.1.txt[1.5.1.1],
197 link:RelNotes-1.5.1.txt[1.5.1].
198
199* link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
200
aba170cd
JH
201* release notes for
202 link:RelNotes-1.5.0.7.txt[1.5.0.7],
2ff3f61a
JH
203 link:RelNotes-1.5.0.6.txt[1.5.0.6],
204 link:RelNotes-1.5.0.5.txt[1.5.0.5],
205 link:RelNotes-1.5.0.3.txt[1.5.0.3],
206 link:RelNotes-1.5.0.2.txt[1.5.0.2],
207 link:RelNotes-1.5.0.1.txt[1.5.0.1],
208 link:RelNotes-1.5.0.txt[1.5.0].
209
210* documentation for release link:v1.4.4.4/git.html[1.4.4.4],
211 link:v1.3.3/git.html[1.3.3],
212 link:v1.2.6/git.html[1.2.6],
213 link:v1.0.13/git.html[1.0.13].
26cfcfbf
JH
214
215============
216
217endif::stalenotes[]
218
cb22bc44
AE
219OPTIONS
220-------
221--version::
a87cd02c 222 Prints the git suite version that the 'git' program came from.
cb22bc44
AE
223
224--help::
a87cd02c 225 Prints the synopsis and a list of the most commonly used
0f6f195b
CC
226 commands. If the option '--all' or '-a' is given then all
227 available commands are printed. If a git command is named this
228 option will bring up the manual page for that command.
45533d26
CC
229+
230Other options are available to control how the manual page is
5162e697 231displayed. See linkgit:git-help[1] for more information,
db5d6666
JN
232because `git --help ...` is converted internally into `git
233help ...`.
cb22bc44
AE
234
235--exec-path::
a87cd02c 236 Path to wherever your core git programs are installed.
cb22bc44 237 This can also be controlled by setting the GIT_EXEC_PATH
56992f76 238 environment variable. If no path is given, 'git' will print
cb22bc44
AE
239 the current setting and then exit.
240
89a56bfb
MH
241--html-path::
242 Print the path to wherever your git HTML documentation is installed
243 and exit.
244
3240240f
SB
245-p::
246--paginate::
06300d97
JN
247 Pipe all output into 'less' (or if set, $PAGER) if standard
248 output is a terminal. This overrides the `pager.<cmd>`
249 configuration options (see the "Configuration Mechanism" section
250 below).
6acbcb92 251
463a849d
MM
252--no-pager::
253 Do not pipe git output into a pager.
254
6acbcb92
JS
255--git-dir=<path>::
256 Set the path to the repository. This can also be controlled by
302cc11a
LY
257 setting the GIT_DIR environment variable. It can be an absolute
258 path or relative path to current working directory.
6acbcb92 259
892c41b9
ML
260--work-tree=<path>::
261 Set the path to the working tree. The value will not be
262 used in combination with repositories found automatically in
263 a .git directory (i.e. $GIT_DIR is not set).
264 This can also be controlled by setting the GIT_WORK_TREE
265 environment variable and the core.worktree configuration
302cc11a
LY
266 variable. It can be an absolute path or relative path to
267 the directory specified by --git-dir or GIT_DIR.
268 Note: If --git-dir or GIT_DIR are specified but none of
269 --work-tree, GIT_WORK_TREE and core.worktree is specified,
270 the current working directory is regarded as the top directory
271 of your working tree.
892c41b9 272
6acbcb92 273--bare::
9277d602
JH
274 Treat the repository as a bare repository. If GIT_DIR
275 environment is not set, it is set to the current working
276 directory.
277
b0fa7ab5
CC
278--no-replace-objects::
279 Do not use replacement refs to replace git objects. See
280 linkgit:git-replace[1] for more information.
281
9755afbd 282
23091e95
BF
283FURTHER DOCUMENTATION
284---------------------
9755afbd 285
23091e95
BF
286See the references above to get started using git. The following is
287probably more detail than necessary for a first-time user.
8db9307c 288
40dac517 289The link:user-manual.html#git-concepts[git concepts chapter of the
6998e4db 290user-manual] and linkgit:gitcore-tutorial[7] both provide
40dac517 291introductions to the underlying git architecture.
e6fc2346 292
801a011d
TR
293See linkgit:gitworkflows[7] for an overview of recommended workflows.
294
23091e95
BF
295See also the link:howto-index.html[howto] documents for some useful
296examples.
9755afbd 297
6998e4db
JN
298The internals are documented in the
299link:technical/api-index.html[GIT API documentation].
530e741c 300
23091e95
BF
301GIT COMMANDS
302------------
9755afbd 303
23091e95
BF
304We divide git into high level ("porcelain") commands and low level
305("plumbing") commands.
8b15e2fb 306
23091e95
BF
307High-level commands (porcelain)
308-------------------------------
309
310We separate the porcelain commands into the main commands and some
311ancillary user utilities.
312
313Main porcelain commands
314~~~~~~~~~~~~~~~~~~~~~~~
905197de 315
377e8139 316include::cmds-mainporcelain.txt[]
e31bb3bb 317
90933efb 318Ancillary Commands
23091e95 319~~~~~~~~~~~~~~~~~~
2f2de9b4
JH
320Manipulators:
321
377e8139 322include::cmds-ancillarymanipulators.txt[]
204ee6a9 323
90933efb 324Interrogators:
204ee6a9 325
377e8139 326include::cmds-ancillaryinterrogators.txt[]
7fc9d69f 327
89bf2077
JH
328
329Interacting with Others
330~~~~~~~~~~~~~~~~~~~~~~~
331
332These commands are to interact with foreign SCM and with other
333people via patch over e-mail.
334
335include::cmds-foreignscminterface.txt[]
336
337
b1f33d62
RR
338Low-level commands (plumbing)
339-----------------------------
340
341Although git includes its
342own porcelain layer, its low-level commands are sufficient to support
343development of alternative porcelains. Developers of such porcelains
5162e697
DM
344might start by reading about linkgit:git-update-index[1] and
345linkgit:git-read-tree[1].
b1f33d62 346
89bf2077
JH
347The interface (input, output, set of options and the semantics)
348to these low-level commands are meant to be a lot more stable
349than Porcelain level commands, because these commands are
350primarily for scripted use. The interface to Porcelain commands
351on the other hand are subject to change in order to improve the
352end user experience.
353
354The following description divides
355the low-level commands into commands that manipulate objects (in
b1f33d62
RR
356the repository, index, and working tree), commands that interrogate and
357compare objects, and commands that move objects and references between
358repositories.
359
89bf2077 360
b1f33d62
RR
361Manipulation commands
362~~~~~~~~~~~~~~~~~~~~~
b1f33d62 363
377e8139 364include::cmds-plumbingmanipulators.txt[]
b1f33d62
RR
365
366
367Interrogation commands
368~~~~~~~~~~~~~~~~~~~~~~
369
377e8139 370include::cmds-plumbinginterrogators.txt[]
b1f33d62
RR
371
372In general, the interrogate commands do not touch the files in
373the working tree.
374
375
376Synching repositories
377~~~~~~~~~~~~~~~~~~~~~
378
377e8139 379include::cmds-synchingrepositories.txt[]
b1f33d62 380
57f6ec02 381The following are helper commands used by the above; end users
89bf2077
JH
382typically do not use them directly.
383
384include::cmds-synchelpers.txt[]
385
386
387Internal helper commands
388~~~~~~~~~~~~~~~~~~~~~~~~
389
390These are internal helper commands used by other commands; end
391users typically do not use them directly.
392
393include::cmds-purehelpers.txt[]
394
b1f33d62 395
5773c9f2
JH
396Configuration Mechanism
397-----------------------
398
2fa090b6 399Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
5773c9f2 400is used to hold per-repository configuration options. It is a
addf88e4 401simple text file modeled after `.ini` format familiar to some
5773c9f2
JH
402people. Here is an example:
403
404------------
405#
2fa090b6 406# A '#' or ';' character indicates a comment.
5773c9f2
JH
407#
408
409; core variables
410[core]
411 ; Don't trust file modes
412 filemode = false
413
414; user identity
415[user]
416 name = "Junio C Hamano"
417 email = "junkio@twinsun.com"
418
419------------
420
421Various commands read from the configuration file and adjust
06300d97
JN
422their operation accordingly. See linkgit:git-config[1] for a
423list.
5773c9f2
JH
424
425
6c84e2e0 426Identifier Terminology
2cf565c5
DG
427----------------------
428<object>::
2fa090b6 429 Indicates the object name for any type of object.
2cf565c5
DG
430
431<blob>::
2fa090b6 432 Indicates a blob object name.
2cf565c5
DG
433
434<tree>::
2fa090b6 435 Indicates a tree object name.
2cf565c5
DG
436
437<commit>::
2fa090b6 438 Indicates a commit object name.
2cf565c5
DG
439
440<tree-ish>::
2fa090b6 441 Indicates a tree, commit or tag object name. A
6c84e2e0
DG
442 command that takes a <tree-ish> argument ultimately wants to
443 operate on a <tree> object but automatically dereferences
444 <commit> and <tag> objects that point at a <tree>.
2cf565c5 445
043d7605
TT
446<commit-ish>::
447 Indicates a commit or tag object name. A
448 command that takes a <commit-ish> argument ultimately wants to
449 operate on a <commit> object but automatically dereferences
450 <tag> objects that point at a <commit>.
451
2cf565c5
DG
452<type>::
453 Indicates that an object type is required.
2fa090b6 454 Currently one of: `blob`, `tree`, `commit`, or `tag`.
2cf565c5
DG
455
456<file>::
2fa090b6
JH
457 Indicates a filename - almost always relative to the
458 root of the tree structure `GIT_INDEX_FILE` describes.
2cf565c5 459
c1bdacf9
DG
460Symbolic Identifiers
461--------------------
90933efb 462Any git command accepting any <object> can also use the following
6c84e2e0 463symbolic notation:
c1bdacf9
DG
464
465HEAD::
2fa090b6
JH
466 indicates the head of the current branch (i.e. the
467 contents of `$GIT_DIR/HEAD`).
468
c1bdacf9 469<tag>::
2fa090b6
JH
470 a valid tag 'name'
471 (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
472
c1bdacf9 473<head>::
2fa090b6
JH
474 a valid head 'name'
475 (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
476
d47107d8 477For a more complete list of ways to spell object names, see
5162e697 478"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
d47107d8 479
c1bdacf9
DG
480
481File/Directory Structure
482------------------------
c1bdacf9 483
6998e4db 484Please see the linkgit:gitrepository-layout[5] document.
c1bdacf9 485
6998e4db 486Read linkgit:githooks[5] for more details about each hook.
6250ad1e 487
c1bdacf9 488Higher level SCMs may provide and manage additional information in the
2fa090b6 489`$GIT_DIR`.
c1bdacf9 490
a1d4aa74 491
2cf565c5
DG
492Terminology
493-----------
6998e4db 494Please see linkgit:gitglossary[7].
2cf565c5
DG
495
496
497Environment Variables
498---------------------
499Various git commands use the following environment variables:
500
c1bdacf9
DG
501The git Repository
502~~~~~~~~~~~~~~~~~~
503These environment variables apply to 'all' core git commands. Nb: it
504is worth noting that they may be used/overridden by SCMS sitting above
2fa090b6 505git so take care if using Cogito etc.
c1bdacf9
DG
506
507'GIT_INDEX_FILE'::
508 This environment allows the specification of an alternate
5f3aa197
LS
509 index file. If not specified, the default of `$GIT_DIR/index`
510 is used.
c1bdacf9
DG
511
512'GIT_OBJECT_DIRECTORY'::
513 If the object storage directory is specified via this
514 environment variable then the sha1 directories are created
515 underneath - otherwise the default `$GIT_DIR/objects`
516 directory is used.
517
518'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
519 Due to the immutable nature of git objects, old objects can be
520 archived into shared, read-only directories. This variable
80ba074f
JS
521 specifies a ":" separated (on Windows ";" separated) list
522 of git object directories which can be used to search for git
523 objects. New objects will not be written to these directories.
c1bdacf9
DG
524
525'GIT_DIR'::
2fa090b6
JH
526 If the 'GIT_DIR' environment variable is set then it
527 specifies a path to use instead of the default `.git`
528 for the base of the repository.
c1bdacf9 529
892c41b9
ML
530'GIT_WORK_TREE'::
531 Set the path to the working tree. The value will not be
532 used in combination with repositories found automatically in
533 a .git directory (i.e. $GIT_DIR is not set).
534 This can also be controlled by the '--work-tree' command line
535 option and the core.worktree configuration variable.
536
0454dd93
DR
537'GIT_CEILING_DIRECTORIES'::
538 This should be a colon-separated list of absolute paths.
539 If set, it is a list of directories that git should not chdir
540 up into while looking for a repository directory.
541 It will not exclude the current working directory or
542 a GIT_DIR set on the command line or in the environment.
543 (Useful for excluding slow-loading network directories.)
544
c1bdacf9
DG
545git Commits
546~~~~~~~~~~~
547'GIT_AUTHOR_NAME'::
548'GIT_AUTHOR_EMAIL'::
549'GIT_AUTHOR_DATE'::
550'GIT_COMMITTER_NAME'::
551'GIT_COMMITTER_EMAIL'::
4e58bf97 552'GIT_COMMITTER_DATE'::
28a94f88 553'EMAIL'::
5162e697 554 see linkgit:git-commit-tree[1]
c1bdacf9
DG
555
556git Diffs
557~~~~~~~~~
d81ed1b5 558'GIT_DIFF_OPTS'::
fde97d8a
SE
559 Only valid setting is "--unified=??" or "-u??" to set the
560 number of context lines shown when a unified diff is created.
561 This takes precedence over any "-U" or "--unified" option
562 value passed on the git diff command line.
563
d81ed1b5 564'GIT_EXTERNAL_DIFF'::
fde97d8a
SE
565 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
566 program named by it is called, instead of the diff invocation
567 described above. For a path that is added, removed, or modified,
568 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
569
570 path old-file old-hex old-mode new-file new-hex new-mode
571+
572where:
573
574 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
575 contents of <old|new>,
576 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
577 <old|new>-mode:: are the octal representation of the file modes.
578
579+
580The file parameters can point at the user's working file
581(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
582when a new file is added), or a temporary file (e.g. `old-file` in the
583index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
584temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
585+
586For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
587parameter, <path>.
2cf565c5 588
575ba9d6
ML
589other
590~~~~~
dbddb714
JN
591'GIT_MERGE_VERBOSITY'::
592 A number controlling the amount of output shown by
593 the recursive merge strategy. Overrides merge.verbosity.
5162e697 594 See linkgit:git-merge[1]
dbddb714 595
c27d205a 596'GIT_PAGER'::
a7738c77
SG
597 This environment variable overrides `$PAGER`. If it is set
598 to an empty string or to the value "cat", git will not launch
ab54cd6c
JN
599 a pager. See also the `core.pager` option in
600 linkgit:git-config[1].
c27d205a 601
d5538b41 602'GIT_SSH'::
0b444cdb
TR
603 If this environment variable is set then 'git fetch'
604 and 'git push' will use this command instead
2fd02c92 605 of 'ssh' when they need to connect to a remote system.
483bc4f0 606 The '$GIT_SSH' command will be given exactly two arguments:
d5538b41
SP
607 the 'username@host' (or just 'host') from the URL and the
608 shell command to execute on that remote system.
609+
610To pass options to the program that you want to list in GIT_SSH
611you will need to wrap the program and options into a shell script,
612then set GIT_SSH to refer to the shell script.
613+
614Usually it is easier to configure any desired options through your
615personal `.ssh/config` file. Please consult your ssh documentation
616for further details.
617
06f59e9f
TT
618'GIT_FLUSH'::
619 If this environment variable is set to "1", then commands such
0b444cdb
TR
620 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
621 and 'git whatchanged' will force a flush of the output stream
06f59e9f
TT
622 after each commit-oriented record have been flushed. If this
623 variable is set to "0", the output of these commands will be done
624 using completely buffered I/O. If this environment variable is
625 not set, git will choose buffered or record-oriented flushing
626 based on whether stdout appears to be redirected to a file or not.
627
575ba9d6 628'GIT_TRACE'::
2886bdb1
CC
629 If this variable is set to "1", "2" or "true" (comparison
630 is case insensitive), git will print `trace:` messages on
575ba9d6
ML
631 stderr telling about alias expansion, built-in command
632 execution and external command execution.
2886bdb1
CC
633 If this variable is set to an integer value greater than 1
634 and lower than 10 (strictly) then git will interpret this
635 value as an open file descriptor and will try to write the
636 trace messages into this file descriptor.
637 Alternatively, if this variable is set to an absolute path
638 (starting with a '/' character), git will interpret this
639 as a file path and will try to write the trace messages
640 into it.
575ba9d6 641
8db9307c
JH
642Discussion[[Discussion]]
643------------------------
40dac517
BF
644
645More detail on the following is available from the
646link:user-manual.html#git-concepts[git concepts chapter of the
6998e4db 647user-manual] and linkgit:gitcore-tutorial[7].
40dac517
BF
648
649A git project normally consists of a working directory with a ".git"
650subdirectory at the top level. The .git directory contains, among other
651things, a compressed object database representing the complete history
652of the project, an "index" file which links that history to the current
653contents of the working tree, and named pointers into that history such
654as tags and branch heads.
655
656The object database contains objects of three main types: blobs, which
657hold file data; trees, which point to blobs and other trees to build up
02ff6250 658directory hierarchies; and commits, which each reference a single tree
40dac517
BF
659and some number of parent commits.
660
661The commit, equivalent to what other systems call a "changeset" or
662"version", represents a step in the project's history, and each parent
663represents an immediately preceding step. Commits with more than one
664parent represent merges of independent lines of development.
665
666All objects are named by the SHA1 hash of their contents, normally
667written as a string of 40 hex digits. Such names are globally unique.
668The entire history leading up to a commit can be vouched for by signing
669just that commit. A fourth object type, the tag, is provided for this
670purpose.
671
672When first created, objects are stored in individual files, but for
673efficiency may later be compressed together into "pack files".
674
675Named pointers called refs mark interesting points in history. A ref
676may contain the SHA1 name of an object or the name of another ref. Refs
677with names beginning `ref/head/` contain the SHA1 name of the most
02ff6250 678recent commit (or "head") of a branch under development. SHA1 names of
40dac517
BF
679tags of interest are stored under `ref/tags/`. A special ref named
680`HEAD` contains the name of the currently checked-out branch.
681
682The index file is initialized with a list of all paths and, for each
683path, a blob object and a set of attributes. The blob object represents
684the contents of the file as of the head of the current branch. The
685attributes (last modified time, size, etc.) are taken from the
686corresponding file in the working tree. Subsequent changes to the
687working tree can be found by comparing these attributes. The index may
688be updated with new content, and new commits may be created from the
689content stored in the index.
690
691The index is also capable of storing multiple entries (called "stages")
692for a given pathname. These stages are used to hold the various
693unmerged version of a file when a merge is in progress.
6c84e2e0 694
cb22bc44
AE
695Authors
696-------
9755afbd 697* git's founding father is Linus Torvalds <torvalds@osdl.org>.
947ad2e1 698* The current git nurse is Junio C Hamano <gitster@pobox.com>.
0240e21a 699* The git potty was written by Andreas Ericsson <ae@op5.se>.
9755afbd 700* General upbringing is handled by the git-list <git@vger.kernel.org>.
2cf565c5
DG
701
702Documentation
703--------------
9755afbd
JH
704The documentation for git suite was started by David Greaves
705<david@dgreaves.com>, and later enhanced greatly by the
706contributors on the git-list <git@vger.kernel.org>.
2cf565c5 707
497c8331
CC
708SEE ALSO
709--------
710linkgit:gittutorial[7], linkgit:gittutorial-2[7],
5cbef01a 711link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
497c8331 712linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
801a011d
TR
713linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
714linkgit:gitworkflows[7]
497c8331 715
2cf565c5
DG
716GIT
717---
9e1f0a85 718Part of the linkgit:git[1] suite