git(7)
======
-May 2005
+v0.99.5, Aug 2005
NAME
----
This is reference information for the core git commands.
+Before reading this cover to cover, you may want to take a look
+at the link:tutorial.html[tutorial] document.
+
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!
+After you get the general feel from the tutorial and this
+overview page, you may want to take a look at the
+link:howto-index.html[howto] documents.
+
+
David Greaves <david@dgreaves.com>
08/05/05
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.
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
-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-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-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-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
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)
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-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.
+
+
+Porcelain-ish Commands
+----------------------
+link:git-revert-script.html[git-revert-script]::
+ Revert an existing commit.
+
+link:git-rebase-script.html[git-rebase-script]::
+ Rebase local commits to new upstream head.
+
+link:git-add-script.html[git-add-script]::
+ Add paths to the index file.
+
+link:git-branch-script.html[git-branch-script]::
+ Create and Show branches.
+
+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-resolve-script.html[git-resolve-script]::
+ Merge two commits.
+
+link:git-octopus-script.html[git-octopus-script]::
+ Merge more than two commits.
+
+link:git-push-script.html[git-push-script]::
+ Update remote refs along with associated objects.
+
+link:git-commit-script.html[git-commit-script]::
+ Record changes to the repository.
-Ancilliary Commands
--------------------
+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.
+
+link:git-verify-tag-script.html[git-verify-tag-script]::
+ Check the GPG signature of tag.
+
+
+Ancillary Commands
+------------------
Manipulators:
+link:git-relink-script.html[git-relink-script]::
+ Hardlink common objects in local repositories.
+
link:git-apply-patch-script.html[git-apply-patch-script]::
Sample script to apply the diffs from git-diff-*
link:git-prune-script.html[git-prune-script]::
Prunes all unreachable objects from the object database
-link:git-resolve-script.html[git-resolve-script]::
- Script used to merge two trees
-
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-patch-id.html[git-patch-id]::
+ Compute unique ID for a patch.
+
+link:git-count-objects-script.html[git-count-objects-script]::
+ Count unpacked number of objects and their disk consumption.
+
+link:git-cherry.html[git-cherry]::
+ Find commits not merged upstream.
link:git-diff-helper.html[git-diff-helper]::
Generates patch format output for git-diff-*
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.
+
+link:git-sh-setup-script.html[git-sh-setup-script]::
+ Common git shell script setup code.
+
+
+Commands not yet documented
+---------------------------
+
+link:git-applymbox.html[git-applymbox]::
+ git-applymbox.
+
+link:git-applypatch.html[git-applypatch]::
+ git-applypatch.
+
+link:git-mailinfo.html[git-mailinfo]::
+ git-mailinfo.
+
+link:git-mailsplit.html[git-mailsplit]::
+ git-mailsplit.
+
+link:git-bisect-script.html[git-bisect-script]::
+ git-bisect-script.
+
+link:git-build-rev-cache.html[git-build-rev-cache]::
+ git-build-rev-cache.
+
+link:git-checkout-script.html[git-checkout-script]::
+ git-checkout-script.
+
+link:git-clone-dumb-http.html[git-clone-dumb-http]::
+ git-clone-dumb-http.
+
+link:git-daemon.html[git-daemon]::
+ git-daemon.
+
+link:git-diff-script.html[git-diff-script]::
+ git-diff-script.
+
+link:git-format-patch-script.html[git-format-patch-script]::
+ git-format-patch-script.
+
+link:git-get-tar-commit-id.html[git-get-tar-commit-id]::
+ git-get-tar-commit-id.
+
+link:git-request-pull-script.html[git-request-pull-script]::
+ git-request-pull-script.
+
+link:git-reset-script.html[git-reset-script]::
+ git-reset-script.
+
+link:git-rev-parse.html[git-rev-parse]::
+ git-rev-parse.
+
+link:git-show-rev-cache.html[git-show-rev-cache]::
+ git-show-rev-cache.
+
+link:git-stripspace.html[git-stripspace]::
+ git-stripspace.
+
+link:gitk.html[gitk]::
+ gitk.
Identifier Terminology
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::
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
'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.