<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
<head>\r
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 7.0.1" />\r
+<meta name="generator" content="AsciiDoc 7.0.2" />\r
<style type="text/css">\r
/* Debug borders */\r
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
</div>\r
<h2>DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<p><em>git</em> is both a program and a directory content tracker system.\r
-The program <em>git</em> is just a wrapper to reach the core git programs\r
-(or a potty if you like, as it's not exactly porcelain but still\r
-brings your stuff to the plumbing).</p>\r
+<p>Git is a fast, scalable, distributed revision control system with an\r
+unusually rich command set that provides both high-level operations\r
+and full access to internals.</p>\r
+<p>See this <a href="tutorial.html">tutorial</a> to get started, then see\r
+<a href="everyday.html">Everyday Git</a> for a useful minimum set of commands, and\r
+"man git-commandname" for documentation of each command. CVS users may\r
+also want to read <a href="cvs-migration.html">CVS migration</a>.</p>\r
</div>\r
<h2>OPTIONS</h2>\r
<div class="sectionbody">\r
</dt>\r
<dd>\r
<p>\r
- prints the git suite version that the <em>git</em> program came from.\r
+ Prints the git suite version that the <em>git</em> program came from.\r
</p>\r
</dd>\r
<dt>\r
</dt>\r
<dd>\r
<p>\r
- prints the synopsis and a list of available commands.\r
- If a git command is named this option will bring up the\r
- man-page for that command.\r
+ Prints the synopsis and a list of the most commonly used\r
+ commands. If a git command is named this option will bring up\r
+ the man-page for that command. If the option <em>--all</em> or <em>-a</em> is\r
+ given then all available commands are printed.\r
</p>\r
</dd>\r
<dt>\r
</dt>\r
<dd>\r
<p>\r
- path to wherever your core git programs are installed.\r
+ Path to wherever your core git programs are installed.\r
This can also be controlled by setting the GIT_EXEC_PATH\r
environment variable. If no path is given <em>git</em> will print\r
the current setting and then exit.\r
</dd>\r
</dl>\r
</div>\r
-<h2>NOT LEARNING CORE GIT COMMANDS</h2>\r
+<h2>FURTHER DOCUMENTATION</h2>\r
<div class="sectionbody">\r
-<p>This manual is intended to give complete background information\r
-and internal workings of git, which may be too much for most\r
-people. The <a href="#Discussion">[Discussion]</a> section below contains much useful\r
-definition and clarification - read that first.</p>\r
-<p>If you are interested in using git to manage (version control)\r
-projects, use <a href="everyday.html">Everyday GIT</a> as a guide to the\r
-minimum set of commands you need to know for day-to-day work.\r
-Most likely, that will get you started, and you can go a long\r
-way without knowing the low level details too much.</p>\r
-<p>The <a href="tutorial.html">tutorial</a> document covers how things\r
-internally work.</p>\r
-<p>If you are migrating from CVS, <a href="cvs-migration.html">cvs\r
-migration</a> document may be helpful after you finish the\r
-tutorial.</p>\r
-<p>After you get the general feel from the tutorial and this\r
-overview page, you may want to take a look at the\r
-<a href="howto-index.html">howto</a> documents.</p>\r
+<p>See the references above to get started using git. The following is\r
+probably more detail than necessary for a first-time user.</p>\r
+<p>The <a href="#Discussion">Discussion</a> section below and the\r
+<a href="core-tutorial.html">Core tutorial</a> both provide introductions to the\r
+underlying git architecture.</p>\r
+<p>See also the <a href="howto-index.html">howto</a> documents for some useful\r
+examples.</p>\r
</div>\r
-<h2>CORE GIT COMMANDS</h2>\r
+<h2>GIT COMMANDS</h2>\r
<div class="sectionbody">\r
-<p>If you are writing your own Porcelain, you need to be familiar\r
-with most of the low level commands --- I suggest starting from\r
-<a href="git-update-index.html">git-update-index(1)</a> and <a href="git-read-tree.html">git-read-tree(1)</a>.</p>\r
+<p>We divide git into high level ("porcelain") commands and low level\r
+("plumbing") commands.</p>\r
</div>\r
-<h2>Commands Overview</h2>\r
+<h2>Low-level commands (plumbing)</h2>\r
<div class="sectionbody">\r
-<p>The git commands can helpfully be split into those that manipulate\r
-the repository, the index and the files in the working tree, those that\r
-interrogate and compare them, and those that moves objects and\r
-references between repositories.</p>\r
-<p>In addition, git itself comes with a spartan set of porcelain\r
-commands. They are usable but are not meant to compete with real\r
-Porcelains.</p>\r
-<p>There are also some ancillary programs that can be viewed as useful\r
-aids for using the core commands but which are unlikely to be used by\r
-SCMs layered over git.</p>\r
+<p>Although git includes its\r
+own porcelain layer, its low-level commands are sufficient to support\r
+development of alternative porcelains. Developers of such porcelains\r
+might start by reading about <a href="git-update-index.html">git-update-index(1)</a> and\r
+<a href="git-read-tree.html">git-read-tree(1)</a>.</p>\r
+<p>We divide the low-level commands into commands that manipulate objects (in\r
+the repository, index, and working tree), commands that interrogate and\r
+compare objects, and commands that move objects and references between\r
+repositories.</p>\r
<h3>Manipulation commands</h3>\r
<dl>\r
<dt>\r
</p>\r
</dd>\r
<dt>\r
+<a href="git-mktree.html">git-mktree(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Build a tree-object from ls-tree formatted text.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-pack-objects.html">git-pack-objects(1)</a>\r
</dt>\r
<dd>\r
</dd>\r
</dl>\r
</div>\r
-<h2>Porcelain-ish Commands</h2>\r
+<h2>High-level commands (porcelain)</h2>\r
<div class="sectionbody">\r
+<p>We separate the porcelain commands into the main commands and some\r
+ancillary user utilities.</p>\r
+<h3>Main porcelain commands</h3>\r
<dl>\r
<dt>\r
<a href="git-add.html">git-add(1)</a>\r
</p>\r
</dd>\r
<dt>\r
+<a href="git-clean.html">git-clean(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Remove untracked files from the working tree.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-clone.html">git-clone(1)</a>\r
</dt>\r
<dd>\r
</p>\r
</dd>\r
<dt>\r
+<a href="git-rerere.html">git-rerere(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Reuse recorded resolution of conflicted merges.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-reset.html">git-reset(1)</a>\r
</dt>\r
<dd>\r
</p>\r
</dd>\r
<dt>\r
+<a href="git-rm.html">git-rm(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Remove files from the working tree and from the index.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-shortlog.html">git-shortlog(1)</a>\r
</dt>\r
<dd>\r
</p>\r
</dd>\r
<dt>\r
+<a href="git-show.html">git-show(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Show one commit log and its diff.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-show-branch.html">git-show-branch(1)</a>\r
</dt>\r
<dd>\r
</p>\r
</dd>\r
</dl>\r
-</div>\r
-<h2>Ancillary Commands</h2>\r
-<div class="sectionbody">\r
+<h3>Ancillary Commands</h3>\r
<p>Manipulators:</p>\r
<dl>\r
<dt>\r
</p>\r
</dd>\r
<dt>\r
+<a href="git-cvsserver.html">git-cvsserver(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ A CVS server emulator for git.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-lost-found.html">git-lost-found(1)</a>\r
</dt>\r
<dd>\r
<p>Interrogators:</p>\r
<dl>\r
<dt>\r
+<a href="git-annotate.html">git-annotate(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Annotate file lines with commit info.\r
+</p>\r
+</dd>\r
+<dt>\r
+<a href="git-blame.html">git-blame(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Blame file lines on commits.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-check-ref-format.html">git-check-ref-format(1)</a>\r
</dt>\r
<dd>\r
</p>\r
</dd>\r
<dt>\r
+<a href="git-fmt-merge-msg.html">git-fmt-merge-msg(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Produce a merge commit message.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-get-tar-commit-id.html">git-get-tar-commit-id(1)</a>\r
</dt>\r
<dd>\r
</p>\r
</dd>\r
<dt>\r
+<a href="git-imap-send.html">git-imap-send(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Dump a mailbox from stdin into an imap folder.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-mailinfo.html">git-mailinfo(1)</a>\r
</dt>\r
<dd>\r
</p>\r
</dd>\r
<dt>\r
+<a href="git-merge-tree.html">git-merge-tree(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Show three-way merge without touching index.\r
+</p>\r
+</dd>\r
+<dt>\r
<a href="git-patch-id.html">git-patch-id(1)</a>\r
</dt>\r
<dd>\r
</p>\r
</dd>\r
<dt>\r
-<a href="git-symbolic-refs.html">git-symbolic-refs(1)</a>\r
+<a href="git-symbolic-ref.html">git-symbolic-ref(1)</a>\r
</dt>\r
<dd>\r
<p>\r
(i.e. the contents of <tt>$GIT_DIR/refs/heads/<head></tt>).\r
</p>\r
</dd>\r
-<dt>\r
-<snap>\r
-</dt>\r
-<dd>\r
-<p>\r
- a valid snapshot <em>name</em>\r
- (i.e. the contents of <tt>$GIT_DIR/refs/snap/<snap></tt>).\r
-</p>\r
-</dd>\r
</dl>\r
</div>\r
<h2>File/Directory Structure</h2>\r
<div class="sectionbody">\r
<p>Please see <a href="repository-layout.html">repository layout</a> document.</p>\r
+<p>Read <a href="hooks.html">hooks</a> for more details about each hook.</p>\r
<p>Higher level SCMs may provide and manage additional information in the\r
<tt>$GIT_DIR</tt>.</p>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 27-Dec-2005 18:31:54 PDT\r
+Last updated 18-Apr-2006 21:30:44 UTC\r
</div>\r
</div>\r
</body>\r
projects / git.git / blobdiff