Documentation/git.txt

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