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