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