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