blob: 3aada6c19bc219bdb3f8d53a701375a422883311 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231<!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 Hamano40f2f8d2006-02-07 08:04:396<meta name="generator" content="AsciiDoc 7.0.2" />
Junio C Hamano1a4e8412005-12-27 08:17:237<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
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git(7)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git(7) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git -
269 the stupid content tracker
270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano6b2cee12006-08-26 08:43:31275<div class="verseblock">
Junio C Hamanocae86272007-08-21 02:20:49276<div class="content"><em>git</em> [--version] [--exec-path[=GIT_EXEC_PATH]]
277 [-p|--paginate|--no-pager]
Junio C Hamanod526ba92007-07-02 00:17:42278 [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
279 [--help] COMMAND [ARGS]</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23280</div>
281<h2>DESCRIPTION</h2>
282<div class="sectionbody">
Junio C Hamanoe27fb932006-04-03 05:34:10283<p>Git is a fast, scalable, distributed revision control system with an
284unusually rich command set that provides both high-level operations
285and full access to internals.</p>
286<p>See this <a href="tutorial.html">tutorial</a> to get started, then see
287<a href="everyday.html">Everyday Git</a> for a useful minimum set of commands, and
288"man git-commandname" for documentation of each command. CVS users may
Junio C Hamano3d30fd52007-05-08 00:32:53289also want to read <a href="cvs-migration.html">CVS migration</a>. See
290<a href="user-manual.html">Git User's Manual</a> for a more in-depth
291introduction.</p>
Junio C Hamano33db4372006-06-07 19:51:45292<p>The COMMAND is either a name of a Git command (see below) or an alias
Junio C Hamano7ad22dc2007-01-29 02:55:48293as defined in the configuration file (see <a href="git-config.html">git-config(1)</a>).</p>
Junio C Hamanob63afff2007-05-01 03:05:55294<p>Formatted and hyperlinked version of the latest git
295documentation can be viewed at
296<tt>http://www.kernel.org/pub/software/scm/git/docs/</tt>.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23297</div>
298<h2>OPTIONS</h2>
299<div class="sectionbody">
300<dl>
301<dt>
302--version
303</dt>
304<dd>
305<p>
Junio C Hamano01078922006-03-10 00:31:47306 Prints the git suite version that the <em>git</em> program came from.
Junio C Hamano1a4e8412005-12-27 08:17:23307</p>
308</dd>
309<dt>
310--help
311</dt>
312<dd>
313<p>
Junio C Hamano01078922006-03-10 00:31:47314 Prints the synopsis and a list of the most commonly used
315 commands. If a git command is named this option will bring up
316 the man-page for that command. If the option <em>--all</em> or <em>-a</em> is
317 given then all available commands are printed.
Junio C Hamano1a4e8412005-12-27 08:17:23318</p>
319</dd>
320<dt>
321--exec-path
322</dt>
323<dd>
324<p>
Junio C Hamano01078922006-03-10 00:31:47325 Path to wherever your core git programs are installed.
Junio C Hamano1a4e8412005-12-27 08:17:23326 This can also be controlled by setting the GIT_EXEC_PATH
327 environment variable. If no path is given <em>git</em> will print
328 the current setting and then exit.
329</p>
330</dd>
Junio C Hamanof870ef82006-07-29 09:10:13331<dt>
332-p|--paginate
333</dt>
334<dd>
335<p>
336 Pipe all output into <em>less</em> (or if set, $PAGER).
337</p>
338</dd>
339<dt>
Junio C Hamanocae86272007-08-21 02:20:49340--no-pager
341</dt>
342<dd>
343<p>
344 Do not pipe git output into a pager.
345</p>
346</dd>
347<dt>
Junio C Hamanof870ef82006-07-29 09:10:13348--git-dir=&lt;path&gt;
349</dt>
350<dd>
351<p>
352 Set the path to the repository. This can also be controlled by
353 setting the GIT_DIR environment variable.
354</p>
355</dd>
356<dt>
Junio C Hamanod526ba92007-07-02 00:17:42357--work-tree=&lt;path&gt;
358</dt>
359<dd>
360<p>
361 Set the path to the working tree. The value will not be
362 used in combination with repositories found automatically in
363 a .git directory (i.e. $GIT_DIR is not set).
364 This can also be controlled by setting the GIT_WORK_TREE
365 environment variable and the core.worktree configuration
366 variable.
367</p>
368</dd>
369<dt>
Junio C Hamanof870ef82006-07-29 09:10:13370--bare
371</dt>
372<dd>
373<p>
Junio C Hamanoc435b1c2007-08-28 06:25:35374 Treat the repository as a bare repository. If GIT_DIR
375 environment is not set, it is set to the current working
376 directory.
Junio C Hamanof870ef82006-07-29 09:10:13377</p>
378</dd>
Junio C Hamano1a4e8412005-12-27 08:17:23379</dl>
380</div>
Junio C Hamanoe27fb932006-04-03 05:34:10381<h2>FURTHER DOCUMENTATION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23382<div class="sectionbody">
Junio C Hamanoe27fb932006-04-03 05:34:10383<p>See the references above to get started using git. The following is
384probably more detail than necessary for a first-time user.</p>
Junio C Hamano597ffcf2007-09-17 17:33:15385<p>The <a href="user-manual.html#git-concepts">git concepts chapter of the
386user-manual</a> and the <a href="core-tutorial.html">Core tutorial</a> both provide
387introductions to the underlying git architecture.</p>
Junio C Hamanoe27fb932006-04-03 05:34:10388<p>See also the <a href="howto-index.html">howto</a> documents for some useful
389examples.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23390</div>
Junio C Hamanoe27fb932006-04-03 05:34:10391<h2>GIT COMMANDS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23392<div class="sectionbody">
Junio C Hamanoe27fb932006-04-03 05:34:10393<p>We divide git into high level ("porcelain") commands and low level
394("plumbing") commands.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23395</div>
Junio C Hamanoe27fb932006-04-03 05:34:10396<h2>High-level commands (porcelain)</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23397<div class="sectionbody">
Junio C Hamanoe27fb932006-04-03 05:34:10398<p>We separate the porcelain commands into the main commands and some
399ancillary user utilities.</p>
400<h3>Main porcelain commands</h3>
Junio C Hamano1a4e8412005-12-27 08:17:23401<dl>
402<dt>
403<a href="git-add.html">git-add(1)</a>
404</dt>
405<dd>
406<p>
Junio C Hamano4cd1c0e2007-08-06 04:39:14407 Add file contents to the index.
Junio C Hamano1a4e8412005-12-27 08:17:23408</p>
409</dd>
410<dt>
411<a href="git-am.html">git-am(1)</a>
412</dt>
413<dd>
414<p>
Junio C Hamano7c73c662007-01-19 00:37:50415 Apply a series of patches from a mailbox.
Junio C Hamano1a4e8412005-12-27 08:17:23416</p>
417</dd>
418<dt>
Junio C Hamano817abb42006-09-26 07:16:58419<a href="git-archive.html">git-archive(1)</a>
420</dt>
421<dd>
422<p>
Junio C Hamano4ec06712007-06-09 20:39:33423 Create an archive of files from a named tree.
Junio C Hamano817abb42006-09-26 07:16:58424</p>
425</dd>
426<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23427<a href="git-bisect.html">git-bisect(1)</a>
428</dt>
429<dd>
430<p>
431 Find the change that introduced a bug by binary search.
432</p>
433</dd>
434<dt>
435<a href="git-branch.html">git-branch(1)</a>
436</dt>
437<dd>
438<p>
Junio C Hamano7c73c662007-01-19 00:37:50439 List, create, or delete branches.
Junio C Hamano1a4e8412005-12-27 08:17:23440</p>
441</dd>
442<dt>
Junio C Hamano6ac2f142007-03-01 01:24:56443<a href="git-bundle.html">git-bundle(1)</a>
444</dt>
445<dd>
446<p>
447 Move objects and refs by archive.
448</p>
449</dd>
450<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23451<a href="git-checkout.html">git-checkout(1)</a>
452</dt>
453<dd>
454<p>
455 Checkout and switch to a branch.
456</p>
457</dd>
458<dt>
459<a href="git-cherry-pick.html">git-cherry-pick(1)</a>
460</dt>
461<dd>
462<p>
Junio C Hamano7c73c662007-01-19 00:37:50463 Apply the change introduced by an existing commit.
Junio C Hamano1a4e8412005-12-27 08:17:23464</p>
465</dd>
466<dt>
Junio C Hamano58784fc2007-06-23 08:48:57467<a href="git-citool.html">git-citool(1)</a>
468</dt>
469<dd>
470<p>
471 Graphical alternative to git-commit.
472</p>
473</dd>
474<dt>
Junio C Hamano54559c82006-04-13 07:45:12475<a href="git-clean.html">git-clean(1)</a>
476</dt>
477<dd>
478<p>
479 Remove untracked files from the working tree.
480</p>
481</dd>
482<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23483<a href="git-clone.html">git-clone(1)</a>
484</dt>
485<dd>
486<p>
Junio C Hamano4ec06712007-06-09 20:39:33487 Clone a repository into a new directory.
Junio C Hamano1a4e8412005-12-27 08:17:23488</p>
489</dd>
490<dt>
491<a href="git-commit.html">git-commit(1)</a>
492</dt>
493<dd>
494<p>
495 Record changes to the repository.
496</p>
497</dd>
498<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50499<a href="git-describe.html">git-describe(1)</a>
500</dt>
501<dd>
502<p>
503 Show the most recent tag that is reachable from a commit.
504</p>
505</dd>
506<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23507<a href="git-diff.html">git-diff(1)</a>
508</dt>
509<dd>
510<p>
511 Show changes between commits, commit and working tree, etc.
512</p>
513</dd>
514<dt>
515<a href="git-fetch.html">git-fetch(1)</a>
516</dt>
517<dd>
518<p>
Junio C Hamano7c73c662007-01-19 00:37:50519 Download objects and refs from another repository.
Junio C Hamano1a4e8412005-12-27 08:17:23520</p>
521</dd>
522<dt>
523<a href="git-format-patch.html">git-format-patch(1)</a>
524</dt>
525<dd>
526<p>
527 Prepare patches for e-mail submission.
528</p>
529</dd>
530<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50531<a href="git-gc.html">git-gc(1)</a>
532</dt>
533<dd>
534<p>
535 Cleanup unnecessary files and optimize the local repository.
536</p>
537</dd>
538<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23539<a href="git-grep.html">git-grep(1)</a>
540</dt>
541<dd>
542<p>
543 Print lines matching a pattern.
544</p>
545</dd>
546<dt>
Junio C Hamano58784fc2007-06-23 08:48:57547<a href="git-gui.html">git-gui(1)</a>
548</dt>
549<dd>
550<p>
551 A portable graphical interface to Git.
552</p>
553</dd>
554<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50555<a href="git-init.html">git-init(1)</a>
556</dt>
557<dd>
558<p>
559 Create an empty git repository or reinitialize an existing one.
560</p>
561</dd>
562<dt>
Junio C Hamanoeb8e3572006-09-01 08:25:07563<a href="gitk.html">gitk(1)</a>
564</dt>
565<dd>
566<p>
567 The git repository browser.
568</p>
569</dd>
570<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23571<a href="git-log.html">git-log(1)</a>
572</dt>
573<dd>
574<p>
Junio C Hamano7c73c662007-01-19 00:37:50575 Show commit logs.
Junio C Hamano1a4e8412005-12-27 08:17:23576</p>
577</dd>
578<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23579<a href="git-merge.html">git-merge(1)</a>
580</dt>
581<dd>
582<p>
Junio C Hamano7c73c662007-01-19 00:37:50583 Join two or more development histories together.
Junio C Hamano1a4e8412005-12-27 08:17:23584</p>
585</dd>
586<dt>
587<a href="git-mv.html">git-mv(1)</a>
588</dt>
589<dd>
590<p>
591 Move or rename a file, a directory, or a symlink.
592</p>
593</dd>
594<dt>
595<a href="git-pull.html">git-pull(1)</a>
596</dt>
597<dd>
598<p>
Junio C Hamano7c73c662007-01-19 00:37:50599 Fetch from and merge with another repository or a local branch.
Junio C Hamano1a4e8412005-12-27 08:17:23600</p>
601</dd>
602<dt>
603<a href="git-push.html">git-push(1)</a>
604</dt>
605<dd>
606<p>
607 Update remote refs along with associated objects.
608</p>
609</dd>
610<dt>
611<a href="git-rebase.html">git-rebase(1)</a>
612</dt>
613<dd>
614<p>
Junio C Hamano7c73c662007-01-19 00:37:50615 Forward-port local commits to the updated upstream head.
Junio C Hamano1a4e8412005-12-27 08:17:23616</p>
617</dd>
618<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23619<a href="git-reset.html">git-reset(1)</a>
620</dt>
621<dd>
622<p>
623 Reset current HEAD to the specified state.
624</p>
625</dd>
626<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23627<a href="git-revert.html">git-revert(1)</a>
628</dt>
629<dd>
630<p>
631 Revert an existing commit.
632</p>
633</dd>
634<dt>
Junio C Hamano54559c82006-04-13 07:45:12635<a href="git-rm.html">git-rm(1)</a>
636</dt>
637<dd>
638<p>
639 Remove files from the working tree and from the index.
640</p>
641</dd>
642<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23643<a href="git-shortlog.html">git-shortlog(1)</a>
644</dt>
645<dd>
646<p>
Junio C Hamano7c73c662007-01-19 00:37:50647 Summarize <em>git log</em> output.
Junio C Hamano1a4e8412005-12-27 08:17:23648</p>
649</dd>
650<dt>
Junio C Hamano2b135272006-03-18 07:45:42651<a href="git-show.html">git-show(1)</a>
652</dt>
653<dd>
654<p>
Junio C Hamano7c73c662007-01-19 00:37:50655 Show various types of objects.
Junio C Hamano2b135272006-03-18 07:45:42656</p>
657</dd>
658<dt>
Junio C Hamano1d90cb02007-07-03 07:05:31659<a href="git-stash.html">git-stash(1)</a>
660</dt>
661<dd>
662<p>
663 Stash the changes in a dirty working directory away.
664</p>
665</dd>
666<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23667<a href="git-status.html">git-status(1)</a>
668</dt>
669<dd>
670<p>
Junio C Hamano7c73c662007-01-19 00:37:50671 Show the working tree status.
Junio C Hamano1a4e8412005-12-27 08:17:23672</p>
673</dd>
674<dt>
Junio C Hamano38b693c2007-06-03 08:40:14675<a href="git-submodule.html">git-submodule(1)</a>
676</dt>
677<dd>
678<p>
679 Initialize, update or inspect submodules.
680</p>
681</dd>
682<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50683<a href="git-tag.html">git-tag(1)</a>
684</dt>
685<dd>
686<p>
Junio C Hamanodb450ba2007-01-21 08:57:14687 Create, list, delete or verify a tag object signed with GPG.
Junio C Hamano4ad294b2007-01-20 02:22:50688</p>
689</dd>
690</dl>
691<h3>Ancillary Commands</h3>
692<p>Manipulators:</p>
693<dl>
694<dt>
Junio C Hamanob1d6e882007-08-11 08:30:16695<a href="git-config.html">git-config(1)</a>
696</dt>
697<dd>
698<p>
699 Get and set repository or global options.
700</p>
701</dd>
702<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50703<a href="git-convert-objects.html">git-convert-objects(1)</a>
704</dt>
705<dd>
706<p>
707 Converts old-style git repository.
708</p>
709</dd>
710<dt>
Junio C Hamanodfc4ce72007-02-07 23:17:29711<a href="git-fast-import.html">git-fast-import(1)</a>
712</dt>
713<dd>
714<p>
Junio C Hamano053827f2007-02-14 07:23:58715 Backend for fast Git data importers.
Junio C Hamanodfc4ce72007-02-07 23:17:29716</p>
717</dd>
718<dt>
Junio C Hamanobb0f4042007-07-04 06:41:40719<a href="git-filter-branch.html">git-filter-branch(1)</a>
720</dt>
721<dd>
722<p>
723 Rewrite branches.
724</p>
725</dd>
726<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50727<a href="git-lost-found.html">git-lost-found(1)</a>
728</dt>
729<dd>
730<p>
731 Recover lost refs that luckily have not yet been pruned.
732</p>
733</dd>
734<dt>
Junio C Hamano103ad7f2007-03-14 11:19:26735<a href="git-mergetool.html">git-mergetool(1)</a>
736</dt>
737<dd>
738<p>
739 Run merge conflict resolution tools to resolve merge conflicts.
740</p>
741</dd>
742<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50743<a href="git-pack-refs.html">git-pack-refs(1)</a>
744</dt>
745<dd>
746<p>
747 Pack heads and tags for efficient repository access.
748</p>
749</dd>
750<dt>
751<a href="git-prune.html">git-prune(1)</a>
752</dt>
753<dd>
754<p>
Junio C Hamano4ec06712007-06-09 20:39:33755 Prune all unreachable objects from the object database.
Junio C Hamano4ad294b2007-01-20 02:22:50756</p>
757</dd>
758<dt>
759<a href="git-reflog.html">git-reflog(1)</a>
760</dt>
761<dd>
762<p>
763 Manage reflog information.
764</p>
765</dd>
766<dt>
767<a href="git-relink.html">git-relink(1)</a>
768</dt>
769<dd>
770<p>
771 Hardlink common objects in local repositories.
772</p>
773</dd>
774<dt>
Junio C Hamano053827f2007-02-14 07:23:58775<a href="git-remote.html">git-remote(1)</a>
776</dt>
777<dd>
778<p>
779 manage set of tracked repositories.
780</p>
781</dd>
Junio C Hamanob1d6e882007-08-11 08:30:16782<dt>
783<a href="git-repack.html">git-repack(1)</a>
784</dt>
785<dd>
786<p>
787 Pack unpacked objects in a repository.
788</p>
789</dd>
Junio C Hamano4ad294b2007-01-20 02:22:50790</dl>
791<p>Interrogators:</p>
792<dl>
793<dt>
794<a href="git-annotate.html">git-annotate(1)</a>
795</dt>
796<dd>
797<p>
798 Annotate file lines with commit info.
799</p>
800</dd>
801<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50802<a href="git-blame.html">git-blame(1)</a>
803</dt>
804<dd>
805<p>
806 Show what revision and author last modified each line of a file.
807</p>
808</dd>
809<dt>
810<a href="git-cherry.html">git-cherry(1)</a>
811</dt>
812<dd>
813<p>
814 Find commits not merged upstream.
815</p>
816</dd>
817<dt>
818<a href="git-count-objects.html">git-count-objects(1)</a>
819</dt>
820<dd>
821<p>
822 Count unpacked number of objects and their disk consumption.
823</p>
824</dd>
825<dt>
Junio C Hamano7ad22dc2007-01-29 02:55:48826<a href="git-fsck.html">git-fsck(1)</a>
Junio C Hamano4ad294b2007-01-20 02:22:50827</dt>
828<dd>
829<p>
830 Verifies the connectivity and validity of the objects in the database.
831</p>
832</dd>
833<dt>
834<a href="git-get-tar-commit-id.html">git-get-tar-commit-id(1)</a>
835</dt>
836<dd>
837<p>
838 Extract commit ID from an archive created using git-tar-tree.
839</p>
840</dd>
841<dt>
842<a href="git-instaweb.html">git-instaweb(1)</a>
843</dt>
844<dd>
845<p>
846 Instantly browse your working repository in gitweb.
847</p>
848</dd>
849<dt>
850<a href="git-merge-tree.html">git-merge-tree(1)</a>
851</dt>
852<dd>
853<p>
854 Show three-way merge without touching index.
855</p>
856</dd>
857<dt>
858<a href="git-rerere.html">git-rerere(1)</a>
859</dt>
860<dd>
861<p>
862 Reuse recorded resolution of conflicted merges.
863</p>
864</dd>
865<dt>
866<a href="git-rev-parse.html">git-rev-parse(1)</a>
867</dt>
868<dd>
869<p>
870 Pick out and massage parameters.
871</p>
872</dd>
873<dt>
874<a href="git-runstatus.html">git-runstatus(1)</a>
875</dt>
876<dd>
877<p>
878 A helper for git-status and git-commit.
879</p>
880</dd>
881<dt>
882<a href="git-show-branch.html">git-show-branch(1)</a>
883</dt>
884<dd>
885<p>
886 Show branches and their commits.
887</p>
888</dd>
889<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23890<a href="git-verify-tag.html">git-verify-tag(1)</a>
891</dt>
892<dd>
893<p>
Junio C Hamanob1d6e882007-08-11 08:30:16894 Check the GPG signature of tags.
Junio C Hamano1a4e8412005-12-27 08:17:23895</p>
896</dd>
897<dt>
898<a href="git-whatchanged.html">git-whatchanged(1)</a>
899</dt>
900<dd>
901<p>
Junio C Hamano7c73c662007-01-19 00:37:50902 Show logs with difference each commit introduces.
Junio C Hamano1a4e8412005-12-27 08:17:23903</p>
904</dd>
905</dl>
Junio C Hamano4ad294b2007-01-20 02:22:50906<h3>Interacting with Others</h3>
907<p>These commands are to interact with foreign SCM and with other
908people via patch over e-mail.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23909<dl>
910<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23911<a href="git-archimport.html">git-archimport(1)</a>
912</dt>
913<dd>
914<p>
Junio C Hamano7c73c662007-01-19 00:37:50915 Import an Arch repository into git.
Junio C Hamano1a4e8412005-12-27 08:17:23916</p>
917</dd>
918<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23919<a href="git-cvsexportcommit.html">git-cvsexportcommit(1)</a>
920</dt>
921<dd>
922<p>
923 Export a single commit to a CVS checkout.
924</p>
925</dd>
926<dt>
Junio C Hamano7c73c662007-01-19 00:37:50927<a href="git-cvsimport.html">git-cvsimport(1)</a>
928</dt>
929<dd>
930<p>
931 Salvage your data out of another SCM people love to hate.
932</p>
933</dd>
934<dt>
Junio C Hamano54559c82006-04-13 07:45:12935<a href="git-cvsserver.html">git-cvsserver(1)</a>
936</dt>
937<dd>
938<p>
939 A CVS server emulator for git.
940</p>
941</dd>
942<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50943<a href="git-imap-send.html">git-imap-send(1)</a>
Junio C Hamano52299462006-12-28 00:59:38944</dt>
945<dd>
946<p>
Junio C Hamano4ad294b2007-01-20 02:22:50947 Dump a mailbox from stdin into an imap folder.
Junio C Hamano1a4e8412005-12-27 08:17:23948</p>
949</dd>
950<dt>
Junio C Hamano33db4372006-06-07 19:51:45951<a href="git-quiltimport.html">git-quiltimport(1)</a>
952</dt>
953<dd>
954<p>
955 Applies a quilt patchset onto the current branch.
956</p>
957</dd>
958<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50959<a href="git-request-pull.html">git-request-pull(1)</a>
Junio C Hamano74640642006-12-27 10:59:55960</dt>
961<dd>
962<p>
Junio C Hamano4ad294b2007-01-20 02:22:50963 Generates a summary of pending changes.
Junio C Hamano74640642006-12-27 10:59:55964</p>
965</dd>
966<dt>
Junio C Hamano4ad294b2007-01-20 02:22:50967<a href="git-send-email.html">git-send-email(1)</a>
Junio C Hamano1a4e8412005-12-27 08:17:23968</dt>
969<dd>
970<p>
Junio C Hamano4ad294b2007-01-20 02:22:50971 Send a collection of patches as emails.
Junio C Hamano7c73c662007-01-19 00:37:50972</p>
973</dd>
974<dt>
Junio C Hamanob518f452006-08-04 00:18:06975<a href="git-svn.html">git-svn(1)</a>
976</dt>
977<dd>
978<p>
979 Bidirectional operation between a single Subversion branch and git.
980</p>
981</dd>
982<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23983<a href="git-svnimport.html">git-svnimport(1)</a>
984</dt>
985<dd>
986<p>
987 Import a SVN repository into git.
988</p>
989</dd>
Junio C Hamano1a4e8412005-12-27 08:17:23990</dl>
991</div>
Junio C Hamanob19b4f02006-10-29 20:47:22992<h2>Low-level commands (plumbing)</h2>
993<div class="sectionbody">
994<p>Although git includes its
995own porcelain layer, its low-level commands are sufficient to support
996development of alternative porcelains. Developers of such porcelains
997might start by reading about <a href="git-update-index.html">git-update-index(1)</a> and
998<a href="git-read-tree.html">git-read-tree(1)</a>.</p>
Junio C Hamano4ad294b2007-01-20 02:22:50999<p>The interface (input, output, set of options and the semantics)
1000to these low-level commands are meant to be a lot more stable
1001than Porcelain level commands, because these commands are
1002primarily for scripted use. The interface to Porcelain commands
1003on the other hand are subject to change in order to improve the
1004end user experience.</p>
1005<p>The following description divides
1006the low-level commands into commands that manipulate objects (in
Junio C Hamanob19b4f02006-10-29 20:47:221007the repository, index, and working tree), commands that interrogate and
1008compare objects, and commands that move objects and references between
1009repositories.</p>
1010<h3>Manipulation commands</h3>
1011<dl>
1012<dt>
1013<a href="git-apply.html">git-apply(1)</a>
1014</dt>
1015<dd>
1016<p>
Junio C Hamano7c73c662007-01-19 00:37:501017 Apply a patch on a git index file and a working tree.
Junio C Hamanob19b4f02006-10-29 20:47:221018</p>
1019</dd>
1020<dt>
1021<a href="git-checkout-index.html">git-checkout-index(1)</a>
1022</dt>
1023<dd>
1024<p>
1025 Copy files from the index to the working tree.
1026</p>
1027</dd>
1028<dt>
1029<a href="git-commit-tree.html">git-commit-tree(1)</a>
1030</dt>
1031<dd>
1032<p>
Junio C Hamano7c73c662007-01-19 00:37:501033 Create a new commit object.
Junio C Hamanob19b4f02006-10-29 20:47:221034</p>
1035</dd>
1036<dt>
1037<a href="git-hash-object.html">git-hash-object(1)</a>
1038</dt>
1039<dd>
1040<p>
Junio C Hamano7c73c662007-01-19 00:37:501041 Compute object ID and optionally creates a blob from a file.
Junio C Hamanob19b4f02006-10-29 20:47:221042</p>
1043</dd>
1044<dt>
1045<a href="git-index-pack.html">git-index-pack(1)</a>
1046</dt>
1047<dd>
1048<p>
Junio C Hamano7c73c662007-01-19 00:37:501049 Build pack index file for an existing packed archive.
Junio C Hamanob19b4f02006-10-29 20:47:221050</p>
1051</dd>
1052<dt>
Junio C Hamano1de7bc62006-12-17 19:31:541053<a href="git-merge-file.html">git-merge-file(1)</a>
1054</dt>
1055<dd>
1056<p>
Junio C Hamano7c73c662007-01-19 00:37:501057 Run a three-way file merge.
Junio C Hamano1de7bc62006-12-17 19:31:541058</p>
1059</dd>
1060<dt>
Junio C Hamanob19b4f02006-10-29 20:47:221061<a href="git-merge-index.html">git-merge-index(1)</a>
1062</dt>
1063<dd>
1064<p>
Junio C Hamano7c73c662007-01-19 00:37:501065 Run a merge for files needing merging.
Junio C Hamanob19b4f02006-10-29 20:47:221066</p>
1067</dd>
1068<dt>
1069<a href="git-mktag.html">git-mktag(1)</a>
1070</dt>
1071<dd>
1072<p>
1073 Creates a tag object.
1074</p>
1075</dd>
1076<dt>
1077<a href="git-mktree.html">git-mktree(1)</a>
1078</dt>
1079<dd>
1080<p>
1081 Build a tree-object from ls-tree formatted text.
1082</p>
1083</dd>
1084<dt>
1085<a href="git-pack-objects.html">git-pack-objects(1)</a>
1086</dt>
1087<dd>
1088<p>
Junio C Hamano7c73c662007-01-19 00:37:501089 Create a packed archive of objects.
Junio C Hamanob19b4f02006-10-29 20:47:221090</p>
1091</dd>
1092<dt>
1093<a href="git-prune-packed.html">git-prune-packed(1)</a>
1094</dt>
1095<dd>
1096<p>
1097 Remove extra objects that are already in pack files.
1098</p>
1099</dd>
1100<dt>
1101<a href="git-read-tree.html">git-read-tree(1)</a>
1102</dt>
1103<dd>
1104<p>
1105 Reads tree information into the index.
1106</p>
1107</dd>
1108<dt>
Junio C Hamano4ad294b2007-01-20 02:22:501109<a href="git-symbolic-ref.html">git-symbolic-ref(1)</a>
Junio C Hamanob19b4f02006-10-29 20:47:221110</dt>
1111<dd>
1112<p>
Junio C Hamano4ad294b2007-01-20 02:22:501113 Read and modify symbolic refs.
Junio C Hamanob19b4f02006-10-29 20:47:221114</p>
1115</dd>
1116<dt>
1117<a href="git-unpack-objects.html">git-unpack-objects(1)</a>
1118</dt>
1119<dd>
1120<p>
Junio C Hamano7c73c662007-01-19 00:37:501121 Unpack objects from a packed archive.
Junio C Hamanob19b4f02006-10-29 20:47:221122</p>
1123</dd>
1124<dt>
1125<a href="git-update-index.html">git-update-index(1)</a>
1126</dt>
1127<dd>
1128<p>
Junio C Hamano7c73c662007-01-19 00:37:501129 Register file contents in the working tree to the index.
Junio C Hamanob19b4f02006-10-29 20:47:221130</p>
1131</dd>
1132<dt>
Junio C Hamano4ad294b2007-01-20 02:22:501133<a href="git-update-ref.html">git-update-ref(1)</a>
1134</dt>
1135<dd>
1136<p>
1137 Update the object name stored in a ref safely.
1138</p>
1139</dd>
1140<dt>
Junio C Hamanob19b4f02006-10-29 20:47:221141<a href="git-write-tree.html">git-write-tree(1)</a>
1142</dt>
1143<dd>
1144<p>
Junio C Hamano7c73c662007-01-19 00:37:501145 Create a tree object from the current index.
Junio C Hamanob19b4f02006-10-29 20:47:221146</p>
1147</dd>
1148</dl>
1149<h3>Interrogation commands</h3>
1150<dl>
1151<dt>
1152<a href="git-cat-file.html">git-cat-file(1)</a>
1153</dt>
1154<dd>
1155<p>
1156 Provide content or type/size information for repository objects.
1157</p>
1158</dd>
1159<dt>
Junio C Hamanob19b4f02006-10-29 20:47:221160<a href="git-diff-files.html">git-diff-files(1)</a>
1161</dt>
1162<dd>
1163<p>
1164 Compares files in the working tree and the index.
1165</p>
1166</dd>
1167<dt>
Junio C Hamano7c73c662007-01-19 00:37:501168<a href="git-diff-index.html">git-diff-index(1)</a>
1169</dt>
1170<dd>
1171<p>
1172 Compares content and mode of blobs between the index and repository.
1173</p>
1174</dd>
1175<dt>
Junio C Hamanob19b4f02006-10-29 20:47:221176<a href="git-diff-tree.html">git-diff-tree(1)</a>
1177</dt>
1178<dd>
1179<p>
1180 Compares the content and mode of blobs found via two tree objects.
1181</p>
1182</dd>
1183<dt>
1184<a href="git-for-each-ref.html">git-for-each-ref(1)</a>
1185</dt>
1186<dd>
1187<p>
1188 Output information on each ref.
1189</p>
1190</dd>
1191<dt>
Junio C Hamanob19b4f02006-10-29 20:47:221192<a href="git-ls-files.html">git-ls-files(1)</a>
1193</dt>
1194<dd>
1195<p>
Junio C Hamano7c73c662007-01-19 00:37:501196 Show information about files in the index and the working tree.
Junio C Hamanob19b4f02006-10-29 20:47:221197</p>
1198</dd>
1199<dt>
Junio C Hamano4ad294b2007-01-20 02:22:501200<a href="git-ls-remote.html">git-ls-remote(1)</a>
1201</dt>
1202<dd>
1203<p>
1204 List references in a remote repository.
1205</p>
1206</dd>
1207<dt>
Junio C Hamanob19b4f02006-10-29 20:47:221208<a href="git-ls-tree.html">git-ls-tree(1)</a>
1209</dt>
1210<dd>
1211<p>
Junio C Hamano7c73c662007-01-19 00:37:501212 List the contents of a tree object.
Junio C Hamanob19b4f02006-10-29 20:47:221213</p>
1214</dd>
1215<dt>
1216<a href="git-merge-base.html">git-merge-base(1)</a>
1217</dt>
1218<dd>
1219<p>
Junio C Hamano7c73c662007-01-19 00:37:501220 Find as good common ancestors as possible for a merge.
Junio C Hamanob19b4f02006-10-29 20:47:221221</p>
1222</dd>
1223<dt>
1224<a href="git-name-rev.html">git-name-rev(1)</a>
1225</dt>
1226<dd>
1227<p>
1228 Find symbolic names for given revs.
1229</p>
1230</dd>
1231<dt>
1232<a href="git-pack-redundant.html">git-pack-redundant(1)</a>
1233</dt>
1234<dd>
1235<p>
1236 Find redundant pack files.
1237</p>
1238</dd>
1239<dt>
1240<a href="git-rev-list.html">git-rev-list(1)</a>
1241</dt>
1242<dd>
1243<p>
1244 Lists commit objects in reverse chronological order.
1245</p>
1246</dd>
1247<dt>
1248<a href="git-show-index.html">git-show-index(1)</a>
1249</dt>
1250<dd>
1251<p>
Junio C Hamano7c73c662007-01-19 00:37:501252 Show packed archive index.
Junio C Hamanob19b4f02006-10-29 20:47:221253</p>
1254</dd>
1255<dt>
Junio C Hamanod8c9d432006-11-07 07:19:131256<a href="git-show-ref.html">git-show-ref(1)</a>
1257</dt>
1258<dd>
1259<p>
1260 List references in a local repository.
1261</p>
1262</dd>
1263<dt>
Junio C Hamanob19b4f02006-10-29 20:47:221264<a href="git-tar-tree.html">git-tar-tree(1)</a>
1265</dt>
1266<dd>
1267<p>
Junio C Hamano7c73c662007-01-19 00:37:501268 Create a tar archive of the files in the named tree object.
Junio C Hamanob19b4f02006-10-29 20:47:221269</p>
1270</dd>
1271<dt>
1272<a href="git-unpack-file.html">git-unpack-file(1)</a>
1273</dt>
1274<dd>
1275<p>
1276 Creates a temporary file with a blob's contents.
1277</p>
1278</dd>
1279<dt>
1280<a href="git-var.html">git-var(1)</a>
1281</dt>
1282<dd>
1283<p>
Junio C Hamano7c73c662007-01-19 00:37:501284 Show a git logical variable.
Junio C Hamanob19b4f02006-10-29 20:47:221285</p>
1286</dd>
1287<dt>
1288<a href="git-verify-pack.html">git-verify-pack(1)</a>
1289</dt>
1290<dd>
1291<p>
Junio C Hamano7c73c662007-01-19 00:37:501292 Validate packed git archive files.
Junio C Hamanob19b4f02006-10-29 20:47:221293</p>
1294</dd>
1295</dl>
1296<p>In general, the interrogate commands do not touch the files in
1297the working tree.</p>
1298<h3>Synching repositories</h3>
1299<dl>
1300<dt>
Junio C Hamano4ad294b2007-01-20 02:22:501301<a href="git-daemon.html">git-daemon(1)</a>
1302</dt>
1303<dd>
1304<p>
1305 A really simple server for git repositories.
1306</p>
1307</dd>
1308<dt>
Junio C Hamanob19b4f02006-10-29 20:47:221309<a href="git-fetch-pack.html">git-fetch-pack(1)</a>
1310</dt>
1311<dd>
1312<p>
Junio C Hamano7c73c662007-01-19 00:37:501313 Receive missing objects from another repository.
Junio C Hamanob19b4f02006-10-29 20:47:221314</p>
1315</dd>
1316<dt>
Junio C Hamano7c73c662007-01-19 00:37:501317<a href="git-local-fetch.html">git-local-fetch(1)</a>
1318</dt>
1319<dd>
1320<p>
1321 Duplicate another git repository on a local system.
1322</p>
1323</dd>
1324<dt>
Junio C Hamano7c73c662007-01-19 00:37:501325<a href="git-send-pack.html">git-send-pack(1)</a>
1326</dt>
1327<dd>
1328<p>
Junio C Hamanoee1e4282007-02-04 08:32:041329 Push objects over git protocol to another repository.
Junio C Hamanob19b4f02006-10-29 20:47:221330</p>
1331</dd>
1332<dt>
Junio C Hamanob19b4f02006-10-29 20:47:221333<a href="git-ssh-fetch.html">git-ssh-fetch(1)</a>
1334</dt>
1335<dd>
1336<p>
Junio C Hamano7c73c662007-01-19 00:37:501337 Fetch from a remote repository over ssh connection.
Junio C Hamanob19b4f02006-10-29 20:47:221338</p>
1339</dd>
1340<dt>
1341<a href="git-ssh-upload.html">git-ssh-upload(1)</a>
1342</dt>
1343<dd>
1344<p>
Junio C Hamano7c73c662007-01-19 00:37:501345 Push to a remote repository over ssh connection.
Junio C Hamanob19b4f02006-10-29 20:47:221346</p>
1347</dd>
1348<dt>
1349<a href="git-update-server-info.html">git-update-server-info(1)</a>
1350</dt>
1351<dd>
1352<p>
Junio C Hamano7c73c662007-01-19 00:37:501353 Update auxiliary info file to help dumb servers.
Junio C Hamanob19b4f02006-10-29 20:47:221354</p>
1355</dd>
Junio C Hamano4ad294b2007-01-20 02:22:501356</dl>
1357<p>The following are helper programs used by the above; end users
1358typically do not use them directly.</p>
1359<dl>
1360<dt>
1361<a href="git-http-fetch.html">git-http-fetch(1)</a>
1362</dt>
1363<dd>
1364<p>
1365 Download from a remote git repository via HTTP.
1366</p>
1367</dd>
1368<dt>
1369<a href="git-http-push.html">git-http-push(1)</a>
1370</dt>
1371<dd>
1372<p>
1373 Push objects over HTTP/DAV to another repository.
1374</p>
1375</dd>
1376<dt>
1377<a href="git-parse-remote.html">git-parse-remote(1)</a>
1378</dt>
1379<dd>
1380<p>
1381 Routines to help parsing remote repository access parameters.
1382</p>
1383</dd>
1384<dt>
1385<a href="git-receive-pack.html">git-receive-pack(1)</a>
1386</dt>
1387<dd>
1388<p>
1389 Receive what is pushed into the repository.
1390</p>
1391</dd>
1392<dt>
1393<a href="git-shell.html">git-shell(1)</a>
1394</dt>
1395<dd>
1396<p>
1397 Restricted login shell for GIT-only SSH access.
1398</p>
1399</dd>
Junio C Hamanob19b4f02006-10-29 20:47:221400<dt>
1401<a href="git-upload-archive.html">git-upload-archive(1)</a>
1402</dt>
1403<dd>
1404<p>
Junio C Hamano7c73c662007-01-19 00:37:501405 Send archive back to git-archive.
Junio C Hamanob19b4f02006-10-29 20:47:221406</p>
1407</dd>
1408<dt>
1409<a href="git-upload-pack.html">git-upload-pack(1)</a>
1410</dt>
1411<dd>
1412<p>
Junio C Hamano7c73c662007-01-19 00:37:501413 Send objects packed back to git-fetch-pack.
Junio C Hamanob19b4f02006-10-29 20:47:221414</p>
1415</dd>
1416</dl>
Junio C Hamano4ad294b2007-01-20 02:22:501417<h3>Internal helper commands</h3>
1418<p>These are internal helper commands used by other commands; end
1419users typically do not use them directly.</p>
1420<dl>
1421<dt>
Junio C Hamanoe90436a2007-04-22 07:22:131422<a href="git-check-attr.html">git-check-attr(1)</a>
1423</dt>
1424<dd>
1425<p>
1426 Display gitattributes information..
1427</p>
1428</dd>
1429<dt>
Junio C Hamano4ad294b2007-01-20 02:22:501430<a href="git-check-ref-format.html">git-check-ref-format(1)</a>
1431</dt>
1432<dd>
1433<p>
1434 Make sure ref name is well formed.
1435</p>
1436</dd>
1437<dt>
1438<a href="git-fmt-merge-msg.html">git-fmt-merge-msg(1)</a>
1439</dt>
1440<dd>
1441<p>
1442 Produce a merge commit message.
1443</p>
1444</dd>
1445<dt>
1446<a href="git-mailinfo.html">git-mailinfo(1)</a>
1447</dt>
1448<dd>
1449<p>
1450 Extracts patch and authorship from a single e-mail message.
1451</p>
1452</dd>
1453<dt>
1454<a href="git-mailsplit.html">git-mailsplit(1)</a>
1455</dt>
1456<dd>
1457<p>
1458 Simple UNIX mbox splitter program.
1459</p>
1460</dd>
1461<dt>
1462<a href="git-merge-one-file.html">git-merge-one-file(1)</a>
1463</dt>
1464<dd>
1465<p>
1466 The standard helper program to use with git-merge-index.
1467</p>
1468</dd>
1469<dt>
1470<a href="git-patch-id.html">git-patch-id(1)</a>
1471</dt>
1472<dd>
1473<p>
1474 Compute unique ID for a patch.
1475</p>
1476</dd>
1477<dt>
1478<a href="git-peek-remote.html">git-peek-remote(1)</a>
1479</dt>
1480<dd>
1481<p>
1482 List the references in a remote repository.
1483</p>
1484</dd>
1485<dt>
1486<a href="git-sh-setup.html">git-sh-setup(1)</a>
1487</dt>
1488<dd>
1489<p>
1490 Common git shell script setup code.
1491</p>
1492</dd>
1493<dt>
1494<a href="git-stripspace.html">git-stripspace(1)</a>
1495</dt>
1496<dd>
1497<p>
1498 Filter out empty lines.
1499</p>
1500</dd>
1501</dl>
Junio C Hamanob19b4f02006-10-29 20:47:221502</div>
Junio C Hamano1a4e8412005-12-27 08:17:231503<h2>Configuration Mechanism</h2>
1504<div class="sectionbody">
1505<p>Starting from 0.99.9 (actually mid 0.99.8.GIT), <tt>.git/config</tt> file
1506is used to hold per-repository configuration options. It is a
Junio C Hamano51c2ab02006-07-09 20:38:541507simple text file modeled after <tt>.ini</tt> format familiar to some
Junio C Hamano1a4e8412005-12-27 08:17:231508people. Here is an example:</p>
1509<div class="listingblock">
1510<div class="content">
1511<pre><tt>#
1512# A '#' or ';' character indicates a comment.
1513#
1514
1515; core variables
1516[core]
1517 ; Don't trust file modes
1518 filemode = false
1519
1520; user identity
1521[user]
1522 name = "Junio C Hamano"
1523 email = "junkio@twinsun.com"
1524</tt></pre>
1525</div></div>
1526<p>Various commands read from the configuration file and adjust
1527their operation accordingly.</p>
1528</div>
1529<h2>Identifier Terminology</h2>
1530<div class="sectionbody">
1531<dl>
1532<dt>
1533&lt;object&gt;
1534</dt>
1535<dd>
1536<p>
1537 Indicates the object name for any type of object.
1538</p>
1539</dd>
1540<dt>
1541&lt;blob&gt;
1542</dt>
1543<dd>
1544<p>
1545 Indicates a blob object name.
1546</p>
1547</dd>
1548<dt>
1549&lt;tree&gt;
1550</dt>
1551<dd>
1552<p>
1553 Indicates a tree object name.
1554</p>
1555</dd>
1556<dt>
1557&lt;commit&gt;
1558</dt>
1559<dd>
1560<p>
1561 Indicates a commit object name.
1562</p>
1563</dd>
1564<dt>
1565&lt;tree-ish&gt;
1566</dt>
1567<dd>
1568<p>
1569 Indicates a tree, commit or tag object name. A
1570 command that takes a &lt;tree-ish&gt; argument ultimately wants to
1571 operate on a &lt;tree&gt; object but automatically dereferences
1572 &lt;commit&gt; and &lt;tag&gt; objects that point at a &lt;tree&gt;.
1573</p>
1574</dd>
1575<dt>
Junio C Hamano60f8aa82007-03-06 09:58:261576&lt;commit-ish&gt;
1577</dt>
1578<dd>
1579<p>
1580 Indicates a commit or tag object name. A
1581 command that takes a &lt;commit-ish&gt; argument ultimately wants to
1582 operate on a &lt;commit&gt; object but automatically dereferences
1583 &lt;tag&gt; objects that point at a &lt;commit&gt;.
1584</p>
1585</dd>
1586<dt>
Junio C Hamano1a4e8412005-12-27 08:17:231587&lt;type&gt;
1588</dt>
1589<dd>
1590<p>
1591 Indicates that an object type is required.
1592 Currently one of: <tt>blob</tt>, <tt>tree</tt>, <tt>commit</tt>, or <tt>tag</tt>.
1593</p>
1594</dd>
1595<dt>
1596&lt;file&gt;
1597</dt>
1598<dd>
1599<p>
1600 Indicates a filename - almost always relative to the
1601 root of the tree structure <tt>GIT_INDEX_FILE</tt> describes.
1602</p>
1603</dd>
1604</dl>
1605</div>
1606<h2>Symbolic Identifiers</h2>
1607<div class="sectionbody">
1608<p>Any git command accepting any &lt;object&gt; can also use the following
1609symbolic notation:</p>
1610<dl>
1611<dt>
1612HEAD
1613</dt>
1614<dd>
1615<p>
1616 indicates the head of the current branch (i.e. the
1617 contents of <tt>$GIT_DIR/HEAD</tt>).
1618</p>
1619</dd>
1620<dt>
1621&lt;tag&gt;
1622</dt>
1623<dd>
1624<p>
1625 a valid tag <em>name</em>
1626 (i.e. the contents of <tt>$GIT_DIR/refs/tags/&lt;tag&gt;</tt>).
1627</p>
1628</dd>
1629<dt>
1630&lt;head&gt;
1631</dt>
1632<dd>
1633<p>
1634 a valid head <em>name</em>
1635 (i.e. the contents of <tt>$GIT_DIR/refs/heads/&lt;head&gt;</tt>).
1636</p>
1637</dd>
Junio C Hamano1a4e8412005-12-27 08:17:231638</dl>
Junio C Hamanoff4b4312006-10-25 22:55:311639<p>For a more complete list of ways to spell object names, see
1640"SPECIFYING REVISIONS" section in <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p>
Junio C Hamano1a4e8412005-12-27 08:17:231641</div>
1642<h2>File/Directory Structure</h2>
1643<div class="sectionbody">
1644<p>Please see <a href="repository-layout.html">repository layout</a> document.</p>
Junio C Hamano818f7d62006-03-26 01:49:301645<p>Read <a href="hooks.html">hooks</a> for more details about each hook.</p>
Junio C Hamano1a4e8412005-12-27 08:17:231646<p>Higher level SCMs may provide and manage additional information in the
1647<tt>$GIT_DIR</tt>.</p>
1648</div>
1649<h2>Terminology</h2>
1650<div class="sectionbody">
1651<p>Please see <a href="glossary.html">glossary</a> document.</p>
1652</div>
1653<h2>Environment Variables</h2>
1654<div class="sectionbody">
1655<p>Various git commands use the following environment variables:</p>
1656<h3>The git Repository</h3>
1657<p>These environment variables apply to <em>all</em> core git commands. Nb: it
1658is worth noting that they may be used/overridden by SCMS sitting above
1659git so take care if using Cogito etc.</p>
1660<dl>
1661<dt>
1662<em>GIT_INDEX_FILE</em>
1663</dt>
1664<dd>
1665<p>
1666 This environment allows the specification of an alternate
1667 index file. If not specified, the default of <tt>$GIT_DIR/index</tt>
1668 is used.
1669</p>
1670</dd>
1671<dt>
1672<em>GIT_OBJECT_DIRECTORY</em>
1673</dt>
1674<dd>
1675<p>
1676 If the object storage directory is specified via this
1677 environment variable then the sha1 directories are created
1678 underneath - otherwise the default <tt>$GIT_DIR/objects</tt>
1679 directory is used.
1680</p>
1681</dd>
1682<dt>
1683<em>GIT_ALTERNATE_OBJECT_DIRECTORIES</em>
1684</dt>
1685<dd>
1686<p>
1687 Due to the immutable nature of git objects, old objects can be
1688 archived into shared, read-only directories. This variable
1689 specifies a ":" separated list of git object directories which
1690 can be used to search for git objects. New objects will not be
1691 written to these directories.
1692</p>
1693</dd>
1694<dt>
1695<em>GIT_DIR</em>
1696</dt>
1697<dd>
1698<p>
1699 If the <em>GIT_DIR</em> environment variable is set then it
1700 specifies a path to use instead of the default <tt>.git</tt>
1701 for the base of the repository.
1702</p>
1703</dd>
Junio C Hamanod526ba92007-07-02 00:17:421704<dt>
1705<em>GIT_WORK_TREE</em>
1706</dt>
1707<dd>
1708<p>
1709 Set the path to the working tree. The value will not be
1710 used in combination with repositories found automatically in
1711 a .git directory (i.e. $GIT_DIR is not set).
1712 This can also be controlled by the <em>--work-tree</em> command line
1713 option and the core.worktree configuration variable.
1714</p>
1715</dd>
Junio C Hamano1a4e8412005-12-27 08:17:231716</dl>
1717<h3>git Commits</h3>
1718<dl>
1719<dt>
1720<em>GIT_AUTHOR_NAME</em>
1721</dt>
1722<dt>
1723<em>GIT_AUTHOR_EMAIL</em>
1724</dt>
1725<dt>
1726<em>GIT_AUTHOR_DATE</em>
1727</dt>
1728<dt>
1729<em>GIT_COMMITTER_NAME</em>
1730</dt>
1731<dt>
1732<em>GIT_COMMITTER_EMAIL</em>
1733</dt>
Junio C Hamano469d60e2007-04-29 18:30:341734<dt>
1735<em>GIT_COMMITTER_DATE</em>
1736</dt>
1737<dt>
1738<em>EMAIL</em>
1739</dt>
Junio C Hamano1a4e8412005-12-27 08:17:231740<dd>
1741<p>
1742 see <a href="git-commit-tree.html">git-commit-tree(1)</a>
1743</p>
1744</dd>
1745</dl>
1746<h3>git Diffs</h3>
1747<dl>
1748<dt>
1749<em>GIT_DIFF_OPTS</em>
1750</dt>
Junio C Hamano1c437122006-11-28 02:22:251751<dd>
1752<p>
1753 Only valid setting is "--unified=??" or "-u??" to set the
1754 number of context lines shown when a unified diff is created.
1755 This takes precedence over any "-U" or "--unified" option
1756 value passed on the git diff command line.
1757</p>
1758</dd>
Junio C Hamano1a4e8412005-12-27 08:17:231759<dt>
1760<em>GIT_EXTERNAL_DIFF</em>
1761</dt>
1762<dd>
1763<p>
Junio C Hamano1c437122006-11-28 02:22:251764 When the environment variable <em>GIT_EXTERNAL_DIFF</em> is set, the
1765 program named by it is called, instead of the diff invocation
1766 described above. For a path that is added, removed, or modified,
1767 <em>GIT_EXTERNAL_DIFF</em> is called with 7 parameters:
Junio C Hamano1a4e8412005-12-27 08:17:231768</p>
Junio C Hamano1c437122006-11-28 02:22:251769<div class="literalblock">
1770<div class="content">
1771<pre><tt>path old-file old-hex old-mode new-file new-hex new-mode</tt></pre>
1772</div></div>
1773<p>where:</p>
1774<div class="hlist"><table>
1775<tr>
1776<td class="hlist1">
1777&lt;old|new&gt;-file
1778</td>
1779<td class="hlist2">
1780are files GIT_EXTERNAL_DIFF can use to read the
1781 contents of &lt;old|new&gt;,
1782</td>
1783</tr>
1784<tr>
1785<td class="hlist1">
1786&lt;old|new&gt;-hex
1787</td>
1788<td class="hlist2">
1789are the 40-hexdigit SHA1 hashes,
1790</td>
1791</tr>
1792<tr>
1793<td class="hlist1">
1794&lt;old|new&gt;-mode
1795</td>
1796<td class="hlist2">
1797are the octal representation of the file modes.
1798</td>
1799</tr>
1800</table></div>
1801<p>The file parameters can point at the user's working file
1802(e.g. <tt>new-file</tt> in "git-diff-files"), <tt>/dev/null</tt> (e.g. <tt>old-file</tt>
1803when a new file is added), or a temporary file (e.g. <tt>old-file</tt> in the
1804index). <em>GIT_EXTERNAL_DIFF</em> should not worry about unlinking the
1805temporary file --- it is removed when <em>GIT_EXTERNAL_DIFF</em> exits.</p>
1806<p>For a path that is unmerged, <em>GIT_EXTERNAL_DIFF</em> is called with 1
1807parameter, &lt;path&gt;.</p>
Junio C Hamano1a4e8412005-12-27 08:17:231808</dd>
1809</dl>
Junio C Hamano7ccb9fd2006-07-15 01:38:401810<h3>other</h3>
1811<dl>
1812<dt>
Junio C Hamano1e6e0062007-07-13 05:33:251813<em>GIT_MERGE_VERBOSITY</em>
1814</dt>
1815<dd>
1816<p>
1817 A number controlling the amount of output shown by
1818 the recursive merge strategy. Overrides merge.verbosity.
1819 See <a href="git-merge.html">git-merge(1)</a>
1820</p>
1821</dd>
1822<dt>
Junio C Hamano85e45fa2006-08-13 07:47:411823<em>GIT_PAGER</em>
1824</dt>
1825<dd>
1826<p>
Junio C Hamanof6002a92007-07-20 10:28:221827 This environment variable overrides <tt>$PAGER</tt>. If it is set
1828 to an empty string or to the value "cat", git will not launch
1829 a pager.
Junio C Hamano85e45fa2006-08-13 07:47:411830</p>
1831</dd>
1832<dt>
Junio C Hamano4cd1c0e2007-08-06 04:39:141833<em>GIT_SSH</em>
1834</dt>
1835<dd>
1836<p>
1837 If this environment variable is set then <a href="git-fetch.html">git-fetch(1)</a>
1838 and <a href="git-push.html">git-push(1)</a> will use this command instead
1839 of <tt>ssh</tt> when they need to connect to a remote system.
1840 The <em>GIT_SSH</em> command will be given exactly two arguments:
1841 the <em>username@host</em> (or just <em>host</em>) from the URL and the
1842 shell command to execute on that remote system.
1843</p>
1844<p>To pass options to the program that you want to list in GIT_SSH
1845you will need to wrap the program and options into a shell script,
1846then set GIT_SSH to refer to the shell script.</p>
1847<p>Usually it is easier to configure any desired options through your
1848personal <tt>.ssh/config</tt> file. Please consult your ssh documentation
1849for further details.</p>
1850</dd>
1851<dt>
Junio C Hamano401939f2007-07-01 06:34:301852<em>GIT_FLUSH</em>
1853</dt>
1854<dd>
1855<p>
1856 If this environment variable is set to "1", then commands such
1857 as git-blame (in incremental mode), git-rev-list, git-log,
1858 git-whatchanged, etc., will force a flush of the output stream
1859 after each commit-oriented record have been flushed. If this
1860 variable is set to "0", the output of these commands will be done
1861 using completely buffered I/O. If this environment variable is
1862 not set, git will choose buffered or record-oriented flushing
1863 based on whether stdout appears to be redirected to a file or not.
1864</p>
1865</dd>
1866<dt>
Junio C Hamano7ccb9fd2006-07-15 01:38:401867<em>GIT_TRACE</em>
1868</dt>
1869<dd>
1870<p>
Junio C Hamanoef4b48b2006-09-04 10:08:341871 If this variable is set to "1", "2" or "true" (comparison
1872 is case insensitive), git will print <tt>trace:</tt> messages on
Junio C Hamano7ccb9fd2006-07-15 01:38:401873 stderr telling about alias expansion, built-in command
1874 execution and external command execution.
Junio C Hamanoef4b48b2006-09-04 10:08:341875 If this variable is set to an integer value greater than 1
1876 and lower than 10 (strictly) then git will interpret this
1877 value as an open file descriptor and will try to write the
1878 trace messages into this file descriptor.
1879 Alternatively, if this variable is set to an absolute path
1880 (starting with a <em>/</em> character), git will interpret this
1881 as a file path and will try to write the trace messages
1882 into it.
Junio C Hamano7ccb9fd2006-07-15 01:38:401883</p>
1884</dd>
1885</dl>
Junio C Hamano1a4e8412005-12-27 08:17:231886</div>
1887<h2>Discussion<a id="Discussion"></a></h2>
1888<div class="sectionbody">
Junio C Hamano597ffcf2007-09-17 17:33:151889<p>More detail on the following is available from the
1890<a href="user-manual.html#git-concepts">git concepts chapter of the
1891user-manual</a> and the <a href="core-tutorial.html">Core tutorial</a>.</p>
1892<p>A git project normally consists of a working directory with a ".git"
1893subdirectory at the top level. The .git directory contains, among other
1894things, a compressed object database representing the complete history
1895of the project, an "index" file which links that history to the current
1896contents of the working tree, and named pointers into that history such
1897as tags and branch heads.</p>
1898<p>The object database contains objects of three main types: blobs, which
1899hold file data; trees, which point to blobs and other trees to build up
1900directory heirarchies; and commits, which each reference a single tree
1901and some number of parent commits.</p>
1902<p>The commit, equivalent to what other systems call a "changeset" or
1903"version", represents a step in the project's history, and each parent
1904represents an immediately preceding step. Commits with more than one
1905parent represent merges of independent lines of development.</p>
1906<p>All objects are named by the SHA1 hash of their contents, normally
1907written as a string of 40 hex digits. Such names are globally unique.
1908The entire history leading up to a commit can be vouched for by signing
1909just that commit. A fourth object type, the tag, is provided for this
1910purpose.</p>
1911<p>When first created, objects are stored in individual files, but for
1912efficiency may later be compressed together into "pack files".</p>
1913<p>Named pointers called refs mark interesting points in history. A ref
1914may contain the SHA1 name of an object or the name of another ref. Refs
1915with names beginning <tt>ref/head/</tt> contain the SHA1 name of the most
1916recent commit (or "head") of a branch under developement. SHA1 names of
1917tags of interest are stored under <tt>ref/tags/</tt>. A special ref named
1918<tt>HEAD</tt> contains the name of the currently checked-out branch.</p>
1919<p>The index file is initialized with a list of all paths and, for each
1920path, a blob object and a set of attributes. The blob object represents
1921the contents of the file as of the head of the current branch. The
1922attributes (last modified time, size, etc.) are taken from the
1923corresponding file in the working tree. Subsequent changes to the
1924working tree can be found by comparing these attributes. The index may
1925be updated with new content, and new commits may be created from the
1926content stored in the index.</p>
1927<p>The index is also capable of storing multiple entries (called "stages")
1928for a given pathname. These stages are used to hold the various
1929unmerged version of a file when a merge is in progress.</p>
Junio C Hamano1a4e8412005-12-27 08:17:231930</div>
1931<h2>Authors</h2>
1932<div class="sectionbody">
1933<ul>
1934<li>
1935<p>
1936git's founding father is Linus Torvalds &lt;torvalds@osdl.org&gt;.
1937</p>
1938</li>
1939<li>
1940<p>
Junio C Hamanodbb64592007-09-01 11:17:391941The current git nurse is Junio C Hamano &lt;gitster@pobox.com&gt;.
Junio C Hamano1a4e8412005-12-27 08:17:231942</p>
1943</li>
1944<li>
1945<p>
1946The git potty was written by Andres Ericsson &lt;ae@op5.se&gt;.
1947</p>
1948</li>
1949<li>
1950<p>
1951General upbringing is handled by the git-list &lt;git@vger.kernel.org&gt;.
1952</p>
1953</li>
1954</ul>
1955</div>
1956<h2>Documentation</h2>
1957<div class="sectionbody">
1958<p>The documentation for git suite was started by David Greaves
1959&lt;david@dgreaves.com&gt;, and later enhanced greatly by the
1960contributors on the git-list &lt;git@vger.kernel.org&gt;.</p>
1961</div>
1962<h2>GIT</h2>
1963<div class="sectionbody">
1964<p>Part of the <a href="git.html">git(7)</a> suite</p>
1965</div>
1966<div id="footer">
1967<div id="footer-text">
Junio C Hamano597ffcf2007-09-17 17:33:151968Last updated 17-Sep-2007 17:32:48 UTC
Junio C Hamano1a4e8412005-12-27 08:17:231969</div>
1970</div>
1971</body>
1972</html>