Documentation / git.txton commit Merge branch 'mm/two-more-xstrfmt' into maint (f989ac2)
   1git(1)
   2======
   3
   4NAME
   5----
   6git - the stupid content tracker
   7
   8
   9SYNOPSIS
  10--------
  11[verse]
  12'git' [--version] [--help] [-C <path>] [-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    [--super-prefix=<path>]
  17    <command> [<args>]
  18
  19DESCRIPTION
  20-----------
  21Git is a fast, scalable, distributed revision control system with an
  22unusually rich command set that provides both high-level operations
  23and full access to internals.
  24
  25See linkgit:gittutorial[7] to get started, then see
  26linkgit:giteveryday[7] for a useful minimum set of
  27commands.  The link:user-manual.html[Git User's Manual] has a more
  28in-depth introduction.
  29
  30After you mastered the basic concepts, you can come back to this
  31page to learn what commands Git offers.  You can learn more about
  32individual Git commands with "git help command".  linkgit:gitcli[7]
  33manual page gives you an overview of the command-line command syntax.
  34
  35A formatted and hyperlinked copy of the latest Git documentation
  36can be viewed at `https://git.github.io/htmldocs/git.html`.
  37
  38ifdef::stalenotes[]
  39[NOTE]
  40============
  41
  42You are reading the documentation for the latest (possibly
  43unreleased) version of Git, that is available from the 'master'
  44branch of the `git.git` repository.
  45Documentation for older releases are available here:
  46
  47* link:v2.12.0/git.html[documentation for release 2.12.0]
  48
  49* release notes for
  50  link:RelNotes/2.12.0.txt[2.12].
  51
  52* link:v2.11.1/git.html[documentation for release 2.11.1]
  53
  54* release notes for
  55  link:RelNotes/2.11.1.txt[2.11.1],
  56  link:RelNotes/2.11.0.txt[2.11].
  57
  58* link:v2.10.2/git.html[documentation for release 2.10.2]
  59
  60* release notes for
  61  link:RelNotes/2.10.2.txt[2.10.2],
  62  link:RelNotes/2.10.1.txt[2.10.1],
  63  link:RelNotes/2.10.0.txt[2.10].
  64
  65* link:v2.9.3/git.html[documentation for release 2.9.3]
  66
  67* release notes for
  68  link:RelNotes/2.9.3.txt[2.9.3],
  69  link:RelNotes/2.9.2.txt[2.9.2],
  70  link:RelNotes/2.9.1.txt[2.9.1],
  71  link:RelNotes/2.9.0.txt[2.9].
  72
  73* link:v2.8.4/git.html[documentation for release 2.8.4]
  74
  75* release notes for
  76  link:RelNotes/2.8.4.txt[2.8.4],
  77  link:RelNotes/2.8.3.txt[2.8.3],
  78  link:RelNotes/2.8.2.txt[2.8.2],
  79  link:RelNotes/2.8.1.txt[2.8.1],
  80  link:RelNotes/2.8.0.txt[2.8].
  81
  82* link:v2.7.3/git.html[documentation for release 2.7.3]
  83
  84* release notes for
  85  link:RelNotes/2.7.3.txt[2.7.3],
  86  link:RelNotes/2.7.2.txt[2.7.2],
  87  link:RelNotes/2.7.1.txt[2.7.1],
  88  link:RelNotes/2.7.0.txt[2.7].
  89
  90* link:v2.6.6/git.html[documentation for release 2.6.6]
  91
  92* release notes for
  93  link:RelNotes/2.6.6.txt[2.6.6],
  94  link:RelNotes/2.6.5.txt[2.6.5],
  95  link:RelNotes/2.6.4.txt[2.6.4],
  96  link:RelNotes/2.6.3.txt[2.6.3],
  97  link:RelNotes/2.6.2.txt[2.6.2],
  98  link:RelNotes/2.6.1.txt[2.6.1],
  99  link:RelNotes/2.6.0.txt[2.6].
 100
 101* link:v2.5.5/git.html[documentation for release 2.5.5]
 102
 103* release notes for
 104  link:RelNotes/2.5.5.txt[2.5.5],
 105  link:RelNotes/2.5.4.txt[2.5.4],
 106  link:RelNotes/2.5.3.txt[2.5.3],
 107  link:RelNotes/2.5.2.txt[2.5.2],
 108  link:RelNotes/2.5.1.txt[2.5.1],
 109  link:RelNotes/2.5.0.txt[2.5].
 110
 111* link:v2.4.11/git.html[documentation for release 2.4.11]
 112
 113* release notes for
 114  link:RelNotes/2.4.11.txt[2.4.11],
 115  link:RelNotes/2.4.10.txt[2.4.10],
 116  link:RelNotes/2.4.9.txt[2.4.9],
 117  link:RelNotes/2.4.8.txt[2.4.8],
 118  link:RelNotes/2.4.7.txt[2.4.7],
 119  link:RelNotes/2.4.6.txt[2.4.6],
 120  link:RelNotes/2.4.5.txt[2.4.5],
 121  link:RelNotes/2.4.4.txt[2.4.4],
 122  link:RelNotes/2.4.3.txt[2.4.3],
 123  link:RelNotes/2.4.2.txt[2.4.2],
 124  link:RelNotes/2.4.1.txt[2.4.1],
 125  link:RelNotes/2.4.0.txt[2.4].
 126
 127* link:v2.3.10/git.html[documentation for release 2.3.10]
 128
 129* release notes for
 130  link:RelNotes/2.3.10.txt[2.3.10],
 131  link:RelNotes/2.3.9.txt[2.3.9],
 132  link:RelNotes/2.3.8.txt[2.3.8],
 133  link:RelNotes/2.3.7.txt[2.3.7],
 134  link:RelNotes/2.3.6.txt[2.3.6],
 135  link:RelNotes/2.3.5.txt[2.3.5],
 136  link:RelNotes/2.3.4.txt[2.3.4],
 137  link:RelNotes/2.3.3.txt[2.3.3],
 138  link:RelNotes/2.3.2.txt[2.3.2],
 139  link:RelNotes/2.3.1.txt[2.3.1],
 140  link:RelNotes/2.3.0.txt[2.3].
 141
 142* link:v2.2.3/git.html[documentation for release 2.2.3]
 143
 144* release notes for
 145  link:RelNotes/2.2.3.txt[2.2.3],
 146  link:RelNotes/2.2.2.txt[2.2.2],
 147  link:RelNotes/2.2.1.txt[2.2.1],
 148  link:RelNotes/2.2.0.txt[2.2].
 149
 150* link:v2.1.4/git.html[documentation for release 2.1.4]
 151
 152* release notes for
 153  link:RelNotes/2.1.4.txt[2.1.4],
 154  link:RelNotes/2.1.3.txt[2.1.3],
 155  link:RelNotes/2.1.2.txt[2.1.2],
 156  link:RelNotes/2.1.1.txt[2.1.1],
 157  link:RelNotes/2.1.0.txt[2.1].
 158
 159* link:v2.0.5/git.html[documentation for release 2.0.5]
 160
 161* release notes for
 162  link:RelNotes/2.0.5.txt[2.0.5],
 163  link:RelNotes/2.0.4.txt[2.0.4],
 164  link:RelNotes/2.0.3.txt[2.0.3],
 165  link:RelNotes/2.0.2.txt[2.0.2],
 166  link:RelNotes/2.0.1.txt[2.0.1],
 167  link:RelNotes/2.0.0.txt[2.0.0].
 168
 169* link:v1.9.5/git.html[documentation for release 1.9.5]
 170
 171* release notes for
 172  link:RelNotes/1.9.5.txt[1.9.5],
 173  link:RelNotes/1.9.4.txt[1.9.4],
 174  link:RelNotes/1.9.3.txt[1.9.3],
 175  link:RelNotes/1.9.2.txt[1.9.2],
 176  link:RelNotes/1.9.1.txt[1.9.1],
 177  link:RelNotes/1.9.0.txt[1.9.0].
 178
 179* link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
 180
 181* release notes for
 182  link:RelNotes/1.8.5.6.txt[1.8.5.6],
 183  link:RelNotes/1.8.5.5.txt[1.8.5.5],
 184  link:RelNotes/1.8.5.4.txt[1.8.5.4],
 185  link:RelNotes/1.8.5.3.txt[1.8.5.3],
 186  link:RelNotes/1.8.5.2.txt[1.8.5.2],
 187  link:RelNotes/1.8.5.1.txt[1.8.5.1],
 188  link:RelNotes/1.8.5.txt[1.8.5].
 189
 190* link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
 191
 192* release notes for
 193  link:RelNotes/1.8.4.5.txt[1.8.4.5],
 194  link:RelNotes/1.8.4.4.txt[1.8.4.4],
 195  link:RelNotes/1.8.4.3.txt[1.8.4.3],
 196  link:RelNotes/1.8.4.2.txt[1.8.4.2],
 197  link:RelNotes/1.8.4.1.txt[1.8.4.1],
 198  link:RelNotes/1.8.4.txt[1.8.4].
 199
 200* link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
 201
 202* release notes for
 203  link:RelNotes/1.8.3.4.txt[1.8.3.4],
 204  link:RelNotes/1.8.3.3.txt[1.8.3.3],
 205  link:RelNotes/1.8.3.2.txt[1.8.3.2],
 206  link:RelNotes/1.8.3.1.txt[1.8.3.1],
 207  link:RelNotes/1.8.3.txt[1.8.3].
 208
 209* link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
 210
 211* release notes for
 212  link:RelNotes/1.8.2.3.txt[1.8.2.3],
 213  link:RelNotes/1.8.2.2.txt[1.8.2.2],
 214  link:RelNotes/1.8.2.1.txt[1.8.2.1],
 215  link:RelNotes/1.8.2.txt[1.8.2].
 216
 217* link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
 218
 219* release notes for
 220  link:RelNotes/1.8.1.6.txt[1.8.1.6],
 221  link:RelNotes/1.8.1.5.txt[1.8.1.5],
 222  link:RelNotes/1.8.1.4.txt[1.8.1.4],
 223  link:RelNotes/1.8.1.3.txt[1.8.1.3],
 224  link:RelNotes/1.8.1.2.txt[1.8.1.2],
 225  link:RelNotes/1.8.1.1.txt[1.8.1.1],
 226  link:RelNotes/1.8.1.txt[1.8.1].
 227
 228* link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
 229
 230* release notes for
 231  link:RelNotes/1.8.0.3.txt[1.8.0.3],
 232  link:RelNotes/1.8.0.2.txt[1.8.0.2],
 233  link:RelNotes/1.8.0.1.txt[1.8.0.1],
 234  link:RelNotes/1.8.0.txt[1.8.0].
 235
 236* link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
 237
 238* release notes for
 239  link:RelNotes/1.7.12.4.txt[1.7.12.4],
 240  link:RelNotes/1.7.12.3.txt[1.7.12.3],
 241  link:RelNotes/1.7.12.2.txt[1.7.12.2],
 242  link:RelNotes/1.7.12.1.txt[1.7.12.1],
 243  link:RelNotes/1.7.12.txt[1.7.12].
 244
 245* link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
 246
 247* release notes for
 248  link:RelNotes/1.7.11.7.txt[1.7.11.7],
 249  link:RelNotes/1.7.11.6.txt[1.7.11.6],
 250  link:RelNotes/1.7.11.5.txt[1.7.11.5],
 251  link:RelNotes/1.7.11.4.txt[1.7.11.4],
 252  link:RelNotes/1.7.11.3.txt[1.7.11.3],
 253  link:RelNotes/1.7.11.2.txt[1.7.11.2],
 254  link:RelNotes/1.7.11.1.txt[1.7.11.1],
 255  link:RelNotes/1.7.11.txt[1.7.11].
 256
 257* link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
 258
 259* release notes for
 260  link:RelNotes/1.7.10.5.txt[1.7.10.5],
 261  link:RelNotes/1.7.10.4.txt[1.7.10.4],
 262  link:RelNotes/1.7.10.3.txt[1.7.10.3],
 263  link:RelNotes/1.7.10.2.txt[1.7.10.2],
 264  link:RelNotes/1.7.10.1.txt[1.7.10.1],
 265  link:RelNotes/1.7.10.txt[1.7.10].
 266
 267* link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
 268
 269* release notes for
 270  link:RelNotes/1.7.9.7.txt[1.7.9.7],
 271  link:RelNotes/1.7.9.6.txt[1.7.9.6],
 272  link:RelNotes/1.7.9.5.txt[1.7.9.5],
 273  link:RelNotes/1.7.9.4.txt[1.7.9.4],
 274  link:RelNotes/1.7.9.3.txt[1.7.9.3],
 275  link:RelNotes/1.7.9.2.txt[1.7.9.2],
 276  link:RelNotes/1.7.9.1.txt[1.7.9.1],
 277  link:RelNotes/1.7.9.txt[1.7.9].
 278
 279* link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
 280
 281* release notes for
 282  link:RelNotes/1.7.8.6.txt[1.7.8.6],
 283  link:RelNotes/1.7.8.5.txt[1.7.8.5],
 284  link:RelNotes/1.7.8.4.txt[1.7.8.4],
 285  link:RelNotes/1.7.8.3.txt[1.7.8.3],
 286  link:RelNotes/1.7.8.2.txt[1.7.8.2],
 287  link:RelNotes/1.7.8.1.txt[1.7.8.1],
 288  link:RelNotes/1.7.8.txt[1.7.8].
 289
 290* link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
 291
 292* release notes for
 293  link:RelNotes/1.7.7.7.txt[1.7.7.7],
 294  link:RelNotes/1.7.7.6.txt[1.7.7.6],
 295  link:RelNotes/1.7.7.5.txt[1.7.7.5],
 296  link:RelNotes/1.7.7.4.txt[1.7.7.4],
 297  link:RelNotes/1.7.7.3.txt[1.7.7.3],
 298  link:RelNotes/1.7.7.2.txt[1.7.7.2],
 299  link:RelNotes/1.7.7.1.txt[1.7.7.1],
 300  link:RelNotes/1.7.7.txt[1.7.7].
 301
 302* link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
 303
 304* release notes for
 305  link:RelNotes/1.7.6.6.txt[1.7.6.6],
 306  link:RelNotes/1.7.6.5.txt[1.7.6.5],
 307  link:RelNotes/1.7.6.4.txt[1.7.6.4],
 308  link:RelNotes/1.7.6.3.txt[1.7.6.3],
 309  link:RelNotes/1.7.6.2.txt[1.7.6.2],
 310  link:RelNotes/1.7.6.1.txt[1.7.6.1],
 311  link:RelNotes/1.7.6.txt[1.7.6].
 312
 313* link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
 314
 315* release notes for
 316  link:RelNotes/1.7.5.4.txt[1.7.5.4],
 317  link:RelNotes/1.7.5.3.txt[1.7.5.3],
 318  link:RelNotes/1.7.5.2.txt[1.7.5.2],
 319  link:RelNotes/1.7.5.1.txt[1.7.5.1],
 320  link:RelNotes/1.7.5.txt[1.7.5].
 321
 322* link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
 323
 324* release notes for
 325  link:RelNotes/1.7.4.5.txt[1.7.4.5],
 326  link:RelNotes/1.7.4.4.txt[1.7.4.4],
 327  link:RelNotes/1.7.4.3.txt[1.7.4.3],
 328  link:RelNotes/1.7.4.2.txt[1.7.4.2],
 329  link:RelNotes/1.7.4.1.txt[1.7.4.1],
 330  link:RelNotes/1.7.4.txt[1.7.4].
 331
 332* link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
 333
 334* release notes for
 335  link:RelNotes/1.7.3.5.txt[1.7.3.5],
 336  link:RelNotes/1.7.3.4.txt[1.7.3.4],
 337  link:RelNotes/1.7.3.3.txt[1.7.3.3],
 338  link:RelNotes/1.7.3.2.txt[1.7.3.2],
 339  link:RelNotes/1.7.3.1.txt[1.7.3.1],
 340  link:RelNotes/1.7.3.txt[1.7.3].
 341
 342* link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
 343
 344* release notes for
 345  link:RelNotes/1.7.2.5.txt[1.7.2.5],
 346  link:RelNotes/1.7.2.4.txt[1.7.2.4],
 347  link:RelNotes/1.7.2.3.txt[1.7.2.3],
 348  link:RelNotes/1.7.2.2.txt[1.7.2.2],
 349  link:RelNotes/1.7.2.1.txt[1.7.2.1],
 350  link:RelNotes/1.7.2.txt[1.7.2].
 351
 352* link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
 353
 354* release notes for
 355  link:RelNotes/1.7.1.4.txt[1.7.1.4],
 356  link:RelNotes/1.7.1.3.txt[1.7.1.3],
 357  link:RelNotes/1.7.1.2.txt[1.7.1.2],
 358  link:RelNotes/1.7.1.1.txt[1.7.1.1],
 359  link:RelNotes/1.7.1.txt[1.7.1].
 360
 361* link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
 362
 363* release notes for
 364  link:RelNotes/1.7.0.9.txt[1.7.0.9],
 365  link:RelNotes/1.7.0.8.txt[1.7.0.8],
 366  link:RelNotes/1.7.0.7.txt[1.7.0.7],
 367  link:RelNotes/1.7.0.6.txt[1.7.0.6],
 368  link:RelNotes/1.7.0.5.txt[1.7.0.5],
 369  link:RelNotes/1.7.0.4.txt[1.7.0.4],
 370  link:RelNotes/1.7.0.3.txt[1.7.0.3],
 371  link:RelNotes/1.7.0.2.txt[1.7.0.2],
 372  link:RelNotes/1.7.0.1.txt[1.7.0.1],
 373  link:RelNotes/1.7.0.txt[1.7.0].
 374
 375* link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
 376
 377* release notes for
 378  link:RelNotes/1.6.6.3.txt[1.6.6.3],
 379  link:RelNotes/1.6.6.2.txt[1.6.6.2],
 380  link:RelNotes/1.6.6.1.txt[1.6.6.1],
 381  link:RelNotes/1.6.6.txt[1.6.6].
 382
 383* link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
 384
 385* release notes for
 386  link:RelNotes/1.6.5.9.txt[1.6.5.9],
 387  link:RelNotes/1.6.5.8.txt[1.6.5.8],
 388  link:RelNotes/1.6.5.7.txt[1.6.5.7],
 389  link:RelNotes/1.6.5.6.txt[1.6.5.6],
 390  link:RelNotes/1.6.5.5.txt[1.6.5.5],
 391  link:RelNotes/1.6.5.4.txt[1.6.5.4],
 392  link:RelNotes/1.6.5.3.txt[1.6.5.3],
 393  link:RelNotes/1.6.5.2.txt[1.6.5.2],
 394  link:RelNotes/1.6.5.1.txt[1.6.5.1],
 395  link:RelNotes/1.6.5.txt[1.6.5].
 396
 397* link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
 398
 399* release notes for
 400  link:RelNotes/1.6.4.5.txt[1.6.4.5],
 401  link:RelNotes/1.6.4.4.txt[1.6.4.4],
 402  link:RelNotes/1.6.4.3.txt[1.6.4.3],
 403  link:RelNotes/1.6.4.2.txt[1.6.4.2],
 404  link:RelNotes/1.6.4.1.txt[1.6.4.1],
 405  link:RelNotes/1.6.4.txt[1.6.4].
 406
 407* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
 408
 409* release notes for
 410  link:RelNotes/1.6.3.4.txt[1.6.3.4],
 411  link:RelNotes/1.6.3.3.txt[1.6.3.3],
 412  link:RelNotes/1.6.3.2.txt[1.6.3.2],
 413  link:RelNotes/1.6.3.1.txt[1.6.3.1],
 414  link:RelNotes/1.6.3.txt[1.6.3].
 415
 416* release notes for
 417  link:RelNotes/1.6.2.5.txt[1.6.2.5],
 418  link:RelNotes/1.6.2.4.txt[1.6.2.4],
 419  link:RelNotes/1.6.2.3.txt[1.6.2.3],
 420  link:RelNotes/1.6.2.2.txt[1.6.2.2],
 421  link:RelNotes/1.6.2.1.txt[1.6.2.1],
 422  link:RelNotes/1.6.2.txt[1.6.2].
 423
 424* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
 425
 426* release notes for
 427  link:RelNotes/1.6.1.3.txt[1.6.1.3],
 428  link:RelNotes/1.6.1.2.txt[1.6.1.2],
 429  link:RelNotes/1.6.1.1.txt[1.6.1.1],
 430  link:RelNotes/1.6.1.txt[1.6.1].
 431
 432* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
 433
 434* release notes for
 435  link:RelNotes/1.6.0.6.txt[1.6.0.6],
 436  link:RelNotes/1.6.0.5.txt[1.6.0.5],
 437  link:RelNotes/1.6.0.4.txt[1.6.0.4],
 438  link:RelNotes/1.6.0.3.txt[1.6.0.3],
 439  link:RelNotes/1.6.0.2.txt[1.6.0.2],
 440  link:RelNotes/1.6.0.1.txt[1.6.0.1],
 441  link:RelNotes/1.6.0.txt[1.6.0].
 442
 443* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
 444
 445* release notes for
 446  link:RelNotes/1.5.6.6.txt[1.5.6.6],
 447  link:RelNotes/1.5.6.5.txt[1.5.6.5],
 448  link:RelNotes/1.5.6.4.txt[1.5.6.4],
 449  link:RelNotes/1.5.6.3.txt[1.5.6.3],
 450  link:RelNotes/1.5.6.2.txt[1.5.6.2],
 451  link:RelNotes/1.5.6.1.txt[1.5.6.1],
 452  link:RelNotes/1.5.6.txt[1.5.6].
 453
 454* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
 455
 456* release notes for
 457  link:RelNotes/1.5.5.6.txt[1.5.5.6],
 458  link:RelNotes/1.5.5.5.txt[1.5.5.5],
 459  link:RelNotes/1.5.5.4.txt[1.5.5.4],
 460  link:RelNotes/1.5.5.3.txt[1.5.5.3],
 461  link:RelNotes/1.5.5.2.txt[1.5.5.2],
 462  link:RelNotes/1.5.5.1.txt[1.5.5.1],
 463  link:RelNotes/1.5.5.txt[1.5.5].
 464
 465* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
 466
 467* release notes for
 468  link:RelNotes/1.5.4.7.txt[1.5.4.7],
 469  link:RelNotes/1.5.4.6.txt[1.5.4.6],
 470  link:RelNotes/1.5.4.5.txt[1.5.4.5],
 471  link:RelNotes/1.5.4.4.txt[1.5.4.4],
 472  link:RelNotes/1.5.4.3.txt[1.5.4.3],
 473  link:RelNotes/1.5.4.2.txt[1.5.4.2],
 474  link:RelNotes/1.5.4.1.txt[1.5.4.1],
 475  link:RelNotes/1.5.4.txt[1.5.4].
 476
 477* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
 478
 479* release notes for
 480  link:RelNotes/1.5.3.8.txt[1.5.3.8],
 481  link:RelNotes/1.5.3.7.txt[1.5.3.7],
 482  link:RelNotes/1.5.3.6.txt[1.5.3.6],
 483  link:RelNotes/1.5.3.5.txt[1.5.3.5],
 484  link:RelNotes/1.5.3.4.txt[1.5.3.4],
 485  link:RelNotes/1.5.3.3.txt[1.5.3.3],
 486  link:RelNotes/1.5.3.2.txt[1.5.3.2],
 487  link:RelNotes/1.5.3.1.txt[1.5.3.1],
 488  link:RelNotes/1.5.3.txt[1.5.3].
 489
 490* link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
 491
 492* release notes for
 493  link:RelNotes/1.5.2.5.txt[1.5.2.5],
 494  link:RelNotes/1.5.2.4.txt[1.5.2.4],
 495  link:RelNotes/1.5.2.3.txt[1.5.2.3],
 496  link:RelNotes/1.5.2.2.txt[1.5.2.2],
 497  link:RelNotes/1.5.2.1.txt[1.5.2.1],
 498  link:RelNotes/1.5.2.txt[1.5.2].
 499
 500* link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
 501
 502* release notes for
 503  link:RelNotes/1.5.1.6.txt[1.5.1.6],
 504  link:RelNotes/1.5.1.5.txt[1.5.1.5],
 505  link:RelNotes/1.5.1.4.txt[1.5.1.4],
 506  link:RelNotes/1.5.1.3.txt[1.5.1.3],
 507  link:RelNotes/1.5.1.2.txt[1.5.1.2],
 508  link:RelNotes/1.5.1.1.txt[1.5.1.1],
 509  link:RelNotes/1.5.1.txt[1.5.1].
 510
 511* link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
 512
 513* release notes for
 514  link:RelNotes/1.5.0.7.txt[1.5.0.7],
 515  link:RelNotes/1.5.0.6.txt[1.5.0.6],
 516  link:RelNotes/1.5.0.5.txt[1.5.0.5],
 517  link:RelNotes/1.5.0.3.txt[1.5.0.3],
 518  link:RelNotes/1.5.0.2.txt[1.5.0.2],
 519  link:RelNotes/1.5.0.1.txt[1.5.0.1],
 520  link:RelNotes/1.5.0.txt[1.5.0].
 521
 522* documentation for release link:v1.4.4.4/git.html[1.4.4.4],
 523  link:v1.3.3/git.html[1.3.3],
 524  link:v1.2.6/git.html[1.2.6],
 525  link:v1.0.13/git.html[1.0.13].
 526
 527============
 528
 529endif::stalenotes[]
 530
 531OPTIONS
 532-------
 533--version::
 534        Prints the Git suite version that the 'git' program came from.
 535
 536--help::
 537        Prints the synopsis and a list of the most commonly used
 538        commands. If the option `--all` or `-a` is given then all
 539        available commands are printed. If a Git command is named this
 540        option will bring up the manual page for that command.
 541+
 542Other options are available to control how the manual page is
 543displayed. See linkgit:git-help[1] for more information,
 544because `git --help ...` is converted internally into `git
 545help ...`.
 546
 547-C <path>::
 548        Run as if git was started in '<path>' instead of the current working
 549        directory.  When multiple `-C` options are given, each subsequent
 550        non-absolute `-C <path>` is interpreted relative to the preceding `-C
 551        <path>`.
 552+
 553This option affects options that expect path name like `--git-dir` and
 554`--work-tree` in that their interpretations of the path names would be
 555made relative to the working directory caused by the `-C` option. For
 556example the following invocations are equivalent:
 557
 558    git --git-dir=a.git --work-tree=b -C c status
 559    git --git-dir=c/a.git --work-tree=c/b status
 560
 561-c <name>=<value>::
 562        Pass a configuration parameter to the command. The value
 563        given will override values from configuration files.
 564        The <name> is expected in the same format as listed by
 565        'git config' (subkeys separated by dots).
 566+
 567Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
 568`foo.bar` to the boolean true value (just like `[foo]bar` would in a
 569config file). Including the equals but with an empty value (like `git -c
 570foo.bar= ...`) sets `foo.bar` to the empty string.
 571
 572--exec-path[=<path>]::
 573        Path to wherever your core Git programs are installed.
 574        This can also be controlled by setting the GIT_EXEC_PATH
 575        environment variable. If no path is given, 'git' will print
 576        the current setting and then exit.
 577
 578--html-path::
 579        Print the path, without trailing slash, where Git's HTML
 580        documentation is installed and exit.
 581
 582--man-path::
 583        Print the manpath (see `man(1)`) for the man pages for
 584        this version of Git and exit.
 585
 586--info-path::
 587        Print the path where the Info files documenting this
 588        version of Git are installed and exit.
 589
 590-p::
 591--paginate::
 592        Pipe all output into 'less' (or if set, $PAGER) if standard
 593        output is a terminal.  This overrides the `pager.<cmd>`
 594        configuration options (see the "Configuration Mechanism" section
 595        below).
 596
 597--no-pager::
 598        Do not pipe Git output into a pager.
 599
 600--git-dir=<path>::
 601        Set the path to the repository. This can also be controlled by
 602        setting the `GIT_DIR` environment variable. It can be an absolute
 603        path or relative path to current working directory.
 604
 605--work-tree=<path>::
 606        Set the path to the working tree. It can be an absolute path
 607        or a path relative to the current working directory.
 608        This can also be controlled by setting the GIT_WORK_TREE
 609        environment variable and the core.worktree configuration
 610        variable (see core.worktree in linkgit:git-config[1] for a
 611        more detailed discussion).
 612
 613--namespace=<path>::
 614        Set the Git namespace.  See linkgit:gitnamespaces[7] for more
 615        details.  Equivalent to setting the `GIT_NAMESPACE` environment
 616        variable.
 617
 618--super-prefix=<path>::
 619        Currently for internal use only.  Set a prefix which gives a path from
 620        above a repository down to its root.  One use is to give submodules
 621        context about the superproject that invoked it.
 622
 623--bare::
 624        Treat the repository as a bare repository.  If GIT_DIR
 625        environment is not set, it is set to the current working
 626        directory.
 627
 628--no-replace-objects::
 629        Do not use replacement refs to replace Git objects. See
 630        linkgit:git-replace[1] for more information.
 631
 632--literal-pathspecs::
 633        Treat pathspecs literally (i.e. no globbing, no pathspec magic).
 634        This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
 635        variable to `1`.
 636
 637--glob-pathspecs::
 638        Add "glob" magic to all pathspec. This is equivalent to setting
 639        the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
 640        globbing on individual pathspecs can be done using pathspec
 641        magic ":(literal)"
 642
 643--noglob-pathspecs::
 644        Add "literal" magic to all pathspec. This is equivalent to setting
 645        the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
 646        globbing on individual pathspecs can be done using pathspec
 647        magic ":(glob)"
 648
 649--icase-pathspecs::
 650        Add "icase" magic to all pathspec. This is equivalent to setting
 651        the `GIT_ICASE_PATHSPECS` environment variable to `1`.
 652
 653GIT COMMANDS
 654------------
 655
 656We divide Git into high level ("porcelain") commands and low level
 657("plumbing") commands.
 658
 659High-level commands (porcelain)
 660-------------------------------
 661
 662We separate the porcelain commands into the main commands and some
 663ancillary user utilities.
 664
 665Main porcelain commands
 666~~~~~~~~~~~~~~~~~~~~~~~
 667
 668include::cmds-mainporcelain.txt[]
 669
 670Ancillary Commands
 671~~~~~~~~~~~~~~~~~~
 672Manipulators:
 673
 674include::cmds-ancillarymanipulators.txt[]
 675
 676Interrogators:
 677
 678include::cmds-ancillaryinterrogators.txt[]
 679
 680
 681Interacting with Others
 682~~~~~~~~~~~~~~~~~~~~~~~
 683
 684These commands are to interact with foreign SCM and with other
 685people via patch over e-mail.
 686
 687include::cmds-foreignscminterface.txt[]
 688
 689
 690Low-level commands (plumbing)
 691-----------------------------
 692
 693Although Git includes its
 694own porcelain layer, its low-level commands are sufficient to support
 695development of alternative porcelains.  Developers of such porcelains
 696might start by reading about linkgit:git-update-index[1] and
 697linkgit:git-read-tree[1].
 698
 699The interface (input, output, set of options and the semantics)
 700to these low-level commands are meant to be a lot more stable
 701than Porcelain level commands, because these commands are
 702primarily for scripted use.  The interface to Porcelain commands
 703on the other hand are subject to change in order to improve the
 704end user experience.
 705
 706The following description divides
 707the low-level commands into commands that manipulate objects (in
 708the repository, index, and working tree), commands that interrogate and
 709compare objects, and commands that move objects and references between
 710repositories.
 711
 712
 713Manipulation commands
 714~~~~~~~~~~~~~~~~~~~~~
 715
 716include::cmds-plumbingmanipulators.txt[]
 717
 718
 719Interrogation commands
 720~~~~~~~~~~~~~~~~~~~~~~
 721
 722include::cmds-plumbinginterrogators.txt[]
 723
 724In general, the interrogate commands do not touch the files in
 725the working tree.
 726
 727
 728Synching repositories
 729~~~~~~~~~~~~~~~~~~~~~
 730
 731include::cmds-synchingrepositories.txt[]
 732
 733The following are helper commands used by the above; end users
 734typically do not use them directly.
 735
 736include::cmds-synchelpers.txt[]
 737
 738
 739Internal helper commands
 740~~~~~~~~~~~~~~~~~~~~~~~~
 741
 742These are internal helper commands used by other commands; end
 743users typically do not use them directly.
 744
 745include::cmds-purehelpers.txt[]
 746
 747
 748Configuration Mechanism
 749-----------------------
 750
 751Git uses a simple text format to store customizations that are per
 752repository and are per user.  Such a configuration file may look
 753like this:
 754
 755------------
 756#
 757# A '#' or ';' character indicates a comment.
 758#
 759
 760; core variables
 761[core]
 762        ; Don't trust file modes
 763        filemode = false
 764
 765; user identity
 766[user]
 767        name = "Junio C Hamano"
 768        email = "gitster@pobox.com"
 769
 770------------
 771
 772Various commands read from the configuration file and adjust
 773their operation accordingly.  See linkgit:git-config[1] for a
 774list and more details about the configuration mechanism.
 775
 776
 777Identifier Terminology
 778----------------------
 779<object>::
 780        Indicates the object name for any type of object.
 781
 782<blob>::
 783        Indicates a blob object name.
 784
 785<tree>::
 786        Indicates a tree object name.
 787
 788<commit>::
 789        Indicates a commit object name.
 790
 791<tree-ish>::
 792        Indicates a tree, commit or tag object name.  A
 793        command that takes a <tree-ish> argument ultimately wants to
 794        operate on a <tree> object but automatically dereferences
 795        <commit> and <tag> objects that point at a <tree>.
 796
 797<commit-ish>::
 798        Indicates a commit or tag object name.  A
 799        command that takes a <commit-ish> argument ultimately wants to
 800        operate on a <commit> object but automatically dereferences
 801        <tag> objects that point at a <commit>.
 802
 803<type>::
 804        Indicates that an object type is required.
 805        Currently one of: `blob`, `tree`, `commit`, or `tag`.
 806
 807<file>::
 808        Indicates a filename - almost always relative to the
 809        root of the tree structure `GIT_INDEX_FILE` describes.
 810
 811Symbolic Identifiers
 812--------------------
 813Any Git command accepting any <object> can also use the following
 814symbolic notation:
 815
 816HEAD::
 817        indicates the head of the current branch.
 818
 819<tag>::
 820        a valid tag 'name'
 821        (i.e. a `refs/tags/<tag>` reference).
 822
 823<head>::
 824        a valid head 'name'
 825        (i.e. a `refs/heads/<head>` reference).
 826
 827For a more complete list of ways to spell object names, see
 828"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
 829
 830
 831File/Directory Structure
 832------------------------
 833
 834Please see the linkgit:gitrepository-layout[5] document.
 835
 836Read linkgit:githooks[5] for more details about each hook.
 837
 838Higher level SCMs may provide and manage additional information in the
 839`$GIT_DIR`.
 840
 841
 842Terminology
 843-----------
 844Please see linkgit:gitglossary[7].
 845
 846
 847Environment Variables
 848---------------------
 849Various Git commands use the following environment variables:
 850
 851The Git Repository
 852~~~~~~~~~~~~~~~~~~
 853These environment variables apply to 'all' core Git commands. Nb: it
 854is worth noting that they may be used/overridden by SCMS sitting above
 855Git so take care if using a foreign front-end.
 856
 857`GIT_INDEX_FILE`::
 858        This environment allows the specification of an alternate
 859        index file. If not specified, the default of `$GIT_DIR/index`
 860        is used.
 861
 862`GIT_INDEX_VERSION`::
 863        This environment variable allows the specification of an index
 864        version for new repositories.  It won't affect existing index
 865        files.  By default index file version 2 or 3 is used. See
 866        linkgit:git-update-index[1] for more information.
 867
 868`GIT_OBJECT_DIRECTORY`::
 869        If the object storage directory is specified via this
 870        environment variable then the sha1 directories are created
 871        underneath - otherwise the default `$GIT_DIR/objects`
 872        directory is used.
 873
 874`GIT_ALTERNATE_OBJECT_DIRECTORIES`::
 875        Due to the immutable nature of Git objects, old objects can be
 876        archived into shared, read-only directories. This variable
 877        specifies a ":" separated (on Windows ";" separated) list
 878        of Git object directories which can be used to search for Git
 879        objects. New objects will not be written to these directories.
 880+
 881        Entries that begin with `"` (double-quote) will be interpreted
 882        as C-style quoted paths, removing leading and trailing
 883        double-quotes and respecting backslash escapes. E.g., the value
 884        `"path-with-\"-and-:-in-it":vanilla-path` has two paths:
 885        `path-with-"-and-:-in-it` and `vanilla-path`.
 886
 887`GIT_DIR`::
 888        If the `GIT_DIR` environment variable is set then it
 889        specifies a path to use instead of the default `.git`
 890        for the base of the repository.
 891        The `--git-dir` command-line option also sets this value.
 892
 893`GIT_WORK_TREE`::
 894        Set the path to the root of the working tree.
 895        This can also be controlled by the `--work-tree` command-line
 896        option and the core.worktree configuration variable.
 897
 898`GIT_NAMESPACE`::
 899        Set the Git namespace; see linkgit:gitnamespaces[7] for details.
 900        The `--namespace` command-line option also sets this value.
 901
 902`GIT_CEILING_DIRECTORIES`::
 903        This should be a colon-separated list of absolute paths.  If
 904        set, it is a list of directories that Git should not chdir up
 905        into while looking for a repository directory (useful for
 906        excluding slow-loading network directories).  It will not
 907        exclude the current working directory or a GIT_DIR set on the
 908        command line or in the environment.  Normally, Git has to read
 909        the entries in this list and resolve any symlink that
 910        might be present in order to compare them with the current
 911        directory.  However, if even this access is slow, you
 912        can add an empty entry to the list to tell Git that the
 913        subsequent entries are not symlinks and needn't be resolved;
 914        e.g.,
 915        `GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
 916
 917`GIT_DISCOVERY_ACROSS_FILESYSTEM`::
 918        When run in a directory that does not have ".git" repository
 919        directory, Git tries to find such a directory in the parent
 920        directories to find the top of the working tree, but by default it
 921        does not cross filesystem boundaries.  This environment variable
 922        can be set to true to tell Git not to stop at filesystem
 923        boundaries.  Like `GIT_CEILING_DIRECTORIES`, this will not affect
 924        an explicit repository directory set via `GIT_DIR` or on the
 925        command line.
 926
 927`GIT_COMMON_DIR`::
 928        If this variable is set to a path, non-worktree files that are
 929        normally in $GIT_DIR will be taken from this path
 930        instead. Worktree-specific files such as HEAD or index are
 931        taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
 932        linkgit:git-worktree[1] for
 933        details. This variable has lower precedence than other path
 934        variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
 935
 936Git Commits
 937~~~~~~~~~~~
 938`GIT_AUTHOR_NAME`::
 939`GIT_AUTHOR_EMAIL`::
 940`GIT_AUTHOR_DATE`::
 941`GIT_COMMITTER_NAME`::
 942`GIT_COMMITTER_EMAIL`::
 943`GIT_COMMITTER_DATE`::
 944'EMAIL'::
 945        see linkgit:git-commit-tree[1]
 946
 947Git Diffs
 948~~~~~~~~~
 949`GIT_DIFF_OPTS`::
 950        Only valid setting is "--unified=??" or "-u??" to set the
 951        number of context lines shown when a unified diff is created.
 952        This takes precedence over any "-U" or "--unified" option
 953        value passed on the Git diff command line.
 954
 955`GIT_EXTERNAL_DIFF`::
 956        When the environment variable `GIT_EXTERNAL_DIFF` is set, the
 957        program named by it is called, instead of the diff invocation
 958        described above.  For a path that is added, removed, or modified,
 959        `GIT_EXTERNAL_DIFF` is called with 7 parameters:
 960
 961        path old-file old-hex old-mode new-file new-hex new-mode
 962+
 963where:
 964
 965        <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
 966                         contents of <old|new>,
 967        <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
 968        <old|new>-mode:: are the octal representation of the file modes.
 969+
 970The file parameters can point at the user's working file
 971(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
 972when a new file is added), or a temporary file (e.g. `old-file` in the
 973index).  `GIT_EXTERNAL_DIFF` should not worry about unlinking the
 974temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
 975+
 976For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
 977parameter, <path>.
 978+
 979For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
 980`GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
 981
 982`GIT_DIFF_PATH_COUNTER`::
 983        A 1-based counter incremented by one for every path.
 984
 985`GIT_DIFF_PATH_TOTAL`::
 986        The total number of paths.
 987
 988other
 989~~~~~
 990`GIT_MERGE_VERBOSITY`::
 991        A number controlling the amount of output shown by
 992        the recursive merge strategy.  Overrides merge.verbosity.
 993        See linkgit:git-merge[1]
 994
 995`GIT_PAGER`::
 996        This environment variable overrides `$PAGER`. If it is set
 997        to an empty string or to the value "cat", Git will not launch
 998        a pager.  See also the `core.pager` option in
 999        linkgit:git-config[1].
1000
1001`GIT_EDITOR`::
1002        This environment variable overrides `$EDITOR` and `$VISUAL`.
1003        It is used by several Git commands when, on interactive mode,
1004        an editor is to be launched. See also linkgit:git-var[1]
1005        and the `core.editor` option in linkgit:git-config[1].
1006
1007`GIT_SSH`::
1008`GIT_SSH_COMMAND`::
1009        If either of these environment variables is set then 'git fetch'
1010        and 'git push' will use the specified command instead of 'ssh'
1011        when they need to connect to a remote system.
1012        The command will be given exactly two or four arguments: the
1013        'username@host' (or just 'host') from the URL and the shell
1014        command to execute on that remote system, optionally preceded by
1015        `-p` (literally) and the 'port' from the URL when it specifies
1016        something other than the default SSH port.
1017+
1018`$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
1019by the shell, which allows additional arguments to be included.
1020`$GIT_SSH` on the other hand must be just the path to a program
1021(which can be a wrapper shell script, if additional arguments are
1022needed).
1023+
1024Usually it is easier to configure any desired options through your
1025personal `.ssh/config` file.  Please consult your ssh documentation
1026for further details.
1027
1028`GIT_ASKPASS`::
1029        If this environment variable is set, then Git commands which need to
1030        acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
1031        will call this program with a suitable prompt as command-line argument
1032        and read the password from its STDOUT. See also the `core.askPass`
1033        option in linkgit:git-config[1].
1034
1035`GIT_TERMINAL_PROMPT`::
1036        If this environment variable is set to `0`, git will not prompt
1037        on the terminal (e.g., when asking for HTTP authentication).
1038
1039`GIT_CONFIG_NOSYSTEM`::
1040        Whether to skip reading settings from the system-wide
1041        `$(prefix)/etc/gitconfig` file.  This environment variable can
1042        be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
1043        predictable environment for a picky script, or you can set it
1044        temporarily to avoid using a buggy `/etc/gitconfig` file while
1045        waiting for someone with sufficient permissions to fix it.
1046
1047`GIT_FLUSH`::
1048        If this environment variable is set to "1", then commands such
1049        as 'git blame' (in incremental mode), 'git rev-list', 'git log',
1050        'git check-attr' and 'git check-ignore' will
1051        force a flush of the output stream after each record have been
1052        flushed. If this
1053        variable is set to "0", the output of these commands will be done
1054        using completely buffered I/O.   If this environment variable is
1055        not set, Git will choose buffered or record-oriented flushing
1056        based on whether stdout appears to be redirected to a file or not.
1057
1058`GIT_TRACE`::
1059        Enables general trace messages, e.g. alias expansion, built-in
1060        command execution and external command execution.
1061+
1062If this variable is set to "1", "2" or "true" (comparison
1063is case insensitive), trace messages will be printed to
1064stderr.
1065+
1066If the variable is set to an integer value greater than 2
1067and lower than 10 (strictly) then Git will interpret this
1068value as an open file descriptor and will try to write the
1069trace messages into this file descriptor.
1070+
1071Alternatively, if the variable is set to an absolute path
1072(starting with a '/' character), Git will interpret this
1073as a file path and will try to write the trace messages
1074into it.
1075+
1076Unsetting the variable, or setting it to empty, "0" or
1077"false" (case insensitive) disables trace messages.
1078
1079`GIT_TRACE_PACK_ACCESS`::
1080        Enables trace messages for all accesses to any packs. For each
1081        access, the pack file name and an offset in the pack is
1082        recorded. This may be helpful for troubleshooting some
1083        pack-related performance problems.
1084        See `GIT_TRACE` for available trace output options.
1085
1086`GIT_TRACE_PACKET`::
1087        Enables trace messages for all packets coming in or out of a
1088        given program. This can help with debugging object negotiation
1089        or other protocol issues. Tracing is turned off at a packet
1090        starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
1091        See `GIT_TRACE` for available trace output options.
1092
1093`GIT_TRACE_PACKFILE`::
1094        Enables tracing of packfiles sent or received by a
1095        given program. Unlike other trace output, this trace is
1096        verbatim: no headers, and no quoting of binary data. You almost
1097        certainly want to direct into a file (e.g.,
1098        `GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on
1099        the terminal or mixing it with other trace output.
1100+
1101Note that this is currently only implemented for the client side
1102of clones and fetches.
1103
1104`GIT_TRACE_PERFORMANCE`::
1105        Enables performance related trace messages, e.g. total execution
1106        time of each Git command.
1107        See `GIT_TRACE` for available trace output options.
1108
1109`GIT_TRACE_SETUP`::
1110        Enables trace messages printing the .git, working tree and current
1111        working directory after Git has completed its setup phase.
1112        See `GIT_TRACE` for available trace output options.
1113
1114`GIT_TRACE_SHALLOW`::
1115        Enables trace messages that can help debugging fetching /
1116        cloning of shallow repositories.
1117        See `GIT_TRACE` for available trace output options.
1118
1119`GIT_TRACE_CURL`::
1120        Enables a curl full trace dump of all incoming and outgoing data,
1121        including descriptive information, of the git transport protocol.
1122        This is similar to doing curl `--trace-ascii` on the command line.
1123        This option overrides setting the `GIT_CURL_VERBOSE` environment
1124        variable.
1125        See `GIT_TRACE` for available trace output options.
1126
1127`GIT_LITERAL_PATHSPECS`::
1128        Setting this variable to `1` will cause Git to treat all
1129        pathspecs literally, rather than as glob patterns. For example,
1130        running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1131        for commits that touch the path `*.c`, not any paths that the
1132        glob `*.c` matches. You might want this if you are feeding
1133        literal paths to Git (e.g., paths previously given to you by
1134        `git ls-tree`, `--raw` diff output, etc).
1135
1136`GIT_GLOB_PATHSPECS`::
1137        Setting this variable to `1` will cause Git to treat all
1138        pathspecs as glob patterns (aka "glob" magic).
1139
1140`GIT_NOGLOB_PATHSPECS`::
1141        Setting this variable to `1` will cause Git to treat all
1142        pathspecs as literal (aka "literal" magic).
1143
1144`GIT_ICASE_PATHSPECS`::
1145        Setting this variable to `1` will cause Git to treat all
1146        pathspecs as case-insensitive.
1147
1148`GIT_REFLOG_ACTION`::
1149        When a ref is updated, reflog entries are created to keep
1150        track of the reason why the ref was updated (which is
1151        typically the name of the high-level command that updated
1152        the ref), in addition to the old and new values of the ref.
1153        A scripted Porcelain command can use set_reflog_action
1154        helper function in `git-sh-setup` to set its name to this
1155        variable when it is invoked as the top level command by the
1156        end user, to be recorded in the body of the reflog.
1157
1158`GIT_REF_PARANOIA`::
1159        If set to `1`, include broken or badly named refs when iterating
1160        over lists of refs. In a normal, non-corrupted repository, this
1161        does nothing. However, enabling it may help git to detect and
1162        abort some operations in the presence of broken refs. Git sets
1163        this variable automatically when performing destructive
1164        operations like linkgit:git-prune[1]. You should not need to set
1165        it yourself unless you want to be paranoid about making sure
1166        an operation has touched every ref (e.g., because you are
1167        cloning a repository to make a backup).
1168
1169`GIT_ALLOW_PROTOCOL`::
1170        If set to a colon-separated list of protocols, behave as if
1171        `protocol.allow` is set to `never`, and each of the listed
1172        protocols has `protocol.<name>.allow` set to `always`
1173        (overriding any existing configuration). In other words, any
1174        protocol not mentioned will be disallowed (i.e., this is a
1175        whitelist, not a blacklist). See the description of
1176        `protocol.allow` in linkgit:git-config[1] for more details.
1177
1178`GIT_PROTOCOL_FROM_USER`::
1179        Set to 0 to prevent protocols used by fetch/push/clone which are
1180        configured to the `user` state.  This is useful to restrict recursive
1181        submodule initialization from an untrusted repository or for programs
1182        which feed potentially-untrusted URLS to git commands.  See
1183        linkgit:git-config[1] for more details.
1184
1185Discussion[[Discussion]]
1186------------------------
1187
1188More detail on the following is available from the
1189link:user-manual.html#git-concepts[Git concepts chapter of the
1190user-manual] and linkgit:gitcore-tutorial[7].
1191
1192A Git project normally consists of a working directory with a ".git"
1193subdirectory at the top level.  The .git directory contains, among other
1194things, a compressed object database representing the complete history
1195of the project, an "index" file which links that history to the current
1196contents of the working tree, and named pointers into that history such
1197as tags and branch heads.
1198
1199The object database contains objects of three main types: blobs, which
1200hold file data; trees, which point to blobs and other trees to build up
1201directory hierarchies; and commits, which each reference a single tree
1202and some number of parent commits.
1203
1204The commit, equivalent to what other systems call a "changeset" or
1205"version", represents a step in the project's history, and each parent
1206represents an immediately preceding step.  Commits with more than one
1207parent represent merges of independent lines of development.
1208
1209All objects are named by the SHA-1 hash of their contents, normally
1210written as a string of 40 hex digits.  Such names are globally unique.
1211The entire history leading up to a commit can be vouched for by signing
1212just that commit.  A fourth object type, the tag, is provided for this
1213purpose.
1214
1215When first created, objects are stored in individual files, but for
1216efficiency may later be compressed together into "pack files".
1217
1218Named pointers called refs mark interesting points in history.  A ref
1219may contain the SHA-1 name of an object or the name of another ref.  Refs
1220with names beginning `ref/head/` contain the SHA-1 name of the most
1221recent commit (or "head") of a branch under development.  SHA-1 names of
1222tags of interest are stored under `ref/tags/`.  A special ref named
1223`HEAD` contains the name of the currently checked-out branch.
1224
1225The index file is initialized with a list of all paths and, for each
1226path, a blob object and a set of attributes.  The blob object represents
1227the contents of the file as of the head of the current branch.  The
1228attributes (last modified time, size, etc.) are taken from the
1229corresponding file in the working tree.  Subsequent changes to the
1230working tree can be found by comparing these attributes.  The index may
1231be updated with new content, and new commits may be created from the
1232content stored in the index.
1233
1234The index is also capable of storing multiple entries (called "stages")
1235for a given pathname.  These stages are used to hold the various
1236unmerged version of a file when a merge is in progress.
1237
1238FURTHER DOCUMENTATION
1239---------------------
1240
1241See the references in the "description" section to get started
1242using Git.  The following is probably more detail than necessary
1243for a first-time user.
1244
1245The link:user-manual.html#git-concepts[Git concepts chapter of the
1246user-manual] and linkgit:gitcore-tutorial[7] both provide
1247introductions to the underlying Git architecture.
1248
1249See linkgit:gitworkflows[7] for an overview of recommended workflows.
1250
1251See also the link:howto-index.html[howto] documents for some useful
1252examples.
1253
1254The internals are documented in the
1255link:technical/api-index.html[Git API documentation].
1256
1257Users migrating from CVS may also want to
1258read linkgit:gitcvs-migration[7].
1259
1260
1261Authors
1262-------
1263Git was started by Linus Torvalds, and is currently maintained by Junio
1264C Hamano. Numerous contributions have come from the Git mailing list
1265<git@vger.kernel.org>.  http://www.openhub.net/p/git/contributors/summary
1266gives you a more complete list of contributors.
1267
1268If you have a clone of git.git itself, the
1269output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1270the authors for specific parts of the project.
1271
1272Reporting Bugs
1273--------------
1274
1275Report bugs to the Git mailing list <git@vger.kernel.org> where the
1276development and maintenance is primarily done.  You do not have to be
1277subscribed to the list to send a message there.
1278
1279SEE ALSO
1280--------
1281linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1282linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1283linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1284linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1285linkgit:gitworkflows[7]
1286
1287GIT
1288---
1289Part of the linkgit:git[1] suite