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