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 <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 <name>=<value>::
 403         Pass a configuration parameter to the command. The value
 404         given will override values from configuration files.
 405         The <name> is expected in the same format as listed by
 406         'git config' (subkeys separated by dots).
 407
 408 --exec-path[=<path>]::
 409         Path to wherever your core Git programs are installed.
 410         This can also be controlled by setting the GIT_EXEC_PATH
 411         environment variable. If no path is given, 'git' will print
 412         the current setting and then exit.
 413
 414 --html-path::
 415         Print the path, without trailing slash, where Git's HTML
 416         documentation is installed and exit.
 417
 418 --man-path::
 419         Print the manpath (see `man(1)`) for the man pages for
 420         this version of Git and exit.
 421
 422 --info-path::
 423         Print the path where the Info files documenting this
 424         version of Git are installed and exit.
 425
 426 -p::
 427 --paginate::
 428         Pipe all output into 'less' (or if set, $PAGER) if standard
 429         output is a terminal.  This overrides the `pager.<cmd>`
 430         configuration options (see the "Configuration Mechanism" section
 431         below).
 432
 433 --no-pager::
 434         Do not pipe Git output into a pager.
 435
 436 --git-dir=<path>::
 437         Set the path to the repository. This can also be controlled by
 438         setting the GIT_DIR environment variable. It can be an absolute
 439         path or relative path to current working directory.
 440
 441 --work-tree=<path>::
 442         Set the path to the working tree. It can be an absolute path
 443         or a path relative to the current working directory.
 444         This can also be controlled by setting the GIT_WORK_TREE
 445         environment variable and the core.worktree configuration
 446         variable (see core.worktree in linkgit:git-config[1] for a
 447         more detailed discussion).
 448
 449 --namespace=<path>::
 450         Set the Git namespace.  See linkgit:gitnamespaces[7] for more
 451         details.  Equivalent to setting the `GIT_NAMESPACE` environment
 452         variable.
 453
 454 --bare::
 455         Treat the repository as a bare repository.  If GIT_DIR
 456         environment is not set, it is set to the current working
 457         directory.
 458
 459 --no-replace-objects::
 460         Do not use replacement refs to replace Git objects. See
 461         linkgit:git-replace[1] for more information.
 462
 463 --literal-pathspecs::
 464         Treat pathspecs literally, rather than as glob patterns. This is
 465         equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
 466         variable to `1`.
 467
 468
 469 GIT COMMANDS
 470 ------------
 471
 472 We divide Git into high level ("porcelain") commands and low level
 473 ("plumbing") commands.
 474
 475 High-level commands (porcelain)
 476 -------------------------------
 477
 478 We separate the porcelain commands into the main commands and some
 479 ancillary user utilities.
 480
 481 Main porcelain commands
 482 ~~~~~~~~~~~~~~~~~~~~~~~
 483
 484 include::cmds-mainporcelain.txt[]
 485
 486 Ancillary Commands
 487 ~~~~~~~~~~~~~~~~~~
 488 Manipulators:
 489
 490 include::cmds-ancillarymanipulators.txt[]
 491
 492 Interrogators:
 493
 494 include::cmds-ancillaryinterrogators.txt[]
 495
 496
 497 Interacting with Others
 498 ~~~~~~~~~~~~~~~~~~~~~~~
 499
 500 These commands are to interact with foreign SCM and with other
 501 people via patch over e-mail.
 502
 503 include::cmds-foreignscminterface.txt[]
 504
 505
 506 Low-level commands (plumbing)
 507 -----------------------------
 508
 509 Although Git includes its
 510 own porcelain layer, its low-level commands are sufficient to support
 511 development of alternative porcelains.  Developers of such porcelains
 512 might start by reading about linkgit:git-update-index[1] and
 513 linkgit:git-read-tree[1].
 514
 515 The interface (input, output, set of options and the semantics)
 516 to these low-level commands are meant to be a lot more stable
 517 than Porcelain level commands, because these commands are
 518 primarily for scripted use.  The interface to Porcelain commands
 519 on the other hand are subject to change in order to improve the
 520 end user experience.
 521
 522 The following description divides
 523 the low-level commands into commands that manipulate objects (in
 524 the repository, index, and working tree), commands that interrogate and
 525 compare objects, and commands that move objects and references between
 526 repositories.
 527
 528
 529 Manipulation commands
 530 ~~~~~~~~~~~~~~~~~~~~~
 531
 532 include::cmds-plumbingmanipulators.txt[]
 533
 534
 535 Interrogation commands
 536 ~~~~~~~~~~~~~~~~~~~~~~
 537
 538 include::cmds-plumbinginterrogators.txt[]
 539
 540 In general, the interrogate commands do not touch the files in
 541 the working tree.
 542
 543
 544 Synching repositories
 545 ~~~~~~~~~~~~~~~~~~~~~
 546
 547 include::cmds-synchingrepositories.txt[]
 548
 549 The following are helper commands used by the above; end users
 550 typically do not use them directly.
 551
 552 include::cmds-synchelpers.txt[]
 553
 554
 555 Internal helper commands
 556 ~~~~~~~~~~~~~~~~~~~~~~~~
 557
 558 These are internal helper commands used by other commands; end
 559 users typically do not use them directly.
 560
 561 include::cmds-purehelpers.txt[]
 562
 563
 564 Configuration Mechanism
 565 -----------------------
 566
 567 Git uses a simple text format to store customizations that are per
 568 repository and are per user.  Such a configuration file may look
 569 like this:
 570
 571 ------------
 572 #
 573 # A '#' or ';' character indicates a comment.
 574 #
 575
 576 ; core variables
 577 [core]
 578         ; Don't trust file modes
 579         filemode = false
 580
 581 ; user identity
 582 [user]
 583         name = "Junio C Hamano"
 584         email = "gitster@pobox.com"
 585
 586 ------------
 587
 588 Various commands read from the configuration file and adjust
 589 their operation accordingly.  See linkgit:git-config[1] for a
 590 list and more details about the configuration mechanism.
 591
 592
 593 Identifier Terminology
 594 ----------------------
 595 <object>::
 596         Indicates the object name for any type of object.
 597
 598 <blob>::
 599         Indicates a blob object name.
 600
 601 <tree>::
 602         Indicates a tree object name.
 603
 604 <commit>::
 605         Indicates a commit object name.
 606
 607 <tree-ish>::
 608         Indicates a tree, commit or tag object name.  A
 609         command that takes a <tree-ish> argument ultimately wants to
 610         operate on a <tree> object but automatically dereferences
 611         <commit> and <tag> objects that point at a <tree>.
 612
 613 <commit-ish>::
 614         Indicates a commit or tag object name.  A
 615         command that takes a <commit-ish> argument ultimately wants to
 616         operate on a <commit> object but automatically dereferences
 617         <tag> objects that point at a <commit>.
 618
 619 <type>::
 620         Indicates that an object type is required.
 621         Currently one of: `blob`, `tree`, `commit`, or `tag`.
 622
 623 <file>::
 624         Indicates a filename - almost always relative to the
 625         root of the tree structure `GIT_INDEX_FILE` describes.
 626
 627 Symbolic Identifiers
 628 --------------------
 629 Any Git command accepting any <object> can also use the following
 630 symbolic notation:
 631
 632 HEAD::
 633         indicates the head of the current branch.
 634
 635 <tag>::
 636         a valid tag 'name'
 637         (i.e. a `refs/tags/<tag>` reference).
 638
 639 <head>::
 640         a valid head 'name'
 641         (i.e. a `refs/heads/<head>` reference).
 642
 643 For a more complete list of ways to spell object names, see
 644 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
 645
 646
 647 File/Directory Structure
 648 ------------------------
 649
 650 Please see the linkgit:gitrepository-layout[5] document.
 651
 652 Read linkgit:githooks[5] for more details about each hook.
 653
 654 Higher level SCMs may provide and manage additional information in the
 655 `$GIT_DIR`.
 656
 657
 658 Terminology
 659 -----------
 660 Please see linkgit:gitglossary[7].
 661
 662
 663 Environment Variables
 664 ---------------------
 665 Various Git commands use the following environment variables:
 666
 667 The Git Repository
 668 ~~~~~~~~~~~~~~~~~~
 669 These environment variables apply to 'all' core Git commands. Nb: it
 670 is worth noting that they may be used/overridden by SCMS sitting above
 671 Git so take care if using Cogito etc.
 672
 673 'GIT_INDEX_FILE'::
 674         This environment allows the specification of an alternate
 675         index file. If not specified, the default of `$GIT_DIR/index`
 676         is used.
 677
 678 'GIT_OBJECT_DIRECTORY'::
 679         If the object storage directory is specified via this
 680         environment variable then the sha1 directories are created
 681         underneath - otherwise the default `$GIT_DIR/objects`
 682         directory is used.
 683
 684 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
 685         Due to the immutable nature of Git objects, old objects can be
 686         archived into shared, read-only directories. This variable
 687         specifies a ":" separated (on Windows ";" separated) list
 688         of Git object directories which can be used to search for Git
 689         objects. New objects will not be written to these directories.
 690
 691 'GIT_DIR'::
 692         If the 'GIT_DIR' environment variable is set then it
 693         specifies a path to use instead of the default `.git`
 694         for the base of the repository.
 695         The '--git-dir' command-line option also sets this value.
 696
 697 'GIT_WORK_TREE'::
 698         Set the path to the root of the working tree.
 699         This can also be controlled by the '--work-tree' command line
 700         option and the core.worktree configuration variable.
 701
 702 'GIT_NAMESPACE'::
 703         Set the Git namespace; see linkgit:gitnamespaces[7] for details.
 704         The '--namespace' command-line option also sets this value.
 705
 706 'GIT_CEILING_DIRECTORIES'::
 707         This should be a colon-separated list of absolute paths.  If
 708         set, it is a list of directories that Git should not chdir up
 709         into while looking for a repository directory (useful for
 710         excluding slow-loading network directories).  It will not
 711         exclude the current working directory or a GIT_DIR set on the
 712         command line or in the environment.  Normally, Git has to read
 713         the entries in this list and resolve any symlink that
 714         might be present in order to compare them with the current
 715         directory.  However, if even this access is slow, you
 716         can add an empty entry to the list to tell Git that the
 717         subsequent entries are not symlinks and needn't be resolved;
 718         e.g.,
 719         'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
 720
 721 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
 722         When run in a directory that does not have ".git" repository
 723         directory, Git tries to find such a directory in the parent
 724         directories to find the top of the working tree, but by default it
 725         does not cross filesystem boundaries.  This environment variable
 726         can be set to true to tell Git not to stop at filesystem
 727         boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
 728         an explicit repository directory set via 'GIT_DIR' or on the
 729         command line.
 730
 731 Git Commits
 732 ~~~~~~~~~~~
 733 'GIT_AUTHOR_NAME'::
 734 'GIT_AUTHOR_EMAIL'::
 735 'GIT_AUTHOR_DATE'::
 736 'GIT_COMMITTER_NAME'::
 737 'GIT_COMMITTER_EMAIL'::
 738 'GIT_COMMITTER_DATE'::
 739 'EMAIL'::
 740         see linkgit:git-commit-tree[1]
 741
 742 Git Diffs
 743 ~~~~~~~~~
 744 'GIT_DIFF_OPTS'::
 745         Only valid setting is "--unified=??" or "-u??" to set the
 746         number of context lines shown when a unified diff is created.
 747         This takes precedence over any "-U" or "--unified" option
 748         value passed on the Git diff command line.
 749
 750 'GIT_EXTERNAL_DIFF'::
 751         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
 752         program named by it is called, instead of the diff invocation
 753         described above.  For a path that is added, removed, or modified,
 754         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
 755
 756         path old-file old-hex old-mode new-file new-hex new-mode
 757 +
 758 where:
 759
 760         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
 761                          contents of <old|new>,
 762         <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
 763         <old|new>-mode:: are the octal representation of the file modes.
 764 +
 765 The file parameters can point at the user's working file
 766 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
 767 when a new file is added), or a temporary file (e.g. `old-file` in the
 768 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
 769 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
 770 +
 771 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
 772 parameter, <path>.
 773
 774 other
 775 ~~~~~
 776 'GIT_MERGE_VERBOSITY'::
 777         A number controlling the amount of output shown by
 778         the recursive merge strategy.  Overrides merge.verbosity.
 779         See linkgit:git-merge[1]
 780
 781 'GIT_PAGER'::
 782         This environment variable overrides `$PAGER`. If it is set
 783         to an empty string or to the value "cat", Git will not launch
 784         a pager.  See also the `core.pager` option in
 785         linkgit:git-config[1].
 786
 787 'GIT_EDITOR'::
 788         This environment variable overrides `$EDITOR` and `$VISUAL`.
 789         It is used by several Git commands when, on interactive mode,
 790         an editor is to be launched. See also linkgit:git-var[1]
 791         and the `core.editor` option in linkgit:git-config[1].
 792
 793 'GIT_SSH'::
 794         If this environment variable is set then 'git fetch'
 795         and 'git push' will use this command instead
 796         of 'ssh' when they need to connect to a remote system.
 797         The '$GIT_SSH' command will be given exactly two or
 798         four arguments: the 'username@host' (or just 'host')
 799         from the URL and the shell command to execute on that
 800         remote system, optionally preceded by '-p' (literally) and
 801         the 'port' from the URL when it specifies something other
 802         than the default SSH port.
 803 +
 804 To pass options to the program that you want to list in GIT_SSH
 805 you will need to wrap the program and options into a shell script,
 806 then set GIT_SSH to refer to the shell script.
 807 +
 808 Usually it is easier to configure any desired options through your
 809 personal `.ssh/config` file.  Please consult your ssh documentation
 810 for further details.
 811
 812 'GIT_ASKPASS'::
 813         If this environment variable is set, then Git commands which need to
 814         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
 815         will call this program with a suitable prompt as command line argument
 816         and read the password from its STDOUT. See also the 'core.askpass'
 817         option in linkgit:git-config[1].
 818
 819 'GIT_CONFIG_NOSYSTEM'::
 820         Whether to skip reading settings from the system-wide
 821         `$(prefix)/etc/gitconfig` file.  This environment variable can
 822         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
 823         predictable environment for a picky script, or you can set it
 824         temporarily to avoid using a buggy `/etc/gitconfig` file while
 825         waiting for someone with sufficient permissions to fix it.
 826
 827 'GIT_FLUSH'::
 828         If this environment variable is set to "1", then commands such
 829         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
 830         'git check-attr', 'git check-ignore', and 'git whatchanged' will
 831         force a flush of the output stream after each record have been
 832         flushed. If this
 833         variable is set to "0", the output of these commands will be done
 834         using completely buffered I/O.   If this environment variable is
 835         not set, Git will choose buffered or record-oriented flushing
 836         based on whether stdout appears to be redirected to a file or not.
 837
 838 'GIT_TRACE'::
 839         If this variable is set to "1", "2" or "true" (comparison
 840         is case insensitive), Git will print `trace:` messages on
 841         stderr telling about alias expansion, built-in command
 842         execution and external command execution.
 843         If this variable is set to an integer value greater than 1
 844         and lower than 10 (strictly) then Git will interpret this
 845         value as an open file descriptor and will try to write the
 846         trace messages into this file descriptor.
 847         Alternatively, if this variable is set to an absolute path
 848         (starting with a '/' character), Git will interpret this
 849         as a file path and will try to write the trace messages
 850         into it.
 851
 852 'GIT_TRACE_PACK_ACCESS'::
 853         If this variable is set to a path, a file will be created at
 854         the given path logging all accesses to any packs. For each
 855         access, the pack file name and an offset in the pack is
 856         recorded. This may be helpful for troubleshooting some
 857         pack-related performance problems.
 858
 859 'GIT_TRACE_PACKET'::
 860         If this variable is set, it shows a trace of all packets
 861         coming in or out of a given program. This can help with
 862         debugging object negotiation or other protocol issues. Tracing
 863         is turned off at a packet starting with "PACK".
 864
 865 GIT_LITERAL_PATHSPECS::
 866         Setting this variable to `1` will cause Git to treat all
 867         pathspecs literally, rather than as glob patterns. For example,
 868         running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
 869         for commits that touch the path `*.c`, not any paths that the
 870         glob `*.c` matches. You might want this if you are feeding
 871         literal paths to Git (e.g., paths previously given to you by
 872         `git ls-tree`, `--raw` diff output, etc).
 873
 874
 875 Discussion[[Discussion]]
 876 ------------------------
 877
 878 More detail on the following is available from the
 879 link:user-manual.html#git-concepts[Git concepts chapter of the
 880 user-manual] and linkgit:gitcore-tutorial[7].
 881
 882 A Git project normally consists of a working directory with a ".git"
 883 subdirectory at the top level.  The .git directory contains, among other
 884 things, a compressed object database representing the complete history
 885 of the project, an "index" file which links that history to the current
 886 contents of the working tree, and named pointers into that history such
 887 as tags and branch heads.
 888
 889 The object database contains objects of three main types: blobs, which
 890 hold file data; trees, which point to blobs and other trees to build up
 891 directory hierarchies; and commits, which each reference a single tree
 892 and some number of parent commits.
 893
 894 The commit, equivalent to what other systems call a "changeset" or
 895 "version", represents a step in the project's history, and each parent
 896 represents an immediately preceding step.  Commits with more than one
 897 parent represent merges of independent lines of development.
 898
 899 All objects are named by the SHA-1 hash of their contents, normally
 900 written as a string of 40 hex digits.  Such names are globally unique.
 901 The entire history leading up to a commit can be vouched for by signing
 902 just that commit.  A fourth object type, the tag, is provided for this
 903 purpose.
 904
 905 When first created, objects are stored in individual files, but for
 906 efficiency may later be compressed together into "pack files".
 907
 908 Named pointers called refs mark interesting points in history.  A ref
 909 may contain the SHA-1 name of an object or the name of another ref.  Refs
 910 with names beginning `ref/head/` contain the SHA-1 name of the most
 911 recent commit (or "head") of a branch under development.  SHA-1 names of
 912 tags of interest are stored under `ref/tags/`.  A special ref named
 913 `HEAD` contains the name of the currently checked-out branch.
 914
 915 The index file is initialized with a list of all paths and, for each
 916 path, a blob object and a set of attributes.  The blob object represents
 917 the contents of the file as of the head of the current branch.  The
 918 attributes (last modified time, size, etc.) are taken from the
 919 corresponding file in the working tree.  Subsequent changes to the
 920 working tree can be found by comparing these attributes.  The index may
 921 be updated with new content, and new commits may be created from the
 922 content stored in the index.
 923
 924 The index is also capable of storing multiple entries (called "stages")
 925 for a given pathname.  These stages are used to hold the various
 926 unmerged version of a file when a merge is in progress.
 927
 928 FURTHER DOCUMENTATION
 929 ---------------------
 930
 931 See the references in the "description" section to get started
 932 using Git.  The following is probably more detail than necessary
 933 for a first-time user.
 934
 935 The link:user-manual.html#git-concepts[Git concepts chapter of the
 936 user-manual] and linkgit:gitcore-tutorial[7] both provide
 937 introductions to the underlying Git architecture.
 938
 939 See linkgit:gitworkflows[7] for an overview of recommended workflows.
 940
 941 See also the link:howto-index.html[howto] documents for some useful
 942 examples.
 943
 944 The internals are documented in the
 945 link:technical/api-index.html[Git API documentation].
 946
 947 Users migrating from CVS may also want to
 948 read linkgit:gitcvs-migration[7].
 949
 950
 951 Authors
 952 -------
 953 Git was started by Linus Torvalds, and is currently maintained by Junio
 954 C Hamano. Numerous contributions have come from the Git mailing list
 955 <git@vger.kernel.org>.  http://www.ohloh.net/p/git/contributors/summary
 956 gives you a more complete list of contributors.
 957
 958 If you have a clone of git.git itself, the
 959 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
 960 the authors for specific parts of the project.
 961
 962 Reporting Bugs
 963 --------------
 964
 965 Report bugs to the Git mailing list <git@vger.kernel.org> where the
 966 development and maintenance is primarily done.  You do not have to be
 967 subscribed to the list to send a message there.
 968
 969 SEE ALSO
 970 --------
 971 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
 972 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
 973 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
 974 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
 975 linkgit:gitworkflows[7]
 976
 977 GIT
 978 ---
 979 Part of the linkgit:git[1] suite