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