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