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