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