Merge in GIT 1.5.3.8
[git/dscho.git] / Documentation / git.txt
blob4ece40d1ebe88b87e1f1048f63f7446c8c4928e0
1 git(7)
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 this link:tutorial.html[tutorial] 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 link:cvs-migration.html[CVS migration].  See
27 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.5.3.8/git.html[documentation for release 1.5.3.8]
48 * release notes for
49   link:RelNotes-1.5.3.8.txt[1.5.3.8],
50   link:RelNotes-1.5.3.7.txt[1.5.3.7],
51   link:RelNotes-1.5.3.6.txt[1.5.3.6],
52   link:RelNotes-1.5.3.5.txt[1.5.3.5],
53   link:RelNotes-1.5.3.4.txt[1.5.3.4],
54   link:RelNotes-1.5.3.3.txt[1.5.3.3],
55   link:RelNotes-1.5.3.2.txt[1.5.3.2],
56   link:RelNotes-1.5.3.1.txt[1.5.3.1],
57   link:RelNotes-1.5.3.txt[1.5.3].
59 * release notes for
60   link:RelNotes-1.5.2.5.txt[1.5.2.5],
61   link:RelNotes-1.5.2.4.txt[1.5.2.4],
62   link:RelNotes-1.5.2.3.txt[1.5.2.3],
63   link:RelNotes-1.5.2.2.txt[1.5.2.2],
64   link:RelNotes-1.5.2.1.txt[1.5.2.1],
65   link:RelNotes-1.5.2.txt[1.5.2].
67 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
69 * release notes for
70   link:RelNotes-1.5.1.6.txt[1.5.1.6],
71   link:RelNotes-1.5.1.5.txt[1.5.1.5],
72   link:RelNotes-1.5.1.4.txt[1.5.1.4],
73   link:RelNotes-1.5.1.3.txt[1.5.1.3],
74   link:RelNotes-1.5.1.2.txt[1.5.1.2],
75   link:RelNotes-1.5.1.1.txt[1.5.1.1],
76   link:RelNotes-1.5.1.txt[1.5.1].
78 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
80 * release notes for
81   link:RelNotes-1.5.0.7.txt[1.5.0.7],
82   link:RelNotes-1.5.0.6.txt[1.5.0.6],
83   link:RelNotes-1.5.0.5.txt[1.5.0.5],
84   link:RelNotes-1.5.0.3.txt[1.5.0.3],
85   link:RelNotes-1.5.0.2.txt[1.5.0.2],
86   link:RelNotes-1.5.0.1.txt[1.5.0.1],
87   link:RelNotes-1.5.0.txt[1.5.0].
89 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
90   link:v1.3.3/git.html[1.3.3],
91   link:v1.2.6/git.html[1.2.6],
92   link:v1.0.13/git.html[1.0.13].
94 ============
96 endif::stalenotes[]
98 OPTIONS
99 -------
100 --version::
101         Prints the git suite version that the 'git' program came from.
103 --help::
104         Prints the synopsis and a list of the most commonly used
105         commands. If the option '--all' or '-a' is given then all
106         available commands are printed. If a git command is named this
107         option will bring up the manual page for that command.
109 Other options are available to control how the manual page is
110 displayed. See linkgit:git-help[1] for more information,
111 because 'git --help ...' is converted internally into 'git
112 help ...'.
114 --exec-path::
115         Path to wherever your core git programs are installed.
116         This can also be controlled by setting the GIT_EXEC_PATH
117         environment variable. If no path is given 'git' will print
118         the current setting and then exit.
120 -p|--paginate::
121         Pipe all output into 'less' (or if set, $PAGER).
123 --no-pager::
124         Do not pipe git output into a pager.
126 --git-dir=<path>::
127         Set the path to the repository. This can also be controlled by
128         setting the GIT_DIR environment variable.
130 --work-tree=<path>::
131         Set the path to the working tree.  The value will not be
132         used in combination with repositories found automatically in
133         a .git directory (i.e. $GIT_DIR is not set).
134         This can also be controlled by setting the GIT_WORK_TREE
135         environment variable and the core.worktree configuration
136         variable.
138 --bare::
139         Treat the repository as a bare repository.  If GIT_DIR
140         environment is not set, it is set to the current working
141         directory.
144 FURTHER DOCUMENTATION
145 ---------------------
147 See the references above to get started using git.  The following is
148 probably more detail than necessary for a first-time user.
150 The link:user-manual.html#git-concepts[git concepts chapter of the
151 user-manual] and the link:core-tutorial.html[Core tutorial] both provide
152 introductions to the underlying git architecture.
154 See also the link:howto-index.html[howto] documents for some useful
155 examples.
157 The internals are documented link:technical/api-index.html[here].
159 GIT COMMANDS
160 ------------
162 We divide git into high level ("porcelain") commands and low level
163 ("plumbing") commands.
165 High-level commands (porcelain)
166 -------------------------------
168 We separate the porcelain commands into the main commands and some
169 ancillary user utilities.
171 Main porcelain commands
172 ~~~~~~~~~~~~~~~~~~~~~~~
174 include::cmds-mainporcelain.txt[]
176 Ancillary Commands
177 ~~~~~~~~~~~~~~~~~~
178 Manipulators:
180 include::cmds-ancillarymanipulators.txt[]
182 Interrogators:
184 include::cmds-ancillaryinterrogators.txt[]
187 Interacting with Others
188 ~~~~~~~~~~~~~~~~~~~~~~~
190 These commands are to interact with foreign SCM and with other
191 people via patch over e-mail.
193 include::cmds-foreignscminterface.txt[]
196 Low-level commands (plumbing)
197 -----------------------------
199 Although git includes its
200 own porcelain layer, its low-level commands are sufficient to support
201 development of alternative porcelains.  Developers of such porcelains
202 might start by reading about linkgit:git-update-index[1] and
203 linkgit:git-read-tree[1].
205 The interface (input, output, set of options and the semantics)
206 to these low-level commands are meant to be a lot more stable
207 than Porcelain level commands, because these commands are
208 primarily for scripted use.  The interface to Porcelain commands
209 on the other hand are subject to change in order to improve the
210 end user experience.
212 The following description divides
213 the low-level commands into commands that manipulate objects (in
214 the repository, index, and working tree), commands that interrogate and
215 compare objects, and commands that move objects and references between
216 repositories.
219 Manipulation commands
220 ~~~~~~~~~~~~~~~~~~~~~
222 include::cmds-plumbingmanipulators.txt[]
225 Interrogation commands
226 ~~~~~~~~~~~~~~~~~~~~~~
228 include::cmds-plumbinginterrogators.txt[]
230 In general, the interrogate commands do not touch the files in
231 the working tree.
234 Synching repositories
235 ~~~~~~~~~~~~~~~~~~~~~
237 include::cmds-synchingrepositories.txt[]
239 The following are helper programs used by the above; end users
240 typically do not use them directly.
242 include::cmds-synchelpers.txt[]
245 Internal helper commands
246 ~~~~~~~~~~~~~~~~~~~~~~~~
248 These are internal helper commands used by other commands; end
249 users typically do not use them directly.
251 include::cmds-purehelpers.txt[]
254 Configuration Mechanism
255 -----------------------
257 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
258 is used to hold per-repository configuration options.  It is a
259 simple text file modeled after `.ini` format familiar to some
260 people.  Here is an example:
262 ------------
264 # A '#' or ';' character indicates a comment.
267 ; core variables
268 [core]
269         ; Don't trust file modes
270         filemode = false
272 ; user identity
273 [user]
274         name = "Junio C Hamano"
275         email = "junkio@twinsun.com"
277 ------------
279 Various commands read from the configuration file and adjust
280 their operation accordingly.
283 Identifier Terminology
284 ----------------------
285 <object>::
286         Indicates the object name for any type of object.
288 <blob>::
289         Indicates a blob object name.
291 <tree>::
292         Indicates a tree object name.
294 <commit>::
295         Indicates a commit object name.
297 <tree-ish>::
298         Indicates a tree, commit or tag object name.  A
299         command that takes a <tree-ish> argument ultimately wants to
300         operate on a <tree> object but automatically dereferences
301         <commit> and <tag> objects that point at a <tree>.
303 <commit-ish>::
304         Indicates a commit or tag object name.  A
305         command that takes a <commit-ish> argument ultimately wants to
306         operate on a <commit> object but automatically dereferences
307         <tag> objects that point at a <commit>.
309 <type>::
310         Indicates that an object type is required.
311         Currently one of: `blob`, `tree`, `commit`, or `tag`.
313 <file>::
314         Indicates a filename - almost always relative to the
315         root of the tree structure `GIT_INDEX_FILE` describes.
317 Symbolic Identifiers
318 --------------------
319 Any git command accepting any <object> can also use the following
320 symbolic notation:
322 HEAD::
323         indicates the head of the current branch (i.e. the
324         contents of `$GIT_DIR/HEAD`).
326 <tag>::
327         a valid tag 'name'
328         (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
330 <head>::
331         a valid head 'name'
332         (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
334 For a more complete list of ways to spell object names, see
335 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
338 File/Directory Structure
339 ------------------------
341 Please see the link:repository-layout.html[repository layout] document.
343 Read link:hooks.html[hooks] for more details about each hook.
345 Higher level SCMs may provide and manage additional information in the
346 `$GIT_DIR`.
349 Terminology
350 -----------
351 Please see the link:glossary.html[glossary] document.
354 Environment Variables
355 ---------------------
356 Various git commands use the following environment variables:
358 The git Repository
359 ~~~~~~~~~~~~~~~~~~
360 These environment variables apply to 'all' core git commands. Nb: it
361 is worth noting that they may be used/overridden by SCMS sitting above
362 git so take care if using Cogito etc.
364 'GIT_INDEX_FILE'::
365         This environment allows the specification of an alternate
366         index file. If not specified, the default of `$GIT_DIR/index`
367         is used.
369 'GIT_OBJECT_DIRECTORY'::
370         If the object storage directory is specified via this
371         environment variable then the sha1 directories are created
372         underneath - otherwise the default `$GIT_DIR/objects`
373         directory is used.
375 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
376         Due to the immutable nature of git objects, old objects can be
377         archived into shared, read-only directories. This variable
378         specifies a ":" separated list of git object directories which
379         can be used to search for git objects. New objects will not be
380         written to these directories.
382 'GIT_DIR'::
383         If the 'GIT_DIR' environment variable is set then it
384         specifies a path to use instead of the default `.git`
385         for the base of the repository.
387 'GIT_WORK_TREE'::
388         Set the path to the working tree.  The value will not be
389         used in combination with repositories found automatically in
390         a .git directory (i.e. $GIT_DIR is not set).
391         This can also be controlled by the '--work-tree' command line
392         option and the core.worktree configuration variable.
394 git Commits
395 ~~~~~~~~~~~
396 'GIT_AUTHOR_NAME'::
397 'GIT_AUTHOR_EMAIL'::
398 'GIT_AUTHOR_DATE'::
399 'GIT_COMMITTER_NAME'::
400 'GIT_COMMITTER_EMAIL'::
401 'GIT_COMMITTER_DATE'::
402 'EMAIL'::
403         see linkgit:git-commit-tree[1]
405 git Diffs
406 ~~~~~~~~~
407 'GIT_DIFF_OPTS'::
408         Only valid setting is "--unified=??" or "-u??" to set the
409         number of context lines shown when a unified diff is created.
410         This takes precedence over any "-U" or "--unified" option
411         value passed on the git diff command line.
413 'GIT_EXTERNAL_DIFF'::
414         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
415         program named by it is called, instead of the diff invocation
416         described above.  For a path that is added, removed, or modified,
417         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
419         path old-file old-hex old-mode new-file new-hex new-mode
421 where:
423         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
424                          contents of <old|new>,
425         <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
426         <old|new>-mode:: are the octal representation of the file modes.
429 The file parameters can point at the user's working file
430 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
431 when a new file is added), or a temporary file (e.g. `old-file` in the
432 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
433 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
435 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
436 parameter, <path>.
438 other
439 ~~~~~
440 'GIT_MERGE_VERBOSITY'::
441         A number controlling the amount of output shown by
442         the recursive merge strategy.  Overrides merge.verbosity.
443         See linkgit:git-merge[1]
445 'GIT_PAGER'::
446         This environment variable overrides `$PAGER`. If it is set
447         to an empty string or to the value "cat", git will not launch
448         a pager.
450 'GIT_SSH'::
451         If this environment variable is set then linkgit:git-fetch[1]
452         and linkgit:git-push[1] will use this command instead
453         of `ssh` when they need to connect to a remote system.
454         The 'GIT_SSH' command will be given exactly two arguments:
455         the 'username@host' (or just 'host') from the URL and the
456         shell command to execute on that remote system.
458 To pass options to the program that you want to list in GIT_SSH
459 you will need to wrap the program and options into a shell script,
460 then set GIT_SSH to refer to the shell script.
462 Usually it is easier to configure any desired options through your
463 personal `.ssh/config` file.  Please consult your ssh documentation
464 for further details.
466 'GIT_FLUSH'::
467         If this environment variable is set to "1", then commands such
468         as git-blame (in incremental mode), git-rev-list, git-log,
469         git-whatchanged, etc., will force a flush of the output stream
470         after each commit-oriented record have been flushed.   If this
471         variable is set to "0", the output of these commands will be done
472         using completely buffered I/O.   If this environment variable is
473         not set, git will choose buffered or record-oriented flushing
474         based on whether stdout appears to be redirected to a file or not.
476 'GIT_TRACE'::
477         If this variable is set to "1", "2" or "true" (comparison
478         is case insensitive), git will print `trace:` messages on
479         stderr telling about alias expansion, built-in command
480         execution and external command execution.
481         If this variable is set to an integer value greater than 1
482         and lower than 10 (strictly) then git will interpret this
483         value as an open file descriptor and will try to write the
484         trace messages into this file descriptor.
485         Alternatively, if this variable is set to an absolute path
486         (starting with a '/' character), git will interpret this
487         as a file path and will try to write the trace messages
488         into it.
490 Discussion[[Discussion]]
491 ------------------------
493 More detail on the following is available from the
494 link:user-manual.html#git-concepts[git concepts chapter of the
495 user-manual] and the link:core-tutorial.html[Core tutorial].
497 A git project normally consists of a working directory with a ".git"
498 subdirectory at the top level.  The .git directory contains, among other
499 things, a compressed object database representing the complete history
500 of the project, an "index" file which links that history to the current
501 contents of the working tree, and named pointers into that history such
502 as tags and branch heads.
504 The object database contains objects of three main types: blobs, which
505 hold file data; trees, which point to blobs and other trees to build up
506 directory hierarchies; and commits, which each reference a single tree
507 and some number of parent commits.
509 The commit, equivalent to what other systems call a "changeset" or
510 "version", represents a step in the project's history, and each parent
511 represents an immediately preceding step.  Commits with more than one
512 parent represent merges of independent lines of development.
514 All objects are named by the SHA1 hash of their contents, normally
515 written as a string of 40 hex digits.  Such names are globally unique.
516 The entire history leading up to a commit can be vouched for by signing
517 just that commit.  A fourth object type, the tag, is provided for this
518 purpose.
520 When first created, objects are stored in individual files, but for
521 efficiency may later be compressed together into "pack files".
523 Named pointers called refs mark interesting points in history.  A ref
524 may contain the SHA1 name of an object or the name of another ref.  Refs
525 with names beginning `ref/head/` contain the SHA1 name of the most
526 recent commit (or "head") of a branch under development.  SHA1 names of
527 tags of interest are stored under `ref/tags/`.  A special ref named
528 `HEAD` contains the name of the currently checked-out branch.
530 The index file is initialized with a list of all paths and, for each
531 path, a blob object and a set of attributes.  The blob object represents
532 the contents of the file as of the head of the current branch.  The
533 attributes (last modified time, size, etc.) are taken from the
534 corresponding file in the working tree.  Subsequent changes to the
535 working tree can be found by comparing these attributes.  The index may
536 be updated with new content, and new commits may be created from the
537 content stored in the index.
539 The index is also capable of storing multiple entries (called "stages")
540 for a given pathname.  These stages are used to hold the various
541 unmerged version of a file when a merge is in progress.
543 Authors
544 -------
545 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
546 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
547 * The git potty was written by Andreas Ericsson <ae@op5.se>.
548 * General upbringing is handled by the git-list <git@vger.kernel.org>.
550 Documentation
551 --------------
552 The documentation for git suite was started by David Greaves
553 <david@dgreaves.com>, and later enhanced greatly by the
554 contributors on the git-list <git@vger.kernel.org>.
558 Part of the linkgit:git[7] suite