6 git - the stupid content tracker
12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
13 [-p|--paginate|--no-pager] [--no-replace-objects]
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 linkgit:gittutorial[7] 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]. See
27 the 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.6.5.5/git.html[documentation for release 1.6.5.5]
49 link:RelNotes-1.6.5.5.txt[1.6.5.5],
50 link:RelNotes-1.6.5.4.txt[1.6.5.4],
51 link:RelNotes-1.6.5.3.txt[1.6.5.3],
52 link:RelNotes-1.6.5.2.txt[1.6.5.2],
53 link:RelNotes-1.6.5.1.txt[1.6.5.1],
54 link:RelNotes-1.6.5.txt[1.6.5].
56 * link:v1.6.4.4/git.html[documentation for release 1.6.4.4]
59 link:RelNotes-1.6.4.4.txt[1.6.4.4],
60 link:RelNotes-1.6.4.3.txt[1.6.4.3],
61 link:RelNotes-1.6.4.2.txt[1.6.4.2],
62 link:RelNotes-1.6.4.1.txt[1.6.4.1],
63 link:RelNotes-1.6.4.txt[1.6.4].
65 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
68 link:RelNotes-1.6.3.4.txt[1.6.3.4],
69 link:RelNotes-1.6.3.3.txt[1.6.3.3],
70 link:RelNotes-1.6.3.2.txt[1.6.3.2],
71 link:RelNotes-1.6.3.1.txt[1.6.3.1],
72 link:RelNotes-1.6.3.txt[1.6.3].
75 link:RelNotes-1.6.2.5.txt[1.6.2.5],
76 link:RelNotes-1.6.2.4.txt[1.6.2.4],
77 link:RelNotes-1.6.2.3.txt[1.6.2.3],
78 link:RelNotes-1.6.2.2.txt[1.6.2.2],
79 link:RelNotes-1.6.2.1.txt[1.6.2.1],
80 link:RelNotes-1.6.2.txt[1.6.2].
82 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
85 link:RelNotes-1.6.1.3.txt[1.6.1.3],
86 link:RelNotes-1.6.1.2.txt[1.6.1.2],
87 link:RelNotes-1.6.1.1.txt[1.6.1.1],
88 link:RelNotes-1.6.1.txt[1.6.1].
90 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
93 link:RelNotes-1.6.0.6.txt[1.6.0.6],
94 link:RelNotes-1.6.0.5.txt[1.6.0.5],
95 link:RelNotes-1.6.0.4.txt[1.6.0.4],
96 link:RelNotes-1.6.0.3.txt[1.6.0.3],
97 link:RelNotes-1.6.0.2.txt[1.6.0.2],
98 link:RelNotes-1.6.0.1.txt[1.6.0.1],
99 link:RelNotes-1.6.0.txt[1.6.0].
101 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
104 link:RelNotes-1.5.6.6.txt[1.5.6.6],
105 link:RelNotes-1.5.6.5.txt[1.5.6.5],
106 link:RelNotes-1.5.6.4.txt[1.5.6.4],
107 link:RelNotes-1.5.6.3.txt[1.5.6.3],
108 link:RelNotes-1.5.6.2.txt[1.5.6.2],
109 link:RelNotes-1.5.6.1.txt[1.5.6.1],
110 link:RelNotes-1.5.6.txt[1.5.6].
112 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
115 link:RelNotes-1.5.5.6.txt[1.5.5.6],
116 link:RelNotes-1.5.5.5.txt[1.5.5.5],
117 link:RelNotes-1.5.5.4.txt[1.5.5.4],
118 link:RelNotes-1.5.5.3.txt[1.5.5.3],
119 link:RelNotes-1.5.5.2.txt[1.5.5.2],
120 link:RelNotes-1.5.5.1.txt[1.5.5.1],
121 link:RelNotes-1.5.5.txt[1.5.5].
123 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
126 link:RelNotes-1.5.4.7.txt[1.5.4.7],
127 link:RelNotes-1.5.4.6.txt[1.5.4.6],
128 link:RelNotes-1.5.4.5.txt[1.5.4.5],
129 link:RelNotes-1.5.4.4.txt[1.5.4.4],
130 link:RelNotes-1.5.4.3.txt[1.5.4.3],
131 link:RelNotes-1.5.4.2.txt[1.5.4.2],
132 link:RelNotes-1.5.4.1.txt[1.5.4.1],
133 link:RelNotes-1.5.4.txt[1.5.4].
135 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
138 link:RelNotes-1.5.3.8.txt[1.5.3.8],
139 link:RelNotes-1.5.3.7.txt[1.5.3.7],
140 link:RelNotes-1.5.3.6.txt[1.5.3.6],
141 link:RelNotes-1.5.3.5.txt[1.5.3.5],
142 link:RelNotes-1.5.3.4.txt[1.5.3.4],
143 link:RelNotes-1.5.3.3.txt[1.5.3.3],
144 link:RelNotes-1.5.3.2.txt[1.5.3.2],
145 link:RelNotes-1.5.3.1.txt[1.5.3.1],
146 link:RelNotes-1.5.3.txt[1.5.3].
148 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
151 link:RelNotes-1.5.2.5.txt[1.5.2.5],
152 link:RelNotes-1.5.2.4.txt[1.5.2.4],
153 link:RelNotes-1.5.2.3.txt[1.5.2.3],
154 link:RelNotes-1.5.2.2.txt[1.5.2.2],
155 link:RelNotes-1.5.2.1.txt[1.5.2.1],
156 link:RelNotes-1.5.2.txt[1.5.2].
158 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
161 link:RelNotes-1.5.1.6.txt[1.5.1.6],
162 link:RelNotes-1.5.1.5.txt[1.5.1.5],
163 link:RelNotes-1.5.1.4.txt[1.5.1.4],
164 link:RelNotes-1.5.1.3.txt[1.5.1.3],
165 link:RelNotes-1.5.1.2.txt[1.5.1.2],
166 link:RelNotes-1.5.1.1.txt[1.5.1.1],
167 link:RelNotes-1.5.1.txt[1.5.1].
169 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
172 link:RelNotes-1.5.0.7.txt[1.5.0.7],
173 link:RelNotes-1.5.0.6.txt[1.5.0.6],
174 link:RelNotes-1.5.0.5.txt[1.5.0.5],
175 link:RelNotes-1.5.0.3.txt[1.5.0.3],
176 link:RelNotes-1.5.0.2.txt[1.5.0.2],
177 link:RelNotes-1.5.0.1.txt[1.5.0.1],
178 link:RelNotes-1.5.0.txt[1.5.0].
180 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
181 link:v1.3.3/git.html[1.3.3],
182 link:v1.2.6/git.html[1.2.6],
183 link:v1.0.13/git.html[1.0.13].
192 Prints the git suite version that the 'git' program came from.
195 Prints the synopsis and a list of the most commonly used
196 commands. If the option '--all' or '-a' is given then all
197 available commands are printed. If a git command is named this
198 option will bring up the manual page for that command.
200 Other options are available to control how the manual page is
201 displayed. See linkgit:git-help[1] for more information,
202 because `git --help ...` is converted internally into `git
206 Path to wherever your core git programs are installed.
207 This can also be controlled by setting the GIT_EXEC_PATH
208 environment variable. If no path is given, 'git' will print
209 the current setting and then exit.
212 Print the path to wherever your git HTML documentation is installed
217 Pipe all output into 'less' (or if set, $PAGER).
220 Do not pipe git output into a pager.
223 Set the path to the repository. This can also be controlled by
224 setting the GIT_DIR environment variable. It can be an absolute
225 path or relative path to current working directory.
228 Set the path to the working tree. The value will not be
229 used in combination with repositories found automatically in
230 a .git directory (i.e. $GIT_DIR is not set).
231 This can also be controlled by setting the GIT_WORK_TREE
232 environment variable and the core.worktree configuration
233 variable. It can be an absolute path or relative path to
234 the directory specified by --git-dir or GIT_DIR.
235 Note: If --git-dir or GIT_DIR are specified but none of
236 --work-tree, GIT_WORK_TREE and core.worktree is specified,
237 the current working directory is regarded as the top directory
238 of your working tree.
241 Treat the repository as a bare repository. If GIT_DIR
242 environment is not set, it is set to the current working
245 --no-replace-objects::
246 Do not use replacement refs to replace git objects. See
247 linkgit:git-replace[1] for more information.
250 FURTHER DOCUMENTATION
251 ---------------------
253 See the references above to get started using git. The following is
254 probably more detail than necessary for a first-time user.
256 The link:user-manual.html#git-concepts[git concepts chapter of the
257 user-manual] and linkgit:gitcore-tutorial[7] both provide
258 introductions to the underlying git architecture.
260 See linkgit:gitworkflows[7] for an overview of recommended workflows.
262 See also the link:howto-index.html[howto] documents for some useful
265 The internals are documented in the
266 link:technical/api-index.html[GIT API documentation].
271 We divide git into high level ("porcelain") commands and low level
272 ("plumbing") commands.
274 High-level commands (porcelain)
275 -------------------------------
277 We separate the porcelain commands into the main commands and some
278 ancillary user utilities.
280 Main porcelain commands
281 ~~~~~~~~~~~~~~~~~~~~~~~
283 include::cmds-mainporcelain.txt[]
289 include::cmds-ancillarymanipulators.txt[]
293 include::cmds-ancillaryinterrogators.txt[]
296 Interacting with Others
297 ~~~~~~~~~~~~~~~~~~~~~~~
299 These commands are to interact with foreign SCM and with other
300 people via patch over e-mail.
302 include::cmds-foreignscminterface.txt[]
305 Low-level commands (plumbing)
306 -----------------------------
308 Although git includes its
309 own porcelain layer, its low-level commands are sufficient to support
310 development of alternative porcelains. Developers of such porcelains
311 might start by reading about linkgit:git-update-index[1] and
312 linkgit:git-read-tree[1].
314 The interface (input, output, set of options and the semantics)
315 to these low-level commands are meant to be a lot more stable
316 than Porcelain level commands, because these commands are
317 primarily for scripted use. The interface to Porcelain commands
318 on the other hand are subject to change in order to improve the
321 The following description divides
322 the low-level commands into commands that manipulate objects (in
323 the repository, index, and working tree), commands that interrogate and
324 compare objects, and commands that move objects and references between
328 Manipulation commands
329 ~~~~~~~~~~~~~~~~~~~~~
331 include::cmds-plumbingmanipulators.txt[]
334 Interrogation commands
335 ~~~~~~~~~~~~~~~~~~~~~~
337 include::cmds-plumbinginterrogators.txt[]
339 In general, the interrogate commands do not touch the files in
343 Synching repositories
344 ~~~~~~~~~~~~~~~~~~~~~
346 include::cmds-synchingrepositories.txt[]
348 The following are helper commands used by the above; end users
349 typically do not use them directly.
351 include::cmds-synchelpers.txt[]
354 Internal helper commands
355 ~~~~~~~~~~~~~~~~~~~~~~~~
357 These are internal helper commands used by other commands; end
358 users typically do not use them directly.
360 include::cmds-purehelpers.txt[]
363 Configuration Mechanism
364 -----------------------
366 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
367 is used to hold per-repository configuration options. It is a
368 simple text file modeled after `.ini` format familiar to some
369 people. Here is an example:
373 # A '#' or ';' character indicates a comment.
378 ; Don't trust file modes
383 name = "Junio C Hamano"
384 email = "junkio@twinsun.com"
388 Various commands read from the configuration file and adjust
389 their operation accordingly.
392 Identifier Terminology
393 ----------------------
395 Indicates the object name for any type of object.
398 Indicates a blob object name.
401 Indicates a tree object name.
404 Indicates a commit object name.
407 Indicates a tree, commit or tag object name. A
408 command that takes a <tree-ish> argument ultimately wants to
409 operate on a <tree> object but automatically dereferences
410 <commit> and <tag> objects that point at a <tree>.
413 Indicates a commit or tag object name. A
414 command that takes a <commit-ish> argument ultimately wants to
415 operate on a <commit> object but automatically dereferences
416 <tag> objects that point at a <commit>.
419 Indicates that an object type is required.
420 Currently one of: `blob`, `tree`, `commit`, or `tag`.
423 Indicates a filename - almost always relative to the
424 root of the tree structure `GIT_INDEX_FILE` describes.
428 Any git command accepting any <object> can also use the following
432 indicates the head of the current branch (i.e. the
433 contents of `$GIT_DIR/HEAD`).
437 (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
441 (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
443 For a more complete list of ways to spell object names, see
444 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
447 File/Directory Structure
448 ------------------------
450 Please see the linkgit:gitrepository-layout[5] document.
452 Read linkgit:githooks[5] for more details about each hook.
454 Higher level SCMs may provide and manage additional information in the
460 Please see linkgit:gitglossary[7].
463 Environment Variables
464 ---------------------
465 Various git commands use the following environment variables:
469 These environment variables apply to 'all' core git commands. Nb: it
470 is worth noting that they may be used/overridden by SCMS sitting above
471 git so take care if using Cogito etc.
474 This environment allows the specification of an alternate
475 index file. If not specified, the default of `$GIT_DIR/index`
478 'GIT_OBJECT_DIRECTORY'::
479 If the object storage directory is specified via this
480 environment variable then the sha1 directories are created
481 underneath - otherwise the default `$GIT_DIR/objects`
484 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
485 Due to the immutable nature of git objects, old objects can be
486 archived into shared, read-only directories. This variable
487 specifies a ":" separated (on Windows ";" separated) list
488 of git object directories which can be used to search for git
489 objects. New objects will not be written to these directories.
492 If the 'GIT_DIR' environment variable is set then it
493 specifies a path to use instead of the default `.git`
494 for the base of the repository.
497 Set the path to the working tree. The value will not be
498 used in combination with repositories found automatically in
499 a .git directory (i.e. $GIT_DIR is not set).
500 This can also be controlled by the '--work-tree' command line
501 option and the core.worktree configuration variable.
503 'GIT_CEILING_DIRECTORIES'::
504 This should be a colon-separated list of absolute paths.
505 If set, it is a list of directories that git should not chdir
506 up into while looking for a repository directory.
507 It will not exclude the current working directory or
508 a GIT_DIR set on the command line or in the environment.
509 (Useful for excluding slow-loading network directories.)
516 'GIT_COMMITTER_NAME'::
517 'GIT_COMMITTER_EMAIL'::
518 'GIT_COMMITTER_DATE'::
520 see linkgit:git-commit-tree[1]
525 Only valid setting is "--unified=??" or "-u??" to set the
526 number of context lines shown when a unified diff is created.
527 This takes precedence over any "-U" or "--unified" option
528 value passed on the git diff command line.
530 'GIT_EXTERNAL_DIFF'::
531 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
532 program named by it is called, instead of the diff invocation
533 described above. For a path that is added, removed, or modified,
534 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
536 path old-file old-hex old-mode new-file new-hex new-mode
540 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
541 contents of <old|new>,
542 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
543 <old|new>-mode:: are the octal representation of the file modes.
546 The file parameters can point at the user's working file
547 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
548 when a new file is added), or a temporary file (e.g. `old-file` in the
549 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
550 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
552 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
557 'GIT_MERGE_VERBOSITY'::
558 A number controlling the amount of output shown by
559 the recursive merge strategy. Overrides merge.verbosity.
560 See linkgit:git-merge[1]
563 This environment variable overrides `$PAGER`. If it is set
564 to an empty string or to the value "cat", git will not launch
565 a pager. See also the `core.pager` option in
566 linkgit:git-config[1].
569 If this environment variable is set then 'git-fetch'
570 and 'git-push' will use this command instead
571 of 'ssh' when they need to connect to a remote system.
572 The '$GIT_SSH' command will be given exactly two arguments:
573 the 'username@host' (or just 'host') from the URL and the
574 shell command to execute on that remote system.
576 To pass options to the program that you want to list in GIT_SSH
577 you will need to wrap the program and options into a shell script,
578 then set GIT_SSH to refer to the shell script.
580 Usually it is easier to configure any desired options through your
581 personal `.ssh/config` file. Please consult your ssh documentation
585 If this environment variable is set to "1", then commands such
586 as 'git-blame' (in incremental mode), 'git-rev-list', 'git-log',
587 and 'git-whatchanged' will force a flush of the output stream
588 after each commit-oriented record have been flushed. If this
589 variable is set to "0", the output of these commands will be done
590 using completely buffered I/O. If this environment variable is
591 not set, git will choose buffered or record-oriented flushing
592 based on whether stdout appears to be redirected to a file or not.
595 If this variable is set to "1", "2" or "true" (comparison
596 is case insensitive), git will print `trace:` messages on
597 stderr telling about alias expansion, built-in command
598 execution and external command execution.
599 If this variable is set to an integer value greater than 1
600 and lower than 10 (strictly) then git will interpret this
601 value as an open file descriptor and will try to write the
602 trace messages into this file descriptor.
603 Alternatively, if this variable is set to an absolute path
604 (starting with a '/' character), git will interpret this
605 as a file path and will try to write the trace messages
608 Discussion[[Discussion]]
609 ------------------------
611 More detail on the following is available from the
612 link:user-manual.html#git-concepts[git concepts chapter of the
613 user-manual] and linkgit:gitcore-tutorial[7].
615 A git project normally consists of a working directory with a ".git"
616 subdirectory at the top level. The .git directory contains, among other
617 things, a compressed object database representing the complete history
618 of the project, an "index" file which links that history to the current
619 contents of the working tree, and named pointers into that history such
620 as tags and branch heads.
622 The object database contains objects of three main types: blobs, which
623 hold file data; trees, which point to blobs and other trees to build up
624 directory hierarchies; and commits, which each reference a single tree
625 and some number of parent commits.
627 The commit, equivalent to what other systems call a "changeset" or
628 "version", represents a step in the project's history, and each parent
629 represents an immediately preceding step. Commits with more than one
630 parent represent merges of independent lines of development.
632 All objects are named by the SHA1 hash of their contents, normally
633 written as a string of 40 hex digits. Such names are globally unique.
634 The entire history leading up to a commit can be vouched for by signing
635 just that commit. A fourth object type, the tag, is provided for this
638 When first created, objects are stored in individual files, but for
639 efficiency may later be compressed together into "pack files".
641 Named pointers called refs mark interesting points in history. A ref
642 may contain the SHA1 name of an object or the name of another ref. Refs
643 with names beginning `ref/head/` contain the SHA1 name of the most
644 recent commit (or "head") of a branch under development. SHA1 names of
645 tags of interest are stored under `ref/tags/`. A special ref named
646 `HEAD` contains the name of the currently checked-out branch.
648 The index file is initialized with a list of all paths and, for each
649 path, a blob object and a set of attributes. The blob object represents
650 the contents of the file as of the head of the current branch. The
651 attributes (last modified time, size, etc.) are taken from the
652 corresponding file in the working tree. Subsequent changes to the
653 working tree can be found by comparing these attributes. The index may
654 be updated with new content, and new commits may be created from the
655 content stored in the index.
657 The index is also capable of storing multiple entries (called "stages")
658 for a given pathname. These stages are used to hold the various
659 unmerged version of a file when a merge is in progress.
663 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
664 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
665 * The git potty was written by Andreas Ericsson <ae@op5.se>.
666 * General upbringing is handled by the git-list <git@vger.kernel.org>.
670 The documentation for git suite was started by David Greaves
671 <david@dgreaves.com>, and later enhanced greatly by the
672 contributors on the git-list <git@vger.kernel.org>.
676 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
677 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
678 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
679 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
680 linkgit:gitworkflows[7]
684 Part of the linkgit:git[1] suite