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