GIT 0.99.9b
[gitweb.git] / Documentation / git.txt
index f8dd76ac24db980facefe95f6139707100dfabb6..2f9622f5ac492140427e752ebd163cb22d003d8d 100644 (file)
@@ -60,7 +60,6 @@ gitlink:git-apply[1]::
 
 gitlink:git-checkout-index[1]::
        Copy files from the cache to the working directory
-       Previously this command was known as git-checkout-cache.
 
 gitlink:git-commit-tree[1]::
        Creates a new commit object
@@ -68,12 +67,14 @@ gitlink:git-commit-tree[1]::
 gitlink:git-hash-object[1]::
        Computes the object ID from a file.
 
+gitlink:git-index-pack.html[1]::
+       Build pack index file for an existing packed archive.
+
 gitlink:git-init-db[1]::
        Creates an empty git object database
 
 gitlink:git-merge-index[1]::
        Runs a merge for files needing merging
-       Previously this command was known as git-merge-cache.
 
 gitlink:git-mktag[1]::
        Creates a tag object
@@ -92,7 +93,6 @@ gitlink:git-unpack-objects[1]::
 
 gitlink:git-update-index[1]::
        Modifies the index or directory cache
-       Previously this command was known as git-update-cache.
 
 gitlink:git-write-tree[1]::
        Creates a tree from the current cache
@@ -106,7 +106,6 @@ gitlink:git-cat-file[1]::
 
 gitlink:git-diff-index[1]::
        Compares content and mode of blobs between the cache and repository
-       Previously this command was known as git-diff-cache.
 
 gitlink:git-diff-files[1]::
        Compares files in the working tree and the cache
@@ -119,7 +118,6 @@ gitlink:git-diff-tree[1]::
 
 gitlink:git-fsck-objects[1]::
        Verifies the connectivity and validity of the objects in the database
-       Previously this command was known as git-fsck-cache.
 
 gitlink:git-ls-files[1]::
        Information about files in the cache/working directory
@@ -130,6 +128,9 @@ gitlink:git-ls-tree[1]::
 gitlink:git-merge-base[1]::
        Finds as good a common ancestor as possible for a merge
 
+gitlink:git-name-rev[1]::
+       Find symbolic names for given revs
+
 gitlink:git-rev-list[1]::
        Lists commit objects in reverse chronological order
 
@@ -146,7 +147,7 @@ gitlink:git-var[1]::
        Displays a git logical variable
 
 gitlink:git-verify-pack[1]::
-       Validates packed GIT archive files
+       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
@@ -163,12 +164,10 @@ gitlink:git-fetch-pack[1]::
        Updates from a remote repository.
 
 gitlink:git-http-fetch[1]::
-       Downloads a remote GIT repository via HTTP
-       Previously this command was known as git-http-pull.
+       Downloads a remote git repository via HTTP
 
 gitlink:git-local-fetch[1]::
-       Duplicates another GIT repository on a local system
-       Previously this command was known as git-local-pull.
+       Duplicates another git repository on a local system
 
 gitlink:git-peek-remote[1]::
        Lists references on a remote repository using upload-pack protocol.
@@ -179,13 +178,14 @@ gitlink:git-receive-pack[1]::
 gitlink:git-send-pack[1]::
        Pushes to a remote repository, intelligently.
 
+gitlink:git-shell[1]::
+       Restricted shell for GIT-only SSH access.
+
 gitlink:git-ssh-fetch[1]::
        Pulls from a remote repository over ssh connection
-       Previously this command was known as git-ssh-pull.
 
 gitlink:git-ssh-upload[1]::
        Helper "server-side" program used by git-ssh-fetch
-       Previously this command was known as git-ssh-push.
 
 gitlink:git-update-server-info[1]::
        Updates auxiliary information on a dumb server to help
@@ -201,96 +201,81 @@ Porcelain-ish Commands
 
 gitlink:git-add[1]::
        Add paths to the index file.
-       Previously this command was known as git-add-script.
+
+gitlink:git-am[1]::
+       Apply patches from a mailbox, but cooler.
 
 gitlink:git-applymbox[1]::
        Apply patches from a mailbox.
 
 gitlink:git-bisect[1]::
        Find the change that introduced a bug.
-       Previously this command was known as git-bisect-script.
 
 gitlink:git-branch[1]::
        Create and Show branches.
-       Previously this command was known as git-branch-script.
 
 gitlink:git-checkout[1]::
        Checkout and switch to a branch.
-       Previously this command was known as git-checkout-script.
 
 gitlink:git-cherry-pick[1]::
        Cherry-pick the effect of an existing commit.
-       Previously this command was known as git-cherry-pick-script.
 
 gitlink:git-clone[1]::
        Clones a repository into a new directory.
-       Previously this command was known as git-clone-script.
 
 gitlink:git-commit[1]::
        Record changes to the repository.
-       Previously this command was known as git-commit-script.
 
 gitlink:git-diff[1]::
        Show changes between commits, commit and working tree, etc.
-       Previously this command was known as git-diff-script.
 
 gitlink:git-fetch[1]::
        Download from a remote repository via various protocols.
-       Previously this command was known as git-fetch-script.
 
 gitlink:git-format-patch[1]::
        Prepare patches for e-mail submission.
-       Previously this command was known as git-format-patch-script.
 
 gitlink:git-grep[1]::
        Print lines matching a pattern
 
 gitlink:git-log[1]::
        Shows commit logs.
-       Previously this command was known as git-log-script.
 
 gitlink:git-ls-remote[1]::
        Shows references in a remote or local repository.
