Merge with gitk.

[git.git] / Documentation / git.txt

diff --git a/Documentation/git.txt b/Documentation/git.txt
index a02ed6f..d18cf5e 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -1,6 +1,6 @@
-git(1)
+git(7)

 ======
 ======

-v0.1, May 2005
+May 2005

 
 NAME
 ----
 
 NAME
 ----


@@ -16,9 +16,10 @@ DESCRIPTION
 
 This is reference information for the core git commands.
 
 
 This is reference information for the core git commands.
 

-The link:README[] contains much useful definition and clarification
-info - read that first.  And of the commands, I suggest reading
-'git-update-cache' and 'git-read-tree' first - I wish I had!
+The Discussion section below contains much useful definition and
+clarification info - read that first.  And of the commands, I suggest
+reading link:git-update-cache.html[git-update-cache] and
+link:git-read-tree.html[git-read-tree] first - I wish I had!

 
 David Greaves <david@dgreaves.com>
 08/05/05
 
 David Greaves <david@dgreaves.com>
 08/05/05


@@ -29,8 +30,9 @@ reflect recent changes.
 Commands Overview
 -----------------
 The git commands can helpfully be split into those that manipulate
 Commands Overview
 -----------------
 The git commands can helpfully be split into those that manipulate

-the repository, the cache and the working fileset and those that
-interrogate and compare them.
+the repository, the cache and the working fileset, those that
+interrogate and compare them, and those that moves objects and
+references between repositories.

 
 There are also some ancilliary programs that can be viewed as useful
 aids for using the core commands but which are unlikely to be used by
 
 There are also some ancilliary programs that can be viewed as useful
 aids for using the core commands but which are unlikely to be used by


@@ -59,8 +61,8 @@ link:git-read-tree.html[git-read-tree]::
 link:git-update-cache.html[git-update-cache]::
        Modifies the index or directory cache
 
 link:git-update-cache.html[git-update-cache]::
        Modifies the index or directory cache
 

-link:git-write-blob.html[git-write-blob]::
-       Creates a blob from a file
+link:git-hash-object.html[git-hash-object]::
+       Computes the object ID from a file.

 
 link:git-write-tree.html[git-write-tree]::
        Creates a tree from the current cache
 
 link:git-write-tree.html[git-write-tree]::
        Creates a tree from the current cache


@@ -70,9 +72,6 @@ Interrogation commands
 link:git-cat-file.html[git-cat-file]::
        Provide content or type information for repository objects
 
 link:git-cat-file.html[git-cat-file]::
        Provide content or type information for repository objects
 

-link:git-check-files.html[git-check-files]::
-       Verify a list of files are up-to-date
-

 link:git-diff-cache.html[git-diff-cache]::
        Compares content and mode of blobs between the cache and repository
 
 link:git-diff-cache.html[git-diff-cache]::
        Compares content and mode of blobs between the cache and repository
 


@@ -109,10 +108,67 @@ link:git-tar-tree.html[git-tar-tree]::
 link:git-unpack-file.html[git-unpack-file]::
        Creates a temporary file with a blob's contents
 
 link:git-unpack-file.html[git-unpack-file]::
        Creates a temporary file with a blob's contents
 

+link:git-var.html[git-var]::
+       Displays a git logical variable
+
+link:git-verify-pack.html[git-verify-pack]::
+       Validates packed GIT archive files
+

 The interrogate commands may create files - and you can force them to
 touch the working file set - but in general they don't
 
 
 The interrogate commands may create files - and you can force them to
 touch the working file set - but in general they don't
 
 

