OPTIONS
-------
--version::
- prints the git suite version that the 'git' program came from.
+ Prints the git suite version that the 'git' program came from.
--help::
- prints the synopsis and a list of available commands.
- If a git command is named this option will bring up the
- man-page for that command.
+ Prints the synopsis and a list of the most commonly used
+ commands. If a git command is named this option will bring up
+ the man-page for that command. If the option '--all' or '-a' is
+ given then all available commands are printed.
--exec-path::
- path to wherever your core git programs are installed.
+ Path to wherever your core git programs are installed.
This can also be controlled by setting the GIT_EXEC_PATH
environment variable. If no path is given 'git' will print
the current setting and then exit.
-CORE GIT COMMANDS
------------------
-Before reading this cover to cover, you may want to take a look
-at the link:tutorial.html[tutorial] document. If you are
-migrating from CVS, link:cvs-migration.html[cvs migration]
-document may be helpful after you finish the tutorial.
-
-The <<Discussion>> section below contains much useful definition
-and clarification info - read that first. After that, if you
-are interested in using git to manage (version control)
-projects, use link:everyday.html[Everyday GIT] as a guide to the
+
+NOT LEARNING CORE GIT COMMANDS
+------------------------------
+
+This manual is intended to give complete background information
+and internal workings of git, which may be too much for most
+people. The <<Discussion>> section below contains much useful
+definition and clarification - read that first.
+
+If you are interested in using git to manage (version control)
+projects, use link:tutorial.html[The Tutorial] to get you started,
+and then link:everyday.html[Everyday GIT] as a guide to the
minimum set of commands you need to know for day-to-day work.
+Most likely, that will get you started, and you can go a long
+way without knowing the low level details too much.
+
+The link:core-tutorial.html[Core tutorial] document covers how things
+internally work.
+
+If you are migrating from CVS, link:cvs-migration.html[cvs
+migration] document may be helpful after you finish the
+tutorial.
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.
+
+CORE GIT COMMANDS
+-----------------
+
If you are writing your own Porcelain, you need to be familiar
with most of the low level commands --- I suggest starting from
gitlink:git-update-index[1] and gitlink:git-read-tree[1].
-David Greaves <david@dgreaves.com>
-08/05/05
-
-Updated by Junio C Hamano <junkio@cox.net> on 2005-05-05 and
-further on 2005-12-07 to reflect recent changes.
-
Commands Overview
-----------------
The git commands can helpfully be split into those that manipulate
gitlink:git-cat-file[1]::
Provide content or type/size information for repository objects.
+gitlink:git-describe[1]::
+ Show the most recent tag that is reachable from a commit.
+
gitlink:git-diff-index[1]::
Compares content and mode of blobs between the index and repository.
gitlink:git-name-rev[1]::
Find symbolic names for given revs.
+gitlink:git-pack-redundant[1]::
+ Find redundant pack files.
+
gitlink:git-rev-list[1]::
Lists commit objects in reverse chronological order.
gitlink:git-send-pack[1]::
Pushes to a remote repository, intelligently.
+gitlink:git-http-push[1]::
+ Push missing objects using HTTP/DAV.
+
gitlink:git-shell[1]::
Restricted shell for GIT-only SSH access.
gitlink:git-mv[1]::
Move or rename a file, a directory, or a symlink.
-gitlink:git-octopus[1]::
- Merge more than two commits.
-
gitlink:git-pull[1]::
Fetch from and merge with a remote repository.
gitlink:git-repack[1]::
Pack unpacked objects in a repository.
+gitlink:git-rerere[1]::
+ Reuse recorded resolution of conflicted merges.
+
gitlink:git-reset[1]::
Reset current HEAD to the specified state.
gitlink:git-shortlog[1]::
Summarizes 'git log' output.
+gitlink:git-show[1]::
+ Show one commit log and its diff.
+
gitlink:git-show-branch[1]::
Show branches and their commits.
gitlink:git-cvsimport[1]::
Salvage your data out of another SCM people love to hate.
+gitlink:git-cvsexportcommit[1]::
+ Export a single commit to a CVS checkout.
+
gitlink:git-lost-found[1]::
Recover lost refs that luckily have not yet been pruned.
gitlink:git-send-email[1]::
Send patch e-mails out of "format-patch --mbox" output.
-gitlink:git-symbolic-refs[1]::
+gitlink:git-symbolic-ref[1]::
Read and modify symbolic refs.
gitlink:git-stripspace[1]::
a valid head 'name'
(i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
-<snap>::
- a valid snapshot 'name'
- (i.e. the contents of `$GIT_DIR/refs/snap/<snap>`).
-
File/Directory Structure
------------------------
Please see link:repository-layout.html[repository layout] document.
+Read link:hooks.html[hooks] for more details about each hook.
+
Higher level SCMs may provide and manage additional information in the
`$GIT_DIR`.
Discussion[[Discussion]]
------------------------
-include::../README[]
+include::README[]
Authors
-------
- git's founding father is Linus Torvalds <torvalds@osdl.org>.
- The current git nurse is Junio C Hamano <junkio@cox.net>.
-
The git potty was written by Andres Ericsson <ae@op5.se>.
- General upbringing is handled by the git-list <git@vger.kernel.org>.
+* git's founding father is Linus Torvalds <torvalds@osdl.org>.
+* The current git nurse is Junio C Hamano <junkio@cox.net>.
+
* The git potty was written by Andres Ericsson <ae@op5.se>.
+* General upbringing is handled by the git-list <git@vger.kernel.org>.
Documentation
--------------
-Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
+The documentation for git suite was started by David Greaves
+<david@dgreaves.com>, and later enhanced greatly by the
+contributors on the git-list <git@vger.kernel.org>.
GIT
---
projects / git.git / blobdiff