Documentation/git.txt

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