6 git - the stupid content tracker
12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate]
13 [--bare] [--git-dir=GIT_DIR] [--help] COMMAND [ARGS]
17 Git is a fast, scalable, distributed revision control system with an
18 unusually rich command set that provides both high-level operations
19 and full access to internals.
21 See this link:tutorial.html[tutorial] to get started, then see
22 link:everyday.html[Everyday Git] for a useful minimum set of commands, and
23 "man git-commandname" for documentation of each command. CVS users may
24 also want to read link:cvs-migration.html[CVS migration]. See
25 link:user-manual.html[Git User's Manual] for a more in-depth
28 The COMMAND is either a name of a Git command (see below) or an alias
29 as defined in the configuration file (see gitlink:git-config[1]).
31 Formatted and hyperlinked version of the latest git
32 documentation can be viewed at
33 `http://www.kernel.org/pub/software/scm/git/docs/`.
38 You are reading the documentation for the latest version of git.
39 Documentation for older releases are available here:
41 * link:RelNotes-1.5.1.txt[release notes for 1.5.1]
43 * link:v1.5.1.5/git.html[documentation for release 1.5.1.5]
45 * link:RelNotes-1.5.1.5.txt[release notes for 1.5.1.5]
47 * link:RelNotes-1.5.1.4.txt[release notes for 1.5.1.4]
49 * link:RelNotes-1.5.1.3.txt[release notes for 1.5.1.3]
51 * link:RelNotes-1.5.1.2.txt[release notes for 1.5.1.2]
53 * link:RelNotes-1.5.1.1.txt[release notes for 1.5.1.1]
55 * link:RelNotes-1.5.0.7.txt[release notes for 1.5.0.7]
57 * link:RelNotes-1.5.0.6.txt[release notes for 1.5.0.6]
59 * link:RelNotes-1.5.0.5.txt[release notes for 1.5.0.5]
61 * link:RelNotes-1.5.0.3.txt[release notes for 1.5.0.3]
63 * link:RelNotes-1.5.0.2.txt[release notes for 1.5.0.2]
65 * link:RelNotes-1.5.0.1.txt[release notes for 1.5.0.1]
67 * link:RelNotes-1.5.0.txt[release notes for 1.5.0]
69 * link:v1.4.4.4/git.html[documentation for release 1.4.4.4]
71 * link:v1.3.3/git.html[documentation for release 1.3.3]
73 * link:v1.2.6/git.html[documentation for release 1.2.6]
75 * link:v1.0.13/git.html[documentation for release 1.0.13]
84 Prints the git suite version that the 'git' program came from.
87 Prints the synopsis and a list of the most commonly used
88 commands. If a git command is named this option will bring up
89 the man-page for that command. If the option '--all' or '-a' is
90 given then all available commands are printed.
93 Path to wherever your core git programs are installed.
94 This can also be controlled by setting the GIT_EXEC_PATH
95 environment variable. If no path is given 'git' will print
96 the current setting and then exit.
99 Pipe all output into 'less' (or if set, $PAGER).
102 Set the path to the repository. This can also be controlled by
103 setting the GIT_DIR environment variable.
106 Same as --git-dir=`pwd`.
108 FURTHER DOCUMENTATION
109 ---------------------
111 See the references above to get started using git. The following is
112 probably more detail than necessary for a first-time user.
114 The <<Discussion,Discussion>> section below and the
115 link:core-tutorial.html[Core tutorial] both provide introductions to the
116 underlying git architecture.
118 See also the link:howto-index.html[howto] documents for some useful
124 We divide git into high level ("porcelain") commands and low level
125 ("plumbing") commands.
127 High-level commands (porcelain)
128 -------------------------------
130 We separate the porcelain commands into the main commands and some
131 ancillary user utilities.
133 Main porcelain commands
134 ~~~~~~~~~~~~~~~~~~~~~~~
136 include::cmds-mainporcelain.txt[]
142 include::cmds-ancillarymanipulators.txt[]
146 include::cmds-ancillaryinterrogators.txt[]
149 Interacting with Others
150 ~~~~~~~~~~~~~~~~~~~~~~~
152 These commands are to interact with foreign SCM and with other
153 people via patch over e-mail.
155 include::cmds-foreignscminterface.txt[]
158 Low-level commands (plumbing)
159 -----------------------------
161 Although git includes its
162 own porcelain layer, its low-level commands are sufficient to support
163 development of alternative porcelains. Developers of such porcelains
164 might start by reading about gitlink:git-update-index[1] and
165 gitlink:git-read-tree[1].
167 The interface (input, output, set of options and the semantics)
168 to these low-level commands are meant to be a lot more stable
169 than Porcelain level commands, because these commands are
170 primarily for scripted use. The interface to Porcelain commands
171 on the other hand are subject to change in order to improve the
174 The following description divides
175 the low-level commands into commands that manipulate objects (in
176 the repository, index, and working tree), commands that interrogate and
177 compare objects, and commands that move objects and references between
181 Manipulation commands
182 ~~~~~~~~~~~~~~~~~~~~~
184 include::cmds-plumbingmanipulators.txt[]
187 Interrogation commands
188 ~~~~~~~~~~~~~~~~~~~~~~
190 include::cmds-plumbinginterrogators.txt[]
192 In general, the interrogate commands do not touch the files in
196 Synching repositories
197 ~~~~~~~~~~~~~~~~~~~~~
199 include::cmds-synchingrepositories.txt[]
201 The following are helper programs used by the above; end users
202 typically do not use them directly.
204 include::cmds-synchelpers.txt[]
207 Internal helper commands
208 ~~~~~~~~~~~~~~~~~~~~~~~~
210 These are internal helper commands used by other commands; end
211 users typically do not use them directly.
213 include::cmds-purehelpers.txt[]
216 Configuration Mechanism
217 -----------------------
219 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
220 is used to hold per-repository configuration options. It is a
221 simple text file modeled after `.ini` format familiar to some
222 people. Here is an example:
226 # A '#' or ';' character indicates a comment.
231 ; Don't trust file modes
236 name = "Junio C Hamano"
237 email = "junkio@twinsun.com"
241 Various commands read from the configuration file and adjust
242 their operation accordingly.
245 Identifier Terminology
246 ----------------------
248 Indicates the object name for any type of object.
251 Indicates a blob object name.
254 Indicates a tree object name.
257 Indicates a commit object name.
260 Indicates a tree, commit or tag object name. A
261 command that takes a <tree-ish> argument ultimately wants to
262 operate on a <tree> object but automatically dereferences
263 <commit> and <tag> objects that point at a <tree>.
266 Indicates a commit or tag object name. A
267 command that takes a <commit-ish> argument ultimately wants to
268 operate on a <commit> object but automatically dereferences
269 <tag> objects that point at a <commit>.
272 Indicates that an object type is required.
273 Currently one of: `blob`, `tree`, `commit`, or `tag`.
276 Indicates a filename - almost always relative to the
277 root of the tree structure `GIT_INDEX_FILE` describes.
281 Any git command accepting any <object> can also use the following
285 indicates the head of the current branch (i.e. the
286 contents of `$GIT_DIR/HEAD`).
290 (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
294 (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
296 For a more complete list of ways to spell object names, see
297 "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
300 File/Directory Structure
301 ------------------------
303 Please see link:repository-layout.html[repository layout] document.
305 Read link:hooks.html[hooks] for more details about each hook.
307 Higher level SCMs may provide and manage additional information in the
313 Please see link:glossary.html[glossary] document.
316 Environment Variables
317 ---------------------
318 Various git commands use the following environment variables:
322 These environment variables apply to 'all' core git commands. Nb: it
323 is worth noting that they may be used/overridden by SCMS sitting above
324 git so take care if using Cogito etc.
327 This environment allows the specification of an alternate
328 index file. If not specified, the default of `$GIT_DIR/index`
331 'GIT_OBJECT_DIRECTORY'::
332 If the object storage directory is specified via this
333 environment variable then the sha1 directories are created
334 underneath - otherwise the default `$GIT_DIR/objects`
337 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
338 Due to the immutable nature of git objects, old objects can be
339 archived into shared, read-only directories. This variable
340 specifies a ":" separated list of git object directories which
341 can be used to search for git objects. New objects will not be
342 written to these directories.
345 If the 'GIT_DIR' environment variable is set then it
346 specifies a path to use instead of the default `.git`
347 for the base of the repository.
354 'GIT_COMMITTER_NAME'::
355 'GIT_COMMITTER_EMAIL'::
356 'GIT_COMMITTER_DATE'::
358 see gitlink:git-commit-tree[1]
363 Only valid setting is "--unified=??" or "-u??" to set the
364 number of context lines shown when a unified diff is created.
365 This takes precedence over any "-U" or "--unified" option
366 value passed on the git diff command line.
368 'GIT_EXTERNAL_DIFF'::
369 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
370 program named by it is called, instead of the diff invocation
371 described above. For a path that is added, removed, or modified,
372 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
374 path old-file old-hex old-mode new-file new-hex new-mode
378 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
379 contents of <old|new>,
380 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
381 <old|new>-mode:: are the octal representation of the file modes.
384 The file parameters can point at the user's working file
385 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
386 when a new file is added), or a temporary file (e.g. `old-file` in the
387 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
388 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
390 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
396 This environment variable overrides `$PAGER`.
399 If this variable is set to "1", "2" or "true" (comparison
400 is case insensitive), git will print `trace:` messages on
401 stderr telling about alias expansion, built-in command
402 execution and external command execution.
403 If this variable is set to an integer value greater than 1
404 and lower than 10 (strictly) then git will interpret this
405 value as an open file descriptor and will try to write the
406 trace messages into this file descriptor.
407 Alternatively, if this variable is set to an absolute path
408 (starting with a '/' character), git will interpret this
409 as a file path and will try to write the trace messages
412 Discussion[[Discussion]]
413 ------------------------
414 include::core-intro.txt[]
418 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
419 * The current git nurse is Junio C Hamano <junkio@cox.net>.
420 * The git potty was written by Andres Ericsson <ae@op5.se>.
421 * General upbringing is handled by the git-list <git@vger.kernel.org>.
425 The documentation for git suite was started by David Greaves
426 <david@dgreaves.com>, and later enhanced greatly by the
427 contributors on the git-list <git@vger.kernel.org>.
431 Part of the gitlink:git[7] suite