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