+Synching repositories
+~~~~~~~~~~~~~~~~~~~~~
+
+link:git-clone-script.html[git-clone-script]::
+       Clones a repository into the current repository (user interface)
+
+link:git-clone-pack.html[git-clone-pack]::
+       Clones a repository into the current repository (engine
+       for ssh and local transport)
+
+link:git-fetch-script.html[git-fetch-script]::
+       Download from a remote repository via various protocols
+       (user interface).
+
+link:git-pull-script.html[git-pull-script]::
+       Fetch from and merge with a remote repository via
+       various protocols (user interface).
+
+link:git-http-pull.html[git-http-pull]::
+       Downloads a remote GIT repository via HTTP
+
+link:git-local-pull.html[git-local-pull]::
+       Duplicates another GIT repository on a local system
+
+link:git-ssh-pull.html[git-ssh-pull]::
+       Pulls from a remote repository over ssh connection
+
+link:git-send-pack.html[git-send-pack]::
+       Pushes to a remote repository, intelligently.
+
+link:git-receive-pack.html[git-receive-pack]::
+       Invoked by 'git-send-pack' to receive what is pushed to it.
+
+link:git-clone-pack.html[git-clone-pack]::
+       Clones from a remote repository.
+
+link:git-fetch-pack.html[git-fetch-pack]::
+       Updates from a remote repository.
+
+link:git-peek-remote.html[git-peek-remote]::
+       Lists references on a remote repository using upload-pack protocol.
+
+link:git-upload-pack.html[git-upload-pack]::
+       Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
+       what are asked for.
+
+link:git-update-server-info.html[git-update-server-info]::
+       Updates auxiliary information on a dumb server to help
+       clients discover references and packs on it.
+
+

 Ancilliary Commands
 -------------------
 Manipulators:
 Ancilliary Commands
 -------------------
 Manipulators:


@@ -123,18 +179,9 @@ link:git-apply-patch-script.html[git-apply-patch-script]::
 link:git-convert-cache.html[git-convert-cache]::
        Converts old-style GIT repository
 
 link:git-convert-cache.html[git-convert-cache]::
        Converts old-style GIT repository
 

-link:git-http-pull.html[git-http-pull]::
-       Downloads a remote GIT repository via HTTP
-
-link:git-local-pull.html[git-local-pull]::
-       Duplicates another GIT repository on a local system
-

 link:git-merge-one-file-script.html[git-merge-one-file-script]::
        The standard helper program to use with "git-merge-cache"
 
 link:git-merge-one-file-script.html[git-merge-one-file-script]::
        The standard helper program to use with "git-merge-cache"
 

-link:git-pull-script.html[git-pull-script]::
-       Script used by Linus to pull and merge a remote repository
-

 link:git-prune-script.html[git-prune-script]::
        Prunes all unreachable objects from the object database
 
 link:git-prune-script.html[git-prune-script]::
        Prunes all unreachable objects from the object database
 


@@ -144,27 +191,21 @@ link:git-resolve-script.html[git-resolve-script]::
 link:git-tag-script.html[git-tag-script]::
        An example script to create a tag object signed with GPG
 
 link:git-tag-script.html[git-tag-script]::
        An example script to create a tag object signed with GPG
 

-link:git-rpull.html[git-rpull]::
-       Pulls from a remote repository over ssh connection

 
 Interogators:
 
 
 Interogators:
 

-link:git-diff-tree-helper.html[git-diff-tree-helper]::
+link:git-diff-helper.html[git-diff-helper]::

        Generates patch format output for git-diff-*
 
        Generates patch format output for git-diff-*
 

-link:git-rpush.html[git-rpush]::
-       Helper "server-side" program used by git-rpull
+link:git-ssh-push.html[git-ssh-push]::
+       Helper "server-side" program used by git-ssh-pull

 
 
 
 
 
 

-Terminology
------------
-see README for description
-
-Identifier terminology
+Identifier Terminology

 ----------------------
 <object>::
 ----------------------
 <object>::

-       Indicates any object sha1 identifier
+       Indicates the sha1 identifier for any type of object

 
 <blob>::
        Indicates a blob object sha1 identifier
 
 <blob>::
        Indicates a blob object sha1 identifier


@@ -176,11 +217,10 @@ Identifier terminology
        Indicates a commit object sha1 identifier
 
 <tree-ish>::
        Indicates a commit object sha1 identifier
 
 <tree-ish>::

