Documentation/git.txt

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