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