Code

Document rev-list's option --merge
[git.git] / Documentation / git.txt
index 06b2e5303edea64f1a33767c3d9d474fdef3a6e4..bcf187a11cfaf754ecb93a2210139dd88f6a9d32 100644 (file)
@@ -8,7 +8,8 @@ git - the stupid content tracker
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
-'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--help] COMMAND [ARGS]
+'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate]
+       [--bare] [--git-dir=GIT_DIR] [--help] COMMAND [ARGS]
 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------
@@ -21,6 +22,9 @@ link:everyday.html[Everyday Git] for a useful minimum set of commands, and
 "man git-commandname" for documentation of each command.  CVS users may
 also want to read link:cvs-migration.html[CVS migration].
 
 "man git-commandname" for documentation of each command.  CVS users may
 also want to read link:cvs-migration.html[CVS migration].
 
+The COMMAND is either a name of a Git command (see below) or an alias
+as defined in the configuration file (see gitlink:git-repo-config[1]).
+
 OPTIONS
 -------
 --version::
 OPTIONS
 -------
 --version::
@@ -38,6 +42,15 @@ OPTIONS
        environment variable. If no path is given 'git' will print
        the current setting and then exit.
 
        environment variable. If no path is given 'git' will print
        the current setting and then exit.
 
+-p|--paginate::
+       Pipe all output into 'less' (or if set, $PAGER).
+
+--git-dir=<path>::
+       Set the path to the repository. This can also be controlled by
+       setting the GIT_DIR environment variable.
+
+--bare::
+       Same as --git-dir=`pwd`.
 
 FURTHER DOCUMENTATION
 ---------------------
 
 FURTHER DOCUMENTATION
 ---------------------
@@ -100,6 +113,9 @@ gitlink:git-merge-index[1]::
 gitlink:git-mktag[1]::
        Creates a tag object.
 
 gitlink:git-mktag[1]::
        Creates a tag object.
 
+gitlink:git-mktree[1]::
+       Build a tree-object from ls-tree formatted text.
+
 gitlink:git-pack-objects[1]::
        Creates a packed archive of objects.
 
 gitlink:git-pack-objects[1]::
        Creates a packed archive of objects.
 
@@ -186,10 +202,6 @@ the working tree.
 Synching repositories
 ~~~~~~~~~~~~~~~~~~~~~
 
 Synching repositories
 ~~~~~~~~~~~~~~~~~~~~~
 
-gitlink:git-clone-pack[1]::
-       Clones a repository into the current repository (engine
-       for ssh and local transport).
-
 gitlink:git-fetch-pack[1]::
        Updates from a remote repository (engine for ssh and
        local transport).
 gitlink:git-fetch-pack[1]::
        Updates from a remote repository (engine for ssh and
        local transport).
@@ -231,9 +243,13 @@ gitlink:git-update-server-info[1]::
        clients discover references and packs on it.
 
 gitlink:git-upload-pack[1]::
        clients discover references and packs on it.
 
 gitlink:git-upload-pack[1]::
-       Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
+       Invoked by 'git-fetch-pack' to push
        what are asked for.
 
        what are asked for.
 
+gitlink:git-upload-tar[1]::
+       Invoked by 'git-tar-tree --remote' to return the tar
+       archive the other end asked for.
+
 
 High-level commands (porcelain)
 -------------------------------
 
 High-level commands (porcelain)
 -------------------------------
@@ -265,6 +281,9 @@ gitlink:git-checkout[1]::
 gitlink:git-cherry-pick[1]::
        Cherry-pick the effect of an existing commit.
 
 gitlink:git-cherry-pick[1]::
        Cherry-pick the effect of an existing commit.
 
+gitlink:git-clean[1]::
+       Remove untracked files from the working tree.
+
 gitlink:git-clone[1]::
        Clones a repository into a new directory.
 
 gitlink:git-clone[1]::
        Clones a repository into a new directory.
 
@@ -319,6 +338,9 @@ gitlink:git-resolve[1]::
 gitlink:git-revert[1]::
        Revert an existing commit.
 
 gitlink:git-revert[1]::
        Revert an existing commit.
 
+gitlink:git-rm[1]::
+       Remove files from the working tree and from the index.
+
 gitlink:git-shortlog[1]::
        Summarizes 'git log' output.
 
 gitlink:git-shortlog[1]::
        Summarizes 'git log' output.
 
