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