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 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
 539 is used to hold per-repository configuration options.  It is a
 540 simple text file modeled after `.ini` format familiar to some
 541 people.  Here is an example:
 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 = "junkio@twinsun.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.
 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.
 682         If set, it is a list of directories that Git should not chdir
 683         up into while looking for a repository directory.
 684         It will not exclude the current working directory or
 685         a GIT_DIR set on the command line or in the environment.
 686         (Useful for excluding slow-loading network directories.)
 687
 688 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
 689         When run in a directory that does not have ".git" repository
 690         directory, Git tries to find such a directory in the parent
 691         directories to find the top of the working tree, but by default it
 692         does not cross filesystem boundaries.  This environment variable
 693         can be set to true to tell Git not to stop at filesystem
 694         boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
 695         an explicit repository directory set via 'GIT_DIR' or on the
 696         command line.
 697
 698 Git Commits
 699 ~~~~~~~~~~~
 700 'GIT_AUTHOR_NAME'::
 701 'GIT_AUTHOR_EMAIL'::
 702 'GIT_AUTHOR_DATE'::
 703 'GIT_COMMITTER_NAME'::
 704 'GIT_COMMITTER_EMAIL'::
 705 'GIT_COMMITTER_DATE'::
 706 'EMAIL'::
 707         see linkgit:git-commit-tree[1]
 708
 709 Git Diffs
 710 ~~~~~~~~~
 711 'GIT_DIFF_OPTS'::
 712         Only valid setting is "--unified=??" or "-u??" to set the
 713         number of context lines shown when a unified diff is created.
 714         This takes precedence over any "-U" or "--unified" option
 715         value passed on the Git diff command line.
 716
 717 'GIT_EXTERNAL_DIFF'::
 718         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
 719         program named by it is called, instead of the diff invocation
 720         described above.  For a path that is added, removed, or modified,
 721         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
 722
 723         path old-file old-hex old-mode new-file new-hex new-mode
 724 +
 725 where:
 726
 727         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
 728                          contents of <old|new>,
 729         <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
 730         <old|new>-mode:: are the octal representation of the file modes.
 731 +
 732 The file parameters can point at the user's working file
 733 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
 734 when a new file is added), or a temporary file (e.g. `old-file` in the
 735 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
 736 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
 737 +
 738 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
 739 parameter, <path>.
 740
 741 other
 742 ~~~~~
 743 'GIT_MERGE_VERBOSITY'::
 744         A number controlling the amount of output shown by
 745         the recursive merge strategy.  Overrides merge.verbosity.
 746         See linkgit:git-merge[1]
 747
 748 'GIT_PAGER'::
 749         This environment variable overrides `$PAGER`. If it is set
 750         to an empty string or to the value "cat", Git will not launch
 751         a pager.  See also the `core.pager` option in
 752         linkgit:git-config[1].
 753
 754 'GIT_EDITOR'::
 755         This environment variable overrides `$EDITOR` and `$VISUAL`.
 756         It is used by several Git commands when, on interactive mode,
 757         an editor is to be launched. See also linkgit:git-var[1]
 758         and the `core.editor` option in linkgit:git-config[1].
 759
 760 'GIT_SSH'::
 761         If this environment variable is set then 'git fetch'
 762         and 'git push' will use this command instead
 763         of 'ssh' when they need to connect to a remote system.
 764         The '$GIT_SSH' command will be given exactly two arguments:
 765         the 'username@host' (or just 'host') from the URL and the
 766         shell command to execute on that remote system.
 767 +
 768 To pass options to the program that you want to list in GIT_SSH
 769 you will need to wrap the program and options into a shell script,
 770 then set GIT_SSH to refer to the shell script.
 771 +
 772 Usually it is easier to configure any desired options through your
 773 personal `.ssh/config` file.  Please consult your ssh documentation
 774 for further details.
 775
 776 'GIT_ASKPASS'::
 777         If this environment variable is set, then Git commands which need to
 778         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
 779         will call this program with a suitable prompt as command line argument
 780         and read the password from its STDOUT. See also the 'core.askpass'
 781         option in linkgit:git-config[1].
 782
 783 'GIT_CONFIG_NOSYSTEM'::
 784         Whether to skip reading settings from the system-wide
 785         `$(prefix)/etc/gitconfig` file.  This environment variable can
 786         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
 787         predictable environment for a picky script, or you can set it
 788         temporarily to avoid using a buggy `/etc/gitconfig` file while
 789         waiting for someone with sufficient permissions to fix it.
 790
 791 'GIT_FLUSH'::
 792         If this environment variable is set to "1", then commands such
 793         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
 794         and 'git whatchanged' will force a flush of the output stream
 795         after each commit-oriented record have been flushed.   If this
 796         variable is set to "0", the output of these commands will be done
 797         using completely buffered I/O.   If this environment variable is
 798         not set, Git will choose buffered or record-oriented flushing
 799         based on whether stdout appears to be redirected to a file or not.
 800
 801 'GIT_TRACE'::
 802         If this variable is set to "1", "2" or "true" (comparison
 803         is case insensitive), Git will print `trace:` messages on
 804         stderr telling about alias expansion, built-in command
 805         execution and external command execution.
 806         If this variable is set to an integer value greater than 1
 807         and lower than 10 (strictly) then Git will interpret this
 808         value as an open file descriptor and will try to write the
 809         trace messages into this file descriptor.
 810         Alternatively, if this variable is set to an absolute path
 811         (starting with a '/' character), Git will interpret this
 812         as a file path and will try to write the trace messages
 813         into it.
 814
 815 GIT_LITERAL_PATHSPECS::
 816         Setting this variable to `1` will cause Git to treat all
 817         pathspecs literally, rather than as glob patterns. For example,
 818         running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
 819         for commits that touch the path `*.c`, not any paths that the
 820         glob `*.c` matches. You might want this if you are feeding
 821         literal paths to Git (e.g., paths previously given to you by
 822         `git ls-tree`, `--raw` diff output, etc).
 823
 824
 825 Discussion[[Discussion]]
 826 ------------------------
 827
 828 More detail on the following is available from the
 829 link:user-manual.html#git-concepts[Git concepts chapter of the
 830 user-manual] and linkgit:gitcore-tutorial[7].
 831
 832 A Git project normally consists of a working directory with a ".git"
 833 subdirectory at the top level.  The .git directory contains, among other
 834 things, a compressed object database representing the complete history
 835 of the project, an "index" file which links that history to the current
 836 contents of the working tree, and named pointers into that history such
 837 as tags and branch heads.
 838
 839 The object database contains objects of three main types: blobs, which
 840 hold file data; trees, which point to blobs and other trees to build up
 841 directory hierarchies; and commits, which each reference a single tree
 842 and some number of parent commits.
 843
 844 The commit, equivalent to what other systems call a "changeset" or
 845 "version", represents a step in the project's history, and each parent
 846 represents an immediately preceding step.  Commits with more than one
 847 parent represent merges of independent lines of development.
 848
 849 All objects are named by the SHA1 hash of their contents, normally
 850 written as a string of 40 hex digits.  Such names are globally unique.
 851 The entire history leading up to a commit can be vouched for by signing
 852 just that commit.  A fourth object type, the tag, is provided for this
 853 purpose.
 854
 855 When first created, objects are stored in individual files, but for
 856 efficiency may later be compressed together into "pack files".
 857
 858 Named pointers called refs mark interesting points in history.  A ref
 859 may contain the SHA1 name of an object or the name of another ref.  Refs
 860 with names beginning `ref/head/` contain the SHA1 name of the most
 861 recent commit (or "head") of a branch under development.  SHA1 names of
 862 tags of interest are stored under `ref/tags/`.  A special ref named
 863 `HEAD` contains the name of the currently checked-out branch.
 864
 865 The index file is initialized with a list of all paths and, for each
 866 path, a blob object and a set of attributes.  The blob object represents
 867 the contents of the file as of the head of the current branch.  The
 868 attributes (last modified time, size, etc.) are taken from the
 869 corresponding file in the working tree.  Subsequent changes to the
 870 working tree can be found by comparing these attributes.  The index may
 871 be updated with new content, and new commits may be created from the
 872 content stored in the index.
 873
 874 The index is also capable of storing multiple entries (called "stages")
 875 for a given pathname.  These stages are used to hold the various
 876 unmerged version of a file when a merge is in progress.
 877
 878 FURTHER DOCUMENTATION
 879 ---------------------
 880
 881 See the references in the "description" section to get started
 882 using Git.  The following is probably more detail than necessary
 883 for a first-time user.
 884
 885 The link:user-manual.html#git-concepts[Git concepts chapter of the
 886 user-manual] and linkgit:gitcore-tutorial[7] both provide
 887 introductions to the underlying Git architecture.
 888
 889 See linkgit:gitworkflows[7] for an overview of recommended workflows.
 890
 891 See also the link:howto-index.html[howto] documents for some useful
 892 examples.
 893
 894 The internals are documented in the
 895 link:technical/api-index.html[Git API documentation].
 896
 897 Users migrating from CVS may also want to
 898 read linkgit:gitcvs-migration[7].
 899
 900
 901 Authors
 902 -------
 903 Git was started by Linus Torvalds, and is currently maintained by Junio
 904 C Hamano. Numerous contributions have come from the Git mailing list
 905 <git@vger.kernel.org>.  http://www.ohloh.net/p/git/contributors/summary
 906 gives you a more complete list of contributors.
 907
 908 If you have a clone of git.git itself, the
 909 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
 910 the authors for specific parts of the project.
 911
 912 Reporting Bugs
 913 --------------
 914
 915 Report bugs to the Git mailing list <git@vger.kernel.org> where the
 916 development and maintenance is primarily done.  You do not have to be
 917 subscribed to the list to send a message there.
 918
 919 SEE ALSO
 920 --------
 921 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
 922 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
 923 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
 924 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
 925 linkgit:gitworkflows[7]
 926
 927 GIT
 928 ---
 929 Part of the linkgit:git[1] suite