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.4/git.html[documentation for release 1.7.6.4]
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].
56 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
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].
65 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
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].
75 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
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].
85 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
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].
95 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
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].
104 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
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].
118 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
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].
126 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
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].
140 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
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].
150 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
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].
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].
167 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
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].
175 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
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].
186 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
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].
197 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
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].
208 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
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].
220 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
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].
233 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
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].
243 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
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].
254 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
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].
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].
270 ============
272 endif::stalenotes[]
274 OPTIONS
275 -------
276 --version::
277 Prints the git suite version that the 'git' program came from.
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 ...`.
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).
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.
302 --html-path::
303 Print the path, without trailing slash, where git's HTML
304 documentation is installed and exit.
306 --man-path::
307 Print the manpath (see `man(1)`) for the man pages for
308 this version of git and exit.
310 --info-path::
311 Print the path where the Info files documenting this
312 version of git are installed and exit.
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).
321 --no-pager::
322 Do not pipe git output into a pager.
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.
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).
337 --namespace=<path>::
338 Set the git namespace. See linkgit:gitnamespaces[7] for more
339 details. Equivalent to setting the `GIT_NAMESPACE` environment
340 variable.
342 --bare::
343 Treat the repository as a bare repository. If GIT_DIR
344 environment is not set, it is set to the current working
345 directory.
347 --no-replace-objects::
348 Do not use replacement refs to replace git objects. See
349 linkgit:git-replace[1] for more information.
352 FURTHER DOCUMENTATION
353 ---------------------
355 See the references above to get started using git. The following is
356 probably more detail than necessary for a first-time user.
358 The link:user-manual.html#git-concepts[git concepts chapter of the
359 user-manual] and linkgit:gitcore-tutorial[7] both provide
360 introductions to the underlying git architecture.
362 See linkgit:gitworkflows[7] for an overview of recommended workflows.
364 See also the link:howto-index.html[howto] documents for some useful
365 examples.
367 The internals are documented in the
368 link:technical/api-index.html[GIT API documentation].
370 GIT COMMANDS
371 ------------
373 We divide git into high level ("porcelain") commands and low level
374 ("plumbing") commands.
376 High-level commands (porcelain)
377 -------------------------------
379 We separate the porcelain commands into the main commands and some
380 ancillary user utilities.
382 Main porcelain commands
383 ~~~~~~~~~~~~~~~~~~~~~~~
385 include::cmds-mainporcelain.txt[]
387 Ancillary Commands
388 ~~~~~~~~~~~~~~~~~~
389 Manipulators:
391 include::cmds-ancillarymanipulators.txt[]
393 Interrogators:
395 include::cmds-ancillaryinterrogators.txt[]
398 Interacting with Others
399 ~~~~~~~~~~~~~~~~~~~~~~~
401 These commands are to interact with foreign SCM and with other
402 people via patch over e-mail.
404 include::cmds-foreignscminterface.txt[]
407 Low-level commands (plumbing)
408 -----------------------------
410 Although git includes its
411 own porcelain layer, its low-level commands are sufficient to support
412 development of alternative porcelains. Developers of such porcelains
413 might start by reading about linkgit:git-update-index[1] and
414 linkgit:git-read-tree[1].
416 The interface (input, output, set of options and the semantics)
417 to these low-level commands are meant to be a lot more stable
418 than Porcelain level commands, because these commands are
419 primarily for scripted use. The interface to Porcelain commands
420 on the other hand are subject to change in order to improve the
421 end user experience.
423 The following description divides
424 the low-level commands into commands that manipulate objects (in
425 the repository, index, and working tree), commands that interrogate and
426 compare objects, and commands that move objects and references between
427 repositories.
430 Manipulation commands
431 ~~~~~~~~~~~~~~~~~~~~~
433 include::cmds-plumbingmanipulators.txt[]
436 Interrogation commands
437 ~~~~~~~~~~~~~~~~~~~~~~
439 include::cmds-plumbinginterrogators.txt[]
441 In general, the interrogate commands do not touch the files in
442 the working tree.
445 Synching repositories
446 ~~~~~~~~~~~~~~~~~~~~~
448 include::cmds-synchingrepositories.txt[]
450 The following are helper commands used by the above; end users
451 typically do not use them directly.
453 include::cmds-synchelpers.txt[]
456 Internal helper commands
457 ~~~~~~~~~~~~~~~~~~~~~~~~
459 These are internal helper commands used by other commands; end
460 users typically do not use them directly.
462 include::cmds-purehelpers.txt[]
465 Configuration Mechanism
466 -----------------------
468 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
469 is used to hold per-repository configuration options. It is a
470 simple text file modeled after `.ini` format familiar to some
471 people. Here is an example:
473 ------------
474 #
475 # A '#' or ';' character indicates a comment.
476 #
478 ; core variables
479 [core]
480 ; Don't trust file modes
481 filemode = false
483 ; user identity
484 [user]
485 name = "Junio C Hamano"
486 email = "junkio@twinsun.com"
488 ------------
490 Various commands read from the configuration file and adjust
491 their operation accordingly. See linkgit:git-config[1] for a
492 list.
495 Identifier Terminology
496 ----------------------
497 <object>::
498 Indicates the object name for any type of object.
500 <blob>::
501 Indicates a blob object name.
503 <tree>::
504 Indicates a tree object name.
506 <commit>::
507 Indicates a commit object name.
509 <tree-ish>::
510 Indicates a tree, commit or tag object name. A
511 command that takes a <tree-ish> argument ultimately wants to
512 operate on a <tree> object but automatically dereferences
513 <commit> and <tag> objects that point at a <tree>.
515 <commit-ish>::
516 Indicates a commit or tag object name. A
517 command that takes a <commit-ish> argument ultimately wants to
518 operate on a <commit> object but automatically dereferences
519 <tag> objects that point at a <commit>.
521 <type>::
522 Indicates that an object type is required.
523 Currently one of: `blob`, `tree`, `commit`, or `tag`.
525 <file>::
526 Indicates a filename - almost always relative to the
527 root of the tree structure `GIT_INDEX_FILE` describes.
529 Symbolic Identifiers
530 --------------------
531 Any git command accepting any <object> can also use the following
532 symbolic notation:
534 HEAD::
535 indicates the head of the current branch.
537 <tag>::
538 a valid tag 'name'
539 (i.e. a `refs/tags/<tag>` reference).
541 <head>::
542 a valid head 'name'
543 (i.e. a `refs/heads/<head>` reference).
545 For a more complete list of ways to spell object names, see
546 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
549 File/Directory Structure
550 ------------------------
552 Please see the linkgit:gitrepository-layout[5] document.
554 Read linkgit:githooks[5] for more details about each hook.
556 Higher level SCMs may provide and manage additional information in the
557 `$GIT_DIR`.
560 Terminology
561 -----------
562 Please see linkgit:gitglossary[7].
565 Environment Variables
566 ---------------------
567 Various git commands use the following environment variables:
569 The git Repository
570 ~~~~~~~~~~~~~~~~~~
571 These environment variables apply to 'all' core git commands. Nb: it
572 is worth noting that they may be used/overridden by SCMS sitting above
573 git so take care if using Cogito etc.
575 'GIT_INDEX_FILE'::
576 This environment allows the specification of an alternate
577 index file. If not specified, the default of `$GIT_DIR/index`
578 is used.
580 'GIT_OBJECT_DIRECTORY'::
581 If the object storage directory is specified via this
582 environment variable then the sha1 directories are created
583 underneath - otherwise the default `$GIT_DIR/objects`
584 directory is used.
586 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
587 Due to the immutable nature of git objects, old objects can be
588 archived into shared, read-only directories. This variable
589 specifies a ":" separated (on Windows ";" separated) list
590 of git object directories which can be used to search for git
591 objects. New objects will not be written to these directories.
593 'GIT_DIR'::
594 If the 'GIT_DIR' environment variable is set then it
595 specifies a path to use instead of the default `.git`
596 for the base of the repository.
598 'GIT_WORK_TREE'::
599 Set the path to the working tree. The value will not be
600 used in combination with repositories found automatically in
601 a .git directory (i.e. $GIT_DIR is not set).
602 This can also be controlled by the '--work-tree' command line
603 option and the core.worktree configuration variable.
605 'GIT_NAMESPACE'::
606 Set the git namespace; see linkgit:gitnamespaces[7] for details.
607 The '--namespace' command-line option also sets this value.
609 'GIT_CEILING_DIRECTORIES'::
610 This should be a colon-separated list of absolute paths.
611 If set, it is a list of directories that git should not chdir
612 up into while looking for a repository directory.
613 It will not exclude the current working directory or
614 a GIT_DIR set on the command line or in the environment.
615 (Useful for excluding slow-loading network directories.)
617 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
618 When run in a directory that does not have ".git" repository
619 directory, git tries to find such a directory in the parent
620 directories to find the top of the working tree, but by default it
621 does not cross filesystem boundaries. This environment variable
622 can be set to true to tell git not to stop at filesystem
623 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
624 an explicit repository directory set via 'GIT_DIR' or on the
625 command line.
627 git Commits
628 ~~~~~~~~~~~
629 'GIT_AUTHOR_NAME'::
630 'GIT_AUTHOR_EMAIL'::
631 'GIT_AUTHOR_DATE'::
632 'GIT_COMMITTER_NAME'::
633 'GIT_COMMITTER_EMAIL'::
634 'GIT_COMMITTER_DATE'::
635 'EMAIL'::
636 see linkgit:git-commit-tree[1]
638 git Diffs
639 ~~~~~~~~~
640 'GIT_DIFF_OPTS'::
641 Only valid setting is "--unified=??" or "-u??" to set the
642 number of context lines shown when a unified diff is created.
643 This takes precedence over any "-U" or "--unified" option
644 value passed on the git diff command line.
646 'GIT_EXTERNAL_DIFF'::
647 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
648 program named by it is called, instead of the diff invocation
649 described above. For a path that is added, removed, or modified,
650 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
652 path old-file old-hex old-mode new-file new-hex new-mode
653 +
654 where:
656 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
657 contents of <old|new>,
658 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
659 <old|new>-mode:: are the octal representation of the file modes.
660 +
661 The file parameters can point at the user's working file
662 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
663 when a new file is added), or a temporary file (e.g. `old-file` in the
664 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
665 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
666 +
667 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
668 parameter, <path>.
670 other
671 ~~~~~
672 'GIT_MERGE_VERBOSITY'::
673 A number controlling the amount of output shown by
674 the recursive merge strategy. Overrides merge.verbosity.
675 See linkgit:git-merge[1]
677 'GIT_PAGER'::
678 This environment variable overrides `$PAGER`. If it is set
679 to an empty string or to the value "cat", git will not launch
680 a pager. See also the `core.pager` option in
681 linkgit:git-config[1].
683 'GIT_SSH'::
684 If this environment variable is set then 'git fetch'
685 and 'git push' will use this command instead
686 of 'ssh' when they need to connect to a remote system.
687 The '$GIT_SSH' command will be given exactly two arguments:
688 the 'username@host' (or just 'host') from the URL and the
689 shell command to execute on that remote system.
690 +
691 To pass options to the program that you want to list in GIT_SSH
692 you will need to wrap the program and options into a shell script,
693 then set GIT_SSH to refer to the shell script.
694 +
695 Usually it is easier to configure any desired options through your
696 personal `.ssh/config` file. Please consult your ssh documentation
697 for further details.
699 'GIT_ASKPASS'::
700 If this environment variable is set, then git commands which need to
701 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
702 will call this program with a suitable prompt as command line argument
703 and read the password from its STDOUT. See also the 'core.askpass'
704 option in linkgit:git-config[1].
706 'GIT_FLUSH'::
707 If this environment variable is set to "1", then commands such
708 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
709 and 'git whatchanged' will force a flush of the output stream
710 after each commit-oriented record have been flushed. If this
711 variable is set to "0", the output of these commands will be done
712 using completely buffered I/O. If this environment variable is
713 not set, git will choose buffered or record-oriented flushing
714 based on whether stdout appears to be redirected to a file or not.
716 'GIT_TRACE'::
717 If this variable is set to "1", "2" or "true" (comparison
718 is case insensitive), git will print `trace:` messages on
719 stderr telling about alias expansion, built-in command
720 execution and external command execution.
721 If this variable is set to an integer value greater than 1
722 and lower than 10 (strictly) then git will interpret this
723 value as an open file descriptor and will try to write the
724 trace messages into this file descriptor.
725 Alternatively, if this variable is set to an absolute path
726 (starting with a '/' character), git will interpret this
727 as a file path and will try to write the trace messages
728 into it.
730 Discussion[[Discussion]]
731 ------------------------
733 More detail on the following is available from the
734 link:user-manual.html#git-concepts[git concepts chapter of the
735 user-manual] and linkgit:gitcore-tutorial[7].
737 A git project normally consists of a working directory with a ".git"
738 subdirectory at the top level. The .git directory contains, among other
739 things, a compressed object database representing the complete history
740 of the project, an "index" file which links that history to the current
741 contents of the working tree, and named pointers into that history such
742 as tags and branch heads.
744 The object database contains objects of three main types: blobs, which
745 hold file data; trees, which point to blobs and other trees to build up
746 directory hierarchies; and commits, which each reference a single tree
747 and some number of parent commits.
749 The commit, equivalent to what other systems call a "changeset" or
750 "version", represents a step in the project's history, and each parent
751 represents an immediately preceding step. Commits with more than one
752 parent represent merges of independent lines of development.
754 All objects are named by the SHA1 hash of their contents, normally
755 written as a string of 40 hex digits. Such names are globally unique.
756 The entire history leading up to a commit can be vouched for by signing
757 just that commit. A fourth object type, the tag, is provided for this
758 purpose.
760 When first created, objects are stored in individual files, but for
761 efficiency may later be compressed together into "pack files".
763 Named pointers called refs mark interesting points in history. A ref
764 may contain the SHA1 name of an object or the name of another ref. Refs
765 with names beginning `ref/head/` contain the SHA1 name of the most
766 recent commit (or "head") of a branch under development. SHA1 names of
767 tags of interest are stored under `ref/tags/`. A special ref named
768 `HEAD` contains the name of the currently checked-out branch.
770 The index file is initialized with a list of all paths and, for each
771 path, a blob object and a set of attributes. The blob object represents
772 the contents of the file as of the head of the current branch. The
773 attributes (last modified time, size, etc.) are taken from the
774 corresponding file in the working tree. Subsequent changes to the
775 working tree can be found by comparing these attributes. The index may
776 be updated with new content, and new commits may be created from the
777 content stored in the index.
779 The index is also capable of storing multiple entries (called "stages")
780 for a given pathname. These stages are used to hold the various
781 unmerged version of a file when a merge is in progress.
783 Authors
784 -------
785 Git was started by Linus Torvalds, and is currently maintained by Junio
786 C Hamano. Numerous contributions have come from the git mailing list
787 <git@vger.kernel.org>. For a more complete list of contributors, see
788 http://git-scm.com/about. If you have a clone of git.git itself, the
789 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
790 the authors for specific parts of the project.
792 Reporting Bugs
793 --------------
795 Report bugs to the Git mailing list <git@vger.kernel.org> where the
796 development and maintenance is primarily done. You do not have to be
797 subscribed to the list to send a message there.
799 SEE ALSO
800 --------
801 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
802 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
803 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
804 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
805 linkgit:gitworkflows[7]
807 GIT
808 ---
809 Part of the linkgit:git[1] suite