doc/source/en/TortoiseGit/git_doc/git.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git(1)">\r
   5 <articleinfo>\r
   6     <title>git(1)</title>\r
   7 <indexterm>\r
   8 <primary>git(1)</primary>\r
   9 </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git - the stupid content tracker</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git</emphasis> [--version] [--help] [-c &lt;name&gt;=&lt;value&gt;]\r
  19     [--exec-path[=&lt;path&gt;]] [--html-path] [--man-path] [--info-path]\r
  20     [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]\r
  21     [--git-dir=&lt;path&gt;] [--work-tree=&lt;path&gt;] [--namespace=&lt;name&gt;]\r
  22     &lt;command&gt; [&lt;args&gt;]</literallayout>\r
  23 </blockquote>\r
  24 </simplesect>\r
  25 <simplesect id="_description">\r
  26 <title>DESCRIPTION</title>\r
  27 <simpara>Git is a fast, scalable, distributed revision control system with an\r
  28 unusually rich command set that provides both high-level operations\r
  29 and full access to internals.</simpara>\r
  30 <simpara>See <xref linkend="gittutorial(7)" /> to get started, then see\r
  31 link:everyday.html[Everyday Git] for a useful minimum set of commands, and\r
  32 "man git-commandname" for documentation of each command.  CVS users may\r
  33 also want to read <xref linkend="gitcvs-migration(7)" />.  See\r
  34 the link:user-manual.html[Git User's Manual] for a more in-depth\r
  35 introduction.</simpara>\r
  36 <simpara>The <emphasis>&lt;command&gt;</emphasis> is either a name of a Git command (see below) or an alias\r
  37 as defined in the configuration file (see <xref linkend="git-config(1)" />).</simpara>\r
  38 <simpara>Formatted and hyperlinked version of the latest git\r
  39 documentation can be viewed at\r
  40 <emphasis>http://www.kernel.org/pub/software/scm/git/docs/</emphasis>.</simpara>\r
  41 </simplesect>\r
  42 <simplesect id="_options">\r
  43 <title>OPTIONS</title>\r
  44 <variablelist>\r
  45 <varlistentry>\r
  46 <term>\r
  47 --version\r
  48 </term>\r
  49 <listitem>\r
  50 <simpara>\r
  51         Prints the git suite version that the <emphasis>git</emphasis> program came from.\r
  52 </simpara>\r
  53 </listitem>\r
  54 </varlistentry>\r
  55 <varlistentry>\r
  56 <term>\r
  57 --help\r
  58 </term>\r
  59 <listitem>\r
  60 <simpara>\r
  61         Prints the synopsis and a list of the most commonly used\r
  62         commands. If the option <emphasis>--all</emphasis> or <emphasis>-a</emphasis> is given then all\r
  63         available commands are printed. If a git command is named this\r
  64         option will bring up the manual page for that command.\r
  65 </simpara>\r
  66 <simpara>Other options are available to control how the manual page is\r
  67 displayed. See <xref linkend="git-help(1)" /> for more information,\r
  68 because <emphasis>git --help ...</emphasis> is converted internally into <emphasis>git\r
  69 help ...</emphasis>.</simpara>\r
  70 </listitem>\r
  71 </varlistentry>\r
  72 <varlistentry>\r
  73 <term>\r
  74 -c &lt;name&gt;=&lt;value&gt;\r
  75 </term>\r
  76 <listitem>\r
  77 <simpara>\r
  78         Pass a configuration parameter to the command. The value\r
  79         given will override values from configuration files.\r
  80         The &lt;name&gt; is expected in the same format as listed by\r
  81         <emphasis>git config</emphasis> (subkeys separated by dots).\r
  82 </simpara>\r
  83 </listitem>\r
  84 </varlistentry>\r
  85 <varlistentry>\r
  86 <term>\r
  87 --exec-path[=&lt;path&gt;]\r
  88 </term>\r
  89 <listitem>\r
  90 <simpara>\r
  91         Path to wherever your core git programs are installed.\r
  92         This can also be controlled by setting the GIT_EXEC_PATH\r
  93         environment variable. If no path is given, <emphasis>git</emphasis> will print\r
  94         the current setting and then exit.\r
  95 </simpara>\r
  96 </listitem>\r
  97 </varlistentry>\r
  98 <varlistentry>\r
  99 <term>\r
 100 --html-path\r
 101 </term>\r
 102 <listitem>\r
 103 <simpara>\r
 104         Print the path, without trailing slash, where git's HTML\r
 105         documentation is installed and exit.\r
 106 </simpara>\r
 107 </listitem>\r
 108 </varlistentry>\r
 109 <varlistentry>\r
 110 <term>\r
 111 --man-path\r
 112 </term>\r
 113 <listitem>\r
 114 <simpara>\r
 115         Print the manpath (see <emphasis>man(1)</emphasis>) for the man pages for\r
 116         this version of git and exit.\r
 117 </simpara>\r
 118 </listitem>\r
 119 </varlistentry>\r
 120 <varlistentry>\r
 121 <term>\r
 122 --info-path\r
 123 </term>\r
 124 <listitem>\r
 125 <simpara>\r
 126         Print the path where the Info files documenting this\r
 127         version of git are installed and exit.\r
 128 </simpara>\r
 129 </listitem>\r
 130 </varlistentry>\r
 131 <varlistentry>\r
 132 <term>\r
 133 -p\r
 134 </term>\r
 135 <term>\r
 136 --paginate\r
 137 </term>\r
 138 <listitem>\r
 139 <simpara>\r
 140         Pipe all output into <emphasis>less</emphasis> (or if set, $PAGER) if standard\r
 141         output is a terminal.  This overrides the <emphasis>pager.&lt;cmd&gt;</emphasis>\r
 142         configuration options (see the "Configuration Mechanism" section\r
 143         below).\r
 144 </simpara>\r
 145 </listitem>\r
 146 </varlistentry>\r
 147 <varlistentry>\r
 148 <term>\r
 149 --no-pager\r
 150 </term>\r
 151 <listitem>\r
 152 <simpara>\r
 153         Do not pipe git output into a pager.\r
 154 </simpara>\r
 155 </listitem>\r
 156 </varlistentry>\r
 157 <varlistentry>\r
 158 <term>\r
 159 --git-dir=&lt;path&gt;\r
 160 </term>\r
 161 <listitem>\r
 162 <simpara>\r
 163         Set the path to the repository. This can also be controlled by\r
 164         setting the GIT_DIR environment variable. It can be an absolute\r
 165         path or relative path to current working directory.\r
 166 </simpara>\r
 167 </listitem>\r
 168 </varlistentry>\r
 169 <varlistentry>\r
 170 <term>\r
 171 --work-tree=&lt;path&gt;\r
 172 </term>\r
 173 <listitem>\r
 174 <simpara>\r
 175         Set the path to the working tree. It can be an absolute path\r
 176         or a path relative to the current working directory.\r
 177         This can also be controlled by setting the GIT_WORK_TREE\r
 178         environment variable and the core.worktree configuration\r
 179         variable (see core.worktree in <xref linkend="git-config(1)" /> for a\r
 180         more detailed discussion).\r
 181 </simpara>\r
 182 </listitem>\r
 183 </varlistentry>\r
 184 <varlistentry>\r
 185 <term>\r
 186 --namespace=&lt;path&gt;\r
 187 </term>\r
 188 <listitem>\r
 189 <simpara>\r
 190         Set the git namespace.  See <xref linkend="gitnamespaces(7)" /> for more\r
 191         details.  Equivalent to setting the <emphasis>GIT_NAMESPACE</emphasis> environment\r
 192         variable.\r
 193 </simpara>\r
 194 </listitem>\r
 195 </varlistentry>\r
 196 <varlistentry>\r
 197 <term>\r
 198 --bare\r
 199 </term>\r
 200 <listitem>\r
 201 <simpara>\r
 202         Treat the repository as a bare repository.  If GIT_DIR\r
 203         environment is not set, it is set to the current working\r
 204         directory.\r
 205 </simpara>\r
 206 </listitem>\r
 207 </varlistentry>\r
 208 <varlistentry>\r
 209 <term>\r
 210 --no-replace-objects\r
 211 </term>\r
 212 <listitem>\r
 213 <simpara>\r
 214         Do not use replacement refs to replace git objects. See\r
 215         <xref linkend="git-replace(1)" /> for more information.\r
 216 </simpara>\r
 217 </listitem>\r
 218 </varlistentry>\r
 219 </variablelist>\r
 220 </simplesect>\r
 221 <simplesect id="_further_documentation">\r
 222 <title>FURTHER DOCUMENTATION</title>\r
 223 <simpara>See the references above to get started using git.  The following is\r
 224 probably more detail than necessary for a first-time user.</simpara>\r
 225 <simpara>The <link linkend="git-concepts">git concepts chapter of the\r
 226 user-manual</link> and <xref linkend="gitcore-tutorial(7)" /> both provide\r
 227 introductions to the underlying git architecture.</simpara>\r
 228 <simpara>See <xref linkend="gitworkflows(7)" /> for an overview of recommended workflows.</simpara>\r
 229 <simpara>See also the link:howto-index.html[howto] documents for some useful\r
 230 examples.</simpara>\r
 231 <simpara>The internals are documented in the\r
 232 link:technical/api-index.html[GIT API documentation].</simpara>\r
 233 </simplesect>\r
 234 <simplesect id="_git_commands">\r
 235 <title>GIT COMMANDS</title>\r
 236 <simpara>We divide git into high level ("porcelain") commands and low level\r
 237 ("plumbing") commands.</simpara>\r
 238 </simplesect>\r
 239 <simplesect id="_high_level_commands_porcelain">\r
 240 <title>High-level commands (porcelain)</title>\r
 241 <simpara>We separate the porcelain commands into the main commands and some\r
 242 ancillary user utilities.</simpara>\r
 243 <section id="_main_porcelain_commands">\r
 244 <title>Main porcelain commands</title>\r
 245 <variablelist>\r
 246 <varlistentry>\r
 247 <term>\r
 248 <xref linkend="git-add(1)" />\r
 249 </term>\r
 250 <listitem>\r
 251 <simpara>\r
 252         Add file contents to the index.\r
 253 </simpara>\r
 254 </listitem>\r
 255 </varlistentry>\r
 256 <varlistentry>\r
 257 <term>\r
 258 <xref linkend="git-am(1)" />\r
 259 </term>\r
 260 <listitem>\r
 261 <simpara>\r
 262         Apply a series of patches from a mailbox.\r
 263 </simpara>\r
 264 </listitem>\r
 265 </varlistentry>\r
 266 <varlistentry>\r
 267 <term>\r
 268 <xref linkend="git-archive(1)" />\r
 269 </term>\r
 270 <listitem>\r
 271 <simpara>\r
 272         Create an archive of files from a named tree.\r
 273 </simpara>\r
 274 </listitem>\r
 275 </varlistentry>\r
 276 <varlistentry>\r
 277 <term>\r
 278 <xref linkend="git-bisect(1)" />\r
 279 </term>\r
 280 <listitem>\r
 281 <simpara>\r
 282         Find by binary search the change that introduced a bug.\r
 283 </simpara>\r
 284 </listitem>\r
 285 </varlistentry>\r
 286 <varlistentry>\r
 287 <term>\r
 288 <xref linkend="git-branch(1)" />\r
 289 </term>\r
 290 <listitem>\r
 291 <simpara>\r
 292         List, create, or delete branches.\r
 293 </simpara>\r
 294 </listitem>\r
 295 </varlistentry>\r
 296 <varlistentry>\r
 297 <term>\r
 298 <xref linkend="git-bundle(1)" />\r
 299 </term>\r
 300 <listitem>\r
 301 <simpara>\r
 302         Move objects and refs by archive.\r
 303 </simpara>\r
 304 </listitem>\r
 305 </varlistentry>\r
 306 <varlistentry>\r
 307 <term>\r
 308 <xref linkend="git-checkout(1)" />\r
 309 </term>\r
 310 <listitem>\r
 311 <simpara>\r
 312         Checkout a branch or paths to the working tree.\r
 313 </simpara>\r
 314 </listitem>\r
 315 </varlistentry>\r
 316 <varlistentry>\r
 317 <term>\r
 318 <xref linkend="git-cherry-pick(1)" />\r
 319 </term>\r
 320 <listitem>\r
 321 <simpara>\r
 322         Apply the changes introduced by some existing commits.\r
 323 </simpara>\r
 324 </listitem>\r
 325 </varlistentry>\r
 326 <varlistentry>\r
 327 <term>\r
 328 <xref linkend="git-citool(1)" />\r
 329 </term>\r
 330 <listitem>\r
 331 <simpara>\r
 332         Graphical alternative to git-commit.\r
 333 </simpara>\r
 334 </listitem>\r
 335 </varlistentry>\r
 336 <varlistentry>\r
 337 <term>\r
 338 <xref linkend="git-clean(1)" />\r
 339 </term>\r
 340 <listitem>\r
 341 <simpara>\r
 342         Remove untracked files from the working tree.\r
 343 </simpara>\r
 344 </listitem>\r
 345 </varlistentry>\r
 346 <varlistentry>\r
 347 <term>\r
 348 <xref linkend="git-clone(1)" />\r
 349 </term>\r
 350 <listitem>\r
 351 <simpara>\r
 352         Clone a repository into a new directory.\r
 353 </simpara>\r
 354 </listitem>\r
 355 </varlistentry>\r
 356 <varlistentry>\r
 357 <term>\r
 358 <xref linkend="git-commit(1)" />\r
 359 </term>\r
 360 <listitem>\r
 361 <simpara>\r
 362         Record changes to the repository.\r
 363 </simpara>\r
 364 </listitem>\r
 365 </varlistentry>\r
 366 <varlistentry>\r
 367 <term>\r
 368 <xref linkend="git-describe(1)" />\r
 369 </term>\r
 370 <listitem>\r
 371 <simpara>\r
 372         Show the most recent tag that is reachable from a commit.\r
 373 </simpara>\r
 374 </listitem>\r
 375 </varlistentry>\r
 376 <varlistentry>\r
 377 <term>\r
 378 <xref linkend="git-diff(1)" />\r
 379 </term>\r
 380 <listitem>\r
 381 <simpara>\r
 382         Show changes between commits, commit and working tree, etc.\r
 383 </simpara>\r
 384 </listitem>\r
 385 </varlistentry>\r
 386 <varlistentry>\r
 387 <term>\r
 388 <xref linkend="git-fetch(1)" />\r
 389 </term>\r
 390 <listitem>\r
 391 <simpara>\r
 392         Download objects and refs from another repository.\r
 393 </simpara>\r
 394 </listitem>\r
 395 </varlistentry>\r
 396 <varlistentry>\r
 397 <term>\r
 398 <xref linkend="git-format-patch(1)" />\r
 399 </term>\r
 400 <listitem>\r
 401 <simpara>\r
 402         Prepare patches for e-mail submission.\r
 403 </simpara>\r
 404 </listitem>\r
 405 </varlistentry>\r
 406 <varlistentry>\r
 407 <term>\r
 408 <xref linkend="git-gc(1)" />\r
 409 </term>\r
 410 <listitem>\r
 411 <simpara>\r
 412         Cleanup unnecessary files and optimize the local repository.\r
 413 </simpara>\r
 414 </listitem>\r
 415 </varlistentry>\r
 416 <varlistentry>\r
 417 <term>\r
 418 <xref linkend="git-grep(1)" />\r
 419 </term>\r
 420 <listitem>\r
 421 <simpara>\r
 422         Print lines matching a pattern.\r
 423 </simpara>\r
 424 </listitem>\r
 425 </varlistentry>\r
 426 <varlistentry>\r
 427 <term>\r
 428 <xref linkend="git-gui(1)" />\r
 429 </term>\r
 430 <listitem>\r
 431 <simpara>\r
 432         A portable graphical interface to Git.\r
 433 </simpara>\r
 434 </listitem>\r
 435 </varlistentry>\r
 436 <varlistentry>\r
 437 <term>\r
 438 <xref linkend="git-init(1)" />\r
 439 </term>\r
 440 <listitem>\r
 441 <simpara>\r
 442         Create an empty git repository or reinitialize an existing one.\r
 443 </simpara>\r
 444 </listitem>\r
 445 </varlistentry>\r
 446 <varlistentry>\r
 447 <term>\r
 448 <xref linkend="git-log(1)" />\r
 449 </term>\r
 450 <listitem>\r
 451 <simpara>\r
 452         Show commit logs.\r
 453 </simpara>\r
 454 </listitem>\r
 455 </varlistentry>\r
 456 <varlistentry>\r
 457 <term>\r
 458 <xref linkend="git-merge(1)" />\r
 459 </term>\r
 460 <listitem>\r
 461 <simpara>\r
 462         Join two or more development histories together.\r
 463 </simpara>\r
 464 </listitem>\r
 465 </varlistentry>\r
 466 <varlistentry>\r
 467 <term>\r
 468 <xref linkend="git-mv(1)" />\r
 469 </term>\r
 470 <listitem>\r
 471 <simpara>\r
 472         Move or rename a file, a directory, or a symlink.\r
 473 </simpara>\r
 474 </listitem>\r
 475 </varlistentry>\r
 476 <varlistentry>\r
 477 <term>\r
 478 <xref linkend="git-notes(1)" />\r
 479 </term>\r
 480 <listitem>\r
 481 <simpara>\r
 482         Add or inspect object notes.\r
 483 </simpara>\r
 484 </listitem>\r
 485 </varlistentry>\r
 486 <varlistentry>\r
 487 <term>\r
 488 <xref linkend="git-pull(1)" />\r
 489 </term>\r
 490 <listitem>\r
 491 <simpara>\r
 492         Fetch from and merge with another repository or a local branch.\r
 493 </simpara>\r
 494 </listitem>\r
 495 </varlistentry>\r
 496 <varlistentry>\r
 497 <term>\r
 498 <xref linkend="git-push(1)" />\r
 499 </term>\r
 500 <listitem>\r
 501 <simpara>\r
 502         Update remote refs along with associated objects.\r
 503 </simpara>\r
 504 </listitem>\r
 505 </varlistentry>\r
 506 <varlistentry>\r
 507 <term>\r
 508 <xref linkend="git-rebase(1)" />\r
 509 </term>\r
 510 <listitem>\r
 511 <simpara>\r
 512         Forward-port local commits to the updated upstream head.\r
 513 </simpara>\r
 514 </listitem>\r
 515 </varlistentry>\r
 516 <varlistentry>\r
 517 <term>\r
 518 <xref linkend="git-reset(1)" />\r
 519 </term>\r
 520 <listitem>\r
 521 <simpara>\r
 522         Reset current HEAD to the specified state.\r
 523 </simpara>\r
 524 </listitem>\r
 525 </varlistentry>\r
 526 <varlistentry>\r
 527 <term>\r
 528 <xref linkend="git-revert(1)" />\r
 529 </term>\r
 530 <listitem>\r
 531 <simpara>\r
 532         Revert some existing commits.\r
 533 </simpara>\r
 534 </listitem>\r
 535 </varlistentry>\r
 536 <varlistentry>\r
 537 <term>\r
 538 <xref linkend="git-rm(1)" />\r
 539 </term>\r
 540 <listitem>\r
 541 <simpara>\r
 542         Remove files from the working tree and from the index.\r
 543 </simpara>\r
 544 </listitem>\r
 545 </varlistentry>\r
 546 <varlistentry>\r
 547 <term>\r
 548 <xref linkend="git-shortlog(1)" />\r
 549 </term>\r
 550 <listitem>\r
 551 <simpara>\r
 552         Summarize <emphasis>git log</emphasis> output.\r
 553 </simpara>\r
 554 </listitem>\r
 555 </varlistentry>\r
 556 <varlistentry>\r
 557 <term>\r
 558 <xref linkend="git-show(1)" />\r
 559 </term>\r
 560 <listitem>\r
 561 <simpara>\r
 562         Show various types of objects.\r
 563 </simpara>\r
 564 </listitem>\r
 565 </varlistentry>\r
 566 <varlistentry>\r
 567 <term>\r
 568 <xref linkend="git-stash(1)" />\r
 569 </term>\r
 570 <listitem>\r
 571 <simpara>\r
 572         Stash the changes in a dirty working directory away.\r
 573 </simpara>\r
 574 </listitem>\r
 575 </varlistentry>\r
 576 <varlistentry>\r
 577 <term>\r
 578 <xref linkend="git-status(1)" />\r
 579 </term>\r
 580 <listitem>\r
 581 <simpara>\r
 582         Show the working tree status.\r
 583 </simpara>\r
 584 </listitem>\r
 585 </varlistentry>\r
 586 <varlistentry>\r
 587 <term>\r
 588 <xref linkend="git-submodule(1)" />\r
 589 </term>\r
 590 <listitem>\r
 591 <simpara>\r
 592         Initialize, update or inspect submodules.\r
 593 </simpara>\r
 594 </listitem>\r
 595 </varlistentry>\r
 596 <varlistentry>\r
 597 <term>\r
 598 <xref linkend="git-tag(1)" />\r
 599 </term>\r
 600 <listitem>\r
 601 <simpara>\r
 602         Create, list, delete or verify a tag object signed with GPG.\r
 603 </simpara>\r
 604 </listitem>\r
 605 </varlistentry>\r
 606 <varlistentry>\r
 607 <term>\r
 608 <xref linkend="gitk(1)" />\r
 609 </term>\r
 610 <listitem>\r
 611 <simpara>\r
 612         The git repository browser.\r
 613 </simpara>\r
 614 </listitem>\r
 615 </varlistentry>\r
 616 </variablelist>\r
 617 </section>\r
 618 <section id="_ancillary_commands">\r
 619 <title>Ancillary Commands</title>\r
 620 <simpara>Manipulators:</simpara>\r
 621 <variablelist>\r
 622 <varlistentry>\r
 623 <term>\r
 624 <xref linkend="git-config(1)" />\r
 625 </term>\r
 626 <listitem>\r
 627 <simpara>\r
 628         Get and set repository or global options.\r
 629 </simpara>\r
 630 </listitem>\r
 631 </varlistentry>\r
 632 <varlistentry>\r
 633 <term>\r
 634 <xref linkend="git-fast-export(1)" />\r
 635 </term>\r
 636 <listitem>\r
 637 <simpara>\r
 638         Git data exporter.\r
 639 </simpara>\r
 640 </listitem>\r
 641 </varlistentry>\r
 642 <varlistentry>\r
 643 <term>\r
 644 <xref linkend="git-fast-import(1)" />\r
 645 </term>\r
 646 <listitem>\r
 647 <simpara>\r
 648         Backend for fast Git data importers.\r
 649 </simpara>\r
 650 </listitem>\r
 651 </varlistentry>\r
 652 <varlistentry>\r
 653 <term>\r
 654 <xref linkend="git-filter-branch(1)" />\r
 655 </term>\r
 656 <listitem>\r
 657 <simpara>\r
 658         Rewrite branches.\r
 659 </simpara>\r
 660 </listitem>\r
 661 </varlistentry>\r
 662 <varlistentry>\r
 663 <term>\r
 664 <xref linkend="git-lost-found(1)" />\r
 665 </term>\r
 666 <listitem>\r
 667 <simpara>\r
 668         (deprecated) Recover lost refs that luckily have not yet been pruned.\r
 669 </simpara>\r
 670 </listitem>\r
 671 </varlistentry>\r
 672 <varlistentry>\r
 673 <term>\r
 674 <xref linkend="git-mergetool(1)" />\r
 675 </term>\r
 676 <listitem>\r
 677 <simpara>\r
 678         Run merge conflict resolution tools to resolve merge conflicts.\r
 679 </simpara>\r
 680 </listitem>\r
 681 </varlistentry>\r
 682 <varlistentry>\r
 683 <term>\r
 684 <xref linkend="git-pack-refs(1)" />\r
 685 </term>\r
 686 <listitem>\r
 687 <simpara>\r
 688         Pack heads and tags for efficient repository access.\r
 689 </simpara>\r
 690 </listitem>\r
 691 </varlistentry>\r
 692 <varlistentry>\r
 693 <term>\r
 694 <xref linkend="git-prune(1)" />\r
 695 </term>\r
 696 <listitem>\r
 697 <simpara>\r
 698         Prune all unreachable objects from the object database.\r
 699 </simpara>\r
 700 </listitem>\r
 701 </varlistentry>\r
 702 <varlistentry>\r
 703 <term>\r
 704 <xref linkend="git-reflog(1)" />\r
 705 </term>\r
 706 <listitem>\r
 707 <simpara>\r
 708         Manage reflog information.\r
 709 </simpara>\r
 710 </listitem>\r
 711 </varlistentry>\r
 712 <varlistentry>\r
 713 <term>\r
 714 <xref linkend="git-relink(1)" />\r
 715 </term>\r
 716 <listitem>\r
 717 <simpara>\r
 718         Hardlink common objects in local repositories.\r
 719 </simpara>\r
 720 </listitem>\r
 721 </varlistentry>\r
 722 <varlistentry>\r
 723 <term>\r
 724 <xref linkend="git-remote(1)" />\r
 725 </term>\r
 726 <listitem>\r
 727 <simpara>\r
 728         manage set of tracked repositories.\r
 729 </simpara>\r
 730 </listitem>\r
 731 </varlistentry>\r
 732 <varlistentry>\r
 733 <term>\r
 734 <xref linkend="git-repack(1)" />\r
 735 </term>\r
 736 <listitem>\r
 737 <simpara>\r
 738         Pack unpacked objects in a repository.\r
 739 </simpara>\r
 740 </listitem>\r
 741 </varlistentry>\r
 742 <varlistentry>\r
 743 <term>\r
 744 <xref linkend="git-replace(1)" />\r
 745 </term>\r
 746 <listitem>\r
 747 <simpara>\r
 748         Create, list, delete refs to replace objects.\r
 749 </simpara>\r
 750 </listitem>\r
 751 </varlistentry>\r
 752 <varlistentry>\r
 753 <term>\r
 754 <xref linkend="git-repo-config(1)" />\r
 755 </term>\r
 756 <listitem>\r
 757 <simpara>\r
 758         (deprecated) Get and set repository or global options.\r
 759 </simpara>\r
 760 </listitem>\r
 761 </varlistentry>\r
 762 </variablelist>\r
 763 <simpara>Interrogators:</simpara>\r
 764 <variablelist>\r
 765 <varlistentry>\r
 766 <term>\r
 767 <xref linkend="git-annotate(1)" />\r
 768 </term>\r
 769 <listitem>\r
 770 <simpara>\r
 771         Annotate file lines with commit information.\r
 772 </simpara>\r
 773 </listitem>\r
 774 </varlistentry>\r
 775 <varlistentry>\r
 776 <term>\r
 777 <xref linkend="git-blame(1)" />\r
 778 </term>\r
 779 <listitem>\r
 780 <simpara>\r
 781         Show what revision and author last modified each line of a file.\r
 782 </simpara>\r
 783 </listitem>\r
 784 </varlistentry>\r
 785 <varlistentry>\r
 786 <term>\r
 787 <xref linkend="git-cherry(1)" />\r
 788 </term>\r
 789 <listitem>\r
 790 <simpara>\r
 791         Find commits not merged upstream.\r
 792 </simpara>\r
 793 </listitem>\r
 794 </varlistentry>\r
 795 <varlistentry>\r
 796 <term>\r
 797 <xref linkend="git-count-objects(1)" />\r
 798 </term>\r
 799 <listitem>\r
 800 <simpara>\r
 801         Count unpacked number of objects and their disk consumption.\r
 802 </simpara>\r
 803 </listitem>\r
 804 </varlistentry>\r
 805 <varlistentry>\r
 806 <term>\r
 807 <xref linkend="git-difftool(1)" />\r
 808 </term>\r
 809 <listitem>\r
 810 <simpara>\r
 811         Show changes using common diff tools.\r
 812 </simpara>\r
 813 </listitem>\r
 814 </varlistentry>\r
 815 <varlistentry>\r
 816 <term>\r
 817 <xref linkend="git-fsck(1)" />\r
 818 </term>\r
 819 <listitem>\r
 820 <simpara>\r
 821         Verifies the connectivity and validity of the objects in the database.\r
 822 </simpara>\r
 823 </listitem>\r
 824 </varlistentry>\r
 825 <varlistentry>\r
 826 <term>\r
 827 <xref linkend="git-get-tar-commit-id(1)" />\r
 828 </term>\r
 829 <listitem>\r
 830 <simpara>\r
 831         Extract commit ID from an archive created using git-archive.\r
 832 </simpara>\r
 833 </listitem>\r
 834 </varlistentry>\r
 835 <varlistentry>\r
 836 <term>\r
 837 <xref linkend="git-help(1)" />\r
 838 </term>\r
 839 <listitem>\r
 840 <simpara>\r
 841         display help information about git.\r
 842 </simpara>\r
 843 </listitem>\r
 844 </varlistentry>\r
 845 <varlistentry>\r
 846 <term>\r
 847 <xref linkend="git-instaweb(1)" />\r
 848 </term>\r
 849 <listitem>\r
 850 <simpara>\r
 851         Instantly browse your working repository in gitweb.\r
 852 </simpara>\r
 853 </listitem>\r
 854 </varlistentry>\r
 855 <varlistentry>\r
 856 <term>\r
 857 <xref linkend="git-merge-tree(1)" />\r
 858 </term>\r
 859 <listitem>\r
 860 <simpara>\r
 861         Show three-way merge without touching index.\r
 862 </simpara>\r
 863 </listitem>\r
 864 </varlistentry>\r
 865 <varlistentry>\r
 866 <term>\r
 867 <xref linkend="git-rerere(1)" />\r
 868 </term>\r
 869 <listitem>\r
 870 <simpara>\r
 871         Reuse recorded resolution of conflicted merges.\r
 872 </simpara>\r
 873 </listitem>\r
 874 </varlistentry>\r
 875 <varlistentry>\r
 876 <term>\r
 877 <xref linkend="git-rev-parse(1)" />\r
 878 </term>\r
 879 <listitem>\r
 880 <simpara>\r
 881         Pick out and massage parameters.\r
 882 </simpara>\r
 883 </listitem>\r
 884 </varlistentry>\r
 885 <varlistentry>\r
 886 <term>\r
 887 <xref linkend="git-show-branch(1)" />\r
 888 </term>\r
 889 <listitem>\r
 890 <simpara>\r
 891         Show branches and their commits.\r
 892 </simpara>\r
 893 </listitem>\r
 894 </varlistentry>\r
 895 <varlistentry>\r
 896 <term>\r
 897 <xref linkend="git-verify-tag(1)" />\r
 898 </term>\r
 899 <listitem>\r
 900 <simpara>\r
 901         Check the GPG signature of tags.\r
 902 </simpara>\r
 903 </listitem>\r
 904 </varlistentry>\r
 905 <varlistentry>\r
 906 <term>\r
 907 <xref linkend="git-whatchanged(1)" />\r
 908 </term>\r
 909 <listitem>\r
 910 <simpara>\r
 911         Show logs with difference each commit introduces.\r
 912 </simpara>\r
 913 </listitem>\r
 914 </varlistentry>\r
 915 <varlistentry>\r
 916 <term>\r
 917 <xref linkend="gitweb(1)" />\r
 918 </term>\r
 919 <listitem>\r
 920 <simpara>\r
 921         Git web interface (web frontend to Git repositories).\r
 922 </simpara>\r
 923 </listitem>\r
 924 </varlistentry>\r
 925 </variablelist>\r
 926 </section>\r
 927 <section id="_interacting_with_others">\r
 928 <title>Interacting with Others</title>\r
 929 <simpara>These commands are to interact with foreign SCM and with other\r
 930 people via patch over e-mail.</simpara>\r
 931 <variablelist>\r
 932 <varlistentry>\r
 933 <term>\r
 934 <xref linkend="git-archimport(1)" />\r
 935 </term>\r
 936 <listitem>\r
 937 <simpara>\r
 938         Import an Arch repository into git.\r
 939 </simpara>\r
 940 </listitem>\r
 941 </varlistentry>\r
 942 <varlistentry>\r
 943 <term>\r
 944 <xref linkend="git-cvsexportcommit(1)" />\r
 945 </term>\r
 946 <listitem>\r
 947 <simpara>\r
 948         Export a single commit to a CVS checkout.\r
 949 </simpara>\r
 950 </listitem>\r
 951 </varlistentry>\r
 952 <varlistentry>\r
 953 <term>\r
 954 <xref linkend="git-cvsimport(1)" />\r
 955 </term>\r
 956 <listitem>\r
 957 <simpara>\r
 958         Salvage your data out of another SCM people love to hate.\r
 959 </simpara>\r
 960 </listitem>\r
 961 </varlistentry>\r
 962 <varlistentry>\r
 963 <term>\r
 964 <xref linkend="git-cvsserver(1)" />\r
 965 </term>\r
 966 <listitem>\r
 967 <simpara>\r
 968         A CVS server emulator for git.\r
 969 </simpara>\r
 970 </listitem>\r
 971 </varlistentry>\r
 972 <varlistentry>\r
 973 <term>\r
 974 <xref linkend="git-imap-send(1)" />\r
 975 </term>\r
 976 <listitem>\r
 977 <simpara>\r
 978         Send a collection of patches from stdin to an IMAP folder.\r
 979 </simpara>\r
 980 </listitem>\r
 981 </varlistentry>\r
 982 <varlistentry>\r
 983 <term>\r
 984 <xref linkend="git-quiltimport(1)" />\r
 985 </term>\r
 986 <listitem>\r
 987 <simpara>\r
 988         Applies a quilt patchset onto the current branch.\r
 989 </simpara>\r
 990 </listitem>\r
 991 </varlistentry>\r
 992 <varlistentry>\r
 993 <term>\r
 994 <xref linkend="git-request-pull(1)" />\r
 995 </term>\r
 996 <listitem>\r
 997 <simpara>\r
 998         Generates a summary of pending changes.\r
 999 </simpara>\r
1000 </listitem>\r
1001 </varlistentry>\r
1002 <varlistentry>\r
1003 <term>\r
1004 <xref linkend="git-send-email(1)" />\r
1005 </term>\r
1006 <listitem>\r
1007 <simpara>\r
1008         Send a collection of patches as emails.\r
1009 </simpara>\r
1010 </listitem>\r
1011 </varlistentry>\r
1012 <varlistentry>\r
1013 <term>\r
1014 <xref linkend="git-svn(1)" />\r
1015 </term>\r
1016 <listitem>\r
1017 <simpara>\r
1018         Bidirectional operation between a Subversion repository and git.\r
1019 </simpara>\r
1020 </listitem>\r
1021 </varlistentry>\r
1022 </variablelist>\r
1023 </section>\r
1024 </simplesect>\r
1025 <simplesect id="_low_level_commands_plumbing">\r
1026 <title>Low-level commands (plumbing)</title>\r
1027 <simpara>Although git includes its\r
1028 own porcelain layer, its low-level commands are sufficient to support\r
1029 development of alternative porcelains.  Developers of such porcelains\r
1030 might start by reading about <xref linkend="git-update-index(1)" /> and\r
1031 <xref linkend="git-read-tree(1)" />.</simpara>\r
1032 <simpara>The interface (input, output, set of options and the semantics)\r
1033 to these low-level commands are meant to be a lot more stable\r
1034 than Porcelain level commands, because these commands are\r
1035 primarily for scripted use.  The interface to Porcelain commands\r
1036 on the other hand are subject to change in order to improve the\r
1037 end user experience.</simpara>\r
1038 <simpara>The following description divides\r
1039 the low-level commands into commands that manipulate objects (in\r
1040 the repository, index, and working tree), commands that interrogate and\r
1041 compare objects, and commands that move objects and references between\r
1042 repositories.</simpara>\r
1043 <section id="_manipulation_commands">\r
1044 <title>Manipulation commands</title>\r
1045 <variablelist>\r
1046 <varlistentry>\r
1047 <term>\r
1048 <xref linkend="git-apply(1)" />\r
1049 </term>\r
1050 <listitem>\r
1051 <simpara>\r
1052         Apply a patch to files and/or to the index.\r
1053 </simpara>\r
1054 </listitem>\r
1055 </varlistentry>\r
1056 <varlistentry>\r
1057 <term>\r
1058 <xref linkend="git-checkout-index(1)" />\r
1059 </term>\r
1060 <listitem>\r
1061 <simpara>\r
1062         Copy files from the index to the working tree.\r
1063 </simpara>\r
1064 </listitem>\r
1065 </varlistentry>\r
1066 <varlistentry>\r
1067 <term>\r
1068 <xref linkend="git-commit-tree(1)" />\r
1069 </term>\r
1070 <listitem>\r
1071 <simpara>\r
1072         Create a new commit object.\r
1073 </simpara>\r
1074 </listitem>\r
1075 </varlistentry>\r
1076 <varlistentry>\r
1077 <term>\r
1078 <xref linkend="git-hash-object(1)" />\r
1079 </term>\r
1080 <listitem>\r
1081 <simpara>\r
1082         Compute object ID and optionally creates a blob from a file.\r
1083 </simpara>\r
1084 </listitem>\r
1085 </varlistentry>\r
1086 <varlistentry>\r
1087 <term>\r
1088 <xref linkend="git-index-pack(1)" />\r
1089 </term>\r
1090 <listitem>\r
1091 <simpara>\r
1092         Build pack index file for an existing packed archive.\r
1093 </simpara>\r
1094 </listitem>\r
1095 </varlistentry>\r
1096 <varlistentry>\r
1097 <term>\r
1098 <xref linkend="git-merge-file(1)" />\r
1099 </term>\r
1100 <listitem>\r
1101 <simpara>\r
1102         Run a three-way file merge.\r
1103 </simpara>\r
1104 </listitem>\r
1105 </varlistentry>\r
1106 <varlistentry>\r
1107 <term>\r
1108 <xref linkend="git-merge-index(1)" />\r
1109 </term>\r
1110 <listitem>\r
1111 <simpara>\r
1112         Run a merge for files needing merging.\r
1113 </simpara>\r
1114 </listitem>\r
1115 </varlistentry>\r
1116 <varlistentry>\r
1117 <term>\r
1118 <xref linkend="git-mktag(1)" />\r
1119 </term>\r
1120 <listitem>\r
1121 <simpara>\r
1122         Creates a tag object.\r
1123 </simpara>\r
1124 </listitem>\r
1125 </varlistentry>\r
1126 <varlistentry>\r
1127 <term>\r
1128 <xref linkend="git-mktree(1)" />\r
1129 </term>\r
1130 <listitem>\r
1131 <simpara>\r
1132         Build a tree-object from ls-tree formatted text.\r
1133 </simpara>\r
1134 </listitem>\r
1135 </varlistentry>\r
1136 <varlistentry>\r
1137 <term>\r
1138 <xref linkend="git-pack-objects(1)" />\r
1139 </term>\r
1140 <listitem>\r
1141 <simpara>\r
1142         Create a packed archive of objects.\r
1143 </simpara>\r
1144 </listitem>\r
1145 </varlistentry>\r
1146 <varlistentry>\r
1147 <term>\r
1148 <xref linkend="git-prune-packed(1)" />\r
1149 </term>\r
1150 <listitem>\r
1151 <simpara>\r
1152         Remove extra objects that are already in pack files.\r
1153 </simpara>\r
1154 </listitem>\r
1155 </varlistentry>\r
1156 <varlistentry>\r
1157 <term>\r
1158 <xref linkend="git-read-tree(1)" />\r
1159 </term>\r
1160 <listitem>\r
1161 <simpara>\r
1162         Reads tree information into the index.\r
1163 </simpara>\r
1164 </listitem>\r
1165 </varlistentry>\r
1166 <varlistentry>\r
1167 <term>\r
1168 <xref linkend="git-symbolic-ref(1)" />\r
1169 </term>\r
1170 <listitem>\r
1171 <simpara>\r
1172         Read and modify symbolic refs.\r
1173 </simpara>\r
1174 </listitem>\r
1175 </varlistentry>\r
1176 <varlistentry>\r
1177 <term>\r
1178 <xref linkend="git-unpack-objects(1)" />\r
1179 </term>\r
1180 <listitem>\r
1181 <simpara>\r
1182         Unpack objects from a packed archive.\r
1183 </simpara>\r
1184 </listitem>\r
1185 </varlistentry>\r
1186 <varlistentry>\r
1187 <term>\r
1188 <xref linkend="git-update-index(1)" />\r
1189 </term>\r
1190 <listitem>\r
1191 <simpara>\r
1192         Register file contents in the working tree to the index.\r
1193 </simpara>\r
1194 </listitem>\r
1195 </varlistentry>\r
1196 <varlistentry>\r
1197 <term>\r
1198 <xref linkend="git-update-ref(1)" />\r
1199 </term>\r
1200 <listitem>\r
1201 <simpara>\r
1202         Update the object name stored in a ref safely.\r
1203 </simpara>\r
1204 </listitem>\r
1205 </varlistentry>\r
1206 <varlistentry>\r
1207 <term>\r
1208 <xref linkend="git-write-tree(1)" />\r
1209 </term>\r
1210 <listitem>\r
1211 <simpara>\r
1212         Create a tree object from the current index.\r
1213 </simpara>\r
1214 </listitem>\r
1215 </varlistentry>\r
1216 </variablelist>\r
1217 </section>\r
1218 <section id="_interrogation_commands">\r
1219 <title>Interrogation commands</title>\r
1220 <variablelist>\r
1221 <varlistentry>\r
1222 <term>\r
1223 <xref linkend="git-cat-file(1)" />\r
1224 </term>\r
1225 <listitem>\r
1226 <simpara>\r
1227         Provide content or type and size information for repository objects.\r
1228 </simpara>\r
1229 </listitem>\r
1230 </varlistentry>\r
1231 <varlistentry>\r
1232 <term>\r
1233 <xref linkend="git-diff-files(1)" />\r
1234 </term>\r
1235 <listitem>\r
1236 <simpara>\r
1237         Compares files in the working tree and the index.\r
1238 </simpara>\r
1239 </listitem>\r
1240 </varlistentry>\r
1241 <varlistentry>\r
1242 <term>\r
1243 <xref linkend="git-diff-index(1)" />\r
1244 </term>\r
1245 <listitem>\r
1246 <simpara>\r
1247         Compares content and mode of blobs between the index and repository.\r
1248 </simpara>\r
1249 </listitem>\r
1250 </varlistentry>\r
1251 <varlistentry>\r
1252 <term>\r
1253 <xref linkend="git-diff-tree(1)" />\r
1254 </term>\r
1255 <listitem>\r
1256 <simpara>\r
1257         Compares the content and mode of blobs found via two tree objects.\r
1258 </simpara>\r
1259 </listitem>\r
1260 </varlistentry>\r
1261 <varlistentry>\r
1262 <term>\r
1263 <xref linkend="git-for-each-ref(1)" />\r
1264 </term>\r
1265 <listitem>\r
1266 <simpara>\r
1267         Output information on each ref.\r
1268 </simpara>\r
1269 </listitem>\r
1270 </varlistentry>\r
1271 <varlistentry>\r
1272 <term>\r
1273 <xref linkend="git-ls-files(1)" />\r
1274 </term>\r
1275 <listitem>\r
1276 <simpara>\r
1277         Show information about files in the index and the working tree.\r
1278 </simpara>\r
1279 </listitem>\r
1280 </varlistentry>\r
1281 <varlistentry>\r
1282 <term>\r
1283 <xref linkend="git-ls-remote(1)" />\r
1284 </term>\r
1285 <listitem>\r
1286 <simpara>\r
1287         List references in a remote repository.\r
1288 </simpara>\r
1289 </listitem>\r
1290 </varlistentry>\r
1291 <varlistentry>\r
1292 <term>\r
1293 <xref linkend="git-ls-tree(1)" />\r
1294 </term>\r
1295 <listitem>\r
1296 <simpara>\r
1297         List the contents of a tree object.\r
1298 </simpara>\r
1299 </listitem>\r
1300 </varlistentry>\r
1301 <varlistentry>\r
1302 <term>\r
1303 <xref linkend="git-merge-base(1)" />\r
1304 </term>\r
1305 <listitem>\r
1306 <simpara>\r
1307         Find as good common ancestors as possible for a merge.\r
1308 </simpara>\r
1309 </listitem>\r
1310 </varlistentry>\r
1311 <varlistentry>\r
1312 <term>\r
1313 <xref linkend="git-name-rev(1)" />\r
1314 </term>\r
1315 <listitem>\r
1316 <simpara>\r
1317         Find symbolic names for given revs.\r
1318 </simpara>\r
1319 </listitem>\r
1320 </varlistentry>\r
1321 <varlistentry>\r
1322 <term>\r
1323 <xref linkend="git-pack-redundant(1)" />\r
1324 </term>\r
1325 <listitem>\r
1326 <simpara>\r
1327         Find redundant pack files.\r
1328 </simpara>\r
1329 </listitem>\r
1330 </varlistentry>\r
1331 <varlistentry>\r
1332 <term>\r
1333 <xref linkend="git-rev-list(1)" />\r
1334 </term>\r
1335 <listitem>\r
1336 <simpara>\r
1337         Lists commit objects in reverse chronological order.\r
1338 </simpara>\r
1339 </listitem>\r
1340 </varlistentry>\r
1341 <varlistentry>\r
1342 <term>\r
1343 <xref linkend="git-show-index(1)" />\r
1344 </term>\r
1345 <listitem>\r
1346 <simpara>\r
1347         Show packed archive index.\r
1348 </simpara>\r
1349 </listitem>\r
1350 </varlistentry>\r
1351 <varlistentry>\r
1352 <term>\r
1353 <xref linkend="git-show-ref(1)" />\r
1354 </term>\r
1355 <listitem>\r
1356 <simpara>\r
1357         List references in a local repository.\r
1358 </simpara>\r
1359 </listitem>\r
1360 </varlistentry>\r
1361 <varlistentry>\r
1362 <term>\r
1363 <xref linkend="git-tar-tree(1)" />\r
1364 </term>\r
1365 <listitem>\r
1366 <simpara>\r
1367         (deprecated) Create a tar archive of the files in the named tree object.\r
1368 </simpara>\r
1369 </listitem>\r
1370 </varlistentry>\r
1371 <varlistentry>\r
1372 <term>\r
1373 <xref linkend="git-unpack-file(1)" />\r
1374 </term>\r
1375 <listitem>\r
1376 <simpara>\r
1377         Creates a temporary file with a blob's contents.\r
1378 </simpara>\r
1379 </listitem>\r
1380 </varlistentry>\r
1381 <varlistentry>\r
1382 <term>\r
1383 <xref linkend="git-var(1)" />\r
1384 </term>\r
1385 <listitem>\r
1386 <simpara>\r
1387         Show a git logical variable.\r
1388 </simpara>\r
1389 </listitem>\r
1390 </varlistentry>\r
1391 <varlistentry>\r
1392 <term>\r
1393 <xref linkend="git-verify-pack(1)" />\r
1394 </term>\r
1395 <listitem>\r
1396 <simpara>\r
1397         Validate packed git archive files.\r
1398 </simpara>\r
1399 </listitem>\r
1400 </varlistentry>\r
1401 </variablelist>\r
1402 <simpara>In general, the interrogate commands do not touch the files in\r
1403 the working tree.</simpara>\r
1404 </section>\r
1405 <section id="_synching_repositories">\r
1406 <title>Synching repositories</title>\r
1407 <variablelist>\r
1408 <varlistentry>\r
1409 <term>\r
1410 <xref linkend="git-daemon(1)" />\r
1411 </term>\r
1412 <listitem>\r
1413 <simpara>\r
1414         A really simple server for git repositories.\r
1415 </simpara>\r
1416 </listitem>\r
1417 </varlistentry>\r
1418 <varlistentry>\r
1419 <term>\r
1420 <xref linkend="git-fetch-pack(1)" />\r
1421 </term>\r
1422 <listitem>\r
1423 <simpara>\r
1424         Receive missing objects from another repository.\r
1425 </simpara>\r
1426 </listitem>\r
1427 </varlistentry>\r
1428 <varlistentry>\r
1429 <term>\r
1430 <xref linkend="git-http-backend(1)" />\r
1431 </term>\r
1432 <listitem>\r
1433 <simpara>\r
1434         Server side implementation of Git over HTTP.\r
1435 </simpara>\r
1436 </listitem>\r
1437 </varlistentry>\r
1438 <varlistentry>\r
1439 <term>\r
1440 <xref linkend="git-send-pack(1)" />\r
1441 </term>\r
1442 <listitem>\r
1443 <simpara>\r
1444         Push objects over git protocol to another repository.\r
1445 </simpara>\r
1446 </listitem>\r
1447 </varlistentry>\r
1448 <varlistentry>\r
1449 <term>\r
1450 <xref linkend="git-update-server-info(1)" />\r
1451 </term>\r
1452 <listitem>\r
1453 <simpara>\r
1454         Update auxiliary info file to help dumb servers.\r
1455 </simpara>\r
1456 </listitem>\r
1457 </varlistentry>\r
1458 </variablelist>\r
1459 <simpara>The following are helper commands used by the above; end users\r
1460 typically do not use them directly.</simpara>\r
1461 <variablelist>\r
1462 <varlistentry>\r
1463 <term>\r
1464 <xref linkend="git-http-fetch(1)" />\r
1465 </term>\r
1466 <listitem>\r
1467 <simpara>\r
1468         Download from a remote git repository via HTTP.\r
1469 </simpara>\r
1470 </listitem>\r
1471 </varlistentry>\r
1472 <varlistentry>\r
1473 <term>\r
1474 <xref linkend="git-http-push(1)" />\r
1475 </term>\r
1476 <listitem>\r
1477 <simpara>\r
1478         Push objects over HTTP/DAV to another repository.\r
1479 </simpara>\r
1480 </listitem>\r
1481 </varlistentry>\r
1482 <varlistentry>\r
1483 <term>\r
1484 <xref linkend="git-parse-remote(1)" />\r
1485 </term>\r
1486 <listitem>\r
1487 <simpara>\r
1488         Routines to help parsing remote repository access parameters.\r
1489 </simpara>\r
1490 </listitem>\r
1491 </varlistentry>\r
1492 <varlistentry>\r
1493 <term>\r
1494 <xref linkend="git-receive-pack(1)" />\r
1495 </term>\r
1496 <listitem>\r
1497 <simpara>\r
1498         Receive what is pushed into the repository.\r
1499 </simpara>\r
1500 </listitem>\r
1501 </varlistentry>\r
1502 <varlistentry>\r
1503 <term>\r
1504 <xref linkend="git-shell(1)" />\r
1505 </term>\r
1506 <listitem>\r
1507 <simpara>\r
1508         Restricted login shell for Git-only SSH access.\r
1509 </simpara>\r
1510 </listitem>\r
1511 </varlistentry>\r
1512 <varlistentry>\r
1513 <term>\r
1514 <xref linkend="git-upload-archive(1)" />\r
1515 </term>\r
1516 <listitem>\r
1517 <simpara>\r
1518         Send archive back to git-archive.\r
1519 </simpara>\r
1520 </listitem>\r
1521 </varlistentry>\r
1522 <varlistentry>\r
1523 <term>\r
1524 <xref linkend="git-upload-pack(1)" />\r
1525 </term>\r
1526 <listitem>\r
1527 <simpara>\r
1528         Send objects packed back to git-fetch-pack.\r
1529 </simpara>\r
1530 </listitem>\r
1531 </varlistentry>\r
1532 </variablelist>\r
1533 </section>\r
1534 <section id="_internal_helper_commands">\r
1535 <title>Internal helper commands</title>\r
1536 <simpara>These are internal helper commands used by other commands; end\r
1537 users typically do not use them directly.</simpara>\r
1538 <variablelist>\r
1539 <varlistentry>\r
1540 <term>\r
1541 <xref linkend="git-check-attr(1)" />\r
1542 </term>\r
1543 <listitem>\r
1544 <simpara>\r
1545         Display gitattributes information.\r
1546 </simpara>\r
1547 </listitem>\r
1548 </varlistentry>\r
1549 <varlistentry>\r
1550 <term>\r
1551 <xref linkend="git-check-ref-format(1)" />\r
1552 </term>\r
1553 <listitem>\r
1554 <simpara>\r
1555         Ensures that a reference name is well formed.\r
1556 </simpara>\r
1557 </listitem>\r
1558 </varlistentry>\r
1559 <varlistentry>\r
1560 <term>\r
1561 <xref linkend="git-fmt-merge-msg(1)" />\r
1562 </term>\r
1563 <listitem>\r
1564 <simpara>\r
1565         Produce a merge commit message.\r
1566 </simpara>\r
1567 </listitem>\r
1568 </varlistentry>\r
1569 <varlistentry>\r
1570 <term>\r
1571 <xref linkend="git-mailinfo(1)" />\r
1572 </term>\r
1573 <listitem>\r
1574 <simpara>\r
1575         Extracts patch and authorship from a single e-mail message.\r
1576 </simpara>\r
1577 </listitem>\r
1578 </varlistentry>\r
1579 <varlistentry>\r
1580 <term>\r
1581 <xref linkend="git-mailsplit(1)" />\r
1582 </term>\r
1583 <listitem>\r
1584 <simpara>\r
1585         Simple UNIX mbox splitter program.\r
1586 </simpara>\r
1587 </listitem>\r
1588 </varlistentry>\r
1589 <varlistentry>\r
1590 <term>\r
1591 <xref linkend="git-merge-one-file(1)" />\r
1592 </term>\r
1593 <listitem>\r
1594 <simpara>\r
1595         The standard helper program to use with git-merge-index.\r
1596 </simpara>\r
1597 </listitem>\r
1598 </varlistentry>\r
1599 <varlistentry>\r
1600 <term>\r
1601 <xref linkend="git-patch-id(1)" />\r
1602 </term>\r
1603 <listitem>\r
1604 <simpara>\r
1605         Compute unique ID for a patch.\r
1606 </simpara>\r
1607 </listitem>\r
1608 </varlistentry>\r
1609 <varlistentry>\r
1610 <term>\r
1611 <xref linkend="git-peek-remote(1)" />\r
1612 </term>\r
1613 <listitem>\r
1614 <simpara>\r
1615         (deprecated) List the references in a remote repository.\r
1616 </simpara>\r
1617 </listitem>\r
1618 </varlistentry>\r
1619 <varlistentry>\r
1620 <term>\r
1621 <xref linkend="git-sh-setup(1)" />\r
1622 </term>\r
1623 <listitem>\r
1624 <simpara>\r
1625         Common git shell script setup code.\r
1626 </simpara>\r
1627 </listitem>\r
1628 </varlistentry>\r
1629 <varlistentry>\r
1630 <term>\r
1631 <xref linkend="git-stripspace(1)" />\r
1632 </term>\r
1633 <listitem>\r
1634 <simpara>\r
1635         Remove unnecessary whitespace.\r
1636 </simpara>\r
1637 </listitem>\r
1638 </varlistentry>\r
1639 </variablelist>\r
1640 </section>\r
1641 </simplesect>\r
1642 <simplesect id="_configuration_mechanism">\r
1643 <title>Configuration Mechanism</title>\r
1644 <simpara>Starting from 0.99.9 (actually mid 0.99.8.GIT), <emphasis>.git/config</emphasis> file\r
1645 is used to hold per-repository configuration options.  It is a\r
1646 simple text file modeled after <emphasis>.ini</emphasis> format familiar to some\r
1647 people.  Here is an example:</simpara>\r
1648 <screen>#\r
1649 # A '#' or ';' character indicates a comment.\r
1650 #\r
1651 \r
1652 ; core variables\r
1653 [core]\r
1654         ; Don't trust file modes\r
1655         filemode = false\r
1656 \r
1657 ; user identity\r
1658 [user]\r
1659         name = "Junio C Hamano"\r
1660         email = "junkio@twinsun.com"</screen>\r
1661 <simpara>Various commands read from the configuration file and adjust\r
1662 their operation accordingly.  See <xref linkend="git-config(1)" /> for a\r
1663 list.</simpara>\r
1664 </simplesect>\r
1665 <simplesect id="_identifier_terminology">\r
1666 <title>Identifier Terminology</title>\r
1667 <variablelist>\r
1668 <varlistentry>\r
1669 <term>\r
1670 &lt;object&gt;\r
1671 </term>\r
1672 <listitem>\r
1673 <simpara>\r
1674         Indicates the object name for any type of object.\r
1675 </simpara>\r
1676 </listitem>\r
1677 </varlistentry>\r
1678 <varlistentry>\r
1679 <term>\r
1680 &lt;blob&gt;\r
1681 </term>\r
1682 <listitem>\r
1683 <simpara>\r
1684         Indicates a blob object name.\r
1685 </simpara>\r
1686 </listitem>\r
1687 </varlistentry>\r
1688 <varlistentry>\r
1689 <term>\r
1690 &lt;tree&gt;\r
1691 </term>\r
1692 <listitem>\r
1693 <simpara>\r
1694         Indicates a tree object name.\r
1695 </simpara>\r
1696 </listitem>\r
1697 </varlistentry>\r
1698 <varlistentry>\r
1699 <term>\r
1700 &lt;commit&gt;\r
1701 </term>\r
1702 <listitem>\r
1703 <simpara>\r
1704         Indicates a commit object name.\r
1705 </simpara>\r
1706 </listitem>\r
1707 </varlistentry>\r
1708 <varlistentry>\r
1709 <term>\r
1710 &lt;tree-ish&gt;\r
1711 </term>\r
1712 <listitem>\r
1713 <simpara>\r
1714         Indicates a tree, commit or tag object name.  A\r
1715         command that takes a &lt;tree-ish&gt; argument ultimately wants to\r
1716         operate on a &lt;tree&gt; object but automatically dereferences\r
1717         &lt;commit&gt; and &lt;tag&gt; objects that point at a &lt;tree&gt;.\r
1718 </simpara>\r
1719 </listitem>\r
1720 </varlistentry>\r
1721 <varlistentry>\r
1722 <term>\r
1723 &lt;commit-ish&gt;\r
1724 </term>\r
1725 <listitem>\r
1726 <simpara>\r
1727         Indicates a commit or tag object name.  A\r
1728         command that takes a &lt;commit-ish&gt; argument ultimately wants to\r
1729         operate on a &lt;commit&gt; object but automatically dereferences\r
1730         &lt;tag&gt; objects that point at a &lt;commit&gt;.\r
1731 </simpara>\r
1732 </listitem>\r
1733 </varlistentry>\r
1734 <varlistentry>\r
1735 <term>\r
1736 &lt;type&gt;\r
1737 </term>\r
1738 <listitem>\r
1739 <simpara>\r
1740         Indicates that an object type is required.\r
1741         Currently one of: <emphasis>blob</emphasis>, <emphasis>tree</emphasis>, <emphasis>commit</emphasis>, or <emphasis>tag</emphasis>.\r
1742 </simpara>\r
1743 </listitem>\r
1744 </varlistentry>\r
1745 <varlistentry>\r
1746 <term>\r
1747 &lt;file&gt;\r
1748 </term>\r
1749 <listitem>\r
1750 <simpara>\r
1751         Indicates a filename - almost always relative to the\r
1752         root of the tree structure <emphasis>GIT_INDEX_FILE</emphasis> describes.\r
1753 </simpara>\r
1754 </listitem>\r
1755 </varlistentry>\r
1756 </variablelist>\r
1757 </simplesect>\r
1758 <simplesect id="_symbolic_identifiers">\r
1759 <title>Symbolic Identifiers</title>\r
1760 <simpara>Any git command accepting any &lt;object&gt; can also use the following\r
1761 symbolic notation:</simpara>\r
1762 <variablelist>\r
1763 <varlistentry>\r
1764 <term>\r
1765 HEAD\r
1766 </term>\r
1767 <listitem>\r
1768 <simpara>\r
1769         indicates the head of the current branch.\r
1770 </simpara>\r
1771 </listitem>\r
1772 </varlistentry>\r
1773 <varlistentry>\r
1774 <term>\r
1775 &lt;tag&gt;\r
1776 </term>\r
1777 <listitem>\r
1778 <simpara>\r
1779         a valid tag <emphasis>name</emphasis>\r
1780         (i.e. a <emphasis>refs/tags/&lt;tag&gt;</emphasis> reference).\r
1781 </simpara>\r
1782 </listitem>\r
1783 </varlistentry>\r
1784 <varlistentry>\r
1785 <term>\r
1786 &lt;head&gt;\r
1787 </term>\r
1788 <listitem>\r
1789 <simpara>\r
1790         a valid head <emphasis>name</emphasis>\r
1791         (i.e. a <emphasis>refs/heads/&lt;head&gt;</emphasis> reference).\r
1792 </simpara>\r
1793 </listitem>\r
1794 </varlistentry>\r
1795 </variablelist>\r
1796 <simpara>For a more complete list of ways to spell object names, see\r
1797 "SPECIFYING REVISIONS" section in <xref linkend="gitrevisions(7)" />.</simpara>\r
1798 </simplesect>\r
1799 <simplesect id="_file_directory_structure">\r
1800 <title>File/Directory Structure</title>\r
1801 <simpara>Please see the <xref linkend="gitrepository-layout(5)" /> document.</simpara>\r
1802 <simpara>Read <xref linkend="githooks(5)" /> for more details about each hook.</simpara>\r
1803 <simpara>Higher level SCMs may provide and manage additional information in the\r
1804 <emphasis>$GIT_DIR</emphasis>.</simpara>\r
1805 </simplesect>\r
1806 <simplesect id="_terminology">\r
1807 <title>Terminology</title>\r
1808 <simpara>Please see <xref linkend="gitglossary(7)" />.</simpara>\r
1809 </simplesect>\r
1810 <simplesect id="_environment_variables">\r
1811 <title>Environment Variables</title>\r
1812 <simpara>Various git commands use the following environment variables:</simpara>\r
1813 <section id="_the_git_repository">\r
1814 <title>The git Repository</title>\r
1815 <simpara>These environment variables apply to <emphasis>all</emphasis> core git commands. Nb: it\r
1816 is worth noting that they may be used/overridden by SCMS sitting above\r
1817 git so take care if using Cogito etc.</simpara>\r
1818 <variablelist>\r
1819 <varlistentry>\r
1820 <term>\r
1821 <emphasis>GIT_INDEX_FILE</emphasis>\r
1822 </term>\r
1823 <listitem>\r
1824 <simpara>\r
1825         This environment allows the specification of an alternate\r
1826         index file. If not specified, the default of <emphasis>$GIT_DIR/index</emphasis>\r
1827         is used.\r
1828 </simpara>\r
1829 </listitem>\r
1830 </varlistentry>\r
1831 <varlistentry>\r
1832 <term>\r
1833 <emphasis>GIT_OBJECT_DIRECTORY</emphasis>\r
1834 </term>\r
1835 <listitem>\r
1836 <simpara>\r
1837         If the object storage directory is specified via this\r
1838         environment variable then the sha1 directories are created\r
1839         underneath - otherwise the default <emphasis>$GIT_DIR/objects</emphasis>\r
1840         directory is used.\r
1841 </simpara>\r
1842 </listitem>\r
1843 </varlistentry>\r
1844 <varlistentry>\r
1845 <term>\r
1846 <emphasis>GIT_ALTERNATE_OBJECT_DIRECTORIES</emphasis>\r
1847 </term>\r
1848 <listitem>\r
1849 <simpara>\r
1850         Due to the immutable nature of git objects, old objects can be\r
1851         archived into shared, read-only directories. This variable\r
1852         specifies a ":" separated (on Windows ";" separated) list\r
1853         of git object directories which can be used to search for git\r
1854         objects. New objects will not be written to these directories.\r
1855 </simpara>\r
1856 </listitem>\r
1857 </varlistentry>\r
1858 <varlistentry>\r
1859 <term>\r
1860 <emphasis>GIT_DIR</emphasis>\r
1861 </term>\r
1862 <listitem>\r
1863 <simpara>\r
1864         If the <emphasis>GIT_DIR</emphasis> environment variable is set then it\r
1865         specifies a path to use instead of the default <emphasis>.git</emphasis>\r
1866         for the base of the repository.\r
1867 </simpara>\r
1868 </listitem>\r
1869 </varlistentry>\r
1870 <varlistentry>\r
1871 <term>\r
1872 <emphasis>GIT_WORK_TREE</emphasis>\r
1873 </term>\r
1874 <listitem>\r
1875 <simpara>\r
1876         Set the path to the working tree.  The value will not be\r
1877         used in combination with repositories found automatically in\r
1878         a .git directory (i.e. $GIT_DIR is not set).\r
1879         This can also be controlled by the <emphasis>--work-tree</emphasis> command line\r
1880         option and the core.worktree configuration variable.\r
1881 </simpara>\r
1882 </listitem>\r
1883 </varlistentry>\r
1884 <varlistentry>\r
1885 <term>\r
1886 <emphasis>GIT_NAMESPACE</emphasis>\r
1887 </term>\r
1888 <listitem>\r
1889 <simpara>\r
1890         Set the git namespace; see <xref linkend="gitnamespaces(7)" /> for details.\r
1891         The <emphasis>--namespace</emphasis> command-line option also sets this value.\r
1892 </simpara>\r
1893 </listitem>\r
1894 </varlistentry>\r
1895 <varlistentry>\r
1896 <term>\r
1897 <emphasis>GIT_CEILING_DIRECTORIES</emphasis>\r
1898 </term>\r
1899 <listitem>\r
1900 <simpara>\r
1901         This should be a colon-separated list of absolute paths.\r
1902         If set, it is a list of directories that git should not chdir\r
1903         up into while looking for a repository directory.\r
1904         It will not exclude the current working directory or\r
1905         a GIT_DIR set on the command line or in the environment.\r
1906         (Useful for excluding slow-loading network directories.)\r
1907 </simpara>\r
1908 </listitem>\r
1909 </varlistentry>\r
1910 <varlistentry>\r
1911 <term>\r
1912 <emphasis>GIT_DISCOVERY_ACROSS_FILESYSTEM</emphasis>\r
1913 </term>\r
1914 <listitem>\r
1915 <simpara>\r
1916         When run in a directory that does not have ".git" repository\r
1917         directory, git tries to find such a directory in the parent\r
1918         directories to find the top of the working tree, but by default it\r
1919         does not cross filesystem boundaries.  This environment variable\r
1920         can be set to true to tell git not to stop at filesystem\r
1921         boundaries.  Like <emphasis>GIT_CEILING_DIRECTORIES</emphasis>, this will not affect\r
1922         an explicit repository directory set via <emphasis>GIT_DIR</emphasis> or on the\r
1923         command line.\r
1924 </simpara>\r
1925 </listitem>\r
1926 </varlistentry>\r
1927 </variablelist>\r
1928 </section>\r
1929 <section id="_git_commits">\r
1930 <title>git Commits</title>\r
1931 <variablelist>\r
1932 <varlistentry>\r
1933 <term>\r
1934 <emphasis>GIT_AUTHOR_NAME</emphasis>\r
1935 </term>\r
1936 <term>\r
1937 <emphasis>GIT_AUTHOR_EMAIL</emphasis>\r
1938 </term>\r
1939 <term>\r
1940 <emphasis>GIT_AUTHOR_DATE</emphasis>\r
1941 </term>\r
1942 <term>\r
1943 <emphasis>GIT_COMMITTER_NAME</emphasis>\r
1944 </term>\r
1945 <term>\r
1946 <emphasis>GIT_COMMITTER_EMAIL</emphasis>\r
1947 </term>\r
1948 <term>\r
1949 <emphasis>GIT_COMMITTER_DATE</emphasis>\r
1950 </term>\r
1951 <term>\r
1952 <emphasis>EMAIL</emphasis>\r
1953 </term>\r
1954 <listitem>\r
1955 <simpara>\r
1956         see <xref linkend="git-commit-tree(1)" />\r
1957 </simpara>\r
1958 </listitem>\r
1959 </varlistentry>\r
1960 </variablelist>\r
1961 </section>\r
1962 <section id="_git_diffs">\r
1963 <title>git Diffs</title>\r
1964 <variablelist>\r
1965 <varlistentry>\r
1966 <term>\r
1967 <emphasis>GIT_DIFF_OPTS</emphasis>\r
1968 </term>\r
1969 <listitem>\r
1970 <simpara>\r
1971         Only valid setting is "--unified=??" or "-u??" to set the\r
1972         number of context lines shown when a unified diff is created.\r
1973         This takes precedence over any "-U" or "--unified" option\r
1974         value passed on the git diff command line.\r
1975 </simpara>\r
1976 </listitem>\r
1977 </varlistentry>\r
1978 <varlistentry>\r
1979 <term>\r
1980 <emphasis>GIT_EXTERNAL_DIFF</emphasis>\r
1981 </term>\r
1982 <listitem>\r
1983 <simpara>\r
1984         When the environment variable <emphasis>GIT_EXTERNAL_DIFF</emphasis> is set, the\r
1985         program named by it is called, instead of the diff invocation\r
1986         described above.  For a path that is added, removed, or modified,\r
1987         <emphasis>GIT_EXTERNAL_DIFF</emphasis> is called with 7 parameters:\r
1988 </simpara>\r
1989 <literallayout class="monospaced">path old-file old-hex old-mode new-file new-hex new-mode</literallayout>\r
1990 <simpara>where:</simpara>\r
1991 </listitem>\r
1992 </varlistentry>\r
1993 <varlistentry>\r
1994 <term>\r
1995 &lt;old|new&gt;-file\r
1996 </term>\r
1997 <listitem>\r
1998 <simpara>\r
1999 are files GIT_EXTERNAL_DIFF can use to read the\r
2000                          contents of &lt;old|new&gt;,\r
2001 </simpara>\r
2002 </listitem>\r
2003 </varlistentry>\r
2004 <varlistentry>\r
2005 <term>\r
2006 &lt;old|new&gt;-hex\r
2007 </term>\r
2008 <listitem>\r
2009 <simpara>\r
2010 are the 40-hexdigit SHA1 hashes,\r
2011 </simpara>\r
2012 </listitem>\r
2013 </varlistentry>\r
2014 <varlistentry>\r
2015 <term>\r
2016 &lt;old|new&gt;-mode\r
2017 </term>\r
2018 <listitem>\r
2019 <simpara>\r
2020 are the octal representation of the file modes.\r
2021 </simpara>\r
2022 <simpara>The file parameters can point at the user's working file\r
2023 (e.g. <emphasis>new-file</emphasis> in "git-diff-files"), <emphasis>/dev/null</emphasis> (e.g. <emphasis>old-file</emphasis>\r
2024 when a new file is added), or a temporary file (e.g. <emphasis>old-file</emphasis> in the\r
2025 index).  <emphasis>GIT_EXTERNAL_DIFF</emphasis> should not worry about unlinking the\r
2026 temporary file --- it is removed when <emphasis>GIT_EXTERNAL_DIFF</emphasis> exits.</simpara>\r
2027 <simpara>For a path that is unmerged, <emphasis>GIT_EXTERNAL_DIFF</emphasis> is called with 1\r
2028 parameter, &lt;path&gt;.</simpara>\r
2029 </listitem>\r
2030 </varlistentry>\r
2031 </variablelist>\r
2032 </section>\r
2033 <section id="_other">\r
2034 <title>other</title>\r
2035 <variablelist>\r
2036 <varlistentry>\r
2037 <term>\r
2038 <emphasis>GIT_MERGE_VERBOSITY</emphasis>\r
2039 </term>\r
2040 <listitem>\r
2041 <simpara>\r
2042         A number controlling the amount of output shown by\r
2043         the recursive merge strategy.  Overrides merge.verbosity.\r
2044         See <xref linkend="git-merge(1)" />\r
2045 </simpara>\r
2046 </listitem>\r
2047 </varlistentry>\r
2048 <varlistentry>\r
2049 <term>\r
2050 <emphasis>GIT_PAGER</emphasis>\r
2051 </term>\r
2052 <listitem>\r
2053 <simpara>\r
2054         This environment variable overrides <emphasis>$PAGER</emphasis>. If it is set\r
2055         to an empty string or to the value "cat", git will not launch\r
2056         a pager.  See also the <emphasis>core.pager</emphasis> option in\r
2057         <xref linkend="git-config(1)" />.\r
2058 </simpara>\r
2059 </listitem>\r
2060 </varlistentry>\r
2061 <varlistentry>\r
2062 <term>\r
2063 <emphasis>GIT_EDITOR</emphasis>\r
2064 </term>\r
2065 <listitem>\r
2066 <simpara>\r
2067         This environment variable overrides <emphasis>$EDITOR</emphasis> and <emphasis>$VISUAL</emphasis>.\r
2068         It is used by several git comands when, on interactive mode,\r
2069         an editor is to be launched. See also <xref linkend="git-var(1)" />\r
2070         and the <emphasis>core.editor</emphasis> option in <xref linkend="git-config(1)" />.\r
2071 </simpara>\r
2072 </listitem>\r
2073 </varlistentry>\r
2074 <varlistentry>\r
2075 <term>\r
2076 <emphasis>GIT_SSH</emphasis>\r
2077 </term>\r
2078 <listitem>\r
2079 <simpara>\r
2080         If this environment variable is set then <emphasis>git fetch</emphasis>\r
2081         and <emphasis>git push</emphasis> will use this command instead\r
2082         of <emphasis>ssh</emphasis> when they need to connect to a remote system.\r
2083         The <emphasis>$GIT_SSH</emphasis> command will be given exactly two arguments:\r
2084         the <emphasis>username@host</emphasis> (or just <emphasis>host</emphasis>) from the URL and the\r
2085         shell command to execute on that remote system.\r
2086 </simpara>\r
2087 <simpara>To pass options to the program that you want to list in GIT_SSH\r
2088 you will need to wrap the program and options into a shell script,\r
2089 then set GIT_SSH to refer to the shell script.</simpara>\r
2090 <simpara>Usually it is easier to configure any desired options through your\r
2091 personal <emphasis>.ssh/config</emphasis> file.  Please consult your ssh documentation\r
2092 for further details.</simpara>\r
2093 </listitem>\r
2094 </varlistentry>\r
2095 <varlistentry>\r
2096 <term>\r
2097 <emphasis>GIT_ASKPASS</emphasis>\r
2098 </term>\r
2099 <listitem>\r
2100 <simpara>\r
2101         If this environment variable is set, then git commands which need to\r
2102         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)\r
2103         will call this program with a suitable prompt as command line argument\r
2104         and read the password from its STDOUT. See also the <emphasis>core.askpass</emphasis>\r
2105         option in <xref linkend="git-config(1)" />.\r
2106 </simpara>\r
2107 </listitem>\r
2108 </varlistentry>\r
2109 <varlistentry>\r
2110 <term>\r
2111 <emphasis>GIT_FLUSH</emphasis>\r
2112 </term>\r
2113 <listitem>\r
2114 <simpara>\r
2115         If this environment variable is set to "1", then commands such\r
2116         as <emphasis>git blame</emphasis> (in incremental mode), <emphasis>git rev-list</emphasis>, <emphasis>git log</emphasis>,\r
2117         and <emphasis>git whatchanged</emphasis> will force a flush of the output stream\r
2118         after each commit-oriented record have been flushed.   If this\r
2119         variable is set to "0", the output of these commands will be done\r
2120         using completely buffered I/O.   If this environment variable is\r
2121         not set, git will choose buffered or record-oriented flushing\r
2122         based on whether stdout appears to be redirected to a file or not.\r
2123 </simpara>\r
2124 </listitem>\r
2125 </varlistentry>\r
2126 <varlistentry>\r
2127 <term>\r
2128 <emphasis>GIT_TRACE</emphasis>\r
2129 </term>\r
2130 <listitem>\r
2131 <simpara>\r
2132         If this variable is set to "1", "2" or "true" (comparison\r
2133         is case insensitive), git will print <emphasis>trace:</emphasis> messages on\r
2134         stderr telling about alias expansion, built-in command\r
2135         execution and external command execution.\r
2136         If this variable is set to an integer value greater than 1\r
2137         and lower than 10 (strictly) then git will interpret this\r
2138         value as an open file descriptor and will try to write the\r
2139         trace messages into this file descriptor.\r
2140         Alternatively, if this variable is set to an absolute path\r
2141         (starting with a <emphasis>/</emphasis> character), git will interpret this\r
2142         as a file path and will try to write the trace messages\r
2143         into it.\r
2144 </simpara>\r
2145 </listitem>\r
2146 </varlistentry>\r
2147 </variablelist>\r
2148 </section>\r
2149 </simplesect>\r
2150 <simplesect id="_discussion_anchor_id_discussion_xreflabel_discussion">\r
2151 <title>Discussion<anchor id="Discussion" xreflabel="[Discussion]"/></title>\r
2152 <simpara>More detail on the following is available from the\r
2153 <link linkend="git-concepts">git concepts chapter of the\r
2154 user-manual</link> and <xref linkend="gitcore-tutorial(7)" />.</simpara>\r
2155 <simpara>A git project normally consists of a working directory with a ".git"\r
2156 subdirectory at the top level.  The .git directory contains, among other\r
2157 things, a compressed object database representing the complete history\r
2158 of the project, an "index" file which links that history to the current\r
2159 contents of the working tree, and named pointers into that history such\r
2160 as tags and branch heads.</simpara>\r
2161 <simpara>The object database contains objects of three main types: blobs, which\r
2162 hold file data; trees, which point to blobs and other trees to build up\r
2163 directory hierarchies; and commits, which each reference a single tree\r
2164 and some number of parent commits.</simpara>\r
2165 <simpara>The commit, equivalent to what other systems call a "changeset" or\r
2166 "version", represents a step in the project's history, and each parent\r
2167 represents an immediately preceding step.  Commits with more than one\r
2168 parent represent merges of independent lines of development.</simpara>\r
2169 <simpara>All objects are named by the SHA1 hash of their contents, normally\r
2170 written as a string of 40 hex digits.  Such names are globally unique.\r
2171 The entire history leading up to a commit can be vouched for by signing\r
2172 just that commit.  A fourth object type, the tag, is provided for this\r
2173 purpose.</simpara>\r
2174 <simpara>When first created, objects are stored in individual files, but for\r
2175 efficiency may later be compressed together into "pack files".</simpara>\r
2176 <simpara>Named pointers called refs mark interesting points in history.  A ref\r
2177 may contain the SHA1 name of an object or the name of another ref.  Refs\r
2178 with names beginning <emphasis>ref/head/</emphasis> contain the SHA1 name of the most\r
2179 recent commit (or "head") of a branch under development.  SHA1 names of\r
2180 tags of interest are stored under <emphasis>ref/tags/</emphasis>.  A special ref named\r
2181 <emphasis>HEAD</emphasis> contains the name of the currently checked-out branch.</simpara>\r
2182 <simpara>The index file is initialized with a list of all paths and, for each\r
2183 path, a blob object and a set of attributes.  The blob object represents\r
2184 the contents of the file as of the head of the current branch.  The\r
2185 attributes (last modified time, size, etc.) are taken from the\r
2186 corresponding file in the working tree.  Subsequent changes to the\r
2187 working tree can be found by comparing these attributes.  The index may\r
2188 be updated with new content, and new commits may be created from the\r
2189 content stored in the index.</simpara>\r
2190 <simpara>The index is also capable of storing multiple entries (called "stages")\r
2191 for a given pathname.  These stages are used to hold the various\r
2192 unmerged version of a file when a merge is in progress.</simpara>\r
2193 </simplesect>\r
2194 <simplesect id="_authors">\r
2195 <title>Authors</title>\r
2196 <simpara>Git was started by Linus Torvalds, and is currently maintained by Junio\r
2197 C Hamano. Numerous contributions have come from the git mailing list\r
2198 &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;. For a more complete list of contributors, see\r
2199 <ulink url="http://git-scm.com/about">http://git-scm.com/about</ulink>. If you have a clone of git.git itself, the\r
2200 output of <xref linkend="git-shortlog(1)" /> and <xref linkend="git-blame(1)" /> can show you\r
2201 the authors for specific parts of the project.</simpara>\r
2202 </simplesect>\r
2203 <simplesect id="_reporting_bugs">\r
2204 <title>Reporting Bugs</title>\r
2205 <simpara>Report bugs to the Git mailing list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt; where the\r
2206 development and maintenance is primarily done.  You do not have to be\r
2207 subscribed to the list to send a message there.</simpara>\r
2208 </simplesect>\r
2209 <simplesect id="_see_also">\r
2210 <title>SEE ALSO</title>\r
2211 <simpara><xref linkend="gittutorial(7)" />, <xref linkend="gittutorial-2(7)" />,\r
2212 link:everyday.html[Everyday Git], <xref linkend="gitcvs-migration(7)" />,\r
2213 <xref linkend="gitglossary(7)" />, <xref linkend="gitcore-tutorial(7)" />,\r
2214 <xref linkend="gitcli(7)" />, link:user-manual.html[The Git User's Manual],\r
2215 <xref linkend="gitworkflows(7)" /></simpara>\r
2216 </simplesect>\r
2217 <simplesect id="_git">\r
2218 <title>GIT</title>\r
2219 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
2220 </simplesect>\r
2221 </article>\r