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.4.5" />
   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.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Overrides for manpage documents */
 343 h1 {
 344   padding-top: 0.5em;
 345   padding-bottom: 0.5em;
 346   border-top: 2px solid silver;
 347   border-bottom: 2px solid silver;
 348 }
 349 h2 {
 350   border-style: none;
 351 }
 352 div.sectionbody {
 353   margin-left: 5%;
 354 }
 355
 356 @media print {
 357   div#toc { display: none; }
 358 }
 359
 360 /* Workarounds for IE6's broken and incomplete CSS2. */
 361
 362 div.sidebar-content {
 363   background: #ffffee;
 364   border: 1px solid silver;
 365   padding: 0.5em;
 366 }
 367 div.sidebar-title, div.image-title {
 368   color: #527bbd;
 369   font-family: sans-serif;
 370   font-weight: bold;
 371   margin-top: 0.0em;
 372   margin-bottom: 0.5em;
 373 }
 374
 375 div.listingblock div.content {
 376   border: 1px solid silver;
 377   background: #f4f4f4;
 378   padding: 0.5em;
 379 }
 380
 381 div.quoteblock-attribution {
 382   padding-top: 0.5em;
 383   text-align: right;
 384 }
 385
 386 div.verseblock-content {
 387   white-space: pre;
 388 }
 389 div.verseblock-attribution {
 390   padding-top: 0.75em;
 391   text-align: left;
 392 }
 393
 394 div.exampleblock-content {
 395   border-left: 2px solid silver;
 396   padding-left: 0.5em;
 397 }
 398
 399 /* IE6 sets dynamically generated links as visited. */
 400 div#toc a:visited { color: blue; }
 401 </style>
 402 </head>
 403 <body>
 404 <div id="header">
 405 <h1>
 406 git-archive(1) Manual Page
 407 </h1>
 408 <h2>NAME</h2>
 409 <div class="sectionbody">
 410 <p>git-archive -
 411    Create an archive of files from a named tree
 412 </p>
 413 </div>
 414 </div>
 415 <h2 id="_synopsis">SYNOPSIS</h2>
 416 <div class="sectionbody">
 417 <div class="verseblock">
 418 <div class="verseblock-content"><em>git archive</em> [--format=&lt;fmt&gt;] [--list] [--prefix=&lt;prefix&gt;/] [&lt;extra&gt;]
 419               [-o | --output=&lt;file&gt;] [--worktree-attributes]
 420               [--remote=&lt;repo&gt; [--exec=&lt;git-upload-archive&gt;]] &lt;tree-ish&gt;
 421               [&lt;path&gt;&#8230;]</div>
 422 <div class="verseblock-attribution">
 423 </div></div>
 424 </div>
 425 <h2 id="_description">DESCRIPTION</h2>
 426 <div class="sectionbody">
 427 <div class="paragraph"><p>Creates an archive of the specified format containing the tree
 428 structure for the named tree, and writes it out to the standard
 429 output.  If &lt;prefix&gt; is specified it is
 430 prepended to the filenames in the archive.</p></div>
 431 <div class="paragraph"><p><em>git archive</em> behaves differently when given a tree ID versus when
 432 given a commit ID or tag ID.  In the first case the current time is
 433 used as the modification time of each file in the archive.  In the latter
 434 case the commit time as recorded in the referenced commit object is
 435 used instead.  Additionally the commit ID is stored in a global
 436 extended pax header if the tar format is used; it can be extracted
 437 using <em>git get-tar-commit-id</em>. In ZIP files it is stored as a file
 438 comment.</p></div>
 439 </div>
 440 <h2 id="_options">OPTIONS</h2>
 441 <div class="sectionbody">
 442 <div class="dlist"><dl>
 443 <dt class="hdlist1">
 444 --format=&lt;fmt&gt;
 445 </dt>
 446 <dd>
 447 <p>
 448         Format of the resulting archive: <em>tar</em> or <em>zip</em>. If this option
 449         is not given, and the output file is specified, the format is
 450         inferred from the filename if possible (e.g. writing to "foo.zip"
 451         makes the output to be in the zip format). Otherwise the output
 452         format is <tt>tar</tt>.
 453 </p>
 454 </dd>
 455 <dt class="hdlist1">
 456 -l
 457 </dt>
 458 <dt class="hdlist1">
 459 --list
 460 </dt>
 461 <dd>
 462 <p>
 463         Show all available formats.
 464 </p>
 465 </dd>
 466 <dt class="hdlist1">
 467 -v
 468 </dt>
 469 <dt class="hdlist1">
 470 --verbose
 471 </dt>
 472 <dd>
 473 <p>
 474         Report progress to stderr.
 475 </p>
 476 </dd>
 477 <dt class="hdlist1">
 478 --prefix=&lt;prefix&gt;/
 479 </dt>
 480 <dd>
 481 <p>
 482         Prepend &lt;prefix&gt;/ to each filename in the archive.
 483 </p>
 484 </dd>
 485 <dt class="hdlist1">
 486 -o &lt;file&gt;
 487 </dt>
 488 <dt class="hdlist1">
 489 --output=&lt;file&gt;
 490 </dt>
 491 <dd>
 492 <p>
 493         Write the archive to &lt;file&gt; instead of stdout.
 494 </p>
 495 </dd>
 496 <dt class="hdlist1">
 497 --worktree-attributes
 498 </dt>
 499 <dd>
 500 <p>
 501         Look for attributes in .gitattributes in working directory too.
 502 </p>
 503 </dd>
 504 <dt class="hdlist1">
 505 &lt;extra&gt;
 506 </dt>
 507 <dd>
 508 <p>
 509         This can be any options that the archiver backend understands.
 510         See next section.
 511 </p>
 512 </dd>
 513 <dt class="hdlist1">
 514 --remote=&lt;repo&gt;
 515 </dt>
 516 <dd>
 517 <p>
 518         Instead of making a tar archive from the local repository,
 519         retrieve a tar archive from a remote repository.
 520 </p>
 521 </dd>
 522 <dt class="hdlist1">
 523 --exec=&lt;git-upload-archive&gt;
 524 </dt>
 525 <dd>
 526 <p>
 527         Used with --remote to specify the path to the
 528         <em>git-upload-archive</em> on the remote side.
 529 </p>
 530 </dd>
 531 <dt class="hdlist1">
 532 &lt;tree-ish&gt;
 533 </dt>
 534 <dd>
 535 <p>
 536         The tree or commit to produce an archive for.
 537 </p>
 538 </dd>
 539 <dt class="hdlist1">
 540 &lt;path&gt;
 541 </dt>
 542 <dd>
 543 <p>
 544         Without an optional path parameter, all files and subdirectories
 545         of the current working directory are included in the archive.
 546         If one or more paths are specified, only these are included.
 547 </p>
 548 </dd>
 549 </dl></div>
 550 </div>
 551 <h2 id="_backend_extra_options">BACKEND EXTRA OPTIONS</h2>
 552 <div class="sectionbody">
 553 <h3 id="_zip">zip</h3><div style="clear:left"></div>
 554 <div class="dlist"><dl>
 555 <dt class="hdlist1">
 556 -0
 557 </dt>
 558 <dd>
 559 <p>
 560         Store the files instead of deflating them.
 561 </p>
 562 </dd>
 563 <dt class="hdlist1">
 564 -9
 565 </dt>
 566 <dd>
 567 <p>
 568         Highest and slowest compression level.  You can specify any
 569         number from 1 to 9 to adjust compression speed and ratio.
 570 </p>
 571 </dd>
 572 </dl></div>
 573 </div>
 574 <h2 id="_configuration">CONFIGURATION</h2>
 575 <div class="sectionbody">
 576 <div class="dlist"><dl>
 577 <dt class="hdlist1">
 578 tar.umask
 579 </dt>
 580 <dd>
 581 <p>
 582         This variable can be used to restrict the permission bits of
 583         tar archive entries.  The default is 0002, which turns off the
 584         world write bit.  The special value "user" indicates that the
 585         archiving user&#8217;s umask will be used instead.  See umask(2) for
 586         details.
 587 </p>
 588 </dd>
 589 </dl></div>
 590 </div>
 591 <h2 id="_attributes">ATTRIBUTES</h2>
 592 <div class="sectionbody">
 593 <div class="dlist"><dl>
 594 <dt class="hdlist1">
 595 export-ignore
 596 </dt>
 597 <dd>
 598 <p>
 599         Files and directories with the attribute export-ignore won&#8217;t be
 600         added to archive files.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
 601 </p>
 602 </dd>
 603 <dt class="hdlist1">
 604 export-subst
 605 </dt>
 606 <dd>
 607 <p>
 608         If the attribute export-subst is set for a file then git will
 609         expand several placeholders when adding this file to an archive.
 610         See <a href="gitattributes.html">gitattributes(5)</a> for details.
 611 </p>
 612 </dd>
 613 </dl></div>
 614 <div class="paragraph"><p>Note that attributes are by default taken from the <tt>.gitattributes</tt> files
 615 in the tree that is being archived.  If you want to tweak the way the
 616 output is generated after the fact (e.g. you committed without adding an
 617 appropriate export-ignore in its <tt>.gitattributes</tt>), adjust the checked out
 618 <tt>.gitattributes</tt> file as necessary and use <tt>--worktree-attributes</tt>
 619 option.  Alternatively you can keep necessary attributes that should apply
 620 while archiving any tree in your <tt>$GIT_DIR/info/attributes</tt> file.</p></div>
 621 </div>
 622 <h2 id="_examples">EXAMPLES</h2>
 623 <div class="sectionbody">
 624 <div class="dlist"><dl>
 625 <dt class="hdlist1">
 626 git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ &amp;&amp; tar xf -)
 627 </dt>
 628 <dd>
 629 <p>
 630         Create a tar archive that contains the contents of the
 631         latest commit on the current branch, and extract it in the
 632         <tt>/var/tmp/junk</tt> directory.
 633 </p>
 634 </dd>
 635 <dt class="hdlist1">
 636 git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip &gt;git-1.4.0.tar.gz
 637 </dt>
 638 <dd>
 639 <p>
 640         Create a compressed tarball for v1.4.0 release.
 641 </p>
 642 </dd>
 643 <dt class="hdlist1">
 644 git archive --format=tar --prefix=git-1.4.0/ v1.4.0&#94;{tree} | gzip &gt;git-1.4.0.tar.gz
 645 </dt>
 646 <dd>
 647 <p>
 648         Create a compressed tarball for v1.4.0 release, but without a
 649         global extended pax header.
 650 </p>
 651 </dd>
 652 <dt class="hdlist1">
 653 git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ &gt; git-1.4.0-docs.zip
 654 </dt>
 655 <dd>
 656 <p>
 657         Put everything in the current head&#8217;s Documentation/ directory
 658         into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.
 659 </p>
 660 </dd>
 661 <dt class="hdlist1">
 662 git archive -o latest.zip HEAD
 663 </dt>
 664 <dd>
 665 <p>
 666         Create a Zip archive that contains the contents of the latest
 667         commit on the current branch. Note that the output format is
 668         inferred by the extension of the output file.
 669 </p>
 670 </dd>
 671 </dl></div>
 672 </div>
 673 <h2 id="_see_also">SEE ALSO</h2>
 674 <div class="sectionbody">
 675 <div class="paragraph"><p><a href="gitattributes.html">gitattributes(5)</a></p></div>
 676 </div>
 677 <h2 id="_git">GIT</h2>
 678 <div class="sectionbody">
 679 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 680 </div>
 681 <div id="footer">
 682 <div id="footer-text">
 683 Last updated 2011-03-15 23:30:13 UTC
 684 </div>
 685 </div>
 686 </body>
 687 </html>