Google Git
Sign in
chromium / external / gitster / git-htmldocs / e59a0072cf9a106b3fd372b42531d9338e668409 / . / git-archive.html
blob: 5948cc6789e2aae96e543855c1244ae6c49c3f4e [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" />
6<meta name="generator" content="AsciiDoc 7.0.2" />
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
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-archive(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-archive(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-archive -
Junio C Hamano4ec06712007-06-09 20:39:33[diff] [blame]269 Create an archive of files from a named tree
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamanoa9b8d242007-05-19 04:51:55[diff] [blame]275<div class="verseblock">
276<div class="content"><em>git-archive</em> --format=&lt;fmt&gt; [--list] [--prefix=&lt;prefix&gt;/] [&lt;extra&gt;]
277 [--remote=&lt;repo&gt;] &lt;tree-ish&gt; [path&#8230;]</div></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]278</div>
279<h2>DESCRIPTION</h2>
280<div class="sectionbody">
281<p>Creates an archive of the specified format containing the tree
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]282structure for the named tree, and writes it out to the standard
283output. If &lt;prefix&gt; is specified it is
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]284prepended to the filenames in the archive.</p>
285<p><em>git-archive</em> behaves differently when given a tree ID versus when
286given a commit ID or tag ID. In the first case the current time is
287used as modification time of each file in the archive. In the latter
288case the commit time as recorded in the referenced commit object is
289used instead. Additionally the commit ID is stored in a global
290extended pax header if the tar format is used; it can be extracted
291using <em>git-get-tar-commit-id</em>. In ZIP files it is stored as a file
292comment.</p>
293</div>
294<h2>OPTIONS</h2>
295<div class="sectionbody">
296<dl>
297<dt>
298--format=&lt;fmt&gt;
299</dt>
300<dd>
301<p>
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]302 Format of the resulting archive: <em>tar</em> or <em>zip</em>. The default
Junio C Hamanoc3f1dbf2007-04-10 21:31:32[diff] [blame]303 is <em>tar</em>.
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]304</p>
305</dd>
306<dt>
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]307--list, -l
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]308</dt>
309<dd>
310<p>
311 Show all available formats.
312</p>
313</dd>
314<dt>
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]315--verbose, -v
316</dt>
317<dd>
318<p>
319 Report progress to stderr.
320</p>
321</dd>
322<dt>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]323--prefix=&lt;prefix&gt;/
324</dt>
325<dd>
326<p>
327 Prepend &lt;prefix&gt;/ to each filename in the archive.
328</p>
329</dd>
330<dt>
331&lt;extra&gt;
332</dt>
333<dd>
334<p>
335 This can be any options that the archiver backend understand.
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]336 See next section.
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]337</p>
338</dd>
339<dt>
340--remote=&lt;repo&gt;
341</dt>
342<dd>
343<p>
344 Instead of making a tar archive from local repository,
345 retrieve a tar archive from a remote repository.
346</p>
347</dd>
348<dt>
349&lt;tree-ish&gt;
350</dt>
351<dd>
352<p>
353 The tree or commit to produce an archive for.
354</p>
355</dd>
356<dt>
357path
358</dt>
359<dd>
360<p>
361 If one or more paths are specified, include only these in the
362 archive, otherwise include all files and subdirectories.
363</p>
364</dd>
365</dl>
366</div>
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]367<h2>BACKEND EXTRA OPTIONS</h2>
368<div class="sectionbody">
369<h3>zip</h3>
370<dl>
371<dt>
372-0
373</dt>
374<dd>
375<p>
376 Store the files instead of deflating them.
377</p>
378</dd>
379<dt>
380-9
381</dt>
382<dd>
383<p>
384 Highest and slowest compression level. You can specify any
385 number from 1 to 9 to adjust compression speed and ratio.
386</p>
387</dd>
388</dl>
389</div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]390<h2>CONFIGURATION</h2>
391<div class="sectionbody">
Junio C Hamanobdebabb2007-08-23 00:25:09[diff] [blame]392<dl>
393<dt>
394tar.umask
395</dt>
396<dd>
397<p>
398 This variable can be used to restrict the permission bits of
399 tar archive entries. The default is 0002, which turns off the
400 world write bit. The special value "user" indicates that the
401 archiving user's umask will be used instead. See umask(2) for
402 details.
403</p>
404</dd>
405</dl>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]406</div>
407<h2>EXAMPLES</h2>
408<div class="sectionbody">
409<dl>
410<dt>
411git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ &amp;&amp; tar xf -)
412</dt>
413<dd>
414<p>
415 Create a tar archive that contains the contents of the
416 latest commit on the current branch, and extracts it in
417 <tt>/var/tmp/junk</tt> directory.
418</p>
419</dd>
420<dt>
421git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip &gt;git-1.4.0.tar.gz
422</dt>
423<dd>
424<p>
425 Create a compressed tarball for v1.4.0 release.
426</p>
427</dd>
428<dt>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]429git 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]430</dt>
431<dd>
432<p>
433 Create a compressed tarball for v1.4.0 release, but without a
434 global extended pax header.
435</p>
436</dd>
437<dt>
438git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ &gt; git-1.4.0-docs.zip
439</dt>
440<dd>
441<p>
442 Put everything in the current head's Documentation/ directory
443 into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.
444</p>
445</dd>
446</dl>
447</div>
448<h2>Author</h2>
449<div class="sectionbody">
450<p>Written by Franck Bui-Huu and Rene Scharfe.</p>
451</div>
452<h2>Documentation</h2>
453<div class="sectionbody">
454<p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
455</div>
456<h2>GIT</h2>
457<div class="sectionbody">
458<p>Part of the <a href="git.html">git(7)</a> suite</p>
459</div>
460<div id="footer">
461<div id="footer-text">
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]462Last updated 15-Sep-2007 07:45:31 UTC
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]463</div>
464</div>
465</body>
466</html>