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