Code

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