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