Documentation/git.txt

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