Google Git
Sign in
chromium / external / gitster / git-htmldocs / 55295990d1f243a3d284fd822a43502b41566cb7 / . / git.html
blob: eaed1a77ec37b396115667a9b8b0cf41b02d308e [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]83 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]164
165div.attribution {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]214div.olist2 ol {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]306</style>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]307<title>git(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]308</head>
309<body>
310<div id="header">
311<h1>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]312git(1) Manual Page
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git -
317 the stupid content tracker
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamano6b2cee12006-08-26 08:43:31[diff] [blame]323<div class="verseblock">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]324<div class="content"><em>git</em> [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
Junio C Hamanocae86272007-08-21 02:20:49[diff] [blame]325 [-p|--paginate|--no-pager]
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]326 [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
327 [--help] COMMAND [ARGS]</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]328</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]329<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]330<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]331<div class="para"><p>Git is a fast, scalable, distributed revision control system with an
Junio C Hamanoe27fb932006-04-03 05:34:10[diff] [blame]332unusually rich command set that provides both high-level operations
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]333and full access to internals.</p></div>
334<div class="para"><p>See <a href="gittutorial.html">gittutorial(7)</a> to get started, then see
Junio C Hamanoe27fb932006-04-03 05:34:10[diff] [blame]335<a href="everyday.html">Everyday Git</a> for a useful minimum set of commands, and
336"man git-commandname" for documentation of each command. CVS users may
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]337also want to read <a href="gitcvs-migration.html">gitcvs-migration(7)</a>. See
338the <a href="user-manual.html">Git User's Manual</a> for a more in-depth
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]339introduction.</p></div>
340<div class="para"><p>The COMMAND is either a name of a Git command (see below) or an alias
341as defined in the configuration file (see <a href="git-config.html">git-config(1)</a>).</p></div>
342<div class="para"><p>Formatted and hyperlinked version of the latest git
Junio C Hamanob63afff2007-05-01 03:05:55[diff] [blame]343documentation can be viewed at
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]344<tt>http://www.kernel.org/pub/software/scm/git/docs/</tt>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]345</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]347<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]348<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]349<dt>
350--version
351</dt>
352<dd>
353<p>
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]354 Prints the git suite version that the <em>git</em> program came from.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]355</p>
356</dd>
357<dt>
358--help
359</dt>
360<dd>
361<p>
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]362 Prints the synopsis and a list of the most commonly used
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]363 commands. If the option <em>--all</em> or <em>-a</em> is given then all
364 available commands are printed. If a git command is named this
365 option will bring up the manual page for that command.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]366</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]367<div class="para"><p>Other options are available to control how the manual page is
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]368displayed. See <a href="git-help.html">git-help(1)</a> for more information,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]369because <tt>git --help &#8230;</tt> is converted internally into <tt>git
370help &#8230;</tt>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]371</dd>
372<dt>
373--exec-path
374</dt>
375<dd>
376<p>
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]377 Path to wherever your core git programs are installed.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]378 This can also be controlled by setting the GIT_EXEC_PATH
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]379 environment variable. If no path is given, <em>git</em> will print
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]380 the current setting and then exit.
381</p>
382</dd>
Junio C Hamanof870ef82006-07-29 09:10:13[diff] [blame]383<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]384--html-path
385</dt>
386<dd>
387<p>
388 Print the path to wherever your git HTML documentation is installed
389 and exit.
390</p>
391</dd>
392<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]393-p
394</dt>
395<dt>
396--paginate
Junio C Hamanof870ef82006-07-29 09:10:13[diff] [blame]397</dt>
398<dd>
399<p>
400 Pipe all output into <em>less</em> (or if set, $PAGER).
401</p>
402</dd>
403<dt>
Junio C Hamanocae86272007-08-21 02:20:49[diff] [blame]404--no-pager
405</dt>
406<dd>
407<p>
408 Do not pipe git output into a pager.
409</p>
410</dd>
411<dt>
Junio C Hamanof870ef82006-07-29 09:10:13[diff] [blame]412--git-dir=&lt;path&gt;
413</dt>
414<dd>
415<p>
416 Set the path to the repository. This can also be controlled by
Junio C Hamano7d575a52008-04-30 08:45:27[diff] [blame]417 setting the GIT_DIR environment variable. It can be an absolute
418 path or relative path to current working directory.
Junio C Hamanof870ef82006-07-29 09:10:13[diff] [blame]419</p>
420</dd>
421<dt>
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]422--work-tree=&lt;path&gt;
423</dt>
424<dd>
425<p>
426 Set the path to the working tree. The value will not be
427 used in combination with repositories found automatically in
428 a .git directory (i.e. $GIT_DIR is not set).
429 This can also be controlled by setting the GIT_WORK_TREE
430 environment variable and the core.worktree configuration
Junio C Hamano7d575a52008-04-30 08:45:27[diff] [blame]431 variable. It can be an absolute path or relative path to
432 the directory specified by --git-dir or GIT_DIR.
433 Note: If --git-dir or GIT_DIR are specified but none of
434 --work-tree, GIT_WORK_TREE and core.worktree is specified,
435 the current working directory is regarded as the top directory
436 of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]437</p>
438</dd>
439<dt>
Junio C Hamanof870ef82006-07-29 09:10:13[diff] [blame]440--bare
441</dt>
442<dd>
443<p>
Junio C Hamanoc435b1c2007-08-28 06:25:35[diff] [blame]444 Treat the repository as a bare repository. If GIT_DIR
445 environment is not set, it is set to the current working
446 directory.
Junio C Hamanof870ef82006-07-29 09:10:13[diff] [blame]447</p>
448</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]449</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]450</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]451<h2 id="_further_documentation">FURTHER DOCUMENTATION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]452<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]453<div class="para"><p>See the references above to get started using git. The following is
454probably more detail than necessary for a first-time user.</p></div>
455<div class="para"><p>The <a href="user-manual.html#git-concepts">git concepts chapter of the
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]456user-manual</a> and <a href="gitcore-tutorial.html">gitcore-tutorial(7)</a> both provide
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]457introductions to the underlying git architecture.</p></div>
Junio C Hamano804b5212009-06-07 16:05:03[diff] [blame]458<div class="para"><p>See <a href="gitworkflows.html">gitworkflows(7)</a> for an overview of recommended workflows.</p></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]459<div class="para"><p>See also the <a href="howto-index.html">howto</a> documents for some useful
460examples.</p></div>
461<div class="para"><p>The internals are documented in the
462<a href="technical/api-index.html">GIT API documentation</a>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]463</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]464<h2 id="_git_commands">GIT COMMANDS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]465<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]466<div class="para"><p>We divide git into high level ("porcelain") commands and low level
467("plumbing") commands.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]468</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]469<h2 id="_high_level_commands_porcelain">High-level commands (porcelain)</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]470<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]471<div class="para"><p>We separate the porcelain commands into the main commands and some
472ancillary user utilities.</p></div>
473<h3 id="_main_porcelain_commands">Main porcelain commands</h3><div style="clear:left"></div>
474<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]475<dt>
476<a href="git-add.html">git-add(1)</a>
477</dt>
478<dd>
479<p>
Junio C Hamano4cd1c0e2007-08-06 04:39:14[diff] [blame]480 Add file contents to the index.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]481</p>
482</dd>
483<dt>
484<a href="git-am.html">git-am(1)</a>
485</dt>
486<dd>
487<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]488 Apply a series of patches from a mailbox.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]489</p>
490</dd>
491<dt>
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]492<a href="git-archive.html">git-archive(1)</a>
493</dt>
494<dd>
495<p>
Junio C Hamano4ec06712007-06-09 20:39:33[diff] [blame]496 Create an archive of files from a named tree.
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]497</p>
498</dd>
499<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]500<a href="git-bisect.html">git-bisect(1)</a>
501</dt>
502<dd>
503<p>
Junio C Hamanofd83b8e2009-03-22 08:21:41[diff] [blame]504 Find by binary search the change that introduced a bug.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]505</p>
506</dd>
507<dt>
508<a href="git-branch.html">git-branch(1)</a>
509</dt>
510<dd>
511<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]512 List, create, or delete branches.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]513</p>
514</dd>
515<dt>
Junio C Hamano6ac2f142007-03-01 01:24:56[diff] [blame]516<a href="git-bundle.html">git-bundle(1)</a>
517</dt>
518<dd>
519<p>
520 Move objects and refs by archive.
521</p>
522</dd>
523<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]524<a href="git-checkout.html">git-checkout(1)</a>
525</dt>
526<dd>
527<p>
Junio C Hamanoa14a4032008-03-25 09:11:02[diff] [blame]528 Checkout a branch or paths to the working tree.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]529</p>
530</dd>
531<dt>
532<a href="git-cherry-pick.html">git-cherry-pick(1)</a>
533</dt>
534<dd>
535<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]536 Apply the change introduced by an existing commit.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]537</p>
538</dd>
539<dt>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]540<a href="git-citool.html">git-citool(1)</a>
541</dt>
542<dd>
543<p>
544 Graphical alternative to git-commit.
545</p>
546</dd>
547<dt>
Junio C Hamano54559c82006-04-13 07:45:12[diff] [blame]548<a href="git-clean.html">git-clean(1)</a>
549</dt>
550<dd>
551<p>
552 Remove untracked files from the working tree.
553</p>
554</dd>
555<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]556<a href="git-clone.html">git-clone(1)</a>
557</dt>
558<dd>
559<p>
Junio C Hamano4ec06712007-06-09 20:39:33[diff] [blame]560 Clone a repository into a new directory.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]561</p>
562</dd>
563<dt>
564<a href="git-commit.html">git-commit(1)</a>
565</dt>
566<dd>
567<p>
568 Record changes to the repository.
569</p>
570</dd>
571<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]572<a href="git-describe.html">git-describe(1)</a>
573</dt>
574<dd>
575<p>
576 Show the most recent tag that is reachable from a commit.
577</p>
578</dd>
579<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]580<a href="git-diff.html">git-diff(1)</a>
581</dt>
582<dd>
583<p>
584 Show changes between commits, commit and working tree, etc.
585</p>
586</dd>
587<dt>
588<a href="git-fetch.html">git-fetch(1)</a>
589</dt>
590<dd>
591<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]592 Download objects and refs from another repository.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]593</p>
594</dd>
595<dt>
596<a href="git-format-patch.html">git-format-patch(1)</a>
597</dt>
598<dd>
599<p>
600 Prepare patches for e-mail submission.
601</p>
602</dd>
603<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]604<a href="git-gc.html">git-gc(1)</a>
605</dt>
606<dd>
607<p>
608 Cleanup unnecessary files and optimize the local repository.
609</p>
610</dd>
611<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]612<a href="git-grep.html">git-grep(1)</a>
613</dt>
614<dd>
615<p>
616 Print lines matching a pattern.
617</p>
618</dd>
619<dt>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]620<a href="git-gui.html">git-gui(1)</a>
621</dt>
622<dd>
623<p>
624 A portable graphical interface to Git.
625</p>
626</dd>
627<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]628<a href="git-init.html">git-init(1)</a>
629</dt>
630<dd>
631<p>
632 Create an empty git repository or reinitialize an existing one.
633</p>
634</dd>
635<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]636<a href="git-log.html">git-log(1)</a>
637</dt>
638<dd>
639<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]640 Show commit logs.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]641</p>
642</dd>
643<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]644<a href="git-merge.html">git-merge(1)</a>
645</dt>
646<dd>
647<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]648 Join two or more development histories together.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]649</p>
650</dd>
651<dt>
652<a href="git-mv.html">git-mv(1)</a>
653</dt>
654<dd>
655<p>
656 Move or rename a file, a directory, or a symlink.
657</p>
658</dd>
659<dt>
660<a href="git-pull.html">git-pull(1)</a>
661</dt>
662<dd>
663<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]664 Fetch from and merge with another repository or a local branch.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]665</p>
666</dd>
667<dt>
668<a href="git-push.html">git-push(1)</a>
669</dt>
670<dd>
671<p>
672 Update remote refs along with associated objects.
673</p>
674</dd>
675<dt>
676<a href="git-rebase.html">git-rebase(1)</a>
677</dt>
678<dd>
679<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]680 Forward-port local commits to the updated upstream head.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]681</p>
682</dd>
683<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]684<a href="git-reset.html">git-reset(1)</a>
685</dt>
686<dd>
687<p>
688 Reset current HEAD to the specified state.
689</p>
690</dd>
691<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]692<a href="git-revert.html">git-revert(1)</a>
693</dt>
694<dd>
695<p>
696 Revert an existing commit.
697</p>
698</dd>
699<dt>
Junio C Hamano54559c82006-04-13 07:45:12[diff] [blame]700<a href="git-rm.html">git-rm(1)</a>
701</dt>
702<dd>
703<p>
704 Remove files from the working tree and from the index.
705</p>
706</dd>
707<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]708<a href="git-shortlog.html">git-shortlog(1)</a>
709</dt>
710<dd>
711<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]712 Summarize <em>git-log</em> output.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]713</p>
714</dd>
715<dt>
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]716<a href="git-show.html">git-show(1)</a>
717</dt>
718<dd>
719<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]720 Show various types of objects.
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]721</p>
722</dd>
723<dt>
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]724<a href="git-stash.html">git-stash(1)</a>
725</dt>
726<dd>
727<p>
728 Stash the changes in a dirty working directory away.
729</p>
730</dd>
731<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]732<a href="git-status.html">git-status(1)</a>
733</dt>
734<dd>
735<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]736 Show the working tree status.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]737</p>
738</dd>
739<dt>
Junio C Hamano38b693c2007-06-03 08:40:14[diff] [blame]740<a href="git-submodule.html">git-submodule(1)</a>
741</dt>
742<dd>
743<p>
744 Initialize, update or inspect submodules.
745</p>
746</dd>
747<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]748<a href="git-tag.html">git-tag(1)</a>
749</dt>
750<dd>
751<p>
Junio C Hamanodb450ba2007-01-21 08:57:14[diff] [blame]752 Create, list, delete or verify a tag object signed with GPG.
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]753</p>
754</dd>
Junio C Hamano0a16b952007-12-02 18:56:34[diff] [blame]755<dt>
756<a href="gitk.html">gitk(1)</a>
757</dt>
758<dd>
759<p>
760 The git repository browser.
761</p>
762</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]763</dl></div>
764<h3 id="_ancillary_commands">Ancillary Commands</h3><div style="clear:left"></div>
765<div class="para"><p>Manipulators:</p></div>
766<div class="vlist"><dl>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]767<dt>
Junio C Hamanob1d6e882007-08-11 08:30:16[diff] [blame]768<a href="git-config.html">git-config(1)</a>
769</dt>
770<dd>
771<p>
772 Get and set repository or global options.
773</p>
774</dd>
775<dt>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]776<a href="git-fast-export.html">git-fast-export(1)</a>
777</dt>
778<dd>
779<p>
780 Git data exporter.
781</p>
782</dd>
783<dt>
Junio C Hamanodfc4ce72007-02-07 23:17:29[diff] [blame]784<a href="git-fast-import.html">git-fast-import(1)</a>
785</dt>
786<dd>
787<p>
Junio C Hamano053827f2007-02-14 07:23:58[diff] [blame]788 Backend for fast Git data importers.
Junio C Hamanodfc4ce72007-02-07 23:17:29[diff] [blame]789</p>
790</dd>
791<dt>
Junio C Hamanobb0f4042007-07-04 06:41:40[diff] [blame]792<a href="git-filter-branch.html">git-filter-branch(1)</a>
793</dt>
794<dd>
795<p>
796 Rewrite branches.
797</p>
798</dd>
799<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]800<a href="git-lost-found.html">git-lost-found(1)</a>
801</dt>
802<dd>
803<p>
Junio C Hamano2d7f0272007-11-09 10:03:46[diff] [blame]804 (deprecated) Recover lost refs that luckily have not yet been pruned.
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]805</p>
806</dd>
807<dt>
Junio C Hamano103ad7f2007-03-14 11:19:26[diff] [blame]808<a href="git-mergetool.html">git-mergetool(1)</a>
809</dt>
810<dd>
811<p>
812 Run merge conflict resolution tools to resolve merge conflicts.
813</p>
814</dd>
815<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]816<a href="git-pack-refs.html">git-pack-refs(1)</a>
817</dt>
818<dd>
819<p>
820 Pack heads and tags for efficient repository access.
821</p>
822</dd>
823<dt>
824<a href="git-prune.html">git-prune(1)</a>
825</dt>
826<dd>
827<p>
Junio C Hamano4ec06712007-06-09 20:39:33[diff] [blame]828 Prune all unreachable objects from the object database.
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]829</p>
830</dd>
831<dt>
832<a href="git-reflog.html">git-reflog(1)</a>
833</dt>
834<dd>
835<p>
836 Manage reflog information.
837</p>
838</dd>
839<dt>
840<a href="git-relink.html">git-relink(1)</a>
841</dt>
842<dd>
843<p>
844 Hardlink common objects in local repositories.
845</p>
846</dd>
847<dt>
Junio C Hamano053827f2007-02-14 07:23:58[diff] [blame]848<a href="git-remote.html">git-remote(1)</a>
849</dt>
850<dd>
851<p>
852 manage set of tracked repositories.
853</p>
854</dd>
Junio C Hamanob1d6e882007-08-11 08:30:16[diff] [blame]855<dt>
856<a href="git-repack.html">git-repack(1)</a>
857</dt>
858<dd>
859<p>
860 Pack unpacked objects in a repository.
861</p>
862</dd>
Junio C Hamanobe621892008-01-18 10:20:16[diff] [blame]863<dt>
Junio C Hamano55295992009-10-13 09:06:33[diff] [blame^]864<a href="git-replace.html">git-replace(1)</a>
865</dt>
866<dd>
867<p>
868 Create, list, delete refs to replace objects.
869</p>
870</dd>
871<dt>
Junio C Hamanobe621892008-01-18 10:20:16[diff] [blame]872<a href="git-repo-config.html">git-repo-config(1)</a>
873</dt>
874<dd>
875<p>
876 (deprecated) Get and set repository or global options.
877</p>
878</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]879</dl></div>
880<div class="para"><p>Interrogators:</p></div>
881<div class="vlist"><dl>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]882<dt>
883<a href="git-annotate.html">git-annotate(1)</a>
884</dt>
885<dd>
886<p>
Junio C Hamano7924d5e2009-03-03 08:28:48[diff] [blame]887 Annotate file lines with commit information.
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]888</p>
889</dd>
890<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]891<a href="git-blame.html">git-blame(1)</a>
892</dt>
893<dd>
894<p>
895 Show what revision and author last modified each line of a file.
896</p>
897</dd>
898<dt>
899<a href="git-cherry.html">git-cherry(1)</a>
900</dt>
901<dd>
902<p>
903 Find commits not merged upstream.
904</p>
905</dd>
906<dt>
907<a href="git-count-objects.html">git-count-objects(1)</a>
908</dt>
909<dd>
910<p>
911 Count unpacked number of objects and their disk consumption.
912</p>
913</dd>
914<dt>
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]915<a href="git-difftool.html">git-difftool(1)</a>
916</dt>
917<dd>
918<p>
919 Show changes using common diff tools.
920</p>
921</dd>
922<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48[diff] [blame]923<a href="git-fsck.html">git-fsck(1)</a>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]924</dt>
925<dd>
926<p>
927 Verifies the connectivity and validity of the objects in the database.
928</p>
929</dd>
930<dt>
931<a href="git-get-tar-commit-id.html">git-get-tar-commit-id(1)</a>
932</dt>
933<dd>
934<p>
Junio C Hamano393e57f2007-11-20 04:53:25[diff] [blame]935 Extract commit ID from an archive created using git-archive.
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]936</p>
937</dd>
938<dt>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]939<a href="git-help.html">git-help(1)</a>
940</dt>
941<dd>
942<p>
943 display help information about git.
944</p>
945</dd>
946<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]947<a href="git-instaweb.html">git-instaweb(1)</a>
948</dt>
949<dd>
950<p>
951 Instantly browse your working repository in gitweb.
952</p>
953</dd>
954<dt>
955<a href="git-merge-tree.html">git-merge-tree(1)</a>
956</dt>
957<dd>
958<p>
959 Show three-way merge without touching index.
960</p>
961</dd>
962<dt>
963<a href="git-rerere.html">git-rerere(1)</a>
964</dt>
965<dd>
966<p>
967 Reuse recorded resolution of conflicted merges.
968</p>
969</dd>
970<dt>
971<a href="git-rev-parse.html">git-rev-parse(1)</a>
972</dt>
973<dd>
974<p>
975 Pick out and massage parameters.
976</p>
977</dd>
978<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]979<a href="git-show-branch.html">git-show-branch(1)</a>
980</dt>
981<dd>
982<p>
983 Show branches and their commits.
984</p>
985</dd>
986<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]987<a href="git-verify-tag.html">git-verify-tag(1)</a>
988</dt>
989<dd>
990<p>
Junio C Hamanob1d6e882007-08-11 08:30:16[diff] [blame]991 Check the GPG signature of tags.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]992</p>
993</dd>
994<dt>
995<a href="git-whatchanged.html">git-whatchanged(1)</a>
996</dt>
997<dd>
998<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]999 Show logs with difference each commit introduces.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1000</p>
1001</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1002</dl></div>
1003<h3 id="_interacting_with_others">Interacting with Others</h3><div style="clear:left"></div>
1004<div class="para"><p>These commands are to interact with foreign SCM and with other
1005people via patch over e-mail.</p></div>
1006<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1007<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1008<a href="git-archimport.html">git-archimport(1)</a>
1009</dt>
1010<dd>
1011<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1012 Import an Arch repository into git.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1013</p>
1014</dd>
1015<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1016<a href="git-cvsexportcommit.html">git-cvsexportcommit(1)</a>
1017</dt>
1018<dd>
1019<p>
1020 Export a single commit to a CVS checkout.
1021</p>
1022</dd>
1023<dt>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1024<a href="git-cvsimport.html">git-cvsimport(1)</a>
1025</dt>
1026<dd>
1027<p>
1028 Salvage your data out of another SCM people love to hate.
1029</p>
1030</dd>
1031<dt>
Junio C Hamano54559c82006-04-13 07:45:12[diff] [blame]1032<a href="git-cvsserver.html">git-cvsserver(1)</a>
1033</dt>
1034<dd>
1035<p>
1036 A CVS server emulator for git.
1037</p>
1038</dd>
1039<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1040<a href="git-imap-send.html">git-imap-send(1)</a>
Junio C Hamano52299462006-12-28 00:59:38[diff] [blame]1041</dt>
1042<dd>
1043<p>
Junio C Hamano5cf43ca2008-08-20 09:14:14[diff] [blame]1044 Send a collection of patches from stdin to an IMAP folder.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1045</p>
1046</dd>
1047<dt>
Junio C Hamano33db4372006-06-07 19:51:45[diff] [blame]1048<a href="git-quiltimport.html">git-quiltimport(1)</a>
1049</dt>
1050<dd>
1051<p>
1052 Applies a quilt patchset onto the current branch.
1053</p>
1054</dd>
1055<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1056<a href="git-request-pull.html">git-request-pull(1)</a>
Junio C Hamano74640642006-12-27 10:59:55[diff] [blame]1057</dt>
1058<dd>
1059<p>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1060 Generates a summary of pending changes.
Junio C Hamano74640642006-12-27 10:59:55[diff] [blame]1061</p>
1062</dd>
1063<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1064<a href="git-send-email.html">git-send-email(1)</a>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1065</dt>
1066<dd>
1067<p>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1068 Send a collection of patches as emails.
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1069</p>
1070</dd>
1071<dt>
Junio C Hamanob518f452006-08-04 00:18:06[diff] [blame]1072<a href="git-svn.html">git-svn(1)</a>
1073</dt>
1074<dd>
1075<p>
Junio C Hamano688eae02009-06-28 05:19:50[diff] [blame]1076 Bidirectional operation between a Subversion repository and git.
Junio C Hamanob518f452006-08-04 00:18:06[diff] [blame]1077</p>
1078</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1079</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1080</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1081<h2 id="_low_level_commands_plumbing">Low-level commands (plumbing)</h2>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1082<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1083<div class="para"><p>Although git includes its
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1084own porcelain layer, its low-level commands are sufficient to support
1085development of alternative porcelains. Developers of such porcelains
1086might start by reading about <a href="git-update-index.html">git-update-index(1)</a> and
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1087<a href="git-read-tree.html">git-read-tree(1)</a>.</p></div>
1088<div class="para"><p>The interface (input, output, set of options and the semantics)
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1089to these low-level commands are meant to be a lot more stable
1090than Porcelain level commands, because these commands are
1091primarily for scripted use. The interface to Porcelain commands
1092on the other hand are subject to change in order to improve the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1093end user experience.</p></div>
1094<div class="para"><p>The following description divides
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1095the low-level commands into commands that manipulate objects (in
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1096the repository, index, and working tree), commands that interrogate and
1097compare objects, and commands that move objects and references between
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1098repositories.</p></div>
1099<h3 id="_manipulation_commands">Manipulation commands</h3><div style="clear:left"></div>
1100<div class="vlist"><dl>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1101<dt>
1102<a href="git-apply.html">git-apply(1)</a>
1103</dt>
1104<dd>
1105<p>
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]1106 Apply a patch on a git index file and/or a working tree.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1107</p>
1108</dd>
1109<dt>
1110<a href="git-checkout-index.html">git-checkout-index(1)</a>
1111</dt>
1112<dd>
1113<p>
1114 Copy files from the index to the working tree.
1115</p>
1116</dd>
1117<dt>
1118<a href="git-commit-tree.html">git-commit-tree(1)</a>
1119</dt>
1120<dd>
1121<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1122 Create a new commit object.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1123</p>
1124</dd>
1125<dt>
1126<a href="git-hash-object.html">git-hash-object(1)</a>
1127</dt>
1128<dd>
1129<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1130 Compute object ID and optionally creates a blob from a file.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1131</p>
1132</dd>
1133<dt>
1134<a href="git-index-pack.html">git-index-pack(1)</a>
1135</dt>
1136<dd>
1137<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1138 Build pack index file for an existing packed archive.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1139</p>
1140</dd>
1141<dt>
Junio C Hamano1de7bc62006-12-17 19:31:54[diff] [blame]1142<a href="git-merge-file.html">git-merge-file(1)</a>
1143</dt>
1144<dd>
1145<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1146 Run a three-way file merge.
Junio C Hamano1de7bc62006-12-17 19:31:54[diff] [blame]1147</p>
1148</dd>
1149<dt>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1150<a href="git-merge-index.html">git-merge-index(1)</a>
1151</dt>
1152<dd>
1153<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1154 Run a merge for files needing merging.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1155</p>
1156</dd>
1157<dt>
1158<a href="git-mktag.html">git-mktag(1)</a>
1159</dt>
1160<dd>
1161<p>
1162 Creates a tag object.
1163</p>
1164</dd>
1165<dt>
1166<a href="git-mktree.html">git-mktree(1)</a>
1167</dt>
1168<dd>
1169<p>
1170 Build a tree-object from ls-tree formatted text.
1171</p>
1172</dd>
1173<dt>
1174<a href="git-pack-objects.html">git-pack-objects(1)</a>
1175</dt>
1176<dd>
1177<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1178 Create a packed archive of objects.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1179</p>
1180</dd>
1181<dt>
1182<a href="git-prune-packed.html">git-prune-packed(1)</a>
1183</dt>
1184<dd>
1185<p>
1186 Remove extra objects that are already in pack files.
1187</p>
1188</dd>
1189<dt>
1190<a href="git-read-tree.html">git-read-tree(1)</a>
1191</dt>
1192<dd>
1193<p>
1194 Reads tree information into the index.
1195</p>
1196</dd>
1197<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1198<a href="git-symbolic-ref.html">git-symbolic-ref(1)</a>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1199</dt>
1200<dd>
1201<p>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1202 Read and modify symbolic refs.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1203</p>
1204</dd>
1205<dt>
1206<a href="git-unpack-objects.html">git-unpack-objects(1)</a>
1207</dt>
1208<dd>
1209<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1210 Unpack objects from a packed archive.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1211</p>
1212</dd>
1213<dt>
1214<a href="git-update-index.html">git-update-index(1)</a>
1215</dt>
1216<dd>
1217<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1218 Register file contents in the working tree to the index.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1219</p>
1220</dd>
1221<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1222<a href="git-update-ref.html">git-update-ref(1)</a>
1223</dt>
1224<dd>
1225<p>
1226 Update the object name stored in a ref safely.
1227</p>
1228</dd>
1229<dt>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1230<a href="git-write-tree.html">git-write-tree(1)</a>
1231</dt>
1232<dd>
1233<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1234 Create a tree object from the current index.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1235</p>
1236</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1237</dl></div>
1238<h3 id="_interrogation_commands">Interrogation commands</h3><div style="clear:left"></div>
1239<div class="vlist"><dl>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1240<dt>
1241<a href="git-cat-file.html">git-cat-file(1)</a>
1242</dt>
1243<dd>
1244<p>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]1245 Provide content or type and size information for repository objects.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1246</p>
1247</dd>
1248<dt>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1249<a href="git-diff-files.html">git-diff-files(1)</a>
1250</dt>
1251<dd>
1252<p>
1253 Compares files in the working tree and the index.
1254</p>
1255</dd>
1256<dt>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1257<a href="git-diff-index.html">git-diff-index(1)</a>
1258</dt>
1259<dd>
1260<p>
1261 Compares content and mode of blobs between the index and repository.
1262</p>
1263</dd>
1264<dt>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1265<a href="git-diff-tree.html">git-diff-tree(1)</a>
1266</dt>
1267<dd>
1268<p>
1269 Compares the content and mode of blobs found via two tree objects.
1270</p>
1271</dd>
1272<dt>
1273<a href="git-for-each-ref.html">git-for-each-ref(1)</a>
1274</dt>
1275<dd>
1276<p>
1277 Output information on each ref.
1278</p>
1279</dd>
1280<dt>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1281<a href="git-ls-files.html">git-ls-files(1)</a>
1282</dt>
1283<dd>
1284<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1285 Show information about files in the index and the working tree.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1286</p>
1287</dd>
1288<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1289<a href="git-ls-remote.html">git-ls-remote(1)</a>
1290</dt>
1291<dd>
1292<p>
1293 List references in a remote repository.
1294</p>
1295</dd>
1296<dt>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1297<a href="git-ls-tree.html">git-ls-tree(1)</a>
1298</dt>
1299<dd>
1300<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1301 List the contents of a tree object.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1302</p>
1303</dd>
1304<dt>
1305<a href="git-merge-base.html">git-merge-base(1)</a>
1306</dt>
1307<dd>
1308<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1309 Find as good common ancestors as possible for a merge.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1310</p>
1311</dd>
1312<dt>
1313<a href="git-name-rev.html">git-name-rev(1)</a>
1314</dt>
1315<dd>
1316<p>
1317 Find symbolic names for given revs.
1318</p>
1319</dd>
1320<dt>
1321<a href="git-pack-redundant.html">git-pack-redundant(1)</a>
1322</dt>
1323<dd>
1324<p>
1325 Find redundant pack files.
1326</p>
1327</dd>
1328<dt>
1329<a href="git-rev-list.html">git-rev-list(1)</a>
1330</dt>
1331<dd>
1332<p>
1333 Lists commit objects in reverse chronological order.
1334</p>
1335</dd>
1336<dt>
1337<a href="git-show-index.html">git-show-index(1)</a>
1338</dt>
1339<dd>
1340<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1341 Show packed archive index.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1342</p>
1343</dd>
1344<dt>
Junio C Hamanod8c9d432006-11-07 07:19:13[diff] [blame]1345<a href="git-show-ref.html">git-show-ref(1)</a>
1346</dt>
1347<dd>
1348<p>
1349 List references in a local repository.
1350</p>
1351</dd>
1352<dt>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1353<a href="git-tar-tree.html">git-tar-tree(1)</a>
1354</dt>
1355<dd>
1356<p>
Junio C Hamano2d7f0272007-11-09 10:03:46[diff] [blame]1357 (deprecated) Create a tar archive of the files in the named tree object.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1358</p>
1359</dd>
1360<dt>
1361<a href="git-unpack-file.html">git-unpack-file(1)</a>
1362</dt>
1363<dd>
1364<p>
1365 Creates a temporary file with a blob's contents.
1366</p>
1367</dd>
1368<dt>
1369<a href="git-var.html">git-var(1)</a>
1370</dt>
1371<dd>
1372<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1373 Show a git logical variable.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1374</p>
1375</dd>
1376<dt>
1377<a href="git-verify-pack.html">git-verify-pack(1)</a>
1378</dt>
1379<dd>
1380<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1381 Validate packed git archive files.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1382</p>
1383</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1384</dl></div>
1385<div class="para"><p>In general, the interrogate commands do not touch the files in
1386the working tree.</p></div>
1387<h3 id="_synching_repositories">Synching repositories</h3><div style="clear:left"></div>
1388<div class="vlist"><dl>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1389<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1390<a href="git-daemon.html">git-daemon(1)</a>
1391</dt>
1392<dd>
1393<p>
1394 A really simple server for git repositories.
1395</p>
1396</dd>
1397<dt>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1398<a href="git-fetch-pack.html">git-fetch-pack(1)</a>
1399</dt>
1400<dd>
1401<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1402 Receive missing objects from another repository.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1403</p>
1404</dd>
1405<dt>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1406<a href="git-send-pack.html">git-send-pack(1)</a>
1407</dt>
1408<dd>
1409<p>
Junio C Hamanoee1e4282007-02-04 08:32:04[diff] [blame]1410 Push objects over git protocol to another repository.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1411</p>
1412</dd>
1413<dt>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1414<a href="git-update-server-info.html">git-update-server-info(1)</a>
1415</dt>
1416<dd>
1417<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1418 Update auxiliary info file to help dumb servers.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1419</p>
1420</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1421</dl></div>
Junio C Hamano27a128b2009-08-13 01:23:00[diff] [blame]1422<div class="para"><p>The following are helper commands used by the above; end users
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1423typically do not use them directly.</p></div>
1424<div class="vlist"><dl>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1425<dt>
1426<a href="git-http-fetch.html">git-http-fetch(1)</a>
1427</dt>
1428<dd>
1429<p>
1430 Download from a remote git repository via HTTP.
1431</p>
1432</dd>
1433<dt>
1434<a href="git-http-push.html">git-http-push(1)</a>
1435</dt>
1436<dd>
1437<p>
1438 Push objects over HTTP/DAV to another repository.
1439</p>
1440</dd>
1441<dt>
1442<a href="git-parse-remote.html">git-parse-remote(1)</a>
1443</dt>
1444<dd>
1445<p>
1446 Routines to help parsing remote repository access parameters.
1447</p>
1448</dd>
1449<dt>
1450<a href="git-receive-pack.html">git-receive-pack(1)</a>
1451</dt>
1452<dd>
1453<p>
1454 Receive what is pushed into the repository.
1455</p>
1456</dd>
1457<dt>
1458<a href="git-shell.html">git-shell(1)</a>
1459</dt>
1460<dd>
1461<p>
1462 Restricted login shell for GIT-only SSH access.
1463</p>
1464</dd>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1465<dt>
1466<a href="git-upload-archive.html">git-upload-archive(1)</a>
1467</dt>
1468<dd>
1469<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1470 Send archive back to git-archive.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1471</p>
1472</dd>
1473<dt>
1474<a href="git-upload-pack.html">git-upload-pack(1)</a>
1475</dt>
1476<dd>
1477<p>
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]1478 Send objects packed back to git-fetch-pack.
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1479</p>
1480</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1481</dl></div>
1482<h3 id="_internal_helper_commands">Internal helper commands</h3><div style="clear:left"></div>
1483<div class="para"><p>These are internal helper commands used by other commands; end
1484users typically do not use them directly.</p></div>
1485<div class="vlist"><dl>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1486<dt>
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]1487<a href="git-check-attr.html">git-check-attr(1)</a>
1488</dt>
1489<dd>
1490<p>
Junio C Hamano9bd39c42008-11-13 01:54:44[diff] [blame]1491 Display gitattributes information.
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]1492</p>
1493</dd>
1494<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1495<a href="git-check-ref-format.html">git-check-ref-format(1)</a>
1496</dt>
1497<dd>
1498<p>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]1499 Ensures that a reference name is well formed.
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1500</p>
1501</dd>
1502<dt>
1503<a href="git-fmt-merge-msg.html">git-fmt-merge-msg(1)</a>
1504</dt>
1505<dd>
1506<p>
1507 Produce a merge commit message.
1508</p>
1509</dd>
1510<dt>
1511<a href="git-mailinfo.html">git-mailinfo(1)</a>
1512</dt>
1513<dd>
1514<p>
1515 Extracts patch and authorship from a single e-mail message.
1516</p>
1517</dd>
1518<dt>
1519<a href="git-mailsplit.html">git-mailsplit(1)</a>
1520</dt>
1521<dd>
1522<p>
1523 Simple UNIX mbox splitter program.
1524</p>
1525</dd>
1526<dt>
1527<a href="git-merge-one-file.html">git-merge-one-file(1)</a>
1528</dt>
1529<dd>
1530<p>
1531 The standard helper program to use with git-merge-index.
1532</p>
1533</dd>
1534<dt>
1535<a href="git-patch-id.html">git-patch-id(1)</a>
1536</dt>
1537<dd>
1538<p>
1539 Compute unique ID for a patch.
1540</p>
1541</dd>
1542<dt>
1543<a href="git-peek-remote.html">git-peek-remote(1)</a>
1544</dt>
1545<dd>
1546<p>
Junio C Hamano9d2bbb72007-11-25 04:56:07[diff] [blame]1547 (deprecated) List the references in a remote repository.
Junio C Hamano4ad294b2007-01-20 02:22:50[diff] [blame]1548</p>
1549</dd>
1550<dt>
1551<a href="git-sh-setup.html">git-sh-setup(1)</a>
1552</dt>
1553<dd>
1554<p>
1555 Common git shell script setup code.
1556</p>
1557</dd>
1558<dt>
1559<a href="git-stripspace.html">git-stripspace(1)</a>
1560</dt>
1561<dd>
1562<p>
1563 Filter out empty lines.
1564</p>
1565</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1566</dl></div>
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]1567</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1568<h2 id="_configuration_mechanism">Configuration Mechanism</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1569<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1570<div class="para"><p>Starting from 0.99.9 (actually mid 0.99.8.GIT), <tt>.git/config</tt> file
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1571is used to hold per-repository configuration options. It is a
Junio C Hamano51c2ab02006-07-09 20:38:54[diff] [blame]1572simple text file modeled after <tt>.ini</tt> format familiar to some
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1573people. Here is an example:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1574<div class="listingblock">
1575<div class="content">
1576<pre><tt>#
1577# A '#' or ';' character indicates a comment.
1578#
1579
1580; core variables
1581[core]
1582 ; Don't trust file modes
1583 filemode = false
1584
1585; user identity
1586[user]
1587 name = "Junio C Hamano"
1588 email = "junkio@twinsun.com"
1589</tt></pre>
1590</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1591<div class="para"><p>Various commands read from the configuration file and adjust
1592their operation accordingly.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1593</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1594<h2 id="_identifier_terminology">Identifier Terminology</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1595<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1596<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1597<dt>
1598&lt;object&gt;
1599</dt>
1600<dd>
1601<p>
1602 Indicates the object name for any type of object.
1603</p>
1604</dd>
1605<dt>
1606&lt;blob&gt;
1607</dt>
1608<dd>
1609<p>
1610 Indicates a blob object name.
1611</p>
1612</dd>
1613<dt>
1614&lt;tree&gt;
1615</dt>
1616<dd>
1617<p>
1618 Indicates a tree object name.
1619</p>
1620</dd>
1621<dt>
1622&lt;commit&gt;
1623</dt>
1624<dd>
1625<p>
1626 Indicates a commit object name.
1627</p>
1628</dd>
1629<dt>
1630&lt;tree-ish&gt;
1631</dt>
1632<dd>
1633<p>
1634 Indicates a tree, commit or tag object name. A
1635 command that takes a &lt;tree-ish&gt; argument ultimately wants to
1636 operate on a &lt;tree&gt; object but automatically dereferences
1637 &lt;commit&gt; and &lt;tag&gt; objects that point at a &lt;tree&gt;.
1638</p>
1639</dd>
1640<dt>
Junio C Hamano60f8aa82007-03-06 09:58:26[diff] [blame]1641&lt;commit-ish&gt;
1642</dt>
1643<dd>
1644<p>
1645 Indicates a commit or tag object name. A
1646 command that takes a &lt;commit-ish&gt; argument ultimately wants to
1647 operate on a &lt;commit&gt; object but automatically dereferences
1648 &lt;tag&gt; objects that point at a &lt;commit&gt;.
1649</p>
1650</dd>
1651<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1652&lt;type&gt;
1653</dt>
1654<dd>
1655<p>
1656 Indicates that an object type is required.
1657 Currently one of: <tt>blob</tt>, <tt>tree</tt>, <tt>commit</tt>, or <tt>tag</tt>.
1658</p>
1659</dd>
1660<dt>
1661&lt;file&gt;
1662</dt>
1663<dd>
1664<p>
1665 Indicates a filename - almost always relative to the
1666 root of the tree structure <tt>GIT_INDEX_FILE</tt> describes.
1667</p>
1668</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1669</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1670</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1671<h2 id="_symbolic_identifiers">Symbolic Identifiers</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1672<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1673<div class="para"><p>Any git command accepting any &lt;object&gt; can also use the following
1674symbolic notation:</p></div>
1675<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1676<dt>
1677HEAD
1678</dt>
1679<dd>
1680<p>
1681 indicates the head of the current branch (i.e. the
1682 contents of <tt>$GIT_DIR/HEAD</tt>).
1683</p>
1684</dd>
1685<dt>
1686&lt;tag&gt;
1687</dt>
1688<dd>
1689<p>
1690 a valid tag <em>name</em>
1691 (i.e. the contents of <tt>$GIT_DIR/refs/tags/&lt;tag&gt;</tt>).
1692</p>
1693</dd>
1694<dt>
1695&lt;head&gt;
1696</dt>
1697<dd>
1698<p>
1699 a valid head <em>name</em>
1700 (i.e. the contents of <tt>$GIT_DIR/refs/heads/&lt;head&gt;</tt>).
1701</p>
1702</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1703</dl></div>
1704<div class="para"><p>For a more complete list of ways to spell object names, see
1705"SPECIFYING REVISIONS" section in <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1706</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1707<h2 id="_file_directory_structure">File/Directory Structure</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1708<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1709<div class="para"><p>Please see the <a href="gitrepository-layout.html">gitrepository-layout(5)</a> document.</p></div>
1710<div class="para"><p>Read <a href="githooks.html">githooks(5)</a> for more details about each hook.</p></div>
1711<div class="para"><p>Higher level SCMs may provide and manage additional information in the
1712<tt>$GIT_DIR</tt>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1713</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1714<h2 id="_terminology">Terminology</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1715<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1716<div class="para"><p>Please see <a href="gitglossary.html">gitglossary(7)</a>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1717</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1718<h2 id="_environment_variables">Environment Variables</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1719<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1720<div class="para"><p>Various git commands use the following environment variables:</p></div>
1721<h3 id="_the_git_repository">The git Repository</h3><div style="clear:left"></div>
1722<div class="para"><p>These environment variables apply to <em>all</em> core git commands. Nb: it
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1723is worth noting that they may be used/overridden by SCMS sitting above
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1724git so take care if using Cogito etc.</p></div>
1725<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1726<dt>
1727<em>GIT_INDEX_FILE</em>
1728</dt>
1729<dd>
1730<p>
1731 This environment allows the specification of an alternate
1732 index file. If not specified, the default of <tt>$GIT_DIR/index</tt>
1733 is used.
1734</p>
1735</dd>
1736<dt>
1737<em>GIT_OBJECT_DIRECTORY</em>
1738</dt>
1739<dd>
1740<p>
1741 If the object storage directory is specified via this
1742 environment variable then the sha1 directories are created
1743 underneath - otherwise the default <tt>$GIT_DIR/objects</tt>
1744 directory is used.
1745</p>
1746</dd>
1747<dt>
1748<em>GIT_ALTERNATE_OBJECT_DIRECTORIES</em>
1749</dt>
1750<dd>
1751<p>
1752 Due to the immutable nature of git objects, old objects can be
1753 archived into shared, read-only directories. This variable
Junio C Hamano05bf9c52008-07-03 09:21:58[diff] [blame]1754 specifies a ":" separated (on Windows ";" separated) list
1755 of git object directories which can be used to search for git
1756 objects. New objects will not be written to these directories.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1757</p>
1758</dd>
1759<dt>
1760<em>GIT_DIR</em>
1761</dt>
1762<dd>
1763<p>
1764 If the <em>GIT_DIR</em> environment variable is set then it
1765 specifies a path to use instead of the default <tt>.git</tt>
1766 for the base of the repository.
1767</p>
1768</dd>
Junio C Hamanod526ba92007-07-02 00:17:42[diff] [blame]1769<dt>
1770<em>GIT_WORK_TREE</em>
1771</dt>
1772<dd>
1773<p>
1774 Set the path to the working tree. The value will not be
1775 used in combination with repositories found automatically in
1776 a .git directory (i.e. $GIT_DIR is not set).
1777 This can also be controlled by the <em>--work-tree</em> command line
1778 option and the core.worktree configuration variable.
1779</p>
1780</dd>
Junio C Hamano15048272008-07-07 22:10:48[diff] [blame]1781<dt>
1782<em>GIT_CEILING_DIRECTORIES</em>
1783</dt>
1784<dd>
1785<p>
1786 This should be a colon-separated list of absolute paths.
1787 If set, it is a list of directories that git should not chdir
1788 up into while looking for a repository directory.
1789 It will not exclude the current working directory or
1790 a GIT_DIR set on the command line or in the environment.
1791 (Useful for excluding slow-loading network directories.)
1792</p>
1793</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1794</dl></div>
1795<h3 id="_git_commits">git Commits</h3><div style="clear:left"></div>
1796<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1797<dt>
1798<em>GIT_AUTHOR_NAME</em>
1799</dt>
1800<dt>
1801<em>GIT_AUTHOR_EMAIL</em>
1802</dt>
1803<dt>
1804<em>GIT_AUTHOR_DATE</em>
1805</dt>
1806<dt>
1807<em>GIT_COMMITTER_NAME</em>
1808</dt>
1809<dt>
1810<em>GIT_COMMITTER_EMAIL</em>
1811</dt>
Junio C Hamano469d60e2007-04-29 18:30:34[diff] [blame]1812<dt>
1813<em>GIT_COMMITTER_DATE</em>
1814</dt>
1815<dt>
1816<em>EMAIL</em>
1817</dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1818<dd>
1819<p>
1820 see <a href="git-commit-tree.html">git-commit-tree(1)</a>
1821</p>
1822</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1823</dl></div>
1824<h3 id="_git_diffs">git Diffs</h3><div style="clear:left"></div>
1825<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1826<dt>
1827<em>GIT_DIFF_OPTS</em>
1828</dt>
Junio C Hamano1c437122006-11-28 02:22:25[diff] [blame]1829<dd>
1830<p>
1831 Only valid setting is "--unified=??" or "-u??" to set the
1832 number of context lines shown when a unified diff is created.
1833 This takes precedence over any "-U" or "--unified" option
1834 value passed on the git diff command line.
1835</p>
1836</dd>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1837<dt>
1838<em>GIT_EXTERNAL_DIFF</em>
1839</dt>
1840<dd>
1841<p>
Junio C Hamano1c437122006-11-28 02:22:25[diff] [blame]1842 When the environment variable <em>GIT_EXTERNAL_DIFF</em> is set, the
1843 program named by it is called, instead of the diff invocation
1844 described above. For a path that is added, removed, or modified,
1845 <em>GIT_EXTERNAL_DIFF</em> is called with 7 parameters:
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1846</p>
Junio C Hamano1c437122006-11-28 02:22:25[diff] [blame]1847<div class="literalblock">
1848<div class="content">
1849<pre><tt>path old-file old-hex old-mode new-file new-hex new-mode</tt></pre>
1850</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1851<div class="para"><p>where:</p></div>
Junio C Hamano1c437122006-11-28 02:22:25[diff] [blame]1852<div class="hlist"><table>
1853<tr>
1854<td class="hlist1">
1855&lt;old|new&gt;-file
1856</td>
1857<td class="hlist2">
1858are files GIT_EXTERNAL_DIFF can use to read the
1859 contents of &lt;old|new&gt;,
1860</td>
1861</tr>
1862<tr>
1863<td class="hlist1">
1864&lt;old|new&gt;-hex
1865</td>
1866<td class="hlist2">
1867are the 40-hexdigit SHA1 hashes,
1868</td>
1869</tr>
1870<tr>
1871<td class="hlist1">
1872&lt;old|new&gt;-mode
1873</td>
1874<td class="hlist2">
1875are the octal representation of the file modes.
1876</td>
1877</tr>
1878</table></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1879<div class="para"><p>The file parameters can point at the user's working file
Junio C Hamano1c437122006-11-28 02:22:25[diff] [blame]1880(e.g. <tt>new-file</tt> in "git-diff-files"), <tt>/dev/null</tt> (e.g. <tt>old-file</tt>
1881when a new file is added), or a temporary file (e.g. <tt>old-file</tt> in the
1882index). <em>GIT_EXTERNAL_DIFF</em> should not worry about unlinking the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1883temporary file --- it is removed when <em>GIT_EXTERNAL_DIFF</em> exits.</p></div>
1884<div class="para"><p>For a path that is unmerged, <em>GIT_EXTERNAL_DIFF</em> is called with 1
1885parameter, &lt;path&gt;.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1886</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1887</dl></div>
1888<h3 id="_other">other</h3><div style="clear:left"></div>
1889<div class="vlist"><dl>
Junio C Hamano7ccb9fd2006-07-15 01:38:40[diff] [blame]1890<dt>
Junio C Hamano1e6e0062007-07-13 05:33:25[diff] [blame]1891<em>GIT_MERGE_VERBOSITY</em>
1892</dt>
1893<dd>
1894<p>
1895 A number controlling the amount of output shown by
1896 the recursive merge strategy. Overrides merge.verbosity.
1897 See <a href="git-merge.html">git-merge(1)</a>
1898</p>
1899</dd>
1900<dt>
Junio C Hamano85e45fa2006-08-13 07:47:41[diff] [blame]1901<em>GIT_PAGER</em>
1902</dt>
1903<dd>
1904<p>
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]1905 This environment variable overrides <tt>$PAGER</tt>. If it is set
1906 to an empty string or to the value "cat", git will not launch
Junio C Hamano0551f6a2008-08-25 00:33:33[diff] [blame]1907 a pager. See also the <tt>core.pager</tt> option in
1908 <a href="git-config.html">git-config(1)</a>.
Junio C Hamano85e45fa2006-08-13 07:47:41[diff] [blame]1909</p>
1910</dd>
1911<dt>
Junio C Hamano4cd1c0e2007-08-06 04:39:14[diff] [blame]1912<em>GIT_SSH</em>
1913</dt>
1914<dd>
1915<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1916 If this environment variable is set then <em>git-fetch</em>
1917 and <em>git-push</em> will use this command instead
1918 of <em>ssh</em> when they need to connect to a remote system.
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]1919 The <em>$GIT_SSH</em> command will be given exactly two arguments:
Junio C Hamano4cd1c0e2007-08-06 04:39:14[diff] [blame]1920 the <em>username@host</em> (or just <em>host</em>) from the URL and the
1921 shell command to execute on that remote system.
1922</p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1923<div class="para"><p>To pass options to the program that you want to list in GIT_SSH
Junio C Hamano4cd1c0e2007-08-06 04:39:14[diff] [blame]1924you will need to wrap the program and options into a shell script,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1925then set GIT_SSH to refer to the shell script.</p></div>
1926<div class="para"><p>Usually it is easier to configure any desired options through your
Junio C Hamano4cd1c0e2007-08-06 04:39:14[diff] [blame]1927personal <tt>.ssh/config</tt> file. Please consult your ssh documentation
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1928for further details.</p></div>
Junio C Hamano4cd1c0e2007-08-06 04:39:14[diff] [blame]1929</dd>
1930<dt>
Junio C Hamano401939f2007-07-01 06:34:30[diff] [blame]1931<em>GIT_FLUSH</em>
1932</dt>
1933<dd>
1934<p>
1935 If this environment variable is set to "1", then commands such
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1936 as <em>git-blame</em> (in incremental mode), <em>git-rev-list</em>, <em>git-log</em>,
1937 and <em>git-whatchanged</em> will force a flush of the output stream
Junio C Hamano401939f2007-07-01 06:34:30[diff] [blame]1938 after each commit-oriented record have been flushed. If this
1939 variable is set to "0", the output of these commands will be done
1940 using completely buffered I/O. If this environment variable is
1941 not set, git will choose buffered or record-oriented flushing
1942 based on whether stdout appears to be redirected to a file or not.
1943</p>
1944</dd>
1945<dt>
Junio C Hamano7ccb9fd2006-07-15 01:38:40[diff] [blame]1946<em>GIT_TRACE</em>
1947</dt>
1948<dd>
1949<p>
Junio C Hamanoef4b48b2006-09-04 10:08:34[diff] [blame]1950 If this variable is set to "1", "2" or "true" (comparison
1951 is case insensitive), git will print <tt>trace:</tt> messages on
Junio C Hamano7ccb9fd2006-07-15 01:38:40[diff] [blame]1952 stderr telling about alias expansion, built-in command
1953 execution and external command execution.
Junio C Hamanoef4b48b2006-09-04 10:08:34[diff] [blame]1954 If this variable is set to an integer value greater than 1
1955 and lower than 10 (strictly) then git will interpret this
1956 value as an open file descriptor and will try to write the
1957 trace messages into this file descriptor.
1958 Alternatively, if this variable is set to an absolute path
1959 (starting with a <em>/</em> character), git will interpret this
1960 as a file path and will try to write the trace messages
1961 into it.
Junio C Hamano7ccb9fd2006-07-15 01:38:40[diff] [blame]1962</p>
1963</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1964</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1965</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1966<h2 id="_discussion_a_id_discussion_a">Discussion<a id="Discussion"></a></h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1967<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1968<div class="para"><p>More detail on the following is available from the
Junio C Hamano597ffcf2007-09-17 17:33:15[diff] [blame]1969<a href="user-manual.html#git-concepts">git concepts chapter of the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1970user-manual</a> and <a href="gitcore-tutorial.html">gitcore-tutorial(7)</a>.</p></div>
1971<div class="para"><p>A git project normally consists of a working directory with a ".git"
Junio C Hamano597ffcf2007-09-17 17:33:15[diff] [blame]1972subdirectory at the top level. The .git directory contains, among other
1973things, a compressed object database representing the complete history
1974of the project, an "index" file which links that history to the current
1975contents of the working tree, and named pointers into that history such
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1976as tags and branch heads.</p></div>
1977<div class="para"><p>The object database contains objects of three main types: blobs, which
Junio C Hamano597ffcf2007-09-17 17:33:15[diff] [blame]1978hold file data; trees, which point to blobs and other trees to build up
Junio C Hamanofe986052007-12-19 07:33:38[diff] [blame]1979directory hierarchies; and commits, which each reference a single tree
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1980and some number of parent commits.</p></div>
1981<div class="para"><p>The commit, equivalent to what other systems call a "changeset" or
Junio C Hamano597ffcf2007-09-17 17:33:15[diff] [blame]1982"version", represents a step in the project's history, and each parent
1983represents an immediately preceding step. Commits with more than one
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1984parent represent merges of independent lines of development.</p></div>
1985<div class="para"><p>All objects are named by the SHA1 hash of their contents, normally
Junio C Hamano597ffcf2007-09-17 17:33:15[diff] [blame]1986written as a string of 40 hex digits. Such names are globally unique.
1987The entire history leading up to a commit can be vouched for by signing
1988just that commit. A fourth object type, the tag, is provided for this
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1989purpose.</p></div>
1990<div class="para"><p>When first created, objects are stored in individual files, but for
1991efficiency may later be compressed together into "pack files".</p></div>
1992<div class="para"><p>Named pointers called refs mark interesting points in history. A ref
Junio C Hamano597ffcf2007-09-17 17:33:15[diff] [blame]1993may contain the SHA1 name of an object or the name of another ref. Refs
1994with names beginning <tt>ref/head/</tt> contain the SHA1 name of the most
Junio C Hamanofe986052007-12-19 07:33:38[diff] [blame]1995recent commit (or "head") of a branch under development. SHA1 names of
Junio C Hamano597ffcf2007-09-17 17:33:15[diff] [blame]1996tags of interest are stored under <tt>ref/tags/</tt>. A special ref named
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1997<tt>HEAD</tt> contains the name of the currently checked-out branch.</p></div>
1998<div class="para"><p>The index file is initialized with a list of all paths and, for each
Junio C Hamano597ffcf2007-09-17 17:33:15[diff] [blame]1999path, a blob object and a set of attributes. The blob object represents
2000the contents of the file as of the head of the current branch. The
2001attributes (last modified time, size, etc.) are taken from the
2002corresponding file in the working tree. Subsequent changes to the
2003working tree can be found by comparing these attributes. The index may
2004be updated with new content, and new commits may be created from the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2005content stored in the index.</p></div>
2006<div class="para"><p>The index is also capable of storing multiple entries (called "stages")
Junio C Hamano597ffcf2007-09-17 17:33:15[diff] [blame]2007for a given pathname. These stages are used to hold the various
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2008unmerged version of a file when a merge is in progress.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2009</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2010<h2 id="_authors">Authors</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2011<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2012<div class="ilist"><ul>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2013<li>
2014<p>
2015git's founding father is Linus Torvalds &lt;torvalds@osdl.org&gt;.
2016</p>
2017</li>
2018<li>
2019<p>
Junio C Hamanodbb64592007-09-01 11:17:39[diff] [blame]2020The current git nurse is Junio C Hamano &lt;gitster@pobox.com&gt;.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2021</p>
2022</li>
2023<li>
2024<p>
Junio C Hamanoe0facb92007-12-05 10:59:48[diff] [blame]2025The git potty was written by Andreas Ericsson &lt;ae@op5.se&gt;.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2026</p>
2027</li>
2028<li>
2029<p>
2030General upbringing is handled by the git-list &lt;git@vger.kernel.org&gt;.
2031</p>
2032</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2033</ul></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2034</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2035<h2 id="_documentation">Documentation</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2036<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2037<div class="para"><p>The documentation for git suite was started by David Greaves
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2038&lt;david@dgreaves.com&gt;, and later enhanced greatly by the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2039contributors on the git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2040</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2041<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano9e1793f2008-06-02 07:31:16[diff] [blame]2042<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2043<div class="para"><p><a href="gittutorial.html">gittutorial(7)</a>, <a href="gittutorial-2.html">gittutorial-2(7)</a>,
Junio C Hamanoaf1987f2008-08-03 07:58:19[diff] [blame]2044<a href="everyday.html">Everyday Git</a>, <a href="gitcvs-migration.html">gitcvs-migration(7)</a>,
Junio C Hamano9e1793f2008-06-02 07:31:16[diff] [blame]2045<a href="gitglossary.html">gitglossary(7)</a>, <a href="gitcore-tutorial.html">gitcore-tutorial(7)</a>,
Junio C Hamano804b5212009-06-07 16:05:03[diff] [blame]2046<a href="gitcli.html">gitcli(7)</a>, <a href="user-manual.html">The Git User's Manual</a>,
2047<a href="gitworkflows.html">gitworkflows(7)</a></p></div>
Junio C Hamano9e1793f2008-06-02 07:31:16[diff] [blame]2048</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2049<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2050<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]2051<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2052</div>
2053<div id="footer">
2054<div id="footer-text">
Junio C Hamano55295992009-10-13 09:06:33[diff] [blame^]2055Last updated 2009-10-13 09:06:18 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2056</div>
2057</div>
2058</body>
2059</html>