6 git - the stupid content tracker
12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]]
13 [-p|--paginate|--no-pager]
14 [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
15 [--help] COMMAND [ARGS]
19 Git is a fast, scalable, distributed revision control system with an
20 unusually rich command set that provides both high-level operations
21 and full access to internals.
23 See this linkgit:gittutorial[7][tutorial] to get started, then see
24 link:everyday.html[Everyday Git] for a useful minimum set of commands, and
25 "man git-commandname" for documentation of each command. CVS users may
26 also want to read linkgit:gitcvs-migration[7][CVS migration]. See
27 link:user-manual.html[Git User's Manual] for a more in-depth
30 The COMMAND is either a name of a Git command (see below) or an alias
31 as defined in the configuration file (see linkgit:git-config[1]).
33 Formatted and hyperlinked version of the latest git
34 documentation can be viewed at
35 `http://www.kernel.org/pub/software/scm/git/docs/`.
41 You are reading the documentation for the latest (possibly
42 unreleased) version of git, that is available from 'master'
43 branch of the `git.git` repository.
44 Documentation for older releases are available here:
46 * link:v1.5.5/git.html[documentation for release 1.5.5]
49 link:RelNotes-1.5.5.3.txt[1.5.5.3],
50 link:RelNotes-1.5.5.2.txt[1.5.5.2],
51 link:RelNotes-1.5.5.1.txt[1.5.5.1],
52 link:RelNotes-1.5.5.txt[1.5.5].
54 * link:v1.5.5.3/git.html[documentation for release 1.5.5.3]
56 * link:v1.5.4.5/git.html[documentation for release 1.5.4.5]
59 link:RelNotes-1.5.4.5.txt[1.5.4.5],
60 link:RelNotes-1.5.4.4.txt[1.5.4.4],
61 link:RelNotes-1.5.4.3.txt[1.5.4.3],
62 link:RelNotes-1.5.4.2.txt[1.5.4.2],
63 link:RelNotes-1.5.4.1.txt[1.5.4.1],
64 link:RelNotes-1.5.4.txt[1.5.4].
66 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
69 link:RelNotes-1.5.3.8.txt[1.5.3.8],
70 link:RelNotes-1.5.3.7.txt[1.5.3.7],
71 link:RelNotes-1.5.3.6.txt[1.5.3.6],
72 link:RelNotes-1.5.3.5.txt[1.5.3.5],
73 link:RelNotes-1.5.3.4.txt[1.5.3.4],
74 link:RelNotes-1.5.3.3.txt[1.5.3.3],
75 link:RelNotes-1.5.3.2.txt[1.5.3.2],
76 link:RelNotes-1.5.3.1.txt[1.5.3.1],
77 link:RelNotes-1.5.3.txt[1.5.3].
80 link:RelNotes-1.5.2.5.txt[1.5.2.5],
81 link:RelNotes-1.5.2.4.txt[1.5.2.4],
82 link:RelNotes-1.5.2.3.txt[1.5.2.3],
83 link:RelNotes-1.5.2.2.txt[1.5.2.2],
84 link:RelNotes-1.5.2.1.txt[1.5.2.1],
85 link:RelNotes-1.5.2.txt[1.5.2].
87 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
90 link:RelNotes-1.5.1.6.txt[1.5.1.6],
91 link:RelNotes-1.5.1.5.txt[1.5.1.5],
92 link:RelNotes-1.5.1.4.txt[1.5.1.4],
93 link:RelNotes-1.5.1.3.txt[1.5.1.3],
94 link:RelNotes-1.5.1.2.txt[1.5.1.2],
95 link:RelNotes-1.5.1.1.txt[1.5.1.1],
96 link:RelNotes-1.5.1.txt[1.5.1].
98 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
101 link:RelNotes-1.5.0.7.txt[1.5.0.7],
102 link:RelNotes-1.5.0.6.txt[1.5.0.6],
103 link:RelNotes-1.5.0.5.txt[1.5.0.5],
104 link:RelNotes-1.5.0.3.txt[1.5.0.3],
105 link:RelNotes-1.5.0.2.txt[1.5.0.2],
106 link:RelNotes-1.5.0.1.txt[1.5.0.1],
107 link:RelNotes-1.5.0.txt[1.5.0].
109 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
110 link:v1.3.3/git.html[1.3.3],
111 link:v1.2.6/git.html[1.2.6],
112 link:v1.0.13/git.html[1.0.13].
121 Prints the git suite version that the 'git' program came from.
124 Prints the synopsis and a list of the most commonly used
125 commands. If the option '--all' or '-a' is given then all
126 available commands are printed. If a git command is named this
127 option will bring up the manual page for that command.
129 Other options are available to control how the manual page is
130 displayed. See linkgit:git-help[1] for more information,
131 because 'git --help ...' is converted internally into 'git
135 Path to wherever your core git programs are installed.
136 This can also be controlled by setting the GIT_EXEC_PATH
137 environment variable. If no path is given 'git' will print
138 the current setting and then exit.
141 Pipe all output into 'less' (or if set, $PAGER).
144 Do not pipe git output into a pager.
147 Set the path to the repository. This can also be controlled by
148 setting the GIT_DIR environment variable. It can be an absolute
149 path or relative path to current working directory.
152 Set the path to the working tree. The value will not be
153 used in combination with repositories found automatically in
154 a .git directory (i.e. $GIT_DIR is not set).
155 This can also be controlled by setting the GIT_WORK_TREE
156 environment variable and the core.worktree configuration
157 variable. It can be an absolute path or relative path to
158 the directory specified by --git-dir or GIT_DIR.
159 Note: If --git-dir or GIT_DIR are specified but none of
160 --work-tree, GIT_WORK_TREE and core.worktree is specified,
161 the current working directory is regarded as the top directory
162 of your working tree.
165 Treat the repository as a bare repository. If GIT_DIR
166 environment is not set, it is set to the current working
170 FURTHER DOCUMENTATION
171 ---------------------
173 See the references above to get started using git. The following is
174 probably more detail than necessary for a first-time user.
176 The link:user-manual.html#git-concepts[git concepts chapter of the
177 user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial] both provide
178 introductions to the underlying git architecture.
180 See also the link:howto-index.html[howto] documents for some useful
183 The internals are documented link:technical/api-index.html[here].
188 We divide git into high level ("porcelain") commands and low level
189 ("plumbing") commands.
191 High-level commands (porcelain)
192 -------------------------------
194 We separate the porcelain commands into the main commands and some
195 ancillary user utilities.
197 Main porcelain commands
198 ~~~~~~~~~~~~~~~~~~~~~~~
200 include::cmds-mainporcelain.txt[]
206 include::cmds-ancillarymanipulators.txt[]
210 include::cmds-ancillaryinterrogators.txt[]
213 Interacting with Others
214 ~~~~~~~~~~~~~~~~~~~~~~~
216 These commands are to interact with foreign SCM and with other
217 people via patch over e-mail.
219 include::cmds-foreignscminterface.txt[]
222 Low-level commands (plumbing)
223 -----------------------------
225 Although git includes its
226 own porcelain layer, its low-level commands are sufficient to support
227 development of alternative porcelains. Developers of such porcelains
228 might start by reading about linkgit:git-update-index[1] and
229 linkgit:git-read-tree[1].
231 The interface (input, output, set of options and the semantics)
232 to these low-level commands are meant to be a lot more stable
233 than Porcelain level commands, because these commands are
234 primarily for scripted use. The interface to Porcelain commands
235 on the other hand are subject to change in order to improve the
238 The following description divides
239 the low-level commands into commands that manipulate objects (in
240 the repository, index, and working tree), commands that interrogate and
241 compare objects, and commands that move objects and references between
245 Manipulation commands
246 ~~~~~~~~~~~~~~~~~~~~~
248 include::cmds-plumbingmanipulators.txt[]
251 Interrogation commands
252 ~~~~~~~~~~~~~~~~~~~~~~
254 include::cmds-plumbinginterrogators.txt[]
256 In general, the interrogate commands do not touch the files in
260 Synching repositories
261 ~~~~~~~~~~~~~~~~~~~~~
263 include::cmds-synchingrepositories.txt[]
265 The following are helper programs used by the above; end users
266 typically do not use them directly.
268 include::cmds-synchelpers.txt[]
271 Internal helper commands
272 ~~~~~~~~~~~~~~~~~~~~~~~~
274 These are internal helper commands used by other commands; end
275 users typically do not use them directly.
277 include::cmds-purehelpers.txt[]
280 Configuration Mechanism
281 -----------------------
283 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
284 is used to hold per-repository configuration options. It is a
285 simple text file modeled after `.ini` format familiar to some
286 people. Here is an example:
290 # A '#' or ';' character indicates a comment.
295 ; Don't trust file modes
300 name = "Junio C Hamano"
301 email = "junkio@twinsun.com"
305 Various commands read from the configuration file and adjust
306 their operation accordingly.
309 Identifier Terminology
310 ----------------------
312 Indicates the object name for any type of object.
315 Indicates a blob object name.
318 Indicates a tree object name.
321 Indicates a commit object name.
324 Indicates a tree, commit or tag object name. A
325 command that takes a <tree-ish> argument ultimately wants to
326 operate on a <tree> object but automatically dereferences
327 <commit> and <tag> objects that point at a <tree>.
330 Indicates a commit or tag object name. A
331 command that takes a <commit-ish> argument ultimately wants to
332 operate on a <commit> object but automatically dereferences
333 <tag> objects that point at a <commit>.
336 Indicates that an object type is required.
337 Currently one of: `blob`, `tree`, `commit`, or `tag`.
340 Indicates a filename - almost always relative to the
341 root of the tree structure `GIT_INDEX_FILE` describes.
345 Any git command accepting any <object> can also use the following
349 indicates the head of the current branch (i.e. the
350 contents of `$GIT_DIR/HEAD`).
354 (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
358 (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
360 For a more complete list of ways to spell object names, see
361 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
364 File/Directory Structure
365 ------------------------
367 Please see the linkgit:gitrepository-layout[5][repository layout]
370 Read linkgit:githooks[5][hooks] for more details about each hook.
372 Higher level SCMs may provide and manage additional information in the
378 Please see the linkgit:gitglossary[7][glossary] document.
381 Environment Variables
382 ---------------------
383 Various git commands use the following environment variables:
387 These environment variables apply to 'all' core git commands. Nb: it
388 is worth noting that they may be used/overridden by SCMS sitting above
389 git so take care if using Cogito etc.
392 This environment allows the specification of an alternate
393 index file. If not specified, the default of `$GIT_DIR/index`
396 'GIT_OBJECT_DIRECTORY'::
397 If the object storage directory is specified via this
398 environment variable then the sha1 directories are created
399 underneath - otherwise the default `$GIT_DIR/objects`
402 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
403 Due to the immutable nature of git objects, old objects can be
404 archived into shared, read-only directories. This variable
405 specifies a ":" separated list of git object directories which
406 can be used to search for git objects. New objects will not be
407 written to these directories.
410 If the 'GIT_DIR' environment variable is set then it
411 specifies a path to use instead of the default `.git`
412 for the base of the repository.
415 Set the path to the working tree. The value will not be
416 used in combination with repositories found automatically in
417 a .git directory (i.e. $GIT_DIR is not set).
418 This can also be controlled by the '--work-tree' command line
419 option and the core.worktree configuration variable.
426 'GIT_COMMITTER_NAME'::
427 'GIT_COMMITTER_EMAIL'::
428 'GIT_COMMITTER_DATE'::
430 see linkgit:git-commit-tree[1]
435 Only valid setting is "--unified=??" or "-u??" to set the
436 number of context lines shown when a unified diff is created.
437 This takes precedence over any "-U" or "--unified" option
438 value passed on the git diff command line.
440 'GIT_EXTERNAL_DIFF'::
441 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
442 program named by it is called, instead of the diff invocation
443 described above. For a path that is added, removed, or modified,
444 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
446 path old-file old-hex old-mode new-file new-hex new-mode
450 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
451 contents of <old|new>,
452 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
453 <old|new>-mode:: are the octal representation of the file modes.
456 The file parameters can point at the user's working file
457 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
458 when a new file is added), or a temporary file (e.g. `old-file` in the
459 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
460 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
462 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
467 'GIT_MERGE_VERBOSITY'::
468 A number controlling the amount of output shown by
469 the recursive merge strategy. Overrides merge.verbosity.
470 See linkgit:git-merge[1]
473 This environment variable overrides `$PAGER`. If it is set
474 to an empty string or to the value "cat", git will not launch
478 If this environment variable is set then linkgit:git-fetch[1]
479 and linkgit:git-push[1] will use this command instead
480 of `ssh` when they need to connect to a remote system.
481 The 'GIT_SSH' command will be given exactly two arguments:
482 the 'username@host' (or just 'host') from the URL and the
483 shell command to execute on that remote system.
485 To pass options to the program that you want to list in GIT_SSH
486 you will need to wrap the program and options into a shell script,
487 then set GIT_SSH to refer to the shell script.
489 Usually it is easier to configure any desired options through your
490 personal `.ssh/config` file. Please consult your ssh documentation
494 If this environment variable is set to "1", then commands such
495 as git-blame (in incremental mode), git-rev-list, git-log,
496 git-whatchanged, etc., will force a flush of the output stream
497 after each commit-oriented record have been flushed. If this
498 variable is set to "0", the output of these commands will be done
499 using completely buffered I/O. If this environment variable is
500 not set, git will choose buffered or record-oriented flushing
501 based on whether stdout appears to be redirected to a file or not.
504 If this variable is set to "1", "2" or "true" (comparison
505 is case insensitive), git will print `trace:` messages on
506 stderr telling about alias expansion, built-in command
507 execution and external command execution.
508 If this variable is set to an integer value greater than 1
509 and lower than 10 (strictly) then git will interpret this
510 value as an open file descriptor and will try to write the
511 trace messages into this file descriptor.
512 Alternatively, if this variable is set to an absolute path
513 (starting with a '/' character), git will interpret this
514 as a file path and will try to write the trace messages
517 Discussion[[Discussion]]
518 ------------------------
520 More detail on the following is available from the
521 link:user-manual.html#git-concepts[git concepts chapter of the
522 user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial].
524 A git project normally consists of a working directory with a ".git"
525 subdirectory at the top level. The .git directory contains, among other
526 things, a compressed object database representing the complete history
527 of the project, an "index" file which links that history to the current
528 contents of the working tree, and named pointers into that history such
529 as tags and branch heads.
531 The object database contains objects of three main types: blobs, which
532 hold file data; trees, which point to blobs and other trees to build up
533 directory hierarchies; and commits, which each reference a single tree
534 and some number of parent commits.
536 The commit, equivalent to what other systems call a "changeset" or
537 "version", represents a step in the project's history, and each parent
538 represents an immediately preceding step. Commits with more than one
539 parent represent merges of independent lines of development.
541 All objects are named by the SHA1 hash of their contents, normally
542 written as a string of 40 hex digits. Such names are globally unique.
543 The entire history leading up to a commit can be vouched for by signing
544 just that commit. A fourth object type, the tag, is provided for this
547 When first created, objects are stored in individual files, but for
548 efficiency may later be compressed together into "pack files".
550 Named pointers called refs mark interesting points in history. A ref
551 may contain the SHA1 name of an object or the name of another ref. Refs
552 with names beginning `ref/head/` contain the SHA1 name of the most
553 recent commit (or "head") of a branch under development. SHA1 names of
554 tags of interest are stored under `ref/tags/`. A special ref named
555 `HEAD` contains the name of the currently checked-out branch.
557 The index file is initialized with a list of all paths and, for each
558 path, a blob object and a set of attributes. The blob object represents
559 the contents of the file as of the head of the current branch. The
560 attributes (last modified time, size, etc.) are taken from the
561 corresponding file in the working tree. Subsequent changes to the
562 working tree can be found by comparing these attributes. The index may
563 be updated with new content, and new commits may be created from the
564 content stored in the index.
566 The index is also capable of storing multiple entries (called "stages")
567 for a given pathname. These stages are used to hold the various
568 unmerged version of a file when a merge is in progress.
572 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
573 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
574 * The git potty was written by Andreas Ericsson <ae@op5.se>.
575 * General upbringing is handled by the git-list <git@vger.kernel.org>.
579 The documentation for git suite was started by David Greaves
580 <david@dgreaves.com>, and later enhanced greatly by the
581 contributors on the git-list <git@vger.kernel.org>.
585 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
586 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
587 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
588 link:user-manual.html[The Git User's Manual]
592 Part of the linkgit:git[1] suite