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