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