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