@@ -357,6 +379,9 @@ gitlink:git-cvsimport[1]::
 gitlink:git-cvsexportcommit[1]::
        Export a single commit to a CVS checkout.
 
 gitlink:git-cvsexportcommit[1]::
        Export a single commit to a CVS checkout.
 
+gitlink:git-cvsserver[1]::
+       A CVS server emulator for git.
+
 gitlink:git-lost-found[1]::
        Recover lost refs that luckily have not yet been pruned.
 
 gitlink:git-lost-found[1]::
        Recover lost refs that luckily have not yet been pruned.
 
@@ -366,9 +391,15 @@ gitlink:git-merge-one-file[1]::
 gitlink:git-prune[1]::
        Prunes all unreachable objects from the object database.
 
 gitlink:git-prune[1]::
        Prunes all unreachable objects from the object database.
 
+gitlink:git-quiltimport[1]::
+       Applies a quilt patchset onto the current branch.
+
 gitlink:git-relink[1]::
        Hardlink common objects in local repositories.
 
 gitlink:git-relink[1]::
        Hardlink common objects in local repositories.
 
+gitlink:git-svn[1]::
+       Bidirectional operation between a single Subversion branch and git.
+
 gitlink:git-svnimport[1]::
        Import a SVN repository into git.
 
 gitlink:git-svnimport[1]::
        Import a SVN repository into git.
 
@@ -387,6 +418,12 @@ gitlink:git-update-ref[1]::
 
 Interrogators:
 
 
 Interrogators:
 
+gitlink:git-annotate[1]::
+       Annotate file lines with commit info.
+
+gitlink:git-blame[1]::
+       Blame file lines on commits.
+
 gitlink:git-check-ref-format[1]::
        Make sure ref name is well formed.
 
 gitlink:git-check-ref-format[1]::
        Make sure ref name is well formed.
 
@@ -399,9 +436,18 @@ gitlink:git-count-objects[1]::
 gitlink:git-daemon[1]::
        A really simple server for git repositories.
 
 gitlink:git-daemon[1]::
        A really simple server for git repositories.
 
+gitlink:git-fmt-merge-msg[1]::
+       Produce a merge commit message.
+
 gitlink:git-get-tar-commit-id[1]::
        Extract commit ID from an archive created using git-tar-tree.
 
 gitlink:git-get-tar-commit-id[1]::
        Extract commit ID from an archive created using git-tar-tree.
 
+gitlink:git-imap-send[1]::
+       Dump a mailbox from stdin into an imap folder.
+
+gitlink:git-instaweb[1]::
+       Instantly browse your working repository in gitweb.
+
 gitlink:git-mailinfo[1]::
        Extracts patch and authorship information from a single
        e-mail message, optionally transliterating the commit
 gitlink:git-mailinfo[1]::
        Extracts patch and authorship information from a single
        e-mail message, optionally transliterating the commit
@@ -411,6 +457,9 @@ gitlink:git-mailsplit[1]::
        A stupid program to split UNIX mbox format mailbox into
        individual pieces of e-mail.
 
        A stupid program to split UNIX mbox format mailbox into
        individual pieces of e-mail.
 
+gitlink:git-merge-tree[1]::
+       Show three-way merge without touching index.
+
 gitlink:git-patch-id[1]::
        Compute unique ID for a patch.
 
 gitlink:git-patch-id[1]::
        Compute unique ID for a patch.
 
@@ -445,7 +494,7 @@ 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
 
 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
+simple text file modeled after `.ini` format familiar to some
 people.  Here is an example:
 
 ------------
 people.  Here is an example:
 
 ------------
@@ -582,6 +631,13 @@ git Diffs
        gitlink:git-diff-files[1];
        gitlink:git-diff-tree[1]
 
        gitlink:git-diff-files[1];
        gitlink:git-diff-tree[1]
 
+other
+~~~~~
+'GIT_TRACE'::
+       If this variable is set git will print `trace:` messages on
+       stderr telling about alias expansion, built-in command
+       execution and external command execution.
+
 Discussion[[Discussion]]
 ------------------------
 include::README[]
 Discussion[[Discussion]]
 ------------------------
 include::README[]