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