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