Back to main site | Back to man page index

GIT(1)                                                Git Manual                                               GIT(1)



NAME
       git - the stupid content tracker

SYNOPSIS
       git [--version] [--help] [-c <name>=<value>]
           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
           [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
           <command> [<args>]


DESCRIPTION
       Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides
       both high-level operations and full access to internals.

       See gittutorial(7) to get started, then see Everyday Git[1] for a useful minimum set of commands. The Git
       User’s Manual[2] has a more in-depth introduction.

       After you mastered the basic concepts, you can come back to this page to learn what commands Git offers. You
       can learn more about individual Git commands with "git help command". gitcli(7) manual page gives you an
       overview of the command line command syntax.

       Formatted and hyperlinked version of the latest Git documentation can be viewed at
       http://git-htmldocs.googlecode.com/git/git.html.

OPTIONS
       --version
           Prints the Git suite version that the git program came from.

       --help
           Prints the synopsis and a list of the most commonly used commands. If the option --all or -a is given then
           all available commands are printed. If a Git command is named this option will bring up the manual page
           for that command.

           Other options are available to control how the manual page is displayed. See git-help(1) for more
           information, because git --help ...  is converted internally into git help ....

       -c <name>=<value>
           Pass a configuration parameter to the command. The value given will override values from configuration
           files. The <name> is expected in the same format as listed by git config (subkeys separated by dots).

       --exec-path[=<path>]
           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.

       --html-path
           Print the path, without trailing slash, where Git’s HTML documentation is installed and exit.

       --man-path
           Print the manpath (see man(1)) for the man pages for this version of Git and exit.

       --info-path
           Print the path where the Info files documenting this version of Git are installed and exit.

       -p, --paginate
           Pipe all output into less (or if set, $PAGER) if standard output is a terminal. This overrides the
           core.worktree configuration variable (see core.worktree in git-config(1) for a more detailed discussion).

       --namespace=<path>
           Set the Git namespace. See gitnamespaces(7) for more details. Equivalent to setting the GIT_NAMESPACE
           environment variable.

       --bare
           Treat the repository as a bare repository. If GIT_DIR environment is not set, it is set to the current
           working directory.

       --no-replace-objects
           Do not use replacement refs to replace Git objects. See git-replace(1) for more information.

       --literal-pathspecs
           Treat pathspecs literally, rather than as glob patterns. This is equivalent to setting the
           GIT_LITERAL_PATHSPECS environment variable to 1.

GIT COMMANDS
       We divide Git into high level ("porcelain") commands and low level ("plumbing") commands.

HIGH-LEVEL COMMANDS (PORCELAIN)
       We separate the porcelain commands into the main commands and some ancillary user utilities.

   Main porcelain commands
       git-add(1)
           Add file contents to the index.

       git-am(1)
           Apply a series of patches from a mailbox.

       git-archive(1)
           Create an archive of files from a named tree.

       git-bisect(1)
           Find by binary search the change that introduced a bug.

       git-branch(1)
           List, create, or delete branches.

       git-bundle(1)
           Move objects and refs by archive.

       git-checkout(1)
           Checkout a branch or paths to the working tree.

       git-cherry-pick(1)
           Apply the changes introduced by some existing commits.

       git-citool(1)
           Graphical alternative to git-commit.

       git-clean(1)
           Remove untracked files from the working tree.


       git-fetch(1)
           Download objects and refs from another repository.

       git-format-patch(1)
           Prepare patches for e-mail submission.

       git-gc(1)
           Cleanup unnecessary files and optimize the local repository.

       git-grep(1)
           Print lines matching a pattern.

       git-gui(1)
           A portable graphical interface to Git.

       git-init(1)
           Create an empty Git repository or reinitialize an existing one.

       git-log(1)
           Show commit logs.

       git-merge(1)
           Join two or more development histories together.

       git-mv(1)
           Move or rename a file, a directory, or a symlink.

       git-notes(1)
           Add or inspect object notes.

       git-pull(1)
           Fetch from and merge with another repository or a local branch.

       git-push(1)
           Update remote refs along with associated objects.

       git-rebase(1)
           Forward-port local commits to the updated upstream head.

       git-reset(1)
           Reset current HEAD to the specified state.

       git-revert(1)
           Revert some existing commits.

       git-rm(1)
           Remove files from the working tree and from the index.

       git-shortlog(1)
           Summarize git log output.

       git-show(1)
           Show various types of objects.


       gitk(1)
           The Git repository browser.

   Ancillary Commands
       Manipulators:

       git-config(1)
           Get and set repository or global options.

       git-fast-export(1)
           Git data exporter.

       git-fast-import(1)
           Backend for fast Git data importers.

       git-filter-branch(1)
           Rewrite branches.

       git-lost-found(1)
           (deprecated) Recover lost refs that luckily have not yet been pruned.

       git-mergetool(1)
           Run merge conflict resolution tools to resolve merge conflicts.

       git-pack-refs(1)
           Pack heads and tags for efficient repository access.

       git-prune(1)
           Prune all unreachable objects from the object database.

       git-reflog(1)
           Manage reflog information.

       git-relink(1)
           Hardlink common objects in local repositories.

       git-remote(1)
           manage set of tracked repositories.

       git-repack(1)
           Pack unpacked objects in a repository.

       git-replace(1)
           Create, list, delete refs to replace objects.

       git-repo-config(1)
           (deprecated) Get and set repository or global options.

       Interrogators:

       git-annotate(1)
           Annotate file lines with commit information.

       git-blame(1)

           Verifies the connectivity and validity of the objects in the database.

       git-get-tar-commit-id(1)
           Extract commit ID from an archive created using git-archive.

       git-help(1)
           Display help information about Git.

       git-instaweb(1)
           Instantly browse your working repository in gitweb.

       git-merge-tree(1)
           Show three-way merge without touching index.

       git-rerere(1)
           Reuse recorded resolution of conflicted merges.

       git-rev-parse(1)
           Pick out and massage parameters.

       git-show-branch(1)
           Show branches and their commits.

       git-verify-tag(1)
           Check the GPG signature of tags.

       git-whatchanged(1)
           Show logs with difference each commit introduces.

       gitweb(1)
           Git web interface (web frontend to Git repositories).

   Interacting with Others
       These commands are to interact with foreign SCM and with other people via patch over e-mail.

       git-archimport(1)
           Import an Arch repository into Git.

       git-cvsexportcommit(1)
           Export a single commit to a CVS checkout.

       git-cvsimport(1)
           Salvage your data out of another SCM people love to hate.

       git-cvsserver(1)
           A CVS server emulator for Git.

       git-imap-send(1)
           Send a collection of patches from stdin to an IMAP folder.

       git-p4(1)
           Import from and submit to Perforce repositories.

       git-quiltimport(1)
       Although Git includes its own porcelain layer, its low-level commands are sufficient to support development of
       alternative porcelains. Developers of such porcelains might start by reading about git-update-index(1) and
       git-read-tree(1).

       The interface (input, output, set of options and the semantics) to these low-level commands are meant to be a
       lot more stable than Porcelain level commands, because these commands are primarily for scripted use. The
       interface to Porcelain commands on the other hand are subject to change in order to improve the end user
       experience.

       The following description divides the low-level commands into commands that manipulate objects (in the
       repository, index, and working tree), commands that interrogate and compare objects, and commands that move
       objects and references between repositories.

   Manipulation commands
       git-apply(1)
           Apply a patch to files and/or to the index.

       git-checkout-index(1)
           Copy files from the index to the working tree.

       git-commit-tree(1)
           Create a new commit object.

       git-hash-object(1)
           Compute object ID and optionally creates a blob from a file.

       git-index-pack(1)
           Build pack index file for an existing packed archive.

       git-merge-file(1)
           Run a three-way file merge.

       git-merge-index(1)
           Run a merge for files needing merging.

       git-mktag(1)
           Creates a tag object.

       git-mktree(1)
           Build a tree-object from ls-tree formatted text.

       git-pack-objects(1)
           Create a packed archive of objects.

       git-prune-packed(1)
           Remove extra objects that are already in pack files.

       git-read-tree(1)
           Reads tree information into the index.

       git-symbolic-ref(1)
           Read, modify and delete symbolic refs.

       git-unpack-objects(1)
       git-cat-file(1)
           Provide content or type and size information for repository objects.

       git-diff-files(1)
           Compares files in the working tree and the index.

       git-diff-index(1)
           Compares content and mode of blobs between the index and repository.

       git-diff-tree(1)
           Compares the content and mode of blobs found via two tree objects.

       git-for-each-ref(1)
           Output information on each ref.

       git-ls-files(1)
           Show information about files in the index and the working tree.

       git-ls-remote(1)
           List references in a remote repository.

       git-ls-tree(1)
           List the contents of a tree object.

       git-merge-base(1)
           Find as good common ancestors as possible for a merge.

       git-name-rev(1)
           Find symbolic names for given revs.

       git-pack-redundant(1)
           Find redundant pack files.

       git-rev-list(1)
           Lists commit objects in reverse chronological order.

       git-show-index(1)
           Show packed archive index.

       git-show-ref(1)
           List references in a local repository.

       git-tar-tree(1)
           (deprecated) Create a tar archive of the files in the named tree object.

       git-unpack-file(1)
           Creates a temporary file with a blob’s contents.

       git-var(1)
           Show a Git logical variable.

       git-verify-pack(1)
           Validate packed Git archive files.


       git-send-pack(1)
           Push objects over Git protocol to another repository.

       git-update-server-info(1)
           Update auxiliary info file to help dumb servers.

       The following are helper commands used by the above; end users typically do not use them directly.

       git-http-fetch(1)
           Download from a remote Git repository via HTTP.

       git-http-push(1)
           Push objects over HTTP/DAV to another repository.

       git-parse-remote(1)
           Routines to help parsing remote repository access parameters.

       git-receive-pack(1)
           Receive what is pushed into the repository.

       git-shell(1)
           Restricted login shell for Git-only SSH access.

       git-upload-archive(1)
           Send archive back to git-archive.

       git-upload-pack(1)
           Send objects packed back to git-fetch-pack.

   Internal helper commands
       These are internal helper commands used by other commands; end users typically do not use them directly.

       git-check-attr(1)
           Display gitattributes information.

       git-check-ignore(1)
           Debug gitignore / exclude files.

       git-check-ref-format(1)
           Ensures that a reference name is well formed.

       git-column(1)
           Display data in columns.

       git-credential(1)
           Retrieve and store user credentials.

       git-credential-cache(1)
           Helper to temporarily store passwords in memory.

       git-credential-store(1)
           Helper to store credentials on disk.

       git-fmt-merge-msg(1)

           Compute unique ID for a patch.

       git-peek-remote(1)
           (deprecated) List the references in a remote repository.

       git-sh-i18n(1)
           Git’s i18n setup code for shell scripts.

       git-sh-setup(1)
           Common Git shell script setup code.

       git-stripspace(1)
           Remove unnecessary whitespace.

CONFIGURATION MECHANISM
       Git uses a simple text format to store customizations that are per repository and are per user. Such a
       configuration file may look like this:

           #
           # A '#' or ';' character indicates a comment.
           #

           ; core variables
           [core]
                   ; Don't trust file modes
                   filemode = false

           ; user identity
           [user]
                   name = "Junio C Hamano"
                   email = "[email protected]"


       Various commands read from the configuration file and adjust their operation accordingly. See git-config(1)
       for a list and more details about the configuration mechanism.

IDENTIFIER TERMINOLOGY
       <object>
           Indicates the object name for any type of object.

       <blob>
           Indicates a blob object name.

       <tree>
           Indicates a tree object name.

       <commit>
           Indicates a commit object name.

       <tree-ish>
           Indicates a tree, commit or tag object name. A command that takes a <tree-ish> argument ultimately wants
           to operate on a <tree> object but automatically dereferences <commit> and <tag> objects that point at a
           <tree>.


       HEAD
           indicates the head of the current branch.

       <tag>
           a valid tag name (i.e. a refs/tags/<tag> reference).

       <head>
           a valid head name (i.e. a refs/heads/<head> reference).

       For a more complete list of ways to spell object names, see "SPECIFYING REVISIONS" section in gitrevisions(7).

FILE/DIRECTORY STRUCTURE
       Please see the gitrepository-layout(5) document.

       Read githooks(5) for more details about each hook.

       Higher level SCMs may provide and manage additional information in the $GIT_DIR.

TERMINOLOGY
       Please see gitglossary(7).

ENVIRONMENT VARIABLES
       Various Git commands use the following environment variables:

   The Git Repository
       These environment variables apply to all core Git commands. Nb: it is worth noting that they may be
       used/overridden by SCMS sitting above Git so take care if using Cogito etc.

       GIT_INDEX_FILE
           This environment allows the specification of an alternate index file. If not specified, the default of
           $GIT_DIR/index is used.

       GIT_OBJECT_DIRECTORY
           If the object storage directory is specified via this environment variable then the sha1 directories are
           created underneath - otherwise the default $GIT_DIR/objects directory is used.

       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 ":" separated (on Windows ";" separated) list of Git object
           directories which can be used to search for Git objects. New objects will not be written to these
           directories.

       GIT_DIR
           If the GIT_DIR environment variable is set then it specifies a path to use instead of the default .git for
           the base of the repository. The --git-dir command-line option also sets this value.

       GIT_WORK_TREE
           Set the path to the working tree. The value will not be used in combination with repositories found
           automatically in a .git directory (i.e. $GIT_DIR is not set). This can also be controlled by the
           --work-tree command line option and the core.worktree configuration variable.

       GIT_NAMESPACE
           Set the Git namespace; see gitnamespaces(7) for details. The --namespace command-line option also sets
           When run in a directory that does not have ".git" repository directory, Git tries to find such a directory
           in the parent directories to find the top of the working tree, but by default it does not cross filesystem
           boundaries. This environment variable can be set to true to tell Git not to stop at filesystem boundaries.
           Like GIT_CEILING_DIRECTORIES, this will not affect an explicit repository directory set via GIT_DIR or on
           the command line.

   Git Commits
       GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
       GIT_COMMITTER_DATE, EMAIL
           see git-commit-tree(1)

   Git Diffs
       GIT_DIFF_OPTS
           Only valid setting is "--unified=??" or "-u??" to set the number of context lines shown when a unified
           diff is created. This takes precedence over any "-U" or "--unified" option value passed on the Git diff
           command line.

       GIT_EXTERNAL_DIFF
           When the environment variable GIT_EXTERNAL_DIFF is set, the program named by it is called, instead of the
           diff invocation described above. For a path that is added, removed, or modified, GIT_EXTERNAL_DIFF is
           called with 7 parameters:

               path old-file old-hex old-mode new-file new-hex new-mode

           where:

       <old|new>-file
           are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,

       <old|new>-hex
           are the 40-hexdigit SHA-1 hashes,

       <old|new>-mode
           are the octal representation of the file modes.

           The file parameters can point at the user’s working file (e.g.  new-file in "git-diff-files"), /dev/null
           (e.g.  old-file when a new file is added), or a temporary file (e.g.  old-file in the index).
           GIT_EXTERNAL_DIFF should not worry about unlinking the temporary file --- it is removed when
           GIT_EXTERNAL_DIFF exits.

           For a path that is unmerged, GIT_EXTERNAL_DIFF is called with 1 parameter, <path>.

   other
       GIT_MERGE_VERBOSITY
           A number controlling the amount of output shown by the recursive merge strategy. Overrides
           merge.verbosity. See git-merge(1)

       GIT_PAGER
           This environment variable overrides $PAGER. If it is set to an empty string or to the value "cat", Git
           will not launch a pager. See also the core.pager option in git-config(1).

       GIT_EDITOR
           This environment variable overrides $EDITOR and $VISUAL. It is used by several Git commands when, on
           interactive mode, an editor is to be launched. See also git-var(1) and the core.editor option in git-
           Usually it is easier to configure any desired options through your personal .ssh/config file. Please
           consult your ssh documentation for further details.

       GIT_ASKPASS
           If this environment variable is set, then Git commands which need to acquire passwords or passphrases
           (e.g. for HTTP or IMAP authentication) will call this program with a suitable prompt as command line
           argument and read the password from its STDOUT. See also the core.askpass option in git-config(1).

       GIT_CONFIG_NOSYSTEM
           Whether to skip reading settings from the system-wide $(prefix)/etc/gitconfig file. This environment
           variable can be used along with $HOME and $XDG_CONFIG_HOME to create a predictable environment for a picky
           script, or you can set it temporarily to avoid using a buggy /etc/gitconfig file while waiting for someone
           with sufficient permissions to fix it.

       GIT_FLUSH
           If this environment variable is set to "1", then commands such as git blame (in incremental mode), git
           rev-list, git log, and git whatchanged will force a flush of the output stream after each commit-oriented
           record have been flushed. If this variable is set to "0", the output of these commands will be done using
           completely buffered I/O. If this environment variable is not set, Git will choose buffered or
           record-oriented flushing based on whether stdout appears to be redirected to a file or not.

       GIT_TRACE
           If this variable is set to "1", "2" or "true" (comparison is case insensitive), Git will print trace:
           messages on stderr telling about alias expansion, built-in command execution and external command
           execution. If this variable is set to an integer value greater than 1 and lower than 10 (strictly) then
           Git will interpret this value as an open file descriptor and will try to write the trace messages into
           this file descriptor. Alternatively, if this variable is set to an absolute path (starting with a /
           character), Git will interpret this as a file path and will try to write the trace messages into it.

       GIT_LITERAL_PATHSPECS
           Setting this variable to 1 will cause Git to treat all pathspecs literally, rather than as glob patterns.
           For example, running GIT_LITERAL_PATHSPECS=1 git log -- '*.c' will search for commits that touch the path
           *.c, not any paths that the glob *.c matches. You might want this if you are feeding literal paths to Git
           (e.g., paths previously given to you by git ls-tree, --raw diff output, etc).

       GIT_ALLOW_PROTOCOL
           If set, provide a colon-separated list of protocols which are allowed to be used with fetch/push/clone.
           This is useful to restrict recursive submodule initialization from an untrusted repository. Any protocol
           not mentioned will be disallowed (i.e., this is a whitelist, not a blacklist). If the variable is not set
           at all, all protocols are enabled. The protocol names currently used by git are:

           ·   file: any local file-based path (including file:// URLs, or local paths)

           ·   git: the anonymous git protocol over a direct TCP connection (or proxy, if configured)

           ·   ssh: git over ssh (including host:path syntax, git+ssh://, etc).

           ·   rsync: git over rsync

           ·   http: git over http, both "smart http" and "dumb http". Note that this does not include https; if you
               want both, you should specify both as http:https.

           ·   any external helpers are named by their protocol (e.g., use hg to allow the git-remote-hg helper)


       The object database contains objects of three main types: blobs, which hold file data; trees, which point to
       blobs and other trees to build up directory hierarchies; and commits, which each reference a single tree and
       some number of parent commits.

       The commit, equivalent to what other systems call a "changeset" or "version", represents a step in the
       project’s history, and each parent represents an immediately preceding step. Commits with more than one parent
       represent merges of independent lines of development.

       All objects are named by the SHA-1 hash of their contents, normally written as a string of 40 hex digits. Such
       names are globally unique. The entire history leading up to a commit can be vouched for by signing just that
       commit. A fourth object type, the tag, is provided for this purpose.

       When first created, objects are stored in individual files, but for efficiency may later be compressed
       together into "pack files".

       Named pointers called refs mark interesting points in history. A ref may contain the SHA-1 name of an object
       or the name of another ref. Refs with names beginning ref/head/ contain the SHA-1 name of the most recent
       commit (or "head") of a branch under development. SHA-1 names of tags of interest are stored under ref/tags/.
       A special ref named HEAD contains the name of the currently checked-out branch.

       The index file is initialized with a list of all paths and, for each path, a blob object and a set of
       attributes. The blob object represents the contents of the file as of the head of the current branch. The
       attributes (last modified time, size, etc.) are taken from the corresponding file in the working tree.
       Subsequent changes to the working tree can be found by comparing these attributes. The index may be updated
       with new content, and new commits may be created from the content stored in the index.

       The index is also capable of storing multiple entries (called "stages") for a given pathname. These stages are
       used to hold the various unmerged version of a file when a merge is in progress.

FURTHER DOCUMENTATION
       See the references in the "description" section to get started using Git. The following is probably more
       detail than necessary for a first-time user.

       The Git concepts chapter of the user-manual[3] and gitcore-tutorial(7) both provide introductions to the
       underlying Git architecture.

       See gitworkflows(7) for an overview of recommended workflows.

       See also the howto[4] documents for some useful examples.

       The internals are documented in the Git API documentation[5].

       Users migrating from CVS may also want to read gitcvs-migration(7).

AUTHORS
       Git was started by Linus Torvalds, and is currently maintained by Junio C Hamano. Numerous contributions have
       come from the Git mailing list <[email protected][6]>. http://www.ohloh.net/p/git/contributors/summary gives
       you a more complete list of contributors.

       If you have a clone of git.git itself, the output of git-shortlog(1) and git-blame(1) can show you the authors
       for specific parts of the project.

REPORTING BUGS
       Report bugs to the Git mailing list <[email protected][6]> where the development and maintenance is

        2. Git User’s Manual
           file:///usr/share/doc/git-1.8.3.1/user-manual.html

        3. Git concepts chapter of the user-manual
           file:///usr/share/doc/git-1.8.3.1/user-manual.html#git-concepts

        4. howto
           file:///usr/share/doc/git-1.8.3.1/howto-index.html

        5. Git API documentation
           file:///usr/share/doc/git-1.8.3.1/technical/api-index.html

        6. [email protected]
           mailto:[email protected]



Git 1.8.3.1                                           03/23/2016                                               GIT(1)