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