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