git-archive.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-archive(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-archive(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-archive -
 743    Create an archive of files from a named tree
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git archive</em> [--format=&lt;fmt&gt;] [--list] [--prefix=&lt;prefix&gt;/] [&lt;extra&gt;]
 753               [-o &lt;file&gt; | --output=&lt;file&gt;] [--worktree-attributes]
 754               [--remote=&lt;repo&gt; [--exec=&lt;git-upload-archive&gt;]] &lt;tree-ish&gt;
 755               [&lt;path&gt;&#8230;]</pre>
 756 <div class="attribution">
 757 </div></div>
 758 </div>
 759 </div>
 760 <div class="sect1">
 761 <h2 id="_description">DESCRIPTION</h2>
 762 <div class="sectionbody">
 763 <div class="paragraph"><p>Creates an archive of the specified format containing the tree
 764 structure for the named tree, and writes it out to the standard
 765 output.  If &lt;prefix&gt; is specified it is
 766 prepended to the filenames in the archive.</p></div>
 767 <div class="paragraph"><p><em>git archive</em> behaves differently when given a tree ID as opposed to a
 768 commit ID or tag ID. When a tree ID is provided, the current time is
 769 used as the modification time of each file in the archive. On the
 770 other hand, when a commit ID or tag ID is provided, the commit time as
 771 recorded in the referenced commit object is used instead.
 772 Additionally the commit ID is stored in a global extended pax header
 773 if the tar format is used; it can be extracted using <em>git
 774 get-tar-commit-id</em>. In ZIP files it is stored as a file comment.</p></div>
 775 </div>
 776 </div>
 777 <div class="sect1">
 778 <h2 id="_options">OPTIONS</h2>
 779 <div class="sectionbody">
 780 <div class="dlist"><dl>
 781 <dt class="hdlist1">
 782 --format=&lt;fmt&gt;
 783 </dt>
 784 <dd>
 785 <p>
 786         Format of the resulting archive. Possible values are <code>tar</code>,
 787         <code>zip</code>, <code>tar.gz</code>, <code>tgz</code>, and any format defined using the
 788         configuration option <code>tar.&lt;format&gt;.command</code>. If <code>--format</code>
 789         is not given, and the output file is specified, the format is
 790         inferred from the filename if possible (e.g. writing to <code>foo.zip</code>
 791         makes the output to be in the <code>zip</code> format). Otherwise the output
 792         format is <code>tar</code>.
 793 </p>
 794 </dd>
 795 <dt class="hdlist1">
 796 -l
 797 </dt>
 798 <dt class="hdlist1">
 799 --list
 800 </dt>
 801 <dd>
 802 <p>
 803         Show all available formats.
 804 </p>
 805 </dd>
 806 <dt class="hdlist1">
 807 -v
 808 </dt>
 809 <dt class="hdlist1">
 810 --verbose
 811 </dt>
 812 <dd>
 813 <p>
 814         Report progress to stderr.
 815 </p>
 816 </dd>
 817 <dt class="hdlist1">
 818 --prefix=&lt;prefix&gt;/
 819 </dt>
 820 <dd>
 821 <p>
 822         Prepend &lt;prefix&gt;/ to paths in the archive.  Can be repeated; its
 823         rightmost value is used for all tracked files.  See below which
 824         value gets used by <code>--add-file</code> and <code>--add-virtual-file</code>.
 825 </p>
 826 </dd>
 827 <dt class="hdlist1">
 828 -o &lt;file&gt;
 829 </dt>
 830 <dt class="hdlist1">
 831 --output=&lt;file&gt;
 832 </dt>
 833 <dd>
 834 <p>
 835         Write the archive to &lt;file&gt; instead of stdout.
 836 </p>
 837 </dd>
 838 <dt class="hdlist1">
 839 --add-file=&lt;file&gt;
 840 </dt>
 841 <dd>
 842 <p>
 843         Add a non-tracked file to the archive.  Can be repeated to add
 844         multiple files.  The path of the file in the archive is built by
 845         concatenating the value of the last <code>--prefix</code> option (if any)
 846         before this <code>--add-file</code> and the basename of &lt;file&gt;.
 847 </p>
 848 </dd>
 849 <dt class="hdlist1">
 850 --add-virtual-file=&lt;path&gt;:&lt;content&gt;
 851 </dt>
 852 <dd>
 853 <p>
 854         Add the specified contents to the archive.  Can be repeated to add
 855         multiple files.  The path of the file in the archive is built
 856         by concatenating the value of the last <code>--prefix</code> option (if any)
 857         before this <code>--add-virtual-file</code> and <code>&lt;path&gt;</code>.
 858 </p>
 859 <div class="paragraph"><p>The <code>&lt;path&gt;</code> argument can start and end with a literal double-quote
 860 character; the contained file name is interpreted as a C-style string,
 861 i.e. the backslash is interpreted as escape character. The path must
 862 be quoted if it contains a colon, to avoid the colon from being
 863 misinterpreted as the separator between the path and the contents, or
 864 if the path begins or ends with a double-quote character.</p></div>
 865 <div class="paragraph"><p>The file mode is limited to a regular file, and the option may be
 866 subject to platform-dependent command-line limits. For non-trivial
 867 cases, write an untracked file and use <code>--add-file</code> instead.</p></div>
 868 </dd>
 869 <dt class="hdlist1">
 870 --worktree-attributes
 871 </dt>
 872 <dd>
 873 <p>
 874         Look for attributes in .gitattributes files in the working tree
 875         as well (see <a href="#ATTRIBUTES">[ATTRIBUTES]</a>).
 876 </p>
 877 </dd>
 878 <dt class="hdlist1">
 879 --mtime=&lt;time&gt;
 880 </dt>
 881 <dd>
 882 <p>
 883         Set modification time of archive entries.  Without this option
 884         the committer time is used if <code>&lt;tree-ish&gt;</code> is a commit or tag,
 885         and the current time if it is a tree.
 886 </p>
 887 </dd>
 888 <dt class="hdlist1">
 889 &lt;extra&gt;
 890 </dt>
 891 <dd>
 892 <p>
 893         This can be any options that the archiver backend understands.
 894         See next section.
 895 </p>
 896 </dd>
 897 <dt class="hdlist1">
 898 --remote=&lt;repo&gt;
 899 </dt>
 900 <dd>
 901 <p>
 902         Instead of making a tar archive from the local repository,
 903         retrieve a tar archive from a remote repository. Note that the
 904         remote repository may place restrictions on which sha1
 905         expressions may be allowed in <code>&lt;tree-ish&gt;</code>. See
 906         <a href="git-upload-archive.html">git-upload-archive(1)</a> for details.
 907 </p>
 908 </dd>
 909 <dt class="hdlist1">
 910 --exec=&lt;git-upload-archive&gt;
 911 </dt>
 912 <dd>
 913 <p>
 914         Used with --remote to specify the path to the
 915         <em>git-upload-archive</em> on the remote side.
 916 </p>
 917 </dd>
 918 <dt class="hdlist1">
 919 &lt;tree-ish&gt;
 920 </dt>
 921 <dd>
 922 <p>
 923         The tree or commit to produce an archive for.
 924 </p>
 925 </dd>
 926 <dt class="hdlist1">
 927 &lt;path&gt;
 928 </dt>
 929 <dd>
 930 <p>
 931         Without an optional path parameter, all files and subdirectories
 932         of the current working directory are included in the archive.
 933         If one or more paths are specified, only these are included.
 934 </p>
 935 </dd>
 936 </dl></div>
 937 </div>
 938 </div>
 939 <div class="sect1">
 940 <h2 id="_backend_extra_options">BACKEND EXTRA OPTIONS</h2>
 941 <div class="sectionbody">
 942 <div class="sect2">
 943 <h3 id="_zip">zip</h3>
 944 <div class="dlist"><dl>
 945 <dt class="hdlist1">
 946 -&lt;digit&gt;
 947 </dt>
 948 <dd>
 949 <p>
 950         Specify compression level.  Larger values allow the command
 951         to spend more time to compress to smaller size.  Supported
 952         values are from <code>-0</code> (store-only) to <code>-9</code> (best ratio).
 953         Default is <code>-6</code> if not given.
 954 </p>
 955 </dd>
 956 </dl></div>
 957 </div>
 958 <div class="sect2">
 959 <h3 id="_tar">tar</h3>
 960 <div class="dlist"><dl>
 961 <dt class="hdlist1">
 962 -&lt;number&gt;
 963 </dt>
 964 <dd>
 965 <p>
 966         Specify compression level. The value will be passed to the
 967         compression command configured in <code>tar.&lt;format&gt;.command</code>. See
 968         manual page of the configured command for the list of supported
 969         levels and the default level if this option isn&#8217;t specified.
 970 </p>
 971 </dd>
 972 </dl></div>
 973 </div>
 974 </div>
 975 </div>
 976 <div class="sect1">
 977 <h2 id="_configuration">CONFIGURATION</h2>
 978 <div class="sectionbody">
 979 <div class="dlist"><dl>
 980 <dt class="hdlist1">
 981 tar.umask
 982 </dt>
 983 <dd>
 984 <p>
 985         This variable can be used to restrict the permission bits of
 986         tar archive entries.  The default is 0002, which turns off the
 987         world write bit.  The special value "user" indicates that the
 988         archiving user&#8217;s umask will be used instead.  See umask(2) for
 989         details.  If <code>--remote</code> is used then only the configuration of
 990         the remote repository takes effect.
 991 </p>
 992 </dd>
 993 <dt class="hdlist1">
 994 tar.&lt;format&gt;.command
 995 </dt>
 996 <dd>
 997 <p>
 998         This variable specifies a shell command through which the tar
 999         output generated by <code>git archive</code> should be piped. The command
1000         is executed using the shell with the generated tar file on its
1001         standard input, and should produce the final output on its
1002         standard output. Any compression-level options will be passed
1003         to the command (e.g., <code>-9</code>).
1004 </p>
1005 <div class="paragraph"><p>The <code>tar.gz</code> and <code>tgz</code> formats are defined automatically and use the
1006 magic command <code>git archive gzip</code> by default, which invokes an internal
1007 implementation of gzip.</p></div>
1008 </dd>
1009 <dt class="hdlist1">
1010 tar.&lt;format&gt;.remote
1011 </dt>
1012 <dd>
1013 <p>
1014         If true, enable the format for use by remote clients via
1015         <a href="git-upload-archive.html">git-upload-archive(1)</a>. Defaults to false for
1016         user-defined formats, but true for the <code>tar.gz</code> and <code>tgz</code>
1017         formats.
1018 </p>
1019 </dd>
1020 </dl></div>
1021 </div>
1022 </div>
1023 <div class="sect1">
1024 <h2 id="ATTRIBUTES">ATTRIBUTES</h2>
1025 <div class="sectionbody">
1026 <div class="dlist"><dl>
1027 <dt class="hdlist1">
1028 export-ignore
1029 </dt>
1030 <dd>
1031 <p>
1032         Files and directories with the attribute export-ignore won&#8217;t be
1033         added to archive files.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
1034 </p>
1035 </dd>
1036 <dt class="hdlist1">
1037 export-subst
1038 </dt>
1039 <dd>
1040 <p>
1041         If the attribute export-subst is set for a file then Git will
1042         expand several placeholders when adding this file to an archive.
1043         See <a href="gitattributes.html">gitattributes(5)</a> for details.
1044 </p>
1045 </dd>
1046 </dl></div>
1047 <div class="paragraph"><p>Note that attributes are by default taken from the <code>.gitattributes</code> files
1048 in the tree that is being archived.  If you want to tweak the way the
1049 output is generated after the fact (e.g. you committed without adding an
1050 appropriate export-ignore in its <code>.gitattributes</code>), adjust the checked out
1051 <code>.gitattributes</code> file as necessary and use <code>--worktree-attributes</code>
1052 option.  Alternatively you can keep necessary attributes that should apply
1053 while archiving any tree in your <code>$GIT_DIR/info/attributes</code> file.</p></div>
1054 </div>
1055 </div>
1056 <div class="sect1">
1057 <h2 id="_examples">EXAMPLES</h2>
1058 <div class="sectionbody">
1059 <div class="dlist"><dl>
1060 <dt class="hdlist1">
1061 <code>git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ &amp;&amp; tar xf -)</code>
1062 </dt>
1063 <dd>
1064 <p>
1065         Create a tar archive that contains the contents of the
1066         latest commit on the current branch, and extract it in the
1067         <code>/var/tmp/junk</code> directory.
1068 </p>
1069 </dd>
1070 <dt class="hdlist1">
1071 <code>git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip &gt;git-1.4.0.tar.gz</code>
1072 </dt>
1073 <dd>
1074 <p>
1075         Create a compressed tarball for v1.4.0 release.
1076 </p>
1077 </dd>
1078 <dt class="hdlist1">
1079 <code>git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 &gt;git-1.4.0.tar.gz</code>
1080 </dt>
1081 <dd>
1082 <p>
1083         Same as above, but using the builtin tar.gz handling.
1084 </p>
1085 </dd>
1086 <dt class="hdlist1">
1087 <code>git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0</code>
1088 </dt>
1089 <dd>
1090 <p>
1091         Same as above, but the format is inferred from the output file.
1092 </p>
1093 </dd>
1094 <dt class="hdlist1">
1095 <code>git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} | gzip &gt;git-1.4.0.tar.gz</code>
1096 </dt>
1097 <dd>
1098 <p>
1099         Create a compressed tarball for v1.4.0 release, but without a
1100         global extended pax header.
1101 </p>
1102 </dd>
1103 <dt class="hdlist1">
1104 <code>git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ &gt; git-1.4.0-docs.zip</code>
1105 </dt>
1106 <dd>
1107 <p>
1108         Put everything in the current head&#8217;s Documentation/ directory
1109         into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.
1110 </p>
1111 </dd>
1112 <dt class="hdlist1">
1113 <code>git archive -o latest.zip HEAD</code>
1114 </dt>
1115 <dd>
1116 <p>
1117         Create a Zip archive that contains the contents of the latest
1118         commit on the current branch. Note that the output format is
1119         inferred by the extension of the output file.
1120 </p>
1121 </dd>
1122 <dt class="hdlist1">
1123 <code>git archive -o latest.tar --prefix=build/ --add-file=configure --prefix= HEAD</code>
1124 </dt>
1125 <dd>
1126 <p>
1127         Creates a tar archive that contains the contents of the latest
1128         commit on the current branch with no prefix and the untracked
1129         file <em>configure</em> with the prefix <em>build/</em>.
1130 </p>
1131 </dd>
1132 <dt class="hdlist1">
1133 <code>git config tar.tar.xz.command "xz -c"</code>
1134 </dt>
1135 <dd>
1136 <p>
1137         Configure a "tar.xz" format for making LZMA-compressed tarfiles.
1138         You can use it specifying <code>--format=tar.xz</code>, or by creating an
1139         output file like <code>-o foo.tar.xz</code>.
1140 </p>
1141 </dd>
1142 </dl></div>
1143 </div>
1144 </div>
1145 <div class="sect1">
1146 <h2 id="_see_also">SEE ALSO</h2>
1147 <div class="sectionbody">
1148 <div class="paragraph"><p><a href="gitattributes.html">gitattributes(5)</a></p></div>
1149 </div>
1150 </div>
1151 <div class="sect1">
1152 <h2 id="_git">GIT</h2>
1153 <div class="sectionbody">
1154 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1155 </div>
1156 </div>
1157 </div>
1158 <div id="footnotes"><hr /></div>
1159 <div id="footer">
1160 <div id="footer-text">
1161 Last updated
1162  2023-10-23 14:43:46 PDT
1163 </div>
1164 </div>
1165 </body>
1166 </html>