Code

Documentation: refer to gitworkflows(7) from tutorial and git(1)
[git.git] / Documentation / git.txt
1 git(1)
2 ======
4 NAME
5 ----
6 git - the stupid content tracker
9 SYNOPSIS
10 --------
11 [verse]
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]
17 DESCRIPTION
18 -----------
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
28 introduction.
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/`.
37 ifdef::stalenotes[]
38 [NOTE]
39 ============
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.3/git.html[documentation for release 1.6.3]
48 * release notes for
49   link:RelNotes-1.6.2.5.txt[1.6.2.5],
50   link:RelNotes-1.6.2.4.txt[1.6.2.4],
51   link:RelNotes-1.6.2.3.txt[1.6.2.3],
52   link:RelNotes-1.6.2.2.txt[1.6.2.2],
53   link:RelNotes-1.6.2.1.txt[1.6.2.1],
54   link:RelNotes-1.6.2.txt[1.6.2].
56 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
58 * release notes for
59   link:RelNotes-1.6.1.3.txt[1.6.1.3],
60   link:RelNotes-1.6.1.2.txt[1.6.1.2],
61   link:RelNotes-1.6.1.1.txt[1.6.1.1],
62   link:RelNotes-1.6.1.txt[1.6.1].
64 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
66 * release notes for
67   link:RelNotes-1.6.0.6.txt[1.6.0.6],
68   link:RelNotes-1.6.0.5.txt[1.6.0.5],
69   link:RelNotes-1.6.0.4.txt[1.6.0.4],
70   link:RelNotes-1.6.0.3.txt[1.6.0.3],
71   link:RelNotes-1.6.0.2.txt[1.6.0.2],
72   link:RelNotes-1.6.0.1.txt[1.6.0.1],
73   link:RelNotes-1.6.0.txt[1.6.0].
75 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
77 * release notes for
78   link:RelNotes-1.5.6.6.txt[1.5.6.6],
79   link:RelNotes-1.5.6.5.txt[1.5.6.5],
80   link:RelNotes-1.5.6.4.txt[1.5.6.4],
81   link:RelNotes-1.5.6.3.txt[1.5.6.3],
82   link:RelNotes-1.5.6.2.txt[1.5.6.2],
83   link:RelNotes-1.5.6.1.txt[1.5.6.1],
84   link:RelNotes-1.5.6.txt[1.5.6].
86 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
88 * release notes for
89   link:RelNotes-1.5.5.6.txt[1.5.5.6],
90   link:RelNotes-1.5.5.5.txt[1.5.5.5],
91   link:RelNotes-1.5.5.4.txt[1.5.5.4],
92   link:RelNotes-1.5.5.3.txt[1.5.5.3],
93   link:RelNotes-1.5.5.2.txt[1.5.5.2],
94   link:RelNotes-1.5.5.1.txt[1.5.5.1],
95   link:RelNotes-1.5.5.txt[1.5.5].
97 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
99 * release notes for
100   link:RelNotes-1.5.4.7.txt[1.5.4.7],
101   link:RelNotes-1.5.4.6.txt[1.5.4.6],
102   link:RelNotes-1.5.4.5.txt[1.5.4.5],
103   link:RelNotes-1.5.4.4.txt[1.5.4.4],
104   link:RelNotes-1.5.4.3.txt[1.5.4.3],
105   link:RelNotes-1.5.4.2.txt[1.5.4.2],
106   link:RelNotes-1.5.4.1.txt[1.5.4.1],
107   link:RelNotes-1.5.4.txt[1.5.4].
109 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
111 * release notes for
112   link:RelNotes-1.5.3.8.txt[1.5.3.8],
113   link:RelNotes-1.5.3.7.txt[1.5.3.7],
114   link:RelNotes-1.5.3.6.txt[1.5.3.6],
115   link:RelNotes-1.5.3.5.txt[1.5.3.5],
116   link:RelNotes-1.5.3.4.txt[1.5.3.4],
117   link:RelNotes-1.5.3.3.txt[1.5.3.3],
118   link:RelNotes-1.5.3.2.txt[1.5.3.2],
119   link:RelNotes-1.5.3.1.txt[1.5.3.1],
120   link:RelNotes-1.5.3.txt[1.5.3].
122 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
124 * release notes for
125   link:RelNotes-1.5.2.5.txt[1.5.2.5],
126   link:RelNotes-1.5.2.4.txt[1.5.2.4],
127   link:RelNotes-1.5.2.3.txt[1.5.2.3],
128   link:RelNotes-1.5.2.2.txt[1.5.2.2],
129   link:RelNotes-1.5.2.1.txt[1.5.2.1],
130   link:RelNotes-1.5.2.txt[1.5.2].
132 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
134 * release notes for
135   link:RelNotes-1.5.1.6.txt[1.5.1.6],
136   link:RelNotes-1.5.1.5.txt[1.5.1.5],
137   link:RelNotes-1.5.1.4.txt[1.5.1.4],
138   link:RelNotes-1.5.1.3.txt[1.5.1.3],
139   link:RelNotes-1.5.1.2.txt[1.5.1.2],
140   link:RelNotes-1.5.1.1.txt[1.5.1.1],
141   link:RelNotes-1.5.1.txt[1.5.1].
143 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
145 * release notes for
146   link:RelNotes-1.5.0.7.txt[1.5.0.7],
147   link:RelNotes-1.5.0.6.txt[1.5.0.6],
148   link:RelNotes-1.5.0.5.txt[1.5.0.5],
149   link:RelNotes-1.5.0.3.txt[1.5.0.3],
150   link:RelNotes-1.5.0.2.txt[1.5.0.2],
151   link:RelNotes-1.5.0.1.txt[1.5.0.1],
152   link:RelNotes-1.5.0.txt[1.5.0].
154 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
155   link:v1.3.3/git.html[1.3.3],
156   link:v1.2.6/git.html[1.2.6],
157   link:v1.0.13/git.html[1.0.13].
159 ============
161 endif::stalenotes[]
163 OPTIONS
164 -------
165 --version::
166         Prints the git suite version that the 'git' program came from.
168 --help::
169         Prints the synopsis and a list of the most commonly used
170         commands. If the option '--all' or '-a' is given then all
171         available commands are printed. If a git command is named this
172         option will bring up the manual page for that command.
174 Other options are available to control how the manual page is
175 displayed. See linkgit:git-help[1] for more information,
176 because `git --help ...` is converted internally into `git
177 help ...`.
179 --exec-path::
180         Path to wherever your core git programs are installed.
181         This can also be controlled by setting the GIT_EXEC_PATH
182         environment variable. If no path is given, 'git' will print
183         the current setting and then exit.
185 --html-path::
186         Print the path to wherever your git HTML documentation is installed
187         and exit.
189 -p::
190 --paginate::
191         Pipe all output into 'less' (or if set, $PAGER).
193 --no-pager::
194         Do not pipe git output into a pager.
196 --git-dir=<path>::
197         Set the path to the repository. This can also be controlled by
198         setting the GIT_DIR environment variable. It can be an absolute
199         path or relative path to current working directory.
201 --work-tree=<path>::
202         Set the path to the working tree.  The value will not be
203         used in combination with repositories found automatically in
204         a .git directory (i.e. $GIT_DIR is not set).
205         This can also be controlled by setting the GIT_WORK_TREE
206         environment variable and the core.worktree configuration
207         variable. It can be an absolute path or relative path to
208         the directory specified by --git-dir or GIT_DIR.
209         Note: If --git-dir or GIT_DIR are specified but none of
210         --work-tree, GIT_WORK_TREE and core.worktree is specified,
211         the current working directory is regarded as the top directory
212         of your working tree.
214 --bare::
215         Treat the repository as a bare repository.  If GIT_DIR
216         environment is not set, it is set to the current working
217         directory.
220 FURTHER DOCUMENTATION
221 ---------------------
223 See the references above to get started using git.  The following is
224 probably more detail than necessary for a first-time user.
226 The link:user-manual.html#git-concepts[git concepts chapter of the
227 user-manual] and linkgit:gitcore-tutorial[7] both provide
228 introductions to the underlying git architecture.
230 See linkgit:gitworkflows[7] for an overview of recommended workflows.
232 See also the link:howto-index.html[howto] documents for some useful
233 examples.
235 The internals are documented in the
236 link:technical/api-index.html[GIT API documentation].
238 GIT COMMANDS
239 ------------
241 We divide git into high level ("porcelain") commands and low level
242 ("plumbing") commands.
244 High-level commands (porcelain)
245 -------------------------------
247 We separate the porcelain commands into the main commands and some
248 ancillary user utilities.
250 Main porcelain commands
251 ~~~~~~~~~~~~~~~~~~~~~~~
253 include::cmds-mainporcelain.txt[]
255 Ancillary Commands
256 ~~~~~~~~~~~~~~~~~~
257 Manipulators:
259 include::cmds-ancillarymanipulators.txt[]
261 Interrogators:
263 include::cmds-ancillaryinterrogators.txt[]
266 Interacting with Others
267 ~~~~~~~~~~~~~~~~~~~~~~~
269 These commands are to interact with foreign SCM and with other
270 people via patch over e-mail.
272 include::cmds-foreignscminterface.txt[]
275 Low-level commands (plumbing)
276 -----------------------------
278 Although git includes its
279 own porcelain layer, its low-level commands are sufficient to support
280 development of alternative porcelains.  Developers of such porcelains
281 might start by reading about linkgit:git-update-index[1] and
282 linkgit:git-read-tree[1].
284 The interface (input, output, set of options and the semantics)
285 to these low-level commands are meant to be a lot more stable
286 than Porcelain level commands, because these commands are
287 primarily for scripted use.  The interface to Porcelain commands
288 on the other hand are subject to change in order to improve the
289 end user experience.
291 The following description divides
292 the low-level commands into commands that manipulate objects (in
293 the repository, index, and working tree), commands that interrogate and
294 compare objects, and commands that move objects and references between
295 repositories.
298 Manipulation commands
299 ~~~~~~~~~~~~~~~~~~~~~
301 include::cmds-plumbingmanipulators.txt[]
304 Interrogation commands
305 ~~~~~~~~~~~~~~~~~~~~~~
307 include::cmds-plumbinginterrogators.txt[]
309 In general, the interrogate commands do not touch the files in
310 the working tree.
313 Synching repositories
314 ~~~~~~~~~~~~~~~~~~~~~
316 include::cmds-synchingrepositories.txt[]
318 The following are helper programs used by the above; end users
319 typically do not use them directly.
321 include::cmds-synchelpers.txt[]
324 Internal helper commands
325 ~~~~~~~~~~~~~~~~~~~~~~~~
327 These are internal helper commands used by other commands; end
328 users typically do not use them directly.
330 include::cmds-purehelpers.txt[]
333 Configuration Mechanism
334 -----------------------
336 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
337 is used to hold per-repository configuration options.  It is a
338 simple text file modeled after `.ini` format familiar to some
339 people.  Here is an example:
341 ------------
343 # A '#' or ';' character indicates a comment.
346 ; core variables
347 [core]
348         ; Don't trust file modes
349         filemode = false
351 ; user identity
352 [user]
353         name = "Junio C Hamano"
354         email = "junkio@twinsun.com"
356 ------------
358 Various commands read from the configuration file and adjust
359 their operation accordingly.
362 Identifier Terminology
363 ----------------------
364 <object>::
365         Indicates the object name for any type of object.
367 <blob>::
368         Indicates a blob object name.
370 <tree>::
371         Indicates a tree object name.
373 <commit>::
374         Indicates a commit object name.
376 <tree-ish>::
377         Indicates a tree, commit or tag object name.  A
378         command that takes a <tree-ish> argument ultimately wants to
379         operate on a <tree> object but automatically dereferences
380         <commit> and <tag> objects that point at a <tree>.
382 <commit-ish>::
383         Indicates a commit or tag object name.  A
384         command that takes a <commit-ish> argument ultimately wants to
385         operate on a <commit> object but automatically dereferences
386         <tag> objects that point at a <commit>.
388 <type>::
389         Indicates that an object type is required.
390         Currently one of: `blob`, `tree`, `commit`, or `tag`.
392 <file>::
393         Indicates a filename - almost always relative to the
394         root of the tree structure `GIT_INDEX_FILE` describes.
396 Symbolic Identifiers
397 --------------------
398 Any git command accepting any <object> can also use the following
399 symbolic notation:
401 HEAD::
402         indicates the head of the current branch (i.e. the
403         contents of `$GIT_DIR/HEAD`).
405 <tag>::
406         a valid tag 'name'
407         (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
409 <head>::
410         a valid head 'name'
411         (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
413 For a more complete list of ways to spell object names, see
414 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
417 File/Directory Structure
418 ------------------------
420 Please see the linkgit:gitrepository-layout[5] document.
422 Read linkgit:githooks[5] for more details about each hook.
424 Higher level SCMs may provide and manage additional information in the
425 `$GIT_DIR`.
428 Terminology
429 -----------
430 Please see linkgit:gitglossary[7].
433 Environment Variables
434 ---------------------
435 Various git commands use the following environment variables:
437 The git Repository
438 ~~~~~~~~~~~~~~~~~~
439 These environment variables apply to 'all' core git commands. Nb: it
440 is worth noting that they may be used/overridden by SCMS sitting above
441 git so take care if using Cogito etc.
443 'GIT_INDEX_FILE'::
444         This environment allows the specification of an alternate
445         index file. If not specified, the default of `$GIT_DIR/index`
446         is used.
448 'GIT_OBJECT_DIRECTORY'::
449         If the object storage directory is specified via this
450         environment variable then the sha1 directories are created
451         underneath - otherwise the default `$GIT_DIR/objects`
452         directory is used.
454 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
455         Due to the immutable nature of git objects, old objects can be
456         archived into shared, read-only directories. This variable
457         specifies a ":" separated (on Windows ";" separated) list
458         of git object directories which can be used to search for git
459         objects. New objects will not be written to these directories.
461 'GIT_DIR'::
462         If the 'GIT_DIR' environment variable is set then it
463         specifies a path to use instead of the default `.git`
464         for the base of the repository.
466 'GIT_WORK_TREE'::
467         Set the path to the working tree.  The value will not be
468         used in combination with repositories found automatically in
469         a .git directory (i.e. $GIT_DIR is not set).
470         This can also be controlled by the '--work-tree' command line
471         option and the core.worktree configuration variable.
473 'GIT_CEILING_DIRECTORIES'::
474         This should be a colon-separated list of absolute paths.
475         If set, it is a list of directories that git should not chdir
476         up into while looking for a repository directory.
477         It will not exclude the current working directory or
478         a GIT_DIR set on the command line or in the environment.
479         (Useful for excluding slow-loading network directories.)
481 git Commits
482 ~~~~~~~~~~~
483 'GIT_AUTHOR_NAME'::
484 'GIT_AUTHOR_EMAIL'::
485 'GIT_AUTHOR_DATE'::
486 'GIT_COMMITTER_NAME'::
487 'GIT_COMMITTER_EMAIL'::
488 'GIT_COMMITTER_DATE'::
489 'EMAIL'::
490         see linkgit:git-commit-tree[1]
492 git Diffs
493 ~~~~~~~~~
494 'GIT_DIFF_OPTS'::
495         Only valid setting is "--unified=??" or "-u??" to set the
496         number of context lines shown when a unified diff is created.
497         This takes precedence over any "-U" or "--unified" option
498         value passed on the git diff command line.
500 'GIT_EXTERNAL_DIFF'::
501         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
502         program named by it is called, instead of the diff invocation
503         described above.  For a path that is added, removed, or modified,
504         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
506         path old-file old-hex old-mode new-file new-hex new-mode
508 where:
510         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
511                          contents of <old|new>,
512         <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
513         <old|new>-mode:: are the octal representation of the file modes.
516 The file parameters can point at the user's working file
517 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
518 when a new file is added), or a temporary file (e.g. `old-file` in the
519 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
520 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
522 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
523 parameter, <path>.
525 other
526 ~~~~~
527 'GIT_MERGE_VERBOSITY'::
528         A number controlling the amount of output shown by
529         the recursive merge strategy.  Overrides merge.verbosity.
530         See linkgit:git-merge[1]
532 'GIT_PAGER'::
533         This environment variable overrides `$PAGER`. If it is set
534         to an empty string or to the value "cat", git will not launch
535         a pager.  See also the `core.pager` option in
536         linkgit:git-config[1].
538 'GIT_SSH'::
539         If this environment variable is set then 'git-fetch'
540         and 'git-push' will use this command instead
541         of 'ssh' when they need to connect to a remote system.
542         The '$GIT_SSH' command will be given exactly two arguments:
543         the 'username@host' (or just 'host') from the URL and the
544         shell command to execute on that remote system.
546 To pass options to the program that you want to list in GIT_SSH
547 you will need to wrap the program and options into a shell script,
548 then set GIT_SSH to refer to the shell script.
550 Usually it is easier to configure any desired options through your
551 personal `.ssh/config` file.  Please consult your ssh documentation
552 for further details.
554 'GIT_FLUSH'::
555         If this environment variable is set to "1", then commands such
556         as 'git-blame' (in incremental mode), 'git-rev-list', 'git-log',
557         and 'git-whatchanged' will force a flush of the output stream
558         after each commit-oriented record have been flushed.   If this
559         variable is set to "0", the output of these commands will be done
560         using completely buffered I/O.   If this environment variable is
561         not set, git will choose buffered or record-oriented flushing
562         based on whether stdout appears to be redirected to a file or not.
564 'GIT_TRACE'::
565         If this variable is set to "1", "2" or "true" (comparison
566         is case insensitive), git will print `trace:` messages on
567         stderr telling about alias expansion, built-in command
568         execution and external command execution.
569         If this variable is set to an integer value greater than 1
570         and lower than 10 (strictly) then git will interpret this
571         value as an open file descriptor and will try to write the
572         trace messages into this file descriptor.
573         Alternatively, if this variable is set to an absolute path
574         (starting with a '/' character), git will interpret this
575         as a file path and will try to write the trace messages
576         into it.
578 Discussion[[Discussion]]
579 ------------------------
581 More detail on the following is available from the
582 link:user-manual.html#git-concepts[git concepts chapter of the
583 user-manual] and linkgit:gitcore-tutorial[7].
585 A git project normally consists of a working directory with a ".git"
586 subdirectory at the top level.  The .git directory contains, among other
587 things, a compressed object database representing the complete history
588 of the project, an "index" file which links that history to the current
589 contents of the working tree, and named pointers into that history such
590 as tags and branch heads.
592 The object database contains objects of three main types: blobs, which
593 hold file data; trees, which point to blobs and other trees to build up
594 directory hierarchies; and commits, which each reference a single tree
595 and some number of parent commits.
597 The commit, equivalent to what other systems call a "changeset" or
598 "version", represents a step in the project's history, and each parent
599 represents an immediately preceding step.  Commits with more than one
600 parent represent merges of independent lines of development.
602 All objects are named by the SHA1 hash of their contents, normally
603 written as a string of 40 hex digits.  Such names are globally unique.
604 The entire history leading up to a commit can be vouched for by signing
605 just that commit.  A fourth object type, the tag, is provided for this
606 purpose.
608 When first created, objects are stored in individual files, but for
609 efficiency may later be compressed together into "pack files".
611 Named pointers called refs mark interesting points in history.  A ref
612 may contain the SHA1 name of an object or the name of another ref.  Refs
613 with names beginning `ref/head/` contain the SHA1 name of the most
614 recent commit (or "head") of a branch under development.  SHA1 names of
615 tags of interest are stored under `ref/tags/`.  A special ref named
616 `HEAD` contains the name of the currently checked-out branch.
618 The index file is initialized with a list of all paths and, for each
619 path, a blob object and a set of attributes.  The blob object represents
620 the contents of the file as of the head of the current branch.  The
621 attributes (last modified time, size, etc.) are taken from the
622 corresponding file in the working tree.  Subsequent changes to the
623 working tree can be found by comparing these attributes.  The index may
624 be updated with new content, and new commits may be created from the
625 content stored in the index.
627 The index is also capable of storing multiple entries (called "stages")
628 for a given pathname.  These stages are used to hold the various
629 unmerged version of a file when a merge is in progress.
631 Authors
632 -------
633 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
634 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
635 * The git potty was written by Andreas Ericsson <ae@op5.se>.
636 * General upbringing is handled by the git-list <git@vger.kernel.org>.
638 Documentation
639 --------------
640 The documentation for git suite was started by David Greaves
641 <david@dgreaves.com>, and later enhanced greatly by the
642 contributors on the git-list <git@vger.kernel.org>.
644 SEE ALSO
645 --------
646 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
647 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
648 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
649 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
650 linkgit:gitworkflows[7]
652 GIT
653 ---
654 Part of the linkgit:git[1] suite