Google Git
Sign in
chromium / external / gitster / git-htmldocs / 8b4977b44285027907f70d94ee9fed0d5bec5f4b / . / git-archive.html
blob: 7d02a68f63e678504e59fb58c221173cff1de01e [file] [log] [blame]
Junio C Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[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 Hamano781d8a22006-09-17 10:34:15[diff] [blame]306</style>
307<title>git-archive(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-archive(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-archive -
Junio C Hamano4ec06712007-06-09 20:39:33[diff] [blame]317 Create an archive of files from a named tree
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanoa9b8d242007-05-19 04:51:55[diff] [blame]323<div class="verseblock">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]324<div class="content"><em>git archive</em> --format=&lt;fmt&gt; [--list] [--prefix=&lt;prefix&gt;/] [&lt;extra&gt;]
Junio C Hamano764a6672007-10-23 01:23:31[diff] [blame]325 [--remote=&lt;repo&gt; [--exec=&lt;git-upload-archive&gt;]] &lt;tree-ish&gt;
326 [path&#8230;]</div></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]327</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]328<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]329<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]330<div class="para"><p>Creates an archive of the specified format containing the tree
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]331structure for the named tree, and writes it out to the standard
332output. If &lt;prefix&gt; is specified it is
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]333prepended to the filenames in the archive.</p></div>
334<div class="para"><p><em>git-archive</em> behaves differently when given a tree ID versus when
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]335given a commit ID or tag ID. In the first case the current time is
336used as modification time of each file in the archive. In the latter
337case the commit time as recorded in the referenced commit object is
338used instead. Additionally the commit ID is stored in a global
339extended pax header if the tar format is used; it can be extracted
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]340using <em>git-get-tar-commit-id</em>. In ZIP files it is stored as a file
341comment.</p></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]342</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]343<h2 id="_options">OPTIONS</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]344<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]345<div class="vlist"><dl>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]346<dt>
347--format=&lt;fmt&gt;
348</dt>
349<dd>
350<p>
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]351 Format of the resulting archive: <em>tar</em> or <em>zip</em>. The default
Junio C Hamanoc3f1dbf2007-04-10 21:31:32[diff] [blame]352 is <em>tar</em>.
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]353</p>
354</dd>
355<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]356-l
357</dt>
358<dt>
359--list
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]360</dt>
361<dd>
362<p>
363 Show all available formats.
364</p>
365</dd>
366<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]367-v
368</dt>
369<dt>
370--verbose
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]371</dt>
372<dd>
373<p>
374 Report progress to stderr.
375</p>
376</dd>
377<dt>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]378--prefix=&lt;prefix&gt;/
379</dt>
380<dd>
381<p>
382 Prepend &lt;prefix&gt;/ to each filename in the archive.
383</p>
384</dd>
385<dt>
386&lt;extra&gt;
387</dt>
388<dd>
389<p>
390 This can be any options that the archiver backend understand.
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]391 See next section.
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]392</p>
393</dd>
394<dt>
395--remote=&lt;repo&gt;
396</dt>
397<dd>
398<p>
399 Instead of making a tar archive from local repository,
400 retrieve a tar archive from a remote repository.
401</p>
402</dd>
403<dt>
Junio C Hamano764a6672007-10-23 01:23:31[diff] [blame]404--exec=&lt;git-upload-archive&gt;
405</dt>
406<dd>
407<p>
408 Used with --remote to specify the path to the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]409 <em>git-upload-archive</em> on the remote side.
Junio C Hamano764a6672007-10-23 01:23:31[diff] [blame]410</p>
411</dd>
412<dt>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]413&lt;tree-ish&gt;
414</dt>
415<dd>
416<p>
417 The tree or commit to produce an archive for.
418</p>
419</dd>
420<dt>
421path
422</dt>
423<dd>
424<p>
425 If one or more paths are specified, include only these in the
426 archive, otherwise include all files and subdirectories.
427</p>
428</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]429</dl></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]430</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]431<h2 id="_backend_extra_options">BACKEND EXTRA OPTIONS</h2>
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]432<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]433<h3 id="_zip">zip</h3><div style="clear:left"></div>
434<div class="vlist"><dl>
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]435<dt>
436-0
437</dt>
438<dd>
439<p>
440 Store the files instead of deflating them.
441</p>
442</dd>
443<dt>
444-9
445</dt>
446<dd>
447<p>
448 Highest and slowest compression level. You can specify any
449 number from 1 to 9 to adjust compression speed and ratio.
450</p>
451</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]452</dl></div>
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]453</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]454<h2 id="_configuration">CONFIGURATION</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]455<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]456<div class="vlist"><dl>
Junio C Hamanobdebabb2007-08-23 00:25:09[diff] [blame]457<dt>
458tar.umask
459</dt>
460<dd>
461<p>
462 This variable can be used to restrict the permission bits of
463 tar archive entries. The default is 0002, which turns off the
464 world write bit. The special value "user" indicates that the
465 archiving user's umask will be used instead. See umask(2) for
466 details.
467</p>
468</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]469</dl></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]470</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]471<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]472<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]473<div class="vlist"><dl>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]474<dt>
475git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ &amp;&amp; tar xf -)
476</dt>
477<dd>
478<p>
479 Create a tar archive that contains the contents of the
480 latest commit on the current branch, and extracts it in
481 <tt>/var/tmp/junk</tt> directory.
482</p>
483</dd>
484<dt>
485git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip &gt;git-1.4.0.tar.gz
486</dt>
487<dd>
488<p>
489 Create a compressed tarball for v1.4.0 release.
490</p>
491</dd>
492<dt>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]493git archive --format=tar --prefix=git-1.4.0/ v1.4.0&#94;{tree} | gzip &gt;git-1.4.0.tar.gz
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]494</dt>
495<dd>
496<p>
497 Create a compressed tarball for v1.4.0 release, but without a
498 global extended pax header.
499</p>
500</dd>
501<dt>
502git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ &gt; git-1.4.0-docs.zip
503</dt>
504<dd>
505<p>
506 Put everything in the current head's Documentation/ directory
507 into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.
508</p>
509</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]510</dl></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]511</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]512<h2 id="_author">Author</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]513<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]514<div class="para"><p>Written by Franck Bui-Huu and Rene Scharfe.</p></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]515</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]516<h2 id="_documentation">Documentation</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]517<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]518<div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]519</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]520<h2 id="_git">GIT</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]521<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]522<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]523</div>
524<div id="footer">
525<div id="footer-text">
Junio C Hamano6f1bbb72008-10-31 11:32:55[diff] [blame]526Last updated 2008-10-31 11:28:20 UTC
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]527</div>
528</div>
529</body>
530</html>