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