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