Google Git
Sign in
chromium / external / gitster / git-htmldocs / 7bd050fbdc12530213c7058bbba1b4a333ec7c02 / . / git-archive.html
blob: 16d14c08426444d81954468c4f74c482e63c22a7 [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 Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7<title>git-archive(1)</title>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]30 color: navy;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]35 color: #083194;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]91}
92span#email {
93}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]121 margin-top: 1.0em;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]137 color: #527bbd;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]177
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]180 text-align: right;
181}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]182
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]205 border-left: 3px solid #dddddd;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]211}
212
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]260thead, p.table.header {
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]285
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286
287div.hdlist {
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]293}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]298 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]299 font-style: normal;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]301 color: navy;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]302}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]303td.hdlist2 {
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]402 color: #527bbd;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]429 border-left: 3px solid #dddddd;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-archive(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-archive -
Junio C Hamano4ec06712007-06-09 20:39:33[diff] [blame]578 Create an archive of files from a named tree
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]582<div id="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]584<div class="sectionbody">
Junio C Hamanoa9b8d242007-05-19 04:51:55[diff] [blame]585<div class="verseblock">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]586<div class="verseblock-content"><em>git archive</em> [--format=&lt;fmt&gt;] [--list] [--prefix=&lt;prefix&gt;/] [&lt;extra&gt;]
Junio C Hamanod6fff402009-09-14 09:40:50[diff] [blame]587 [-o | --output=&lt;file&gt;] [--worktree-attributes]
Junio C Hamano764a6672007-10-23 01:23:31[diff] [blame]588 [--remote=&lt;repo&gt; [--exec=&lt;git-upload-archive&gt;]] &lt;tree-ish&gt;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]589 [&lt;path&gt;&#8230;]</div>
590<div class="verseblock-attribution">
591</div></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]592</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]593<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]594<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]595<div class="paragraph"><p>Creates an archive of the specified format containing the tree
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]596structure for the named tree, and writes it out to the standard
597output. If &lt;prefix&gt; is specified it is
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]598prepended to the filenames in the archive.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]599<div class="paragraph"><p><em>git archive</em> behaves differently when given a tree ID versus when
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]600given a commit ID or tag ID. In the first case the current time is
Junio C Hamanofd83b8e2009-03-22 08:21:41[diff] [blame]601used as the modification time of each file in the archive. In the latter
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]602case the commit time as recorded in the referenced commit object is
603used instead. Additionally the commit ID is stored in a global
604extended pax header if the tar format is used; it can be extracted
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]605using <em>git get-tar-commit-id</em>. In ZIP files it is stored as a file
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]606comment.</p></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]607</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]608<h2 id="_options">OPTIONS</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]609<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]610<div class="dlist"><dl>
611<dt class="hdlist1">
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]612--format=&lt;fmt&gt;
613</dt>
614<dd>
615<p>
Junio C Hamanod6fff402009-09-14 09:40:50[diff] [blame]616 Format of the resulting archive: <em>tar</em> or <em>zip</em>. If this option
617 is not given, and the output file is specified, the format is
618 inferred from the filename if possible (e.g. writing to "foo.zip"
619 makes the output to be in the zip format). Otherwise the output
620 format is <tt>tar</tt>.
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]621</p>
622</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]623<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]624-l
625</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]626<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]627--list
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]628</dt>
629<dd>
630<p>
631 Show all available formats.
632</p>
633</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]634<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]635-v
636</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]637<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]638--verbose
Junio C Hamano81c711d2007-04-20 07:20:14[diff] [blame]639</dt>
640<dd>
641<p>
642 Report progress to stderr.
643</p>
644</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]645<dt class="hdlist1">
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]646--prefix=&lt;prefix&gt;/
647</dt>
648<dd>
649<p>
650 Prepend &lt;prefix&gt;/ to each filename in the archive.
651</p>
652</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]653<dt class="hdlist1">
Junio C Hamanod6fff402009-09-14 09:40:50[diff] [blame]654-o &lt;file&gt;
655</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]656<dt class="hdlist1">
Junio C Hamano36ac9932009-03-05 09:57:10[diff] [blame]657--output=&lt;file&gt;
658</dt>
659<dd>
660<p>
661 Write the archive to &lt;file&gt; instead of stdout.
662</p>
663</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]664<dt class="hdlist1">
Junio C Hamano4cfa5362009-04-18 23:01:01[diff] [blame]665--worktree-attributes
666</dt>
667<dd>
668<p>
669 Look for attributes in .gitattributes in working directory too.
670</p>
671</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]672<dt class="hdlist1">
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]673&lt;extra&gt;
674</dt>
675<dd>
676<p>
Junio C Hamanofd83b8e2009-03-22 08:21:41[diff] [blame]677 This can be any options that the archiver backend understands.
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]678 See next section.
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]679</p>
680</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]681<dt class="hdlist1">
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]682--remote=&lt;repo&gt;
683</dt>
684<dd>
685<p>
Junio C Hamanofd83b8e2009-03-22 08:21:41[diff] [blame]686 Instead of making a tar archive from the local repository,
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]687 retrieve a tar archive from a remote repository.
688</p>
689</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]690<dt class="hdlist1">
Junio C Hamano764a6672007-10-23 01:23:31[diff] [blame]691--exec=&lt;git-upload-archive&gt;
692</dt>
693<dd>
694<p>
695 Used with --remote to specify the path to the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]696 <em>git-upload-archive</em> on the remote side.
Junio C Hamano764a6672007-10-23 01:23:31[diff] [blame]697</p>
698</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]699<dt class="hdlist1">
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]700&lt;tree-ish&gt;
701</dt>
702<dd>
703<p>
704 The tree or commit to produce an archive for.
705</p>
706</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]707<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]708&lt;path&gt;
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]709</dt>
710<dd>
711<p>
Junio C Hamanoe5574b62009-12-06 04:04:45[diff] [blame]712 Without an optional path parameter, all files and subdirectories
713 of the current working directory are included in the archive.
714 If one or more paths are specified, only these are included.
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]715</p>
716</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]717</dl></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]718</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]719<h2 id="_backend_extra_options">BACKEND EXTRA OPTIONS</h2>
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]720<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]721<h3 id="_zip">zip</h3><div style="clear:left"></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]722<div class="dlist"><dl>
723<dt class="hdlist1">
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]724-0
725</dt>
726<dd>
727<p>
728 Store the files instead of deflating them.
729</p>
730</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]731<dt class="hdlist1">
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]732-9
733</dt>
734<dd>
735<p>
736 Highest and slowest compression level. You can specify any
737 number from 1 to 9 to adjust compression speed and ratio.
738</p>
739</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]740</dl></div>
Junio C Hamano817abb42006-09-26 07:16:58[diff] [blame]741</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]742<h2 id="_configuration">CONFIGURATION</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]743<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]744<div class="dlist"><dl>
745<dt class="hdlist1">
Junio C Hamanobdebabb2007-08-23 00:25:09[diff] [blame]746tar.umask
747</dt>
748<dd>
749<p>
750 This variable can be used to restrict the permission bits of
751 tar archive entries. The default is 0002, which turns off the
752 world write bit. The special value "user" indicates that the
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]753 archiving user&#8217;s umask will be used instead. See umask(2) for
Junio C Hamanof75a9402011-04-14 23:39:23[diff] [blame]754 details. If <tt>--remote</tt> is used then only the configuration of
755 the remote repository takes effect.
Junio C Hamanobdebabb2007-08-23 00:25:09[diff] [blame]756</p>
757</dd>
Junio C Hamano708376e2011-07-19 20:02:13[diff] [blame]758<dt class="hdlist1">
759tar.&lt;format&gt;.command
760</dt>
761<dd>
762<p>
763 This variable specifies a shell command through which the tar
764 output generated by <tt>git archive</tt> should be piped. The command
765 is executed using the shell with the generated tar file on its
766 standard input, and should produce the final output on its
767 standard output. Any compression-level options will be passed
768 to the command (e.g., "-9"). An output file with the same
769 extension as <tt>&lt;format&gt;</tt> will be use this format if no other
770 format is given.
771</p>
772<div class="paragraph"><p>The "tar.gz" and "tgz" formats are defined automatically and default to
773<tt>gzip -cn</tt>. You may override them with custom commands.</p></div>
774</dd>
775<dt class="hdlist1">
776tar.&lt;format&gt;.remote
777</dt>
778<dd>
779<p>
780 If true, enable <tt>&lt;format&gt;</tt> for use by remote clients via
781 <a href="git-upload-archive.html">git-upload-archive(1)</a>. Defaults to false for
782 user-defined formats, but true for the "tar.gz" and "tgz"
783 formats.
784</p>
785</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]786</dl></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]787</div>
Junio C Hamanoa9eca4e2009-03-04 08:29:59[diff] [blame]788<h2 id="_attributes">ATTRIBUTES</h2>
789<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]790<div class="dlist"><dl>
791<dt class="hdlist1">
Junio C Hamanoa9eca4e2009-03-04 08:29:59[diff] [blame]792export-ignore
793</dt>
794<dd>
795<p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]796 Files and directories with the attribute export-ignore won&#8217;t be
Junio C Hamanoa9eca4e2009-03-04 08:29:59[diff] [blame]797 added to archive files. See <a href="gitattributes.html">gitattributes(5)</a> for details.
798</p>
799</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]800<dt class="hdlist1">
Junio C Hamanoa9eca4e2009-03-04 08:29:59[diff] [blame]801export-subst
802</dt>
803<dd>
804<p>
805 If the attribute export-subst is set for a file then git will
806 expand several placeholders when adding this file to an archive.
807 See <a href="gitattributes.html">gitattributes(5)</a> for details.
808</p>
809</dd>
810</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]811<div class="paragraph"><p>Note that attributes are by default taken from the <tt>.gitattributes</tt> files
Junio C Hamano1123f302010-02-12 20:51:24[diff] [blame]812in the tree that is being archived. If you want to tweak the way the
813output is generated after the fact (e.g. you committed without adding an
814appropriate export-ignore in its <tt>.gitattributes</tt>), adjust the checked out
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]815<tt>.gitattributes</tt> file as necessary and use <tt>--worktree-attributes</tt>
Junio C Hamano1123f302010-02-12 20:51:24[diff] [blame]816option. Alternatively you can keep necessary attributes that should apply
817while archiving any tree in your <tt>$GIT_DIR/info/attributes</tt> file.</p></div>
Junio C Hamanoa9eca4e2009-03-04 08:29:59[diff] [blame]818</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]819<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]820<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]821<div class="dlist"><dl>
822<dt class="hdlist1">
Junio C Hamano16ebcd02011-08-05 00:05:45[diff] [blame]823<tt>git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ &amp;&amp; tar xf -)</tt>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]824</dt>
825<dd>
826<p>
827 Create a tar archive that contains the contents of the
Junio C Hamanofd83b8e2009-03-22 08:21:41[diff] [blame]828 latest commit on the current branch, and extract it in the
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]829 <tt>/var/tmp/junk</tt> directory.
830</p>
831</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]832<dt class="hdlist1">
Junio C Hamano16ebcd02011-08-05 00:05:45[diff] [blame]833<tt>git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip &gt;git-1.4.0.tar.gz</tt>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]834</dt>
835<dd>
836<p>
837 Create a compressed tarball for v1.4.0 release.
838</p>
839</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]840<dt class="hdlist1">
Junio C Hamano16ebcd02011-08-05 00:05:45[diff] [blame]841<tt>git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 &gt;git-1.4.0.tar.gz</tt>
Junio C Hamano708376e2011-07-19 20:02:13[diff] [blame]842</dt>
843<dd>
844<p>
845 Same as above, but using the builtin tar.gz handling.
846</p>
847</dd>
848<dt class="hdlist1">
Junio C Hamano16ebcd02011-08-05 00:05:45[diff] [blame]849<tt>git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0</tt>
Junio C Hamano708376e2011-07-19 20:02:13[diff] [blame]850</dt>
851<dd>
852<p>
853 Same as above, but the format is inferred from the output file.
854</p>
855</dd>
856<dt class="hdlist1">
Junio C Hamano16ebcd02011-08-05 00:05:45[diff] [blame]857<tt>git archive --format=tar --prefix=git-1.4.0/ v1.4.0&#94;{tree} | gzip &gt;git-1.4.0.tar.gz</tt>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]858</dt>
859<dd>
860<p>
861 Create a compressed tarball for v1.4.0 release, but without a
862 global extended pax header.
863</p>
864</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]865<dt class="hdlist1">
Junio C Hamano16ebcd02011-08-05 00:05:45[diff] [blame]866<tt>git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ &gt; git-1.4.0-docs.zip</tt>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]867</dt>
868<dd>
869<p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]870 Put everything in the current head&#8217;s Documentation/ directory
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]871 into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.
872</p>
873</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]874<dt class="hdlist1">
Junio C Hamano16ebcd02011-08-05 00:05:45[diff] [blame]875<tt>git archive -o latest.zip HEAD</tt>
Junio C Hamanod6fff402009-09-14 09:40:50[diff] [blame]876</dt>
877<dd>
878<p>
879 Create a Zip archive that contains the contents of the latest
880 commit on the current branch. Note that the output format is
881 inferred by the extension of the output file.
882</p>
883</dd>
Junio C Hamano708376e2011-07-19 20:02:13[diff] [blame]884<dt class="hdlist1">
Junio C Hamano16ebcd02011-08-05 00:05:45[diff] [blame]885<tt>git config tar.tar.xz.command "xz -c"</tt>
Junio C Hamano708376e2011-07-19 20:02:13[diff] [blame]886</dt>
887<dd>
888<p>
889 Configure a "tar.xz" format for making LZMA-compressed tarfiles.
890 You can use it specifying <tt>--format=tar.xz</tt>, or by creating an
891 output file like <tt>-o foo.tar.xz</tt>.
892</p>
893</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]894</dl></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]895</div>
Junio C Hamanoa9eca4e2009-03-04 08:29:59[diff] [blame]896<h2 id="_see_also">SEE ALSO</h2>
897<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]898<div class="paragraph"><p><a href="gitattributes.html">gitattributes(5)</a></p></div>
Junio C Hamanoa9eca4e2009-03-04 08:29:59[diff] [blame]899</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]900<h2 id="_git">GIT</h2>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]901<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]902<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]903</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]904</div>
905<div id="footnotes"><hr /></div>
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]906<div id="footer">
907<div id="footer-text">
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]908Last updated 2011-09-21 23:01:14 PDT
Junio C Hamano781d8a22006-09-17 10:34:15[diff] [blame]909</div>
910</div>
911</body>
912</html>