Clean-up output from "git show-branch" and document it.

[git.git] / Documentation / git.txt

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 916a0b7..9d4fccd 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -1,6 +1,6 @@
 git(7)
 ======
 git(7)
 ======

-May 2005
+v0.99.4, Aug 2005

 
 NAME
 ----
 
 NAME
 ----


@@ -34,7 +34,11 @@ the repository, the cache and the working fileset, those that
 interrogate and compare them, and those that moves objects and
 references between repositories.
 
 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
+In addition, git itself comes with a spartan set of porcelain
+commands.  They are usable but are not meant to compete with real
+Porcelains.
+
+There are also some ancillary programs that can be viewed as useful

 aids for using the core commands but which are unlikely to be used by
 SCMs layered over git.
 
 aids for using the core commands but which are unlikely to be used by
 SCMs layered over git.
 


@@ -67,14 +71,25 @@ link:git-hash-object.html[git-hash-object]::
 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
 

+link:git-pack-objects.html[git-pack-objects]::
+       Creates a packed archive of objects.
+
+link:git-unpack-objects.html[git-unpack-objects]::
+       Unpacks objects out of a packed archive.
+
+link:git-prune-packed.html[git-prune-packed]::
+       Remove extra objects that are already in pack files.
+
+link:git-apply.html[git-apply]::
+       Reads a "diff -up1" or git generated patch file and
+       applies it to the working tree.
+
+

 Interrogation commands
 ~~~~~~~~~~~~~~~~~~~~~~
 link:git-cat-file.html[git-cat-file]::
        Provide content or type information for repository objects
 
 Interrogation commands
 ~~~~~~~~~~~~~~~~~~~~~~
 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
 


@@ -84,6 +99,9 @@ link:git-diff-files.html[git-diff-files]::
 link:git-diff-tree.html[git-diff-tree]::
        Compares the content and mode of blobs found via two tree objects
 
 link:git-diff-tree.html[git-diff-tree]::
        Compares the content and mode of blobs found via two tree objects
 

+link:git-diff-stages.html[git-diff-stages]::
+       Compares two "merge stages" in the index file.
+

 link:git-export.html[git-export]::
        Exports each commit and a diff against each of its parents
 
 link:git-export.html[git-export]::
        Exports each commit and a diff against each of its parents
 


@@ -114,6 +132,9 @@ link:git-unpack-file.html[git-unpack-file]::
 link:git-var.html[git-var]::
        Displays a git logical variable
 
 link:git-var.html[git-var]::
        Displays a git logical variable
 

+link:git-show-index.html[git-show-index]::
+       Displays contents of a pack idx file.
+

 link:git-verify-pack.html[git-verify-pack]::
        Validates packed GIT archive files
 
 link:git-verify-pack.html[git-verify-pack]::
        Validates packed GIT archive files
 


@@ -121,6 +142,9 @@ The interrogate commands may create files - and you can force them to
 touch the working file set - but in general they don't
 
 
 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-script.html[git-clone-script]::
        Clones a repository into the current repository (user interface)
 


@@ -128,10 +152,6 @@ link:git-clone-pack.html[git-clone-pack]::
        Clones a repository into the current repository (engine
        for ssh and local transport)
 
        Clones a repository into the current repository (engine
        for ssh and local transport)
 

-link:git-pull-script.html[git-pull-script]::
-       Pull from a repote repository via various protocols
-       (user interface).
-

 link:git-http-pull.html[git-http-pull]::
        Downloads a remote GIT repository via HTTP
 
 link:git-http-pull.html[git-http-pull]::
        Downloads a remote GIT repository via HTTP
 


@@ -153,13 +173,56 @@ link:git-clone-pack.html[git-clone-pack]::
 link:git-fetch-pack.html[git-fetch-pack]::
        Updates 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-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
--------------------
+
+Porcelain-ish Commands
+----------------------
+link:git-whatchanged.html[git-whatchanged]::
+       Shows commit logs and differences they introduce.
+
+link:git-log-script.html[git-log-script]::
+       Shows commit logs.
+
+link:git-shortlog.html[git-shortlog]::
+       Summarizes 'git log' output.
+
+link:git-status-script.html[git-status-script]::
+       Shows the working tree status.
+
+link:git-fetch-script.html[git-fetch-script]::
+       Download from a remote repository via various protocols.
+
+link:git-pull-script.html[git-pull-script]::
+       Fetch from and merge with a remote repository.
+
+link:git-commit-script.html[git-commit-script]::
+       Record changes to the repository.
+
+link:git-show-branch.html[git-show-branch]::
+       Show branches and their commits.
+
+link:git-repack-script.html[git-repack-script]::
+       Pack unpacked objects in a repository.
+
+link:git-rename-script.html[git-rename]::
+       Rename files and directories.
+
+link:git-ls-remote-script.html[git-ls-remote-script]::
+       Shows references in a remote or local repository.
+
+
+Ancillary Commands
+------------------

 Manipulators:
 
 link:git-apply-patch-script.html[git-apply-patch-script]::
 Manipulators:
 
 link:git-apply-patch-script.html[git-apply-patch-script]::


@@ -180,8 +243,11 @@ 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-cvsimport-script.html[git-cvsimport-script]::
+       Salvage your data out of another SCM people love to hate.
+

 
 

-Interogators:
+Interrogators:

 
 link:git-diff-helper.html[git-diff-helper]::
        Generates patch format output for git-diff-*
 
 link:git-diff-helper.html[git-diff-helper]::
        Generates patch format output for git-diff-*


@@ -189,6 +255,8 @@ link:git-diff-helper.html[git-diff-helper]::
 link:git-ssh-push.html[git-ssh-push]::
        Helper "server-side" program used by git-ssh-pull
 
 link:git-ssh-push.html[git-ssh-push]::
        Helper "server-side" program used by git-ssh-pull
 

+link:git-send-email-script.html[git-send-email]::
+       Send patch e-mails out of "format-patch --mbox" output.

 
 
 Identifier Terminology
 
 
 Identifier Terminology


@@ -221,7 +289,7 @@ Identifier Terminology
 
 Symbolic Identifiers
 --------------------
 
 Symbolic Identifiers
 --------------------

-Any git comand accepting any <object> can also use the following
+Any git command accepting any <object> can also use the following

 symbolic notation:
 
 HEAD::
 symbolic notation:
 
 HEAD::


@@ -260,12 +328,7 @@ GIT_DIR.
 
 Terminology
 -----------
 
 Terminology
 -----------

-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
+Please see link:glossary.html[glossary] document.

 
 
 Environment Variables
 
 
 Environment Variables


@@ -292,7 +355,7 @@ git so take care if using Cogito etc
 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
        Due to the immutable nature of git objects, old objects can be
        archived into shared, read-only directories. This variable
 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
        Due to the immutable nature of git objects, old objects can be
        archived into shared, read-only directories. This variable

-       specifies a ":" seperated list of git object directories which
+       specifies a ":" separated list of git object directories which

        can be used to search for git objects. New objects will not be
        written to these directories.
 
        can be used to search for git objects. New objects will not be
        written to these directories.