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