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