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