Code

GIT 1.6.3
[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 also the link:howto-index.html[howto] documents for some useful
231 examples.
233 The internals are documented in the
234 link:technical/api-index.html[GIT API documentation].
236 GIT COMMANDS
237 ------------
239 We divide git into high level ("porcelain") commands and low level
240 ("plumbing") commands.
242 High-level commands (porcelain)
243 -------------------------------
245 We separate the porcelain commands into the main commands and some
246 ancillary user utilities.
248 Main porcelain commands
249 ~~~~~~~~~~~~~~~~~~~~~~~
251 include::cmds-mainporcelain.txt[]
253 Ancillary Commands
254 ~~~~~~~~~~~~~~~~~~
255 Manipulators:
257 include::cmds-ancillarymanipulators.txt[]
259 Interrogators:
261 include::cmds-ancillaryinterrogators.txt[]
264 Interacting with Others
265 ~~~~~~~~~~~~~~~~~~~~~~~
267 These commands are to interact with foreign SCM and with other
268 people via patch over e-mail.
270 include::cmds-foreignscminterface.txt[]
273 Low-level commands (plumbing)
274 -----------------------------
276 Although git includes its
277 own porcelain layer, its low-level commands are sufficient to support
278 development of alternative porcelains.  Developers of such porcelains
279 might start by reading about linkgit:git-update-index[1] and
280 linkgit:git-read-tree[1].
282 The interface (input, output, set of options and the semantics)
283 to these low-level commands are meant to be a lot more stable
284 than Porcelain level commands, because these commands are
285 primarily for scripted use.  The interface to Porcelain commands
286 on the other hand are subject to change in order to improve the
287 end user experience.
289 The following description divides
290 the low-level commands into commands that manipulate objects (in
291 the repository, index, and working tree), commands that interrogate and
292 compare objects, and commands that move objects and references between
293 repositories.
296 Manipulation commands
297 ~~~~~~~~~~~~~~~~~~~~~
299 include::cmds-plumbingmanipulators.txt[]
302 Interrogation commands
303 ~~~~~~~~~~~~~~~~~~~~~~
305 include::cmds-plumbinginterrogators.txt[]
307 In general, the interrogate commands do not touch the files in
308 the working tree.
311 Synching repositories
312 ~~~~~~~~~~~~~~~~~~~~~
314 include::cmds-synchingrepositories.txt[]
316 The following are helper programs used by the above; end users
317 typically do not use them directly.
319 include::cmds-synchelpers.txt[]
322 Internal helper commands
323 ~~~~~~~~~~~~~~~~~~~~~~~~
325 These are internal helper commands used by other commands; end
326 users typically do not use them directly.
328 include::cmds-purehelpers.txt[]
331 Configuration Mechanism
332 -----------------------
334 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
335 is used to hold per-repository configuration options.  It is a
336 simple text file modeled after `.ini` format familiar to some
337 people.  Here is an example:
339 ------------
341 # A '#' or ';' character indicates a comment.
344 ; core variables
345 [core]
346         ; Don't trust file modes
347         filemode = false
349 ; user identity
350 [user]
351         name = "Junio C Hamano"
352         email = "junkio@twinsun.com"
354 ------------
356 Various commands read from the configuration file and adjust
357 their operation accordingly.
360 Identifier Terminology
361 ----------------------
362 <object>::
363         Indicates the object name for any type of object.
365 <blob>::
366         Indicates a blob object name.
368 <tree>::
369         Indicates a tree object name.
371 <commit>::
372         Indicates a commit object name.
374 <tree-ish>::
375         Indicates a tree, commit or tag object name.  A
376         command that takes a <tree-ish> argument ultimately wants to
377         operate on a <tree> object but automatically dereferences
378         <commit> and <tag> objects that point at a <tree>.
380 <commit-ish>::
381         Indicates a commit or tag object name.  A
382         command that takes a <commit-ish> argument ultimately wants to
383         operate on a <commit> object but automatically dereferences
384         <tag> objects that point at a <commit>.
386 <type>::
387         Indicates that an object type is required.
388         Currently one of: `blob`, `tree`, `commit`, or `tag`.
390 <file>::
391         Indicates a filename - almost always relative to the
392         root of the tree structure `GIT_INDEX_FILE` describes.
394 Symbolic Identifiers
395 --------------------
396 Any git command accepting any <object> can also use the following
397 symbolic notation:
399 HEAD::
400         indicates the head of the current branch (i.e. the
401         contents of `$GIT_DIR/HEAD`).
403 <tag>::
404         a valid tag 'name'
405         (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
407 <head>::
408         a valid head 'name'
409         (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
411 For a more complete list of ways to spell object names, see
412 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
415 File/Directory Structure
416 ------------------------
418 Please see the linkgit:gitrepository-layout[5] document.
420 Read linkgit:githooks[5] for more details about each hook.
422 Higher level SCMs may provide and manage additional information in the
423 `$GIT_DIR`.
426 Terminology
427 -----------
428 Please see linkgit:gitglossary[7].
431 Environment Variables
432 ---------------------
433 Various git commands use the following environment variables:
435 The git Repository
436 ~~~~~~~~~~~~~~~~~~
437 These environment variables apply to 'all' core git commands. Nb: it
438 is worth noting that they may be used/overridden by SCMS sitting above
439 git so take care if using Cogito etc.
441 'GIT_INDEX_FILE'::
442         This environment allows the specification of an alternate
443         index file. If not specified, the default of `$GIT_DIR/index`
444         is used.
446 'GIT_OBJECT_DIRECTORY'::
447         If the object storage directory is specified via this
448         environment variable then the sha1 directories are created
449         underneath - otherwise the default `$GIT_DIR/objects`
450         directory is used.
452 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
453         Due to the immutable nature of git objects, old objects can be
454         archived into shared, read-only directories. This variable
455         specifies a ":" separated (on Windows ";" separated) list
456         of git object directories which can be used to search for git
457         objects. New objects will not be written to these directories.
459 'GIT_DIR'::
460         If the 'GIT_DIR' environment variable is set then it
461         specifies a path to use instead of the default `.git`
462         for the base of the repository.
464 'GIT_WORK_TREE'::
465         Set the path to the working tree.  The value will not be
466         used in combination with repositories found automatically in
467         a .git directory (i.e. $GIT_DIR is not set).
468         This can also be controlled by the '--work-tree' command line
469         option and the core.worktree configuration variable.
471 'GIT_CEILING_DIRECTORIES'::
472         This should be a colon-separated list of absolute paths.
473         If set, it is a list of directories that git should not chdir
474         up into while looking for a repository directory.
475         It will not exclude the current working directory or
476         a GIT_DIR set on the command line or in the environment.
477         (Useful for excluding slow-loading network directories.)
479 git Commits
480 ~~~~~~~~~~~
481 'GIT_AUTHOR_NAME'::
482 'GIT_AUTHOR_EMAIL'::
483 'GIT_AUTHOR_DATE'::
484 'GIT_COMMITTER_NAME'::
485 'GIT_COMMITTER_EMAIL'::
486 'GIT_COMMITTER_DATE'::
487 'EMAIL'::
488         see linkgit:git-commit-tree[1]
490 git Diffs
491 ~~~~~~~~~
492 'GIT_DIFF_OPTS'::
493         Only valid setting is "--unified=??" or "-u??" to set the
494         number of context lines shown when a unified diff is created.
495         This takes precedence over any "-U" or "--unified" option
496         value passed on the git diff command line.
498 'GIT_EXTERNAL_DIFF'::
499         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
500         program named by it is called, instead of the diff invocation
501         described above.  For a path that is added, removed, or modified,
502         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
504         path old-file old-hex old-mode new-file new-hex new-mode
506 where:
508         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
509                          contents of <old|new>,
510         <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
511         <old|new>-mode:: are the octal representation of the file modes.
514 The file parameters can point at the user's working file
515 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
516 when a new file is added), or a temporary file (e.g. `old-file` in the
517 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
518 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
520 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
521 parameter, <path>.
523 other
524 ~~~~~
525 'GIT_MERGE_VERBOSITY'::
526         A number controlling the amount of output shown by
527         the recursive merge strategy.  Overrides merge.verbosity.
528         See linkgit:git-merge[1]
530 'GIT_PAGER'::
531         This environment variable overrides `$PAGER`. If it is set
532         to an empty string or to the value "cat", git will not launch
533         a pager.  See also the `core.pager` option in
534         linkgit:git-config[1].
536 'GIT_SSH'::
537         If this environment variable is set then 'git-fetch'
538         and 'git-push' will use this command instead
539         of 'ssh' when they need to connect to a remote system.
540         The '$GIT_SSH' command will be given exactly two arguments:
541         the 'username@host' (or just 'host') from the URL and the
542         shell command to execute on that remote system.
544 To pass options to the program that you want to list in GIT_SSH
545 you will need to wrap the program and options into a shell script,
546 then set GIT_SSH to refer to the shell script.
548 Usually it is easier to configure any desired options through your
549 personal `.ssh/config` file.  Please consult your ssh documentation
550 for further details.
552 'GIT_FLUSH'::
553         If this environment variable is set to "1", then commands such
554         as 'git-blame' (in incremental mode), 'git-rev-list', 'git-log',
555         and 'git-whatchanged' will force a flush of the output stream
556         after each commit-oriented record have been flushed.   If this
557         variable is set to "0", the output of these commands will be done
558         using completely buffered I/O.   If this environment variable is
559         not set, git will choose buffered or record-oriented flushing
560         based on whether stdout appears to be redirected to a file or not.
562 'GIT_TRACE'::
563         If this variable is set to "1", "2" or "true" (comparison
564         is case insensitive), git will print `trace:` messages on
565         stderr telling about alias expansion, built-in command
566         execution and external command execution.
567         If this variable is set to an integer value greater than 1
568         and lower than 10 (strictly) then git will interpret this
569         value as an open file descriptor and will try to write the
570         trace messages into this file descriptor.
571         Alternatively, if this variable is set to an absolute path
572         (starting with a '/' character), git will interpret this
573         as a file path and will try to write the trace messages
574         into it.
576 Discussion[[Discussion]]
577 ------------------------
579 More detail on the following is available from the
580 link:user-manual.html#git-concepts[git concepts chapter of the
581 user-manual] and linkgit:gitcore-tutorial[7].
583 A git project normally consists of a working directory with a ".git"
584 subdirectory at the top level.  The .git directory contains, among other
585 things, a compressed object database representing the complete history
586 of the project, an "index" file which links that history to the current
587 contents of the working tree, and named pointers into that history such
588 as tags and branch heads.
590 The object database contains objects of three main types: blobs, which
591 hold file data; trees, which point to blobs and other trees to build up
592 directory hierarchies; and commits, which each reference a single tree
593 and some number of parent commits.
595 The commit, equivalent to what other systems call a "changeset" or
596 "version", represents a step in the project's history, and each parent
597 represents an immediately preceding step.  Commits with more than one
598 parent represent merges of independent lines of development.
600 All objects are named by the SHA1 hash of their contents, normally
601 written as a string of 40 hex digits.  Such names are globally unique.
602 The entire history leading up to a commit can be vouched for by signing
603 just that commit.  A fourth object type, the tag, is provided for this
604 purpose.
606 When first created, objects are stored in individual files, but for
607 efficiency may later be compressed together into "pack files".
609 Named pointers called refs mark interesting points in history.  A ref
610 may contain the SHA1 name of an object or the name of another ref.  Refs
611 with names beginning `ref/head/` contain the SHA1 name of the most
612 recent commit (or "head") of a branch under development.  SHA1 names of
613 tags of interest are stored under `ref/tags/`.  A special ref named
614 `HEAD` contains the name of the currently checked-out branch.
616 The index file is initialized with a list of all paths and, for each
617 path, a blob object and a set of attributes.  The blob object represents
618 the contents of the file as of the head of the current branch.  The
619 attributes (last modified time, size, etc.) are taken from the
620 corresponding file in the working tree.  Subsequent changes to the
621 working tree can be found by comparing these attributes.  The index may
622 be updated with new content, and new commits may be created from the
623 content stored in the index.
625 The index is also capable of storing multiple entries (called "stages")
626 for a given pathname.  These stages are used to hold the various
627 unmerged version of a file when a merge is in progress.
629 Authors
630 -------
631 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
632 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
633 * The git potty was written by Andreas Ericsson <ae@op5.se>.
634 * General upbringing is handled by the git-list <git@vger.kernel.org>.
636 Documentation
637 --------------
638 The documentation for git suite was started by David Greaves
639 <david@dgreaves.com>, and later enhanced greatly by the
640 contributors on the git-list <git@vger.kernel.org>.
642 SEE ALSO
643 --------
644 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
645 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
646 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
647 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual]
649 GIT
650 ---
651 Part of the linkgit:git[1] suite