Documentation/git.txt

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