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