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 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.5.6.3/git.html[documentation for release 1.5.6.3]
49 link:RelNotes-1.5.6.3.txt[1.5.6.3].
50 link:RelNotes-1.5.6.2.txt[1.5.6.2].
51 link:RelNotes-1.5.6.1.txt[1.5.6.1].
52 link:RelNotes-1.5.6.txt[1.5.6].
54 * link:v1.5.5.4/git.html[documentation for release 1.5.5.4]
57 link:RelNotes-1.5.5.4.txt[1.5.5.4],
58 link:RelNotes-1.5.5.3.txt[1.5.5.3],
59 link:RelNotes-1.5.5.2.txt[1.5.5.2],
60 link:RelNotes-1.5.5.1.txt[1.5.5.1],
61 link:RelNotes-1.5.5.txt[1.5.5].
63 * link:v1.5.4.5/git.html[documentation for release 1.5.4.5]
66 link:RelNotes-1.5.4.5.txt[1.5.4.5],
67 link:RelNotes-1.5.4.4.txt[1.5.4.4],
68 link:RelNotes-1.5.4.3.txt[1.5.4.3],
69 link:RelNotes-1.5.4.2.txt[1.5.4.2],
70 link:RelNotes-1.5.4.1.txt[1.5.4.1],
71 link:RelNotes-1.5.4.txt[1.5.4].
73 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
76 link:RelNotes-1.5.3.8.txt[1.5.3.8],
77 link:RelNotes-1.5.3.7.txt[1.5.3.7],
78 link:RelNotes-1.5.3.6.txt[1.5.3.6],
79 link:RelNotes-1.5.3.5.txt[1.5.3.5],
80 link:RelNotes-1.5.3.4.txt[1.5.3.4],
81 link:RelNotes-1.5.3.3.txt[1.5.3.3],
82 link:RelNotes-1.5.3.2.txt[1.5.3.2],
83 link:RelNotes-1.5.3.1.txt[1.5.3.1],
84 link:RelNotes-1.5.3.txt[1.5.3].
86 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
89 link:RelNotes-1.5.2.5.txt[1.5.2.5],
90 link:RelNotes-1.5.2.4.txt[1.5.2.4],
91 link:RelNotes-1.5.2.3.txt[1.5.2.3],
92 link:RelNotes-1.5.2.2.txt[1.5.2.2],
93 link:RelNotes-1.5.2.1.txt[1.5.2.1],
94 link:RelNotes-1.5.2.txt[1.5.2].
96 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
99 link:RelNotes-1.5.1.6.txt[1.5.1.6],
100 link:RelNotes-1.5.1.5.txt[1.5.1.5],
101 link:RelNotes-1.5.1.4.txt[1.5.1.4],
102 link:RelNotes-1.5.1.3.txt[1.5.1.3],
103 link:RelNotes-1.5.1.2.txt[1.5.1.2],
104 link:RelNotes-1.5.1.1.txt[1.5.1.1],
105 link:RelNotes-1.5.1.txt[1.5.1].
107 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
110 link:RelNotes-1.5.0.7.txt[1.5.0.7],
111 link:RelNotes-1.5.0.6.txt[1.5.0.6],
112 link:RelNotes-1.5.0.5.txt[1.5.0.5],
113 link:RelNotes-1.5.0.3.txt[1.5.0.3],
114 link:RelNotes-1.5.0.2.txt[1.5.0.2],
115 link:RelNotes-1.5.0.1.txt[1.5.0.1],
116 link:RelNotes-1.5.0.txt[1.5.0].
118 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
119 link:v1.3.3/git.html[1.3.3],
120 link:v1.2.6/git.html[1.2.6],
121 link:v1.0.13/git.html[1.0.13].
130 Prints the git suite version that the 'git' program came from.
133 Prints the synopsis and a list of the most commonly used
134 commands. If the option '--all' or '-a' is given then all
135 available commands are printed. If a git command is named this
136 option will bring up the manual page for that command.
138 Other options are available to control how the manual page is
139 displayed. See linkgit:git-help[1] for more information,
140 because `git --help ...` is converted internally into `git
144 Path to wherever your core git programs are installed.
145 This can also be controlled by setting the GIT_EXEC_PATH
146 environment variable. If no path is given, 'git' will print
147 the current setting and then exit.
151 Pipe all output into 'less' (or if set, $PAGER).
154 Do not pipe git output into a pager.
157 Set the path to the repository. This can also be controlled by
158 setting the GIT_DIR environment variable. It can be an absolute
159 path or relative path to current working directory.
162 Set the path to the working tree. The value will not be
163 used in combination with repositories found automatically in
164 a .git directory (i.e. $GIT_DIR is not set).
165 This can also be controlled by setting the GIT_WORK_TREE
166 environment variable and the core.worktree configuration
167 variable. It can be an absolute path or relative path to
168 the directory specified by --git-dir or GIT_DIR.
169 Note: If --git-dir or GIT_DIR are specified but none of
170 --work-tree, GIT_WORK_TREE and core.worktree is specified,
171 the current working directory is regarded as the top directory
172 of your working tree.
175 Treat the repository as a bare repository. If GIT_DIR
176 environment is not set, it is set to the current working
180 FURTHER DOCUMENTATION
181 ---------------------
183 See the references above to get started using git. The following is
184 probably more detail than necessary for a first-time user.
186 The link:user-manual.html#git-concepts[git concepts chapter of the
187 user-manual] and linkgit:gitcore-tutorial[7] both provide
188 introductions to the underlying git architecture.
190 See also the link:howto-index.html[howto] documents for some useful
193 The internals are documented in the
194 link:technical/api-index.html[GIT API documentation].
199 We divide git into high level ("porcelain") commands and low level
200 ("plumbing") commands.
202 High-level commands (porcelain)
203 -------------------------------
205 We separate the porcelain commands into the main commands and some
206 ancillary user utilities.
208 Main porcelain commands
209 ~~~~~~~~~~~~~~~~~~~~~~~
211 include::cmds-mainporcelain.txt[]
217 include::cmds-ancillarymanipulators.txt[]
221 include::cmds-ancillaryinterrogators.txt[]
224 Interacting with Others
225 ~~~~~~~~~~~~~~~~~~~~~~~
227 These commands are to interact with foreign SCM and with other
228 people via patch over e-mail.
230 include::cmds-foreignscminterface.txt[]
233 Low-level commands (plumbing)
234 -----------------------------
236 Although git includes its
237 own porcelain layer, its low-level commands are sufficient to support
238 development of alternative porcelains. Developers of such porcelains
239 might start by reading about linkgit:git-update-index[1] and
240 linkgit:git-read-tree[1].
242 The interface (input, output, set of options and the semantics)
243 to these low-level commands are meant to be a lot more stable
244 than Porcelain level commands, because these commands are
245 primarily for scripted use. The interface to Porcelain commands
246 on the other hand are subject to change in order to improve the
249 The following description divides
250 the low-level commands into commands that manipulate objects (in
251 the repository, index, and working tree), commands that interrogate and
252 compare objects, and commands that move objects and references between
256 Manipulation commands
257 ~~~~~~~~~~~~~~~~~~~~~
259 include::cmds-plumbingmanipulators.txt[]
262 Interrogation commands
263 ~~~~~~~~~~~~~~~~~~~~~~
265 include::cmds-plumbinginterrogators.txt[]
267 In general, the interrogate commands do not touch the files in
271 Synching repositories
272 ~~~~~~~~~~~~~~~~~~~~~
274 include::cmds-synchingrepositories.txt[]
276 The following are helper programs used by the above; end users
277 typically do not use them directly.
279 include::cmds-synchelpers.txt[]
282 Internal helper commands
283 ~~~~~~~~~~~~~~~~~~~~~~~~
285 These are internal helper commands used by other commands; end
286 users typically do not use them directly.
288 include::cmds-purehelpers.txt[]
291 Configuration Mechanism
292 -----------------------
294 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
295 is used to hold per-repository configuration options. It is a
296 simple text file modeled after `.ini` format familiar to some
297 people. Here is an example:
301 # A '#' or ';' character indicates a comment.
306 ; Don't trust file modes
311 name = "Junio C Hamano"
312 email = "junkio@twinsun.com"
316 Various commands read from the configuration file and adjust
317 their operation accordingly.
320 Identifier Terminology
321 ----------------------
323 Indicates the object name for any type of object.
326 Indicates a blob object name.
329 Indicates a tree object name.
332 Indicates a commit object name.
335 Indicates a tree, commit or tag object name. A
336 command that takes a <tree-ish> argument ultimately wants to
337 operate on a <tree> object but automatically dereferences
338 <commit> and <tag> objects that point at a <tree>.
341 Indicates a commit or tag object name. A
342 command that takes a <commit-ish> argument ultimately wants to
343 operate on a <commit> object but automatically dereferences
344 <tag> objects that point at a <commit>.
347 Indicates that an object type is required.
348 Currently one of: `blob`, `tree`, `commit`, or `tag`.
351 Indicates a filename - almost always relative to the
352 root of the tree structure `GIT_INDEX_FILE` describes.
356 Any git command accepting any <object> can also use the following
360 indicates the head of the current branch (i.e. the
361 contents of `$GIT_DIR/HEAD`).
365 (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
369 (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
371 For a more complete list of ways to spell object names, see
372 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
375 File/Directory Structure
376 ------------------------
378 Please see the linkgit:gitrepository-layout[5] document.
380 Read linkgit:githooks[5] for more details about each hook.
382 Higher level SCMs may provide and manage additional information in the
388 Please see linkgit:gitglossary[7].
391 Environment Variables
392 ---------------------
393 Various git commands use the following environment variables:
397 These environment variables apply to 'all' core git commands. Nb: it
398 is worth noting that they may be used/overridden by SCMS sitting above
399 git so take care if using Cogito etc.
402 This environment allows the specification of an alternate
403 index file. If not specified, the default of `$GIT_DIR/index`
406 'GIT_OBJECT_DIRECTORY'::
407 If the object storage directory is specified via this
408 environment variable then the sha1 directories are created
409 underneath - otherwise the default `$GIT_DIR/objects`
412 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
413 Due to the immutable nature of git objects, old objects can be
414 archived into shared, read-only directories. This variable
415 specifies a ":" separated (on Windows ";" separated) list
416 of git object directories which can be used to search for git
417 objects. New objects will not be written to these directories.
420 If the 'GIT_DIR' environment variable is set then it
421 specifies a path to use instead of the default `.git`
422 for the base of the repository.
425 Set the path to the working tree. The value will not be
426 used in combination with repositories found automatically in
427 a .git directory (i.e. $GIT_DIR is not set).
428 This can also be controlled by the '--work-tree' command line
429 option and the core.worktree configuration variable.
431 'GIT_CEILING_DIRECTORIES'::
432 This should be a colon-separated list of absolute paths.
433 If set, it is a list of directories that git should not chdir
434 up into while looking for a repository directory.
435 It will not exclude the current working directory or
436 a GIT_DIR set on the command line or in the environment.
437 (Useful for excluding slow-loading network directories.)
444 'GIT_COMMITTER_NAME'::
445 'GIT_COMMITTER_EMAIL'::
446 'GIT_COMMITTER_DATE'::
448 see linkgit:git-commit-tree[1]
453 Only valid setting is "--unified=??" or "-u??" to set the
454 number of context lines shown when a unified diff is created.
455 This takes precedence over any "-U" or "--unified" option
456 value passed on the git diff command line.
458 'GIT_EXTERNAL_DIFF'::
459 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
460 program named by it is called, instead of the diff invocation
461 described above. For a path that is added, removed, or modified,
462 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
464 path old-file old-hex old-mode new-file new-hex new-mode
468 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
469 contents of <old|new>,
470 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
471 <old|new>-mode:: are the octal representation of the file modes.
474 The file parameters can point at the user's working file
475 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
476 when a new file is added), or a temporary file (e.g. `old-file` in the
477 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
478 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
480 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
485 'GIT_MERGE_VERBOSITY'::
486 A number controlling the amount of output shown by
487 the recursive merge strategy. Overrides merge.verbosity.
488 See linkgit:git-merge[1]
491 This environment variable overrides `$PAGER`. If it is set
492 to an empty string or to the value "cat", git will not launch
496 If this environment variable is set then 'git-fetch'
497 and 'git-push' will use this command instead
498 of 'ssh' when they need to connect to a remote system.
499 The '$GIT_SSH' command will be given exactly two arguments:
500 the 'username@host' (or just 'host') from the URL and the
501 shell command to execute on that remote system.
503 To pass options to the program that you want to list in GIT_SSH
504 you will need to wrap the program and options into a shell script,
505 then set GIT_SSH to refer to the shell script.
507 Usually it is easier to configure any desired options through your
508 personal `.ssh/config` file. Please consult your ssh documentation
512 If this environment variable is set to "1", then commands such
513 as 'git-blame' (in incremental mode), 'git-rev-list', 'git-log',
514 and 'git-whatchanged' will force a flush of the output stream
515 after each commit-oriented record have been flushed. If this
516 variable is set to "0", the output of these commands will be done
517 using completely buffered I/O. If this environment variable is
518 not set, git will choose buffered or record-oriented flushing
519 based on whether stdout appears to be redirected to a file or not.
522 If this variable is set to "1", "2" or "true" (comparison
523 is case insensitive), git will print `trace:` messages on
524 stderr telling about alias expansion, built-in command
525 execution and external command execution.
526 If this variable is set to an integer value greater than 1
527 and lower than 10 (strictly) then git will interpret this
528 value as an open file descriptor and will try to write the
529 trace messages into this file descriptor.
530 Alternatively, if this variable is set to an absolute path
531 (starting with a '/' character), git will interpret this
532 as a file path and will try to write the trace messages
535 Discussion[[Discussion]]
536 ------------------------
538 More detail on the following is available from the
539 link:user-manual.html#git-concepts[git concepts chapter of the
540 user-manual] and linkgit:gitcore-tutorial[7].
542 A git project normally consists of a working directory with a ".git"
543 subdirectory at the top level. The .git directory contains, among other
544 things, a compressed object database representing the complete history
545 of the project, an "index" file which links that history to the current
546 contents of the working tree, and named pointers into that history such
547 as tags and branch heads.
549 The object database contains objects of three main types: blobs, which
550 hold file data; trees, which point to blobs and other trees to build up
551 directory hierarchies; and commits, which each reference a single tree
552 and some number of parent commits.
554 The commit, equivalent to what other systems call a "changeset" or
555 "version", represents a step in the project's history, and each parent
556 represents an immediately preceding step. Commits with more than one
557 parent represent merges of independent lines of development.
559 All objects are named by the SHA1 hash of their contents, normally
560 written as a string of 40 hex digits. Such names are globally unique.
561 The entire history leading up to a commit can be vouched for by signing
562 just that commit. A fourth object type, the tag, is provided for this
565 When first created, objects are stored in individual files, but for
566 efficiency may later be compressed together into "pack files".
568 Named pointers called refs mark interesting points in history. A ref
569 may contain the SHA1 name of an object or the name of another ref. Refs
570 with names beginning `ref/head/` contain the SHA1 name of the most
571 recent commit (or "head") of a branch under development. SHA1 names of
572 tags of interest are stored under `ref/tags/`. A special ref named
573 `HEAD` contains the name of the currently checked-out branch.
575 The index file is initialized with a list of all paths and, for each
576 path, a blob object and a set of attributes. The blob object represents
577 the contents of the file as of the head of the current branch. The
578 attributes (last modified time, size, etc.) are taken from the
579 corresponding file in the working tree. Subsequent changes to the
580 working tree can be found by comparing these attributes. The index may
581 be updated with new content, and new commits may be created from the
582 content stored in the index.
584 The index is also capable of storing multiple entries (called "stages")
585 for a given pathname. These stages are used to hold the various
586 unmerged version of a file when a merge is in progress.
590 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
591 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
592 * The git potty was written by Andreas Ericsson <ae@op5.se>.
593 * General upbringing is handled by the git-list <git@vger.kernel.org>.
597 The documentation for git suite was started by David Greaves
598 <david@dgreaves.com>, and later enhanced greatly by the
599 contributors on the git-list <git@vger.kernel.org>.
603 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
604 linkgit:everyday[7], linkgit:gitcvs-migration[7],
605 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
606 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual]
610 Part of the linkgit:git[1] suite