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