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