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