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