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