git-archive.html

   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 8.5.2" />
   7 <title>git-archive(1)</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, 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
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#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 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.0em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.0em;
 126   margin-bottom: 2.0em;
 127   margin-right: 10%;
 128   color: #606060;
 129 }
 130
 131 div.content { /* Block element content. */
 132   padding: 0;
 133 }
 134
 135 /* Block element titles. */
 136 div.title, caption.title {
 137   color: #527bbd;
 138   font-family: sans-serif;
 139   font-weight: bold;
 140   text-align: left;
 141   margin-top: 1.0em;
 142   margin-bottom: 0.5em;
 143 }
 144 div.title + * {
 145   margin-top: 0;
 146 }
 147
 148 td div.title:first-child {
 149   margin-top: 0.0em;
 150 }
 151 div.content div.title:first-child {
 152   margin-top: 0.0em;
 153 }
 154 div.content + div.title {
 155   margin-top: 0.0em;
 156 }
 157
 158 div.sidebarblock > div.content {
 159   background: #ffffee;
 160   border: 1px solid silver;
 161   padding: 0.5em;
 162 }
 163
 164 div.listingblock > div.content {
 165   border: 1px solid silver;
 166   background: #f4f4f4;
 167   padding: 0.5em;
 168 }
 169
 170 div.quoteblock, div.verseblock {
 171   padding-left: 1.0em;
 172   margin-left: 1.0em;
 173   margin-right: 10%;
 174   border-left: 5px solid #dddddd;
 175   color: #777777;
 176 }
 177
 178 div.quoteblock > div.attribution {
 179   padding-top: 0.5em;
 180   text-align: right;
 181 }
 182
 183 div.verseblock > div.content {
 184   white-space: pre;
 185 }
 186 div.verseblock > div.attribution {
 187   padding-top: 0.75em;
 188   text-align: left;
 189 }
 190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 191 div.verseblock + div.attribution {
 192   text-align: left;
 193 }
 194
 195 div.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 }
 203 div.admonitionblock td.content {
 204   padding-left: 0.5em;
 205   border-left: 3px solid #dddddd;
 206 }
 207
 208 div.exampleblock > div.content {
 209   border-left: 3px solid #dddddd;
 210   padding-left: 0.5em;
 211 }
 212
 213 div.imageblock div.content { padding-left: 0; }
 214 span.image img { border-style: none; }
 215 a.image:visited { color: white; }
 216
 217 dl {
 218   margin-top: 0.8em;
 219   margin-bottom: 0.8em;
 220 }
 221 dt {
 222   margin-top: 0.5em;
 223   margin-bottom: 0;
 224   font-style: normal;
 225   color: navy;
 226 }
 227 dd > *:first-child {
 228   margin-top: 0.1em;
 229 }
 230
 231 ul, ol {
 232     list-style-position: outside;
 233 }
 234 ol.arabic {
 235   list-style-type: decimal;
 236 }
 237 ol.loweralpha {
 238   list-style-type: lower-alpha;
 239 }
 240 ol.upperalpha {
 241   list-style-type: upper-alpha;
 242 }
 243 ol.lowerroman {
 244   list-style-type: lower-roman;
 245 }
 246 ol.upperroman {
 247   list-style-type: upper-roman;
 248 }
 249
 250 div.compact ul, div.compact ol,
 251 div.compact p, div.compact p,
 252 div.compact div, div.compact div {
 253   margin-top: 0.1em;
 254   margin-bottom: 0.1em;
 255 }
 256
 257 div.tableblock > table {
 258   border: 3px solid #527bbd;
 259 }
 260 thead, p.table.header {
 261   font-family: sans-serif;
 262   font-weight: bold;
 263 }
 264 tfoot {
 265   font-weight: bold;
 266 }
 267 td > div.verse {
 268   white-space: pre;
 269 }
 270 p.table {
 271   margin-top: 0;
 272 }
 273 /* Because the table frame attribute is overriden by CSS in most browsers. */
 274 div.tableblock > table[frame="void"] {
 275   border-style: none;
 276 }
 277 div.tableblock > table[frame="hsides"] {
 278   border-left-style: none;
 279   border-right-style: none;
 280 }
 281 div.tableblock > table[frame="vsides"] {
 282   border-top-style: none;
 283   border-bottom-style: none;
 284 }
 285
 286
 287 div.hdlist {
 288   margin-top: 0.8em;
 289   margin-bottom: 0.8em;
 290 }
 291 div.hdlist tr {
 292   padding-bottom: 15px;
 293 }
 294 dt.hdlist1.strong, td.hdlist1.strong {
 295   font-weight: bold;
 296 }
 297 td.hdlist1 {
 298   vertical-align: top;
 299   font-style: normal;
 300   padding-right: 0.8em;
 301   color: navy;
 302 }
 303 td.hdlist2 {
 304   vertical-align: top;
 305 }
 306 div.hdlist.compact tr {
 307   margin: 0;
 308   padding-bottom: 0;
 309 }
 310
 311 .comment {
 312   background: yellow;
 313 }
 314
 315 .footnote, .footnoteref {
 316   font-size: 0.8em;
 317 }
 318
 319 span.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
 343 @media print {
 344   div#footer-badges { display: none; }
 345 }
 346
 347 div#toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 div#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
 360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 361   margin-top: 0;
 362   margin-bottom: 0;
 363 }
 364 div.toclevel2 {
 365   margin-left: 2em;
 366   font-size: 0.9em;
 367 }
 368 div.toclevel3 {
 369   margin-left: 4em;
 370   font-size: 0.9em;
 371 }
 372 div.toclevel4 {
 373   margin-left: 6em;
 374   font-size: 0.9em;
 375 }
 376 /* Overrides for manpage documents */
 377 h1 {
 378   padding-top: 0.5em;
 379   padding-bottom: 0.5em;
 380   border-top: 2px solid silver;
 381   border-bottom: 2px solid silver;
 382 }
 383 h2 {
 384   border-style: none;
 385 }
 386 div.sectionbody {
 387   margin-left: 5%;
 388 }
 389
 390 @media print {
 391   div#toc { display: none; }
 392 }
 393
 394 /* Workarounds for IE6's broken and incomplete CSS2. */
 395
 396 div.sidebar-content {
 397   background: #ffffee;
 398   border: 1px solid silver;
 399   padding: 0.5em;
 400 }
 401 div.sidebar-title, div.image-title {
 402   color: #527bbd;
 403   font-family: sans-serif;
 404   font-weight: bold;
 405   margin-top: 0.0em;
 406   margin-bottom: 0.5em;
 407 }
 408
 409 div.listingblock div.content {
 410   border: 1px solid silver;
 411   background: #f4f4f4;
 412   padding: 0.5em;
 413 }
 414
 415 div.quoteblock-attribution {
 416   padding-top: 0.5em;
 417   text-align: right;
 418 }
 419
 420 div.verseblock-content {
 421   white-space: pre;
 422 }
 423 div.verseblock-attribution {
 424   padding-top: 0.75em;
 425   text-align: left;
 426 }
 427
 428 div.exampleblock-content {
 429   border-left: 3px solid #dddddd;
 430   padding-left: 0.5em;
 431 }
 432
 433 /* IE6 sets dynamically generated links as visited. */
 434 div#toc a:visited { color: blue; }
 435 </style>
 436 <script type="text/javascript">
 437 /*<![CDATA[*/
 438 window.onload = function(){asciidoc.footnotes();}
 439 var 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.
 459 toc: 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
 526 footnotes: 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>
 569 </head>
 570 <body>
 571 <div id="header">
 572 <h1>
 573 git-archive(1) Manual Page
 574 </h1>
 575 <h2>NAME</h2>
 576 <div class="sectionbody">
 577 <p>git-archive -
 578    Create an archive of files from a named tree
 579 </p>
 580 </div>
 581 </div>
 582 <div id="content">
 583 <h2 id="_synopsis">SYNOPSIS</h2>
 584 <div class="sectionbody">
 585 <div class="verseblock">
 586 <div class="verseblock-content"><em>git archive</em> [--format=&lt;fmt&gt;] [--list] [--prefix=&lt;prefix&gt;/] [&lt;extra&gt;]
 587               [-o | --output=&lt;file&gt;] [--worktree-attributes]
 588               [--remote=&lt;repo&gt; [--exec=&lt;git-upload-archive&gt;]] &lt;tree-ish&gt;
 589               [&lt;path&gt;&#8230;]</div>
 590 <div class="verseblock-attribution">
 591 </div></div>
 592 </div>
 593 <h2 id="_description">DESCRIPTION</h2>
 594 <div class="sectionbody">
 595 <div class="paragraph"><p>Creates an archive of the specified format containing the tree
 596 structure for the named tree, and writes it out to the standard
 597 output.  If &lt;prefix&gt; is specified it is
 598 prepended to the filenames in the archive.</p></div>
 599 <div class="paragraph"><p><em>git archive</em> behaves differently when given a tree ID versus when
 600 given a commit ID or tag ID.  In the first case the current time is
 601 used as the modification time of each file in the archive.  In the latter
 602 case the commit time as recorded in the referenced commit object is
 603 used instead.  Additionally the commit ID is stored in a global
 604 extended pax header if the tar format is used; it can be extracted
 605 using <em>git get-tar-commit-id</em>. In ZIP files it is stored as a file
 606 comment.</p></div>
 607 </div>
 608 <h2 id="_options">OPTIONS</h2>
 609 <div class="sectionbody">
 610 <div class="dlist"><dl>
 611 <dt class="hdlist1">
 612 --format=&lt;fmt&gt;
 613 </dt>
 614 <dd>
 615 <p>
 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>.
 621 </p>
 622 </dd>
 623 <dt class="hdlist1">
 624 -l
 625 </dt>
 626 <dt class="hdlist1">
 627 --list
 628 </dt>
 629 <dd>
 630 <p>
 631         Show all available formats.
 632 </p>
 633 </dd>
 634 <dt class="hdlist1">
 635 -v
 636 </dt>
 637 <dt class="hdlist1">
 638 --verbose
 639 </dt>
 640 <dd>
 641 <p>
 642         Report progress to stderr.
 643 </p>
 644 </dd>
 645 <dt class="hdlist1">
 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>
 653 <dt class="hdlist1">
 654 -o &lt;file&gt;
 655 </dt>
 656 <dt class="hdlist1">
 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>
 664 <dt class="hdlist1">
 665 --worktree-attributes
 666 </dt>
 667 <dd>
 668 <p>
 669         Look for attributes in .gitattributes in working directory too.
 670 </p>
 671 </dd>
 672 <dt class="hdlist1">
 673 &lt;extra&gt;
 674 </dt>
 675 <dd>
 676 <p>
 677         This can be any options that the archiver backend understands.
 678         See next section.
 679 </p>
 680 </dd>
 681 <dt class="hdlist1">
 682 --remote=&lt;repo&gt;
 683 </dt>
 684 <dd>
 685 <p>
 686         Instead of making a tar archive from the local repository,
 687         retrieve a tar archive from a remote repository.
 688 </p>
 689 </dd>
 690 <dt class="hdlist1">
 691 --exec=&lt;git-upload-archive&gt;
 692 </dt>
 693 <dd>
 694 <p>
 695         Used with --remote to specify the path to the
 696         <em>git-upload-archive</em> on the remote side.
 697 </p>
 698 </dd>
 699 <dt class="hdlist1">
 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>
 707 <dt class="hdlist1">
 708 &lt;path&gt;
 709 </dt>
 710 <dd>
 711 <p>
 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.
 715 </p>
 716 </dd>
 717 </dl></div>
 718 </div>
 719 <h2 id="_backend_extra_options">BACKEND EXTRA OPTIONS</h2>
 720 <div class="sectionbody">
 721 <h3 id="_zip">zip</h3><div style="clear:left"></div>
 722 <div class="dlist"><dl>
 723 <dt class="hdlist1">
 724 -0
 725 </dt>
 726 <dd>
 727 <p>
 728         Store the files instead of deflating them.
 729 </p>
 730 </dd>
 731 <dt class="hdlist1">
 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>
 740 </dl></div>
 741 </div>
 742 <h2 id="_configuration">CONFIGURATION</h2>
 743 <div class="sectionbody">
 744 <div class="dlist"><dl>
 745 <dt class="hdlist1">
 746 tar.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
 753         archiving user&#8217;s umask will be used instead.  See umask(2) for
 754         details.  If <tt>--remote</tt> is used then only the configuration of
 755         the remote repository takes effect.
 756 </p>
 757 </dd>
 758 <dt class="hdlist1">
 759 tar.&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">
 776 tar.&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>
 786 </dl></div>
 787 </div>
 788 <h2 id="_attributes">ATTRIBUTES</h2>
 789 <div class="sectionbody">
 790 <div class="dlist"><dl>
 791 <dt class="hdlist1">
 792 export-ignore
 793 </dt>
 794 <dd>
 795 <p>
 796         Files and directories with the attribute export-ignore won&#8217;t be
 797         added to archive files.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
 798 </p>
 799 </dd>
 800 <dt class="hdlist1">
 801 export-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>
 811 <div class="paragraph"><p>Note that attributes are by default taken from the <tt>.gitattributes</tt> files
 812 in the tree that is being archived.  If you want to tweak the way the
 813 output is generated after the fact (e.g. you committed without adding an
 814 appropriate export-ignore in its <tt>.gitattributes</tt>), adjust the checked out
 815 <tt>.gitattributes</tt> file as necessary and use <tt>--worktree-attributes</tt>
 816 option.  Alternatively you can keep necessary attributes that should apply
 817 while archiving any tree in your <tt>$GIT_DIR/info/attributes</tt> file.</p></div>
 818 </div>
 819 <h2 id="_examples">EXAMPLES</h2>
 820 <div class="sectionbody">
 821 <div class="dlist"><dl>
 822 <dt class="hdlist1">
 823 <tt>git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ &amp;&amp; tar xf -)</tt>
 824 </dt>
 825 <dd>
 826 <p>
 827         Create a tar archive that contains the contents of the
 828         latest commit on the current branch, and extract it in the
 829         <tt>/var/tmp/junk</tt> directory.
 830 </p>
 831 </dd>
 832 <dt class="hdlist1">
 833 <tt>git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip &gt;git-1.4.0.tar.gz</tt>
 834 </dt>
 835 <dd>
 836 <p>
 837         Create a compressed tarball for v1.4.0 release.
 838 </p>
 839 </dd>
 840 <dt class="hdlist1">
 841 <tt>git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 &gt;git-1.4.0.tar.gz</tt>
 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">
 849 <tt>git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0</tt>
 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">
 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>
 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>
 865 <dt class="hdlist1">
 866 <tt>git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ &gt; git-1.4.0-docs.zip</tt>
 867 </dt>
 868 <dd>
 869 <p>
 870         Put everything in the current head&#8217;s Documentation/ directory
 871         into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.
 872 </p>
 873 </dd>
 874 <dt class="hdlist1">
 875 <tt>git archive -o latest.zip HEAD</tt>
 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>
 884 <dt class="hdlist1">
 885 <tt>git config tar.tar.xz.command "xz -c"</tt>
 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>
 894 </dl></div>
 895 </div>
 896 <h2 id="_see_also">SEE ALSO</h2>
 897 <div class="sectionbody">
 898 <div class="paragraph"><p><a href="gitattributes.html">gitattributes(5)</a></p></div>
 899 </div>
 900 <h2 id="_git">GIT</h2>
 901 <div class="sectionbody">
 902 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 903 </div>
 904 </div>
 905 <div id="footnotes"><hr /></div>
 906 <div id="footer">
 907 <div id="footer-text">
 908 Last updated 2011-09-21 23:01:14 PDT
 909 </div>
 910 </div>
 911 </body>
 912 </html>