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