6 git - the stupid content tracker
12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-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 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.4/git.html[documentation for release 1.6.4]
49 link:RelNotes-1.6.4.txt[1.6.4].
51 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
54 link:RelNotes-1.6.3.4.txt[1.6.3.4],
55 link:RelNotes-1.6.3.3.txt[1.6.3.3],
56 link:RelNotes-1.6.3.2.txt[1.6.3.2],
57 link:RelNotes-1.6.3.1.txt[1.6.3.1],
58 link:RelNotes-1.6.3.txt[1.6.3].
61 link:RelNotes-1.6.2.5.txt[1.6.2.5],
62 link:RelNotes-1.6.2.4.txt[1.6.2.4],
63 link:RelNotes-1.6.2.3.txt[1.6.2.3],
64 link:RelNotes-1.6.2.2.txt[1.6.2.2],
65 link:RelNotes-1.6.2.1.txt[1.6.2.1],
66 link:RelNotes-1.6.2.txt[1.6.2].
68 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
71 link:RelNotes-1.6.1.3.txt[1.6.1.3],
72 link:RelNotes-1.6.1.2.txt[1.6.1.2],
73 link:RelNotes-1.6.1.1.txt[1.6.1.1],
74 link:RelNotes-1.6.1.txt[1.6.1].
76 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
79 link:RelNotes-1.6.0.6.txt[1.6.0.6],
80 link:RelNotes-1.6.0.5.txt[1.6.0.5],
81 link:RelNotes-1.6.0.4.txt[1.6.0.4],
82 link:RelNotes-1.6.0.3.txt[1.6.0.3],
83 link:RelNotes-1.6.0.2.txt[1.6.0.2],
84 link:RelNotes-1.6.0.1.txt[1.6.0.1],
85 link:RelNotes-1.6.0.txt[1.6.0].
87 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
90 link:RelNotes-1.5.6.6.txt[1.5.6.6],
91 link:RelNotes-1.5.6.5.txt[1.5.6.5],
92 link:RelNotes-1.5.6.4.txt[1.5.6.4],
93 link:RelNotes-1.5.6.3.txt[1.5.6.3],
94 link:RelNotes-1.5.6.2.txt[1.5.6.2],
95 link:RelNotes-1.5.6.1.txt[1.5.6.1],
96 link:RelNotes-1.5.6.txt[1.5.6].
98 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
101 link:RelNotes-1.5.5.6.txt[1.5.5.6],
102 link:RelNotes-1.5.5.5.txt[1.5.5.5],
103 link:RelNotes-1.5.5.4.txt[1.5.5.4],
104 link:RelNotes-1.5.5.3.txt[1.5.5.3],
105 link:RelNotes-1.5.5.2.txt[1.5.5.2],
106 link:RelNotes-1.5.5.1.txt[1.5.5.1],
107 link:RelNotes-1.5.5.txt[1.5.5].
109 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
112 link:RelNotes-1.5.4.7.txt[1.5.4.7],
113 link:RelNotes-1.5.4.6.txt[1.5.4.6],
114 link:RelNotes-1.5.4.5.txt[1.5.4.5],
115 link:RelNotes-1.5.4.4.txt[1.5.4.4],
116 link:RelNotes-1.5.4.3.txt[1.5.4.3],
117 link:RelNotes-1.5.4.2.txt[1.5.4.2],
118 link:RelNotes-1.5.4.1.txt[1.5.4.1],
119 link:RelNotes-1.5.4.txt[1.5.4].
121 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
124 link:RelNotes-1.5.3.8.txt[1.5.3.8],
125 link:RelNotes-1.5.3.7.txt[1.5.3.7],
126 link:RelNotes-1.5.3.6.txt[1.5.3.6],
127 link:RelNotes-1.5.3.5.txt[1.5.3.5],
128 link:RelNotes-1.5.3.4.txt[1.5.3.4],
129 link:RelNotes-1.5.3.3.txt[1.5.3.3],
130 link:RelNotes-1.5.3.2.txt[1.5.3.2],
131 link:RelNotes-1.5.3.1.txt[1.5.3.1],
132 link:RelNotes-1.5.3.txt[1.5.3].
134 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
137 link:RelNotes-1.5.2.5.txt[1.5.2.5],
138 link:RelNotes-1.5.2.4.txt[1.5.2.4],
139 link:RelNotes-1.5.2.3.txt[1.5.2.3],
140 link:RelNotes-1.5.2.2.txt[1.5.2.2],
141 link:RelNotes-1.5.2.1.txt[1.5.2.1],
142 link:RelNotes-1.5.2.txt[1.5.2].
144 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
147 link:RelNotes-1.5.1.6.txt[1.5.1.6],
148 link:RelNotes-1.5.1.5.txt[1.5.1.5],
149 link:RelNotes-1.5.1.4.txt[1.5.1.4],
150 link:RelNotes-1.5.1.3.txt[1.5.1.3],
151 link:RelNotes-1.5.1.2.txt[1.5.1.2],
152 link:RelNotes-1.5.1.1.txt[1.5.1.1],
153 link:RelNotes-1.5.1.txt[1.5.1].
155 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
158 link:RelNotes-1.5.0.7.txt[1.5.0.7],
159 link:RelNotes-1.5.0.6.txt[1.5.0.6],
160 link:RelNotes-1.5.0.5.txt[1.5.0.5],
161 link:RelNotes-1.5.0.3.txt[1.5.0.3],
162 link:RelNotes-1.5.0.2.txt[1.5.0.2],
163 link:RelNotes-1.5.0.1.txt[1.5.0.1],
164 link:RelNotes-1.5.0.txt[1.5.0].
166 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
167 link:v1.3.3/git.html[1.3.3],
168 link:v1.2.6/git.html[1.2.6],
169 link:v1.0.13/git.html[1.0.13].
178 Prints the git suite version that the 'git' program came from.
181 Prints the synopsis and a list of the most commonly used
182 commands. If the option '--all' or '-a' is given then all
183 available commands are printed. If a git command is named this
184 option will bring up the manual page for that command.
186 Other options are available to control how the manual page is
187 displayed. See linkgit:git-help[1] for more information,
188 because `git --help ...` is converted internally into `git
192 Path to wherever your core git programs are installed.
193 This can also be controlled by setting the GIT_EXEC_PATH
194 environment variable. If no path is given, 'git' will print
195 the current setting and then exit.
198 Print the path to wherever your git HTML documentation is installed
203 Pipe all output into 'less' (or if set, $PAGER).
206 Do not pipe git output into a pager.
209 Set the path to the repository. This can also be controlled by
210 setting the GIT_DIR environment variable. It can be an absolute
211 path or relative path to current working directory.
214 Set the path to the working tree. The value will not be
215 used in combination with repositories found automatically in
216 a .git directory (i.e. $GIT_DIR is not set).
217 This can also be controlled by setting the GIT_WORK_TREE
218 environment variable and the core.worktree configuration
219 variable. It can be an absolute path or relative path to
220 the directory specified by --git-dir or GIT_DIR.
221 Note: If --git-dir or GIT_DIR are specified but none of
222 --work-tree, GIT_WORK_TREE and core.worktree is specified,
223 the current working directory is regarded as the top directory
224 of your working tree.
227 Treat the repository as a bare repository. If GIT_DIR
228 environment is not set, it is set to the current working
232 FURTHER DOCUMENTATION
233 ---------------------
235 See the references above to get started using git. The following is
236 probably more detail than necessary for a first-time user.
238 The link:user-manual.html#git-concepts[git concepts chapter of the
239 user-manual] and linkgit:gitcore-tutorial[7] both provide
240 introductions to the underlying git architecture.
242 See linkgit:gitworkflows[7] for an overview of recommended workflows.
244 See also the link:howto-index.html[howto] documents for some useful
247 The internals are documented in the
248 link:technical/api-index.html[GIT API documentation].
253 We divide git into high level ("porcelain") commands and low level
254 ("plumbing") commands.
256 High-level commands (porcelain)
257 -------------------------------
259 We separate the porcelain commands into the main commands and some
260 ancillary user utilities.
262 Main porcelain commands
263 ~~~~~~~~~~~~~~~~~~~~~~~
265 include::cmds-mainporcelain.txt[]
271 include::cmds-ancillarymanipulators.txt[]
275 include::cmds-ancillaryinterrogators.txt[]
278 Interacting with Others
279 ~~~~~~~~~~~~~~~~~~~~~~~
281 These commands are to interact with foreign SCM and with other
282 people via patch over e-mail.
284 include::cmds-foreignscminterface.txt[]
287 Low-level commands (plumbing)
288 -----------------------------
290 Although git includes its
291 own porcelain layer, its low-level commands are sufficient to support
292 development of alternative porcelains. Developers of such porcelains
293 might start by reading about linkgit:git-update-index[1] and
294 linkgit:git-read-tree[1].
296 The interface (input, output, set of options and the semantics)
297 to these low-level commands are meant to be a lot more stable
298 than Porcelain level commands, because these commands are
299 primarily for scripted use. The interface to Porcelain commands
300 on the other hand are subject to change in order to improve the
303 The following description divides
304 the low-level commands into commands that manipulate objects (in
305 the repository, index, and working tree), commands that interrogate and
306 compare objects, and commands that move objects and references between
310 Manipulation commands
311 ~~~~~~~~~~~~~~~~~~~~~
313 include::cmds-plumbingmanipulators.txt[]
316 Interrogation commands
317 ~~~~~~~~~~~~~~~~~~~~~~
319 include::cmds-plumbinginterrogators.txt[]
321 In general, the interrogate commands do not touch the files in
325 Synching repositories
326 ~~~~~~~~~~~~~~~~~~~~~
328 include::cmds-synchingrepositories.txt[]
330 The following are helper programs used by the above; end users
331 typically do not use them directly.
333 include::cmds-synchelpers.txt[]
336 Internal helper commands
337 ~~~~~~~~~~~~~~~~~~~~~~~~
339 These are internal helper commands used by other commands; end
340 users typically do not use them directly.
342 include::cmds-purehelpers.txt[]
345 Configuration Mechanism
346 -----------------------
348 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
349 is used to hold per-repository configuration options. It is a
350 simple text file modeled after `.ini` format familiar to some
351 people. Here is an example:
355 # A '#' or ';' character indicates a comment.
360 ; Don't trust file modes
365 name = "Junio C Hamano"
366 email = "junkio@twinsun.com"
370 Various commands read from the configuration file and adjust
371 their operation accordingly.
374 Identifier Terminology
375 ----------------------
377 Indicates the object name for any type of object.
380 Indicates a blob object name.
383 Indicates a tree object name.
386 Indicates a commit object name.
389 Indicates a tree, commit or tag object name. A
390 command that takes a <tree-ish> argument ultimately wants to
391 operate on a <tree> object but automatically dereferences
392 <commit> and <tag> objects that point at a <tree>.
395 Indicates a commit or tag object name. A
396 command that takes a <commit-ish> argument ultimately wants to
397 operate on a <commit> object but automatically dereferences
398 <tag> objects that point at a <commit>.
401 Indicates that an object type is required.
402 Currently one of: `blob`, `tree`, `commit`, or `tag`.
405 Indicates a filename - almost always relative to the
406 root of the tree structure `GIT_INDEX_FILE` describes.
410 Any git command accepting any <object> can also use the following
414 indicates the head of the current branch (i.e. the
415 contents of `$GIT_DIR/HEAD`).
419 (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
423 (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
425 For a more complete list of ways to spell object names, see
426 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
429 File/Directory Structure
430 ------------------------
432 Please see the linkgit:gitrepository-layout[5] document.
434 Read linkgit:githooks[5] for more details about each hook.
436 Higher level SCMs may provide and manage additional information in the
442 Please see linkgit:gitglossary[7].
445 Environment Variables
446 ---------------------
447 Various git commands use the following environment variables:
451 These environment variables apply to 'all' core git commands. Nb: it
452 is worth noting that they may be used/overridden by SCMS sitting above
453 git so take care if using Cogito etc.
456 This environment allows the specification of an alternate
457 index file. If not specified, the default of `$GIT_DIR/index`
460 'GIT_OBJECT_DIRECTORY'::
461 If the object storage directory is specified via this
462 environment variable then the sha1 directories are created
463 underneath - otherwise the default `$GIT_DIR/objects`
466 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
467 Due to the immutable nature of git objects, old objects can be
468 archived into shared, read-only directories. This variable
469 specifies a ":" separated (on Windows ";" separated) list
470 of git object directories which can be used to search for git
471 objects. New objects will not be written to these directories.
474 If the 'GIT_DIR' environment variable is set then it
475 specifies a path to use instead of the default `.git`
476 for the base of the repository.
479 Set the path to the working tree. The value will not be
480 used in combination with repositories found automatically in
481 a .git directory (i.e. $GIT_DIR is not set).
482 This can also be controlled by the '--work-tree' command line
483 option and the core.worktree configuration variable.
485 'GIT_CEILING_DIRECTORIES'::
486 This should be a colon-separated list of absolute paths.
487 If set, it is a list of directories that git should not chdir
488 up into while looking for a repository directory.
489 It will not exclude the current working directory or
490 a GIT_DIR set on the command line or in the environment.
491 (Useful for excluding slow-loading network directories.)
498 'GIT_COMMITTER_NAME'::
499 'GIT_COMMITTER_EMAIL'::
500 'GIT_COMMITTER_DATE'::
502 see linkgit:git-commit-tree[1]
507 Only valid setting is "--unified=??" or "-u??" to set the
508 number of context lines shown when a unified diff is created.
509 This takes precedence over any "-U" or "--unified" option
510 value passed on the git diff command line.
512 'GIT_EXTERNAL_DIFF'::
513 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
514 program named by it is called, instead of the diff invocation
515 described above. For a path that is added, removed, or modified,
516 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
518 path old-file old-hex old-mode new-file new-hex new-mode
522 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
523 contents of <old|new>,
524 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
525 <old|new>-mode:: are the octal representation of the file modes.
528 The file parameters can point at the user's working file
529 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
530 when a new file is added), or a temporary file (e.g. `old-file` in the
531 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
532 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
534 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
539 'GIT_MERGE_VERBOSITY'::
540 A number controlling the amount of output shown by
541 the recursive merge strategy. Overrides merge.verbosity.
542 See linkgit:git-merge[1]
545 This environment variable overrides `$PAGER`. If it is set
546 to an empty string or to the value "cat", git will not launch
547 a pager. See also the `core.pager` option in
548 linkgit:git-config[1].
551 If this environment variable is set then 'git-fetch'
552 and 'git-push' will use this command instead
553 of 'ssh' when they need to connect to a remote system.
554 The '$GIT_SSH' command will be given exactly two arguments:
555 the 'username@host' (or just 'host') from the URL and the
556 shell command to execute on that remote system.
558 To pass options to the program that you want to list in GIT_SSH
559 you will need to wrap the program and options into a shell script,
560 then set GIT_SSH to refer to the shell script.
562 Usually it is easier to configure any desired options through your
563 personal `.ssh/config` file. Please consult your ssh documentation
567 If this environment variable is set to "1", then commands such
568 as 'git-blame' (in incremental mode), 'git-rev-list', 'git-log',
569 and 'git-whatchanged' will force a flush of the output stream
570 after each commit-oriented record have been flushed. If this
571 variable is set to "0", the output of these commands will be done
572 using completely buffered I/O. If this environment variable is
573 not set, git will choose buffered or record-oriented flushing
574 based on whether stdout appears to be redirected to a file or not.
577 If this variable is set to "1", "2" or "true" (comparison
578 is case insensitive), git will print `trace:` messages on
579 stderr telling about alias expansion, built-in command
580 execution and external command execution.
581 If this variable is set to an integer value greater than 1
582 and lower than 10 (strictly) then git will interpret this
583 value as an open file descriptor and will try to write the
584 trace messages into this file descriptor.
585 Alternatively, if this variable is set to an absolute path
586 (starting with a '/' character), git will interpret this
587 as a file path and will try to write the trace messages
590 Discussion[[Discussion]]
591 ------------------------
593 More detail on the following is available from the
594 link:user-manual.html#git-concepts[git concepts chapter of the
595 user-manual] and linkgit:gitcore-tutorial[7].
597 A git project normally consists of a working directory with a ".git"
598 subdirectory at the top level. The .git directory contains, among other
599 things, a compressed object database representing the complete history
600 of the project, an "index" file which links that history to the current
601 contents of the working tree, and named pointers into that history such
602 as tags and branch heads.
604 The object database contains objects of three main types: blobs, which
605 hold file data; trees, which point to blobs and other trees to build up
606 directory hierarchies; and commits, which each reference a single tree
607 and some number of parent commits.
609 The commit, equivalent to what other systems call a "changeset" or
610 "version", represents a step in the project's history, and each parent
611 represents an immediately preceding step. Commits with more than one
612 parent represent merges of independent lines of development.
614 All objects are named by the SHA1 hash of their contents, normally
615 written as a string of 40 hex digits. Such names are globally unique.
616 The entire history leading up to a commit can be vouched for by signing
617 just that commit. A fourth object type, the tag, is provided for this
620 When first created, objects are stored in individual files, but for
621 efficiency may later be compressed together into "pack files".
623 Named pointers called refs mark interesting points in history. A ref
624 may contain the SHA1 name of an object or the name of another ref. Refs
625 with names beginning `ref/head/` contain the SHA1 name of the most
626 recent commit (or "head") of a branch under development. SHA1 names of
627 tags of interest are stored under `ref/tags/`. A special ref named
628 `HEAD` contains the name of the currently checked-out branch.
630 The index file is initialized with a list of all paths and, for each
631 path, a blob object and a set of attributes. The blob object represents
632 the contents of the file as of the head of the current branch. The
633 attributes (last modified time, size, etc.) are taken from the
634 corresponding file in the working tree. Subsequent changes to the
635 working tree can be found by comparing these attributes. The index may
636 be updated with new content, and new commits may be created from the
637 content stored in the index.
639 The index is also capable of storing multiple entries (called "stages")
640 for a given pathname. These stages are used to hold the various
641 unmerged version of a file when a merge is in progress.
645 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
646 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
647 * The git potty was written by Andreas Ericsson <ae@op5.se>.
648 * General upbringing is handled by the git-list <git@vger.kernel.org>.
652 The documentation for git suite was started by David Greaves
653 <david@dgreaves.com>, and later enhanced greatly by the
654 contributors on the git-list <git@vger.kernel.org>.
658 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
659 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
660 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
661 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
662 linkgit:gitworkflows[7]
666 Part of the linkgit:git[1] suite