-       Previously this command was known as git-ls-remote-script.
 
 gitlink:git-merge[1]::
        Grand unified merge driver.
 
+gitlink:git-mv[1]::
+       Move or rename a file, a directory, or a symlink.
+
 gitlink:git-octopus[1]::
        Merge more than two commits.
-       Previously this command was known as git-octopus-script.
 
 gitlink:git-pull[1]::
        Fetch from and merge with a remote repository.
-       Previously this command was known as git-pull-script.
 
 gitlink:git-push[1]::
        Update remote refs along with associated objects.
-       Previously this command was known as git-push-script.
 
 gitlink:git-rebase[1]::
        Rebase local commits to new upstream head.
-       Previously this command was known as git-rebase-script.
 
 gitlink:git-rename[1]::
        Rename files and directories.
-       Previously this command was known as git-rename-script.
 
 gitlink:git-repack[1]::
        Pack unpacked objects in a repository.
-       Previously this command was known as git-repack-script.
 
 gitlink:git-reset[1]::
        Reset current HEAD to the specified state.
-       Previously this command was known as git-reset-script.
 
 gitlink:git-resolve[1]::
        Merge two commits.
-       Previously this command was known as git-resolve-script.
 
 gitlink:git-revert[1]::
        Revert an existing commit.
-       Previously this command was known as git-revert-script.
 
 gitlink:git-shortlog[1]::
        Summarizes 'git log' output.
@@ -300,11 +285,9 @@ gitlink:git-show-branch[1]::
 
 gitlink:git-status[1]::
        Shows the working tree status.
-       Previously this command was known as git-status-script.
 
 gitlink:git-verify-tag[1]::
        Check the GPG signature of tag.
-       Previously this command was known as git-verify-tag-script.
 
 gitlink:git-whatchanged[1]::
        Shows commit logs and differences they introduce.
@@ -319,48 +302,51 @@ gitlink:git-applypatch[1]::
 
 gitlink:git-archimport[1]::
        Import an arch repository into git.
-       Previously this command was known as git-archimport-script.
 
 gitlink:git-convert-objects[1]::
-       Converts old-style GIT repository
-       Previously this command was known as git-convert-cache.
+       Converts old-style git repository
 
 gitlink:git-cvsimport[1]::
        Salvage your data out of another SCM people love to hate.
-       Previously this command was known as git-cvsimport-script.
 
 gitlink:git-merge-one-file[1]::
        The standard helper program to use with "git-merge-index"
-       Previously this command was known as git-merge-one-file-script.
 
 gitlink:git-prune[1]::
        Prunes all unreachable objects from the object database
-       Previously this command was known as git-prune-script.
 
 gitlink:git-relink[1]::
        Hardlink common objects in local repositories.
-       Previously this command was known as git-relink-script.
+
+gitlink:git-svnimport[1]::
+       Import a SVN repository into git.
 
 gitlink:git-sh-setup[1]::
        Common git shell script setup code.
-       Previously this command was known as git-sh-setup-script.
+
+gitlink:git-symbolic-ref[1]::
+       Read and modify symbolic refs
 
 gitlink:git-tag[1]::
        An example script to create a tag object signed with GPG
-       Previously this command was known as git-tag-script.
+
+gitlink:git-update-ref[1]::
+       Update the object name stored in a ref safely.
 
 
 Interrogators:
 
+gitlink:git-check-ref-format[1]::
+       Make sure ref name is well formed.
+
 gitlink:git-cherry[1]::
        Find commits not merged upstream.
 
 gitlink:git-count-objects[1]::
        Count unpacked number of objects and their disk consumption.
-       Previously this command was known as git-count-objects-script.
 
 gitlink:git-daemon[1]::
-       A really simple server for GIT repositories.
+       A really simple server for git repositories.
 
 gitlink:git-get-tar-commit-id[1]::
        Extract commit ID from an archive created using git-tar-tree.
@@ -376,18 +362,18 @@ gitlink:git-patch-id[1]::
 
 gitlink:git-parse-remote[1]::
        Routines to help parsing $GIT_DIR/remotes/
-       Previously this command was known as git-parse-remote-script.
 
 gitlink:git-request-pull[1]::
        git-request-pull.
-       Previously this command was known as git-request-pull-script.
 
 gitlink:git-rev-parse[1]::
        Pick out and massage parameters.
 
 gitlink:git-send-email[1]::
        Send patch e-mails out of "format-patch --mbox" output.
-       Previously this command was known as git-send-email-script.
+
+gitlink:git-symbolic-refs[1]::
+       Read and modify symbolic refs.
 
 gitlink:git-stripspace[1]::
        Filter out empty lines.
@@ -400,6 +386,37 @@ gitlink:gitk[1]::
        gitk.
 
 
+Configuration Mechanism
+-----------------------
+
+Starting from 0.99.9 (actually mid 0.99.8.GIT), .git/config file
+is used to hold per-repository configuration options.  It is a
+simple text file modelled after `.ini` format familiar to some
+people.  Here is an example:
+
+------------
+#
+# This is the config file, and
+# a '#' or ';' character indicates
+# a comment
+#
+
+; core variables
+[core]
+       ; Don't trust file modes
+       filemode = false
+
+; user identity
+[user]
+       name = "Junio C Hamano"
+       email = "junkio@twinsun.com"
+
+------------
+
+Various commands read from the configuration file and adjust
+their operation accordingly.
+
+
 Identifier Terminology
 ----------------------
 <object>::