зеркало из https://github.com/microsoft/git.git
394 строки
11 KiB
Plaintext
394 строки
11 KiB
Plaintext
git(7)
|
|
======
|
|
|
|
NAME
|
|
----
|
|
git - the stupid content tracker
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate]
|
|
[--bare] [--git-dir=GIT_DIR] [--help] 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 this link:tutorial.html[tutorial] to get started, then see
|
|
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].
|
|
link:user-manual.html[Git User's Manual] is still work in
|
|
progress, but when finished hopefully it will guide a new user
|
|
in a coherent way to git enlightenment ;-).
|
|
|
|
The COMMAND is either a name of a Git command (see below) or an alias
|
|
as defined in the configuration file (see gitlink:git-config[1]).
|
|
|
|
ifdef::stalenotes[]
|
|
[NOTE]
|
|
============
|
|
You are reading the documentation for the latest version of git.
|
|
Documentation for older releases are available here:
|
|
|
|
* link:v1.4.4.4/git.html[documentation for release 1.4.4.4]
|
|
|
|
* link:v1.3.3/git.html[documentation for release 1.3.3]
|
|
|
|
* link:v1.2.6/git.html[documentation for release 1.2.6]
|
|
|
|
* link:v1.0.13/git.html[documentation for release 1.0.13]
|
|
|
|
============
|
|
|
|
endif::stalenotes[]
|
|
|
|
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 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.
|
|
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.
|
|
|
|
-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
|
|
---------------------
|
|
|
|
See the references above to get started using git. The following is
|
|
probably more detail than necessary for a first-time user.
|
|
|
|
The <<Discussion,Discussion>> section below and the
|
|
link:core-tutorial.html[Core tutorial] both provide introductions to the
|
|
underlying git architecture.
|
|
|
|
See also the link:howto-index.html[howto] documents for some useful
|
|
examples.
|
|
|
|
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
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
include::cmds-mainporcelain.txt[]
|
|
|
|
Ancillary Commands
|
|
~~~~~~~~~~~~~~~~~~
|
|
Manipulators:
|
|
|
|
include::cmds-ancillarymanipulators.txt[]
|
|
|
|
Interrogators:
|
|
|
|
include::cmds-ancillaryinterrogators.txt[]
|
|
|
|
|
|
Interacting with Others
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
These commands are to interact with foreign SCM and with other
|
|
people via patch over e-mail.
|
|
|
|
include::cmds-foreignscminterface.txt[]
|
|
|
|
|
|
Low-level commands (plumbing)
|
|
-----------------------------
|
|
|
|
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 gitlink:git-update-index[1] and
|
|
gitlink: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
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
include::cmds-plumbingmanipulators.txt[]
|
|
|
|
|
|
Interrogation commands
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
include::cmds-plumbinginterrogators.txt[]
|
|
|
|
In general, the interrogate commands do not touch the files in
|
|
the working tree.
|
|
|
|
|
|
Synching repositories
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
include::cmds-synchingrepositories.txt[]
|
|
|
|
The following are helper programs used by the above; end users
|
|
typically do not use them directly.
|
|
|
|
include::cmds-synchelpers.txt[]
|
|
|
|
|
|
Internal helper commands
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
These are internal helper commands used by other commands; end
|
|
users typically do not use them directly.
|
|
|
|
include::cmds-purehelpers.txt[]
|
|
|
|
|
|
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 modeled after `.ini` format familiar to some
|
|
people. Here is an example:
|
|
|
|
------------
|
|
#
|
|
# 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>::
|
|
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>.
|
|
|
|
<type>::
|
|
Indicates that an object type is required.
|
|
Currently one of: `blob`, `tree`, `commit`, or `tag`.
|
|
|
|
<file>::
|
|
Indicates a filename - almost always relative to the
|
|
root of the tree structure `GIT_INDEX_FILE` describes.
|
|
|
|
Symbolic Identifiers
|
|
--------------------
|
|
Any git command accepting any <object> can also use the following
|
|
symbolic notation:
|
|
|
|
HEAD::
|
|
indicates the head of the current branch (i.e. the
|
|
contents of `$GIT_DIR/HEAD`).
|
|
|
|
<tag>::
|
|
a valid tag 'name'
|
|
(i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
|
|
|
|
<head>::
|
|
a valid head 'name'
|
|
(i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
|
|
|
|
For a more complete list of ways to spell object names, see
|
|
"SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
|
|
|
|
|
|
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`.
|
|
|
|
|
|
Terminology
|
|
-----------
|
|
Please see link:glossary.html[glossary] document.
|
|
|
|
|
|
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 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.
|
|
|
|
git Commits
|
|
~~~~~~~~~~~
|
|
'GIT_AUTHOR_NAME'::
|
|
'GIT_AUTHOR_EMAIL'::
|
|
'GIT_AUTHOR_DATE'::
|
|
'GIT_COMMITTER_NAME'::
|
|
'GIT_COMMITTER_EMAIL'::
|
|
see gitlink: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 SHA1 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_PAGER'::
|
|
This environment variable overrides `$PAGER`.
|
|
|
|
'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.
|
|
|
|
Discussion[[Discussion]]
|
|
------------------------
|
|
include::core-intro.txt[]
|
|
|
|
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>.
|
|
|
|
Documentation
|
|
--------------
|
|
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
|
|
---
|
|
Part of the gitlink:git[7] suite
|
|
|