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 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
 457 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
 458 config file). Including the equals but with an empty value (like `git -c
 459 foo.bar= ...`) sets `foo.bar` to the empty string.
 460
 461 --exec-path[=<path>]::
 462         Path to wherever your core Git programs are installed.
 463         This can also be controlled by setting the GIT_EXEC_PATH
 464         environment variable. If no path is given, 'git' will print
 465         the current setting and then exit.
 466
 467 --html-path::
 468         Print the path, without trailing slash, where Git's HTML
 469         documentation is installed and exit.
 470
 471 --man-path::
 472         Print the manpath (see `man(1)`) for the man pages for
 473         this version of Git and exit.
 474
 475 --info-path::
 476         Print the path where the Info files documenting this
 477         version of Git are installed and exit.
 478
 479 -p::
 480 --paginate::
 481         Pipe all output into 'less' (or if set, $PAGER) if standard
 482         output is a terminal.  This overrides the `pager.<cmd>`
 483         configuration options (see the "Configuration Mechanism" section
 484         below).
 485
 486 --no-pager::
 487         Do not pipe Git output into a pager.
 488
 489 --git-dir=<path>::
 490         Set the path to the repository. This can also be controlled by
 491         setting the GIT_DIR environment variable. It can be an absolute
 492         path or relative path to current working directory.
 493
 494 --work-tree=<path>::
 495         Set the path to the working tree. It can be an absolute path
 496         or a path relative to the current working directory.
 497         This can also be controlled by setting the GIT_WORK_TREE
 498         environment variable and the core.worktree configuration
 499         variable (see core.worktree in linkgit:git-config[1] for a
 500         more detailed discussion).
 501
 502 --namespace=<path>::
 503         Set the Git namespace.  See linkgit:gitnamespaces[7] for more
 504         details.  Equivalent to setting the `GIT_NAMESPACE` environment
 505         variable.
 506
 507 --bare::
 508         Treat the repository as a bare repository.  If GIT_DIR
 509         environment is not set, it is set to the current working
 510         directory.
 511
 512 --no-replace-objects::
 513         Do not use replacement refs to replace Git objects. See
 514         linkgit:git-replace[1] for more information.
 515
 516 --literal-pathspecs::
 517         Treat pathspecs literally (i.e. no globbing, no pathspec magic).
 518         This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
 519         variable to `1`.
 520
 521 --glob-pathspecs::
 522         Add "glob" magic to all pathspec. This is equivalent to setting
 523         the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
 524         globbing on individual pathspecs can be done using pathspec
 525         magic ":(literal)"
 526
 527 --noglob-pathspecs::
 528         Add "literal" magic to all pathspec. This is equivalent to setting
 529         the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
 530         globbing on individual pathspecs can be done using pathspec
 531         magic ":(glob)"
 532
 533 --icase-pathspecs::
 534         Add "icase" magic to all pathspec. This is equivalent to setting
 535         the `GIT_ICASE_PATHSPECS` environment variable to `1`.
 536
 537 GIT COMMANDS
 538 ------------
 539
 540 We divide Git into high level ("porcelain") commands and low level
 541 ("plumbing") commands.
 542
 543 High-level commands (porcelain)
 544 -------------------------------
 545
 546 We separate the porcelain commands into the main commands and some
 547 ancillary user utilities.
 548
 549 Main porcelain commands
 550 ~~~~~~~~~~~~~~~~~~~~~~~
 551
 552 include::cmds-mainporcelain.txt[]
 553
 554 Ancillary Commands
 555 ~~~~~~~~~~~~~~~~~~
 556 Manipulators:
 557
 558 include::cmds-ancillarymanipulators.txt[]
 559
 560 Interrogators:
 561
 562 include::cmds-ancillaryinterrogators.txt[]
 563
 564
 565 Interacting with Others
 566 ~~~~~~~~~~~~~~~~~~~~~~~
 567
 568 These commands are to interact with foreign SCM and with other
 569 people via patch over e-mail.
 570
 571 include::cmds-foreignscminterface.txt[]
 572
 573
 574 Low-level commands (plumbing)
 575 -----------------------------
 576
 577 Although Git includes its
 578 own porcelain layer, its low-level commands are sufficient to support
 579 development of alternative porcelains.  Developers of such porcelains
 580 might start by reading about linkgit:git-update-index[1] and
 581 linkgit:git-read-tree[1].
 582
 583 The interface (input, output, set of options and the semantics)
 584 to these low-level commands are meant to be a lot more stable
 585 than Porcelain level commands, because these commands are
 586 primarily for scripted use.  The interface to Porcelain commands
 587 on the other hand are subject to change in order to improve the
 588 end user experience.
 589
 590 The following description divides
 591 the low-level commands into commands that manipulate objects (in
 592 the repository, index, and working tree), commands that interrogate and
 593 compare objects, and commands that move objects and references between
 594 repositories.
 595
 596
 597 Manipulation commands
 598 ~~~~~~~~~~~~~~~~~~~~~
 599
 600 include::cmds-plumbingmanipulators.txt[]
 601
 602
 603 Interrogation commands
 604 ~~~~~~~~~~~~~~~~~~~~~~
 605
 606 include::cmds-plumbinginterrogators.txt[]
 607
 608 In general, the interrogate commands do not touch the files in
 609 the working tree.
 610
 611
 612 Synching repositories
 613 ~~~~~~~~~~~~~~~~~~~~~
 614
 615 include::cmds-synchingrepositories.txt[]
 616
 617 The following are helper commands used by the above; end users
 618 typically do not use them directly.
 619
 620 include::cmds-synchelpers.txt[]
 621
 622
 623 Internal helper commands
 624 ~~~~~~~~~~~~~~~~~~~~~~~~
 625
 626 These are internal helper commands used by other commands; end
 627 users typically do not use them directly.
 628
 629 include::cmds-purehelpers.txt[]
 630
 631
 632 Configuration Mechanism
 633 -----------------------
 634
 635 Git uses a simple text format to store customizations that are per
 636 repository and are per user.  Such a configuration file may look
 637 like this:
 638
 639 ------------
 640 #
 641 # A '#' or ';' character indicates a comment.
 642 #
 643
 644 ; core variables
 645 [core]
 646         ; Don't trust file modes
 647         filemode = false
 648
 649 ; user identity
 650 [user]
 651         name = "Junio C Hamano"
 652         email = "gitster@pobox.com"
 653
 654 ------------
 655
 656 Various commands read from the configuration file and adjust
 657 their operation accordingly.  See linkgit:git-config[1] for a
 658 list and more details about the configuration mechanism.
 659
 660
 661 Identifier Terminology
 662 ----------------------
 663 <object>::
 664         Indicates the object name for any type of object.
 665
 666 <blob>::
 667         Indicates a blob object name.
 668
 669 <tree>::
 670         Indicates a tree object name.
 671
 672 <commit>::
 673         Indicates a commit object name.
 674
 675 <tree-ish>::
 676         Indicates a tree, commit or tag object name.  A
 677         command that takes a <tree-ish> argument ultimately wants to
 678         operate on a <tree> object but automatically dereferences
 679         <commit> and <tag> objects that point at a <tree>.
 680
 681 <commit-ish>::
 682         Indicates a commit or tag object name.  A
 683         command that takes a <commit-ish> argument ultimately wants to
 684         operate on a <commit> object but automatically dereferences
 685         <tag> objects that point at a <commit>.
 686
 687 <type>::
 688         Indicates that an object type is required.
 689         Currently one of: `blob`, `tree`, `commit`, or `tag`.
 690
 691 <file>::
 692         Indicates a filename - almost always relative to the
 693         root of the tree structure `GIT_INDEX_FILE` describes.
 694
 695 Symbolic Identifiers
 696 --------------------
 697 Any Git command accepting any <object> can also use the following
 698 symbolic notation:
 699
 700 HEAD::
 701         indicates the head of the current branch.
 702
 703 <tag>::
 704         a valid tag 'name'
 705         (i.e. a `refs/tags/<tag>` reference).
 706
 707 <head>::
 708         a valid head 'name'
 709         (i.e. a `refs/heads/<head>` reference).
 710
 711 For a more complete list of ways to spell object names, see
 712 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
 713
 714
 715 File/Directory Structure
 716 ------------------------
 717
 718 Please see the linkgit:gitrepository-layout[5] document.
 719
 720 Read linkgit:githooks[5] for more details about each hook.
 721
 722 Higher level SCMs may provide and manage additional information in the
 723 `$GIT_DIR`.
 724
 725
 726 Terminology
 727 -----------
 728 Please see linkgit:gitglossary[7].
 729
 730
 731 Environment Variables
 732 ---------------------
 733 Various Git commands use the following environment variables:
 734
 735 The Git Repository
 736 ~~~~~~~~~~~~~~~~~~
 737 These environment variables apply to 'all' core Git commands. Nb: it
 738 is worth noting that they may be used/overridden by SCMS sitting above
 739 Git so take care if using Cogito etc.
 740
 741 'GIT_INDEX_FILE'::
 742         This environment allows the specification of an alternate
 743         index file. If not specified, the default of `$GIT_DIR/index`
 744         is used.
 745
 746 'GIT_INDEX_VERSION'::
 747         This environment variable allows the specification of an index
 748         version for new repositories.  It won't affect existing index
 749         files.  By default index file version [23] is used.
 750
 751 'GIT_OBJECT_DIRECTORY'::
 752         If the object storage directory is specified via this
 753         environment variable then the sha1 directories are created
 754         underneath - otherwise the default `$GIT_DIR/objects`
 755         directory is used.
 756
 757 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
 758         Due to the immutable nature of Git objects, old objects can be
 759         archived into shared, read-only directories. This variable
 760         specifies a ":" separated (on Windows ";" separated) list
 761         of Git object directories which can be used to search for Git
 762         objects. New objects will not be written to these directories.
 763
 764 'GIT_DIR'::
 765         If the 'GIT_DIR' environment variable is set then it
 766         specifies a path to use instead of the default `.git`
 767         for the base of the repository.
 768         The '--git-dir' command-line option also sets this value.
 769
 770 'GIT_WORK_TREE'::
 771         Set the path to the root of the working tree.
 772         This can also be controlled by the '--work-tree' command-line
 773         option and the core.worktree configuration variable.
 774
 775 'GIT_NAMESPACE'::
 776         Set the Git namespace; see linkgit:gitnamespaces[7] for details.
 777         The '--namespace' command-line option also sets this value.
 778
 779 'GIT_CEILING_DIRECTORIES'::
 780         This should be a colon-separated list of absolute paths.  If
 781         set, it is a list of directories that Git should not chdir up
 782         into while looking for a repository directory (useful for
 783         excluding slow-loading network directories).  It will not
 784         exclude the current working directory or a GIT_DIR set on the
 785         command line or in the environment.  Normally, Git has to read
 786         the entries in this list and resolve any symlink that
 787         might be present in order to compare them with the current
 788         directory.  However, if even this access is slow, you
 789         can add an empty entry to the list to tell Git that the
 790         subsequent entries are not symlinks and needn't be resolved;
 791         e.g.,
 792         'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
 793
 794 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
 795         When run in a directory that does not have ".git" repository
 796         directory, Git tries to find such a directory in the parent
 797         directories to find the top of the working tree, but by default it
 798         does not cross filesystem boundaries.  This environment variable
 799         can be set to true to tell Git not to stop at filesystem
 800         boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
 801         an explicit repository directory set via 'GIT_DIR' or on the
 802         command line.
 803
 804 Git Commits
 805 ~~~~~~~~~~~
 806 'GIT_AUTHOR_NAME'::
 807 'GIT_AUTHOR_EMAIL'::
 808 'GIT_AUTHOR_DATE'::
 809 'GIT_COMMITTER_NAME'::
 810 'GIT_COMMITTER_EMAIL'::
 811 'GIT_COMMITTER_DATE'::
 812 'EMAIL'::
 813         see linkgit:git-commit-tree[1]
 814
 815 Git Diffs
 816 ~~~~~~~~~
 817 'GIT_DIFF_OPTS'::
 818         Only valid setting is "--unified=??" or "-u??" to set the
 819         number of context lines shown when a unified diff is created.
 820         This takes precedence over any "-U" or "--unified" option
 821         value passed on the Git diff command line.
 822
 823 'GIT_EXTERNAL_DIFF'::
 824         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
 825         program named by it is called, instead of the diff invocation
 826         described above.  For a path that is added, removed, or modified,
 827         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
 828
 829         path old-file old-hex old-mode new-file new-hex new-mode
 830 +
 831 where:
 832
 833         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
 834                          contents of <old|new>,
 835         <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
 836         <old|new>-mode:: are the octal representation of the file modes.
 837 +
 838 The file parameters can point at the user's working file
 839 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
 840 when a new file is added), or a temporary file (e.g. `old-file` in the
 841 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
 842 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
 843 +
 844 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
 845 parameter, <path>.
 846 +
 847 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
 848 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
 849
 850 'GIT_DIFF_PATH_COUNTER'::
 851         A 1-based counter incremented by one for every path.
 852
 853 'GIT_DIFF_PATH_TOTAL'::
 854         The total number of paths.
 855
 856 other
 857 ~~~~~
 858 'GIT_MERGE_VERBOSITY'::
 859         A number controlling the amount of output shown by
 860         the recursive merge strategy.  Overrides merge.verbosity.
 861         See linkgit:git-merge[1]
 862
 863 'GIT_PAGER'::
 864         This environment variable overrides `$PAGER`. If it is set
 865         to an empty string or to the value "cat", Git will not launch
 866         a pager.  See also the `core.pager` option in
 867         linkgit:git-config[1].
 868
 869 'GIT_EDITOR'::
 870         This environment variable overrides `$EDITOR` and `$VISUAL`.
 871         It is used by several Git commands when, on interactive mode,
 872         an editor is to be launched. See also linkgit:git-var[1]
 873         and the `core.editor` option in linkgit:git-config[1].
 874
 875 'GIT_SSH'::
 876         If this environment variable is set then 'git fetch'
 877         and 'git push' will use this command instead
 878         of 'ssh' when they need to connect to a remote system.
 879         The '$GIT_SSH' command will be given exactly two or
 880         four arguments: the 'username@host' (or just 'host')
 881         from the URL and the shell command to execute on that
 882         remote system, optionally preceded by '-p' (literally) and
 883         the 'port' from the URL when it specifies something other
 884         than the default SSH port.
 885 +
 886 To pass options to the program that you want to list in GIT_SSH
 887 you will need to wrap the program and options into a shell script,
 888 then set GIT_SSH to refer to the shell script.
 889 +
 890 Usually it is easier to configure any desired options through your
 891 personal `.ssh/config` file.  Please consult your ssh documentation
 892 for further details.
 893
 894 'GIT_ASKPASS'::
 895         If this environment variable is set, then Git commands which need to
 896         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
 897         will call this program with a suitable prompt as command-line argument
 898         and read the password from its STDOUT. See also the 'core.askpass'
 899         option in linkgit:git-config[1].
 900
 901 'GIT_CONFIG_NOSYSTEM'::
 902         Whether to skip reading settings from the system-wide
 903         `$(prefix)/etc/gitconfig` file.  This environment variable can
 904         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
 905         predictable environment for a picky script, or you can set it
 906         temporarily to avoid using a buggy `/etc/gitconfig` file while
 907         waiting for someone with sufficient permissions to fix it.
 908
 909 'GIT_FLUSH'::
 910         If this environment variable is set to "1", then commands such
 911         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
 912         'git check-attr' and 'git check-ignore' will
 913         force a flush of the output stream after each record have been
 914         flushed. If this
 915         variable is set to "0", the output of these commands will be done
 916         using completely buffered I/O.   If this environment variable is
 917         not set, Git will choose buffered or record-oriented flushing
 918         based on whether stdout appears to be redirected to a file or not.
 919
 920 'GIT_TRACE'::
 921         Enables general trace messages, e.g. alias expansion, built-in
 922         command execution and external command execution.
 923 +
 924 If this variable is set to "1", "2" or "true" (comparison
 925 is case insensitive), trace messages will be printed to
 926 stderr.
 927 +
 928 If the variable is set to an integer value greater than 2
 929 and lower than 10 (strictly) then Git will interpret this
 930 value as an open file descriptor and will try to write the
 931 trace messages into this file descriptor.
 932 +
 933 Alternatively, if the variable is set to an absolute path
 934 (starting with a '/' character), Git will interpret this
 935 as a file path and will try to write the trace messages
 936 into it.
 937 +
 938 Unsetting the variable, or setting it to empty, "0" or
 939 "false" (case insensitive) disables trace messages.
 940
 941 'GIT_TRACE_PACK_ACCESS'::
 942         Enables trace messages for all accesses to any packs. For each
 943         access, the pack file name and an offset in the pack is
 944         recorded. This may be helpful for troubleshooting some
 945         pack-related performance problems.
 946         See 'GIT_TRACE' for available trace output options.
 947
 948 'GIT_TRACE_PACKET'::
 949         Enables trace messages for all packets coming in or out of a
 950         given program. This can help with debugging object negotiation
 951         or other protocol issues. Tracing is turned off at a packet
 952         starting with "PACK".
 953         See 'GIT_TRACE' for available trace output options.
 954
 955 'GIT_TRACE_PERFORMANCE'::
 956         Enables performance related trace messages, e.g. total execution
 957         time of each Git command.
 958         See 'GIT_TRACE' for available trace output options.
 959
 960 'GIT_TRACE_SETUP'::
 961         Enables trace messages printing the .git, working tree and current
 962         working directory after Git has completed its setup phase.
 963         See 'GIT_TRACE' for available trace output options.
 964
 965 'GIT_TRACE_SHALLOW'::
 966         Enables trace messages that can help debugging fetching /
 967         cloning of shallow repositories.
 968         See 'GIT_TRACE' for available trace output options.
 969
 970 GIT_LITERAL_PATHSPECS::
 971         Setting this variable to `1` will cause Git to treat all
 972         pathspecs literally, rather than as glob patterns. For example,
 973         running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
 974         for commits that touch the path `*.c`, not any paths that the
 975         glob `*.c` matches. You might want this if you are feeding
 976         literal paths to Git (e.g., paths previously given to you by
 977         `git ls-tree`, `--raw` diff output, etc).
 978
 979 GIT_GLOB_PATHSPECS::
 980         Setting this variable to `1` will cause Git to treat all
 981         pathspecs as glob patterns (aka "glob" magic).
 982
 983 GIT_NOGLOB_PATHSPECS::
 984         Setting this variable to `1` will cause Git to treat all
 985         pathspecs as literal (aka "literal" magic).
 986
 987 GIT_ICASE_PATHSPECS::
 988         Setting this variable to `1` will cause Git to treat all
 989         pathspecs as case-insensitive.
 990
 991 'GIT_REFLOG_ACTION'::
 992         When a ref is updated, reflog entries are created to keep
 993         track of the reason why the ref was updated (which is
 994         typically the name of the high-level command that updated
 995         the ref), in addition to the old and new values of the ref.
 996         A scripted Porcelain command can use set_reflog_action
 997         helper function in `git-sh-setup` to set its name to this
 998         variable when it is invoked as the top level command by the
 999         end user, to be recorded in the body of the reflog.
1000
1001
1002 Discussion[[Discussion]]
1003 ------------------------
1004
1005 More detail on the following is available from the
1006 link:user-manual.html#git-concepts[Git concepts chapter of the
1007 user-manual] and linkgit:gitcore-tutorial[7].
1008
1009 A Git project normally consists of a working directory with a ".git"
1010 subdirectory at the top level.  The .git directory contains, among other
1011 things, a compressed object database representing the complete history
1012 of the project, an "index" file which links that history to the current
1013 contents of the working tree, and named pointers into that history such
1014 as tags and branch heads.
1015
1016 The object database contains objects of three main types: blobs, which
1017 hold file data; trees, which point to blobs and other trees to build up
1018 directory hierarchies; and commits, which each reference a single tree
1019 and some number of parent commits.
1020
1021 The commit, equivalent to what other systems call a "changeset" or
1022 "version", represents a step in the project's history, and each parent
1023 represents an immediately preceding step.  Commits with more than one
1024 parent represent merges of independent lines of development.
1025
1026 All objects are named by the SHA-1 hash of their contents, normally
1027 written as a string of 40 hex digits.  Such names are globally unique.
1028 The entire history leading up to a commit can be vouched for by signing
1029 just that commit.  A fourth object type, the tag, is provided for this
1030 purpose.
1031
1032 When first created, objects are stored in individual files, but for
1033 efficiency may later be compressed together into "pack files".
1034
1035 Named pointers called refs mark interesting points in history.  A ref
1036 may contain the SHA-1 name of an object or the name of another ref.  Refs
1037 with names beginning `ref/head/` contain the SHA-1 name of the most
1038 recent commit (or "head") of a branch under development.  SHA-1 names of
1039 tags of interest are stored under `ref/tags/`.  A special ref named
1040 `HEAD` contains the name of the currently checked-out branch.
1041
1042 The index file is initialized with a list of all paths and, for each
1043 path, a blob object and a set of attributes.  The blob object represents
1044 the contents of the file as of the head of the current branch.  The
1045 attributes (last modified time, size, etc.) are taken from the
1046 corresponding file in the working tree.  Subsequent changes to the
1047 working tree can be found by comparing these attributes.  The index may
1048 be updated with new content, and new commits may be created from the
1049 content stored in the index.
1050
1051 The index is also capable of storing multiple entries (called "stages")
1052 for a given pathname.  These stages are used to hold the various
1053 unmerged version of a file when a merge is in progress.
1054
1055 FURTHER DOCUMENTATION
1056 ---------------------
1057
1058 See the references in the "description" section to get started
1059 using Git.  The following is probably more detail than necessary
1060 for a first-time user.
1061
1062 The link:user-manual.html#git-concepts[Git concepts chapter of the
1063 user-manual] and linkgit:gitcore-tutorial[7] both provide
1064 introductions to the underlying Git architecture.
1065
1066 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1067
1068 See also the link:howto-index.html[howto] documents for some useful
1069 examples.
1070
1071 The internals are documented in the
1072 link:technical/api-index.html[Git API documentation].
1073
1074 Users migrating from CVS may also want to
1075 read linkgit:gitcvs-migration[7].
1076
1077
1078 Authors
1079 -------
1080 Git was started by Linus Torvalds, and is currently maintained by Junio
1081 C Hamano. Numerous contributions have come from the Git mailing list
1082 <git@vger.kernel.org>.  http://www.openhub.net/p/git/contributors/summary
1083 gives you a more complete list of contributors.
1084
1085 If you have a clone of git.git itself, the
1086 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1087 the authors for specific parts of the project.
1088
1089 Reporting Bugs
1090 --------------
1091
1092 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1093 development and maintenance is primarily done.  You do not have to be
1094 subscribed to the list to send a message there.
1095
1096 SEE ALSO
1097 --------
1098 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1099 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
1100 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1101 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1102 linkgit:gitworkflows[7]
1103
1104 GIT
1105 ---
1106 Part of the linkgit:git[1] suite