-       Indicates a tree, commit or tag object sha1 identifier.
-       A command that takes a <tree-ish> argument ultimately
-       wants to operate on a <tree> object but automatically
-       dereferences <commit> and <tag> that points at a
-       <tree>.
+       Indicates a tree, commit or tag object sha1 identifier.  A
+       command that takes a <tree-ish> argument ultimately wants to
+       operate on a <tree> object but automatically dereferences
+       <commit> and <tag> objects that point at a <tree>.

 
 <type>::
        Indicates that an object type is required.
 
 <type>::
        Indicates that an object type is required.


@@ -192,10 +232,12 @@ Identifier terminology
 
 Symbolic Identifiers
 --------------------
 
 Symbolic Identifiers
 --------------------

-Any git comand accepting any <object> can also use the following symbolic notation:
+Any git comand accepting any <object> can also use the following
+symbolic notation:

 
 HEAD::
 
 HEAD::

-       indicates the head of the repository (ie the contents of `$GIT_DIR/HEAD`)
+       indicates the head of the repository (ie the contents of
+       `$GIT_DIR/HEAD`)

 <tag>::
        a valid tag 'name'+
        (ie the contents of `$GIT_DIR/refs/tags/<tag>`)
 <tag>::
        a valid tag 'name'+
        (ie the contents of `$GIT_DIR/refs/tags/<tag>`)


@@ -213,35 +255,28 @@ The git-core manipulates the following areas in the directory:
 
  .git/        The base (overridden with $GIT_DIR)
    objects/    The object base (overridden with $GIT_OBJECT_DIRECTORY)
 
  .git/        The base (overridden with $GIT_DIR)
    objects/    The object base (overridden with $GIT_OBJECT_DIRECTORY)

-     ??/       'First 2 chars of object' directories
-
-It can interrogate (but never updates) the following areas:
+     ??/       'First 2 chars of object' directories.
+     pack/     Packed archives.

 
    refs/       Directories containing symbolic names for objects
               (each file contains the hex SHA1 + newline)
      heads/    Commits which are heads of various sorts
      tags/     Tags, by the tag name (or some local renaming of it)
 
    refs/       Directories containing symbolic names for objects
               (each file contains the hex SHA1 + newline)
      heads/    Commits which are heads of various sorts
      tags/     Tags, by the tag name (or some local renaming of it)

-     snap/     ????
-   ...         Everything else isn't shared
-   HEAD        Symlink to refs/heads/<something>
+     */        Any other subdirectory of refs/ can be used to store
+              files similar to what are under refs/heads/.
+   HEAD        Symlink to refs/heads/<current-branch-name>

 
 Higher level SCMs may provide and manage additional information in the
 GIT_DIR.
 
 Terminology
 -----------
 
 Higher level SCMs may provide and manage additional information in the
 GIT_DIR.
 
 Terminology
 -----------

-Each line contains terms used interchangeably
+Each line contains terms which you may see used interchangeably

 
  object database, .git directory
  directory cache, index
  id, sha1, sha1-id, sha1 hash
  type, tag
 
  object database, .git directory
  directory cache, index
  id, sha1, sha1-id, sha1 hash
  type, tag

- blob, blob object
- tree, tree object
- commit, commit object
- parent
- root object
- changeset

 
 
 Environment Variables
 
 
 Environment Variables


@@ -288,16 +323,20 @@ git Commits
 
 git Diffs
 ~~~~~~~~~
 
 git Diffs
 ~~~~~~~~~

-GIT_DIFF_OPTS::
-GIT_EXTERNAL_DIFF::
+'GIT_DIFF_OPTS'::
+'GIT_EXTERNAL_DIFF'::

        see the "generating patches" section in :
        link:git-diff-cache.html[git-diff-cache];
        link:git-diff-files.html[git-diff-files];
        link:git-diff-tree.html[git-diff-tree]
 
        see the "generating patches" section in :
        link:git-diff-cache.html[git-diff-cache];
        link:git-diff-files.html[git-diff-files];
        link:git-diff-tree.html[git-diff-tree]
 

+Discussion
+----------
+include::../README[]
+

 Author
 ------
 Author
 ------

-Written by Linus Torvalds <torvalds@osdl.org>
+Written by Linus Torvalds <torvalds@osdl.org> and the git-list <git@vger.kernel.org>.

 
 Documentation
 --------------
 
 Documentation
 --------------