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