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.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, h2, h3, h4, h5, h6 {
  40   color: #527bbd;
  41   font-family: sans-serif;
  42   margin-top: 1.2em;
  43   margin-bottom: 0.5em;
  44   line-height: 1.3;
  45 }
  46
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#footer {
  92   font-family: sans-serif;
  93   font-size: small;
  94   border-top: 2px solid silver;
  95   padding-top: 0.5em;
  96   margin-top: 4.0em;
  97 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.title, caption.title {
 126   font-family: sans-serif;
 127   font-weight: bold;
 128   text-align: left;
 129   margin-top: 1.0em;
 130   margin-bottom: 0.5em;
 131 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.admonitionblock .icon {
 173   vertical-align: top;
 174   font-size: 1.1em;
 175   font-weight: bold;
 176   text-decoration: underline;
 177   color: #527bbd;
 178   padding-right: 0.5em;
 179 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#toctitle {
 250   color: #527bbd;
 251   font-family: sans-serif;
 252   font-size: 1.1em;
 253   font-weight: bold;
 254   margin-top: 1.0em;
 255   margin-bottom: 0.1em;
 256 }
 257
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.sidebar-title, div.image-title {
 283   font-family: sans-serif;
 284   font-weight: bold;
 285   margin-top: 0.0em;
 286   margin-bottom: 0.5em;
 287 }
 288
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-archive(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-archive(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-archive -
 317    Create an archive of files from a named tree
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="verseblock">
 324 <div class="content"><em>git archive</em> [--format=&lt;fmt&gt;] [--list] [--prefix=&lt;prefix&gt;/] [&lt;extra&gt;]
 325               [-o | --output=&lt;file&gt;] [--worktree-attributes]
 326               [--remote=&lt;repo&gt; [--exec=&lt;git-upload-archive&gt;]] &lt;tree-ish&gt;
 327               [path&#8230;]</div></div>
 328 </div>
 329 <h2 id="_description">DESCRIPTION</h2>
 330 <div class="sectionbody">
 331 <div class="para"><p>Creates an archive of the specified format containing the tree
 332 structure for the named tree, and writes it out to the standard
 333 output.  If &lt;prefix&gt; is specified it is
 334 prepended to the filenames in the archive.</p></div>
 335 <div class="para"><p><em>git-archive</em> behaves differently when given a tree ID versus when
 336 given a commit ID or tag ID.  In the first case the current time is
 337 used as the modification time of each file in the archive.  In the latter
 338 case the commit time as recorded in the referenced commit object is
 339 used instead.  Additionally the commit ID is stored in a global
 340 extended pax header if the tar format is used; it can be extracted
 341 using <em>git-get-tar-commit-id</em>. In ZIP files it is stored as a file
 342 comment.</p></div>
 343 </div>
 344 <h2 id="_options">OPTIONS</h2>
 345 <div class="sectionbody">
 346 <div class="vlist"><dl>
 347 <dt>
 348 --format=&lt;fmt&gt;
 349 </dt>
 350 <dd>
 351 <p>
 352         Format of the resulting archive: <em>tar</em> or <em>zip</em>. If this option
 353         is not given, and the output file is specified, the format is
 354         inferred from the filename if possible (e.g. writing to "foo.zip"
 355         makes the output to be in the zip format). Otherwise the output
 356         format is <tt>tar</tt>.
 357 </p>
 358 </dd>
 359 <dt>
 360 -l
 361 </dt>
 362 <dt>
 363 --list
 364 </dt>
 365 <dd>
 366 <p>
 367         Show all available formats.
 368 </p>
 369 </dd>
 370 <dt>
 371 -v
 372 </dt>
 373 <dt>
 374 --verbose
 375 </dt>
 376 <dd>
 377 <p>
 378         Report progress to stderr.
 379 </p>
 380 </dd>
 381 <dt>
 382 --prefix=&lt;prefix&gt;/
 383 </dt>
 384 <dd>
 385 <p>
 386         Prepend &lt;prefix&gt;/ to each filename in the archive.
 387 </p>
 388 </dd>
 389 <dt>
 390 -o &lt;file&gt;
 391 </dt>
 392 <dt>
 393 --output=&lt;file&gt;
 394 </dt>
 395 <dd>
 396 <p>
 397         Write the archive to &lt;file&gt; instead of stdout.
 398 </p>
 399 </dd>
 400 <dt>
 401 --worktree-attributes
 402 </dt>
 403 <dd>
 404 <p>
 405         Look for attributes in .gitattributes in working directory too.
 406 </p>
 407 </dd>
 408 <dt>
 409 &lt;extra&gt;
 410 </dt>
 411 <dd>
 412 <p>
 413         This can be any options that the archiver backend understands.
 414         See next section.
 415 </p>
 416 </dd>
 417 <dt>
 418 --remote=&lt;repo&gt;
 419 </dt>
 420 <dd>
 421 <p>
 422         Instead of making a tar archive from the local repository,
 423         retrieve a tar archive from a remote repository.
 424 </p>
 425 </dd>
 426 <dt>
 427 --exec=&lt;git-upload-archive&gt;
 428 </dt>
 429 <dd>
 430 <p>
 431         Used with --remote to specify the path to the
 432         <em>git-upload-archive</em> on the remote side.
 433 </p>
 434 </dd>
 435 <dt>
 436 &lt;tree-ish&gt;
 437 </dt>
 438 <dd>
 439 <p>
 440         The tree or commit to produce an archive for.
 441 </p>
 442 </dd>
 443 <dt>
 444 path
 445 </dt>
 446 <dd>
 447 <p>
 448         Without an optional path parameter, all files and subdirectories
 449         of the current working directory are included in the archive.
 450         If one or more paths are specified, only these are included.
 451 </p>
 452 </dd>
 453 </dl></div>
 454 </div>
 455 <h2 id="_backend_extra_options">BACKEND EXTRA OPTIONS</h2>
 456 <div class="sectionbody">
 457 <h3 id="_zip">zip</h3><div style="clear:left"></div>
 458 <div class="vlist"><dl>
 459 <dt>
 460 -0
 461 </dt>
 462 <dd>
 463 <p>
 464         Store the files instead of deflating them.
 465 </p>
 466 </dd>
 467 <dt>
 468 -9
 469 </dt>
 470 <dd>
 471 <p>
 472         Highest and slowest compression level.  You can specify any
 473         number from 1 to 9 to adjust compression speed and ratio.
 474 </p>
 475 </dd>
 476 </dl></div>
 477 </div>
 478 <h2 id="_configuration">CONFIGURATION</h2>
 479 <div class="sectionbody">
 480 <div class="vlist"><dl>
 481 <dt>
 482 tar.umask
 483 </dt>
 484 <dd>
 485 <p>
 486         This variable can be used to restrict the permission bits of
 487         tar archive entries.  The default is 0002, which turns off the
 488         world write bit.  The special value "user" indicates that the
 489         archiving user's umask will be used instead.  See umask(2) for
 490         details.
 491 </p>
 492 </dd>
 493 </dl></div>
 494 </div>
 495 <h2 id="_attributes">ATTRIBUTES</h2>
 496 <div class="sectionbody">
 497 <div class="vlist"><dl>
 498 <dt>
 499 export-ignore
 500 </dt>
 501 <dd>
 502 <p>
 503         Files and directories with the attribute export-ignore won't be
 504         added to archive files.  See <a href="gitattributes.html">gitattributes(5)</a> for details.
 505 </p>
 506 </dd>
 507 <dt>
 508 export-subst
 509 </dt>
 510 <dd>
 511 <p>
 512         If the attribute export-subst is set for a file then git will
 513         expand several placeholders when adding this file to an archive.
 514         See <a href="gitattributes.html">gitattributes(5)</a> for details.
 515 </p>
 516 </dd>
 517 </dl></div>
 518 </div>
 519 <h2 id="_examples">EXAMPLES</h2>
 520 <div class="sectionbody">
 521 <div class="vlist"><dl>
 522 <dt>
 523 git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ &amp;&amp; tar xf -)
 524 </dt>
 525 <dd>
 526 <p>
 527         Create a tar archive that contains the contents of the
 528         latest commit on the current branch, and extract it in the
 529         <tt>/var/tmp/junk</tt> directory.
 530 </p>
 531 </dd>
 532 <dt>
 533 git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip &gt;git-1.4.0.tar.gz
 534 </dt>
 535 <dd>
 536 <p>
 537         Create a compressed tarball for v1.4.0 release.
 538 </p>
 539 </dd>
 540 <dt>
 541 git archive --format=tar --prefix=git-1.4.0/ v1.4.0&#94;{tree} | gzip &gt;git-1.4.0.tar.gz
 542 </dt>
 543 <dd>
 544 <p>
 545         Create a compressed tarball for v1.4.0 release, but without a
 546         global extended pax header.
 547 </p>
 548 </dd>
 549 <dt>
 550 git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ &gt; git-1.4.0-docs.zip
 551 </dt>
 552 <dd>
 553 <p>
 554         Put everything in the current head's Documentation/ directory
 555         into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.
 556 </p>
 557 </dd>
 558 <dt>
 559 git archive -o latest.zip HEAD
 560 </dt>
 561 <dd>
 562 <p>
 563         Create a Zip archive that contains the contents of the latest
 564         commit on the current branch. Note that the output format is
 565         inferred by the extension of the output file.
 566 </p>
 567 </dd>
 568 </dl></div>
 569 </div>
 570 <h2 id="_see_also">SEE ALSO</h2>
 571 <div class="sectionbody">
 572 <div class="para"><p><a href="gitattributes.html">gitattributes(5)</a></p></div>
 573 </div>
 574 <h2 id="_author">Author</h2>
 575 <div class="sectionbody">
 576 <div class="para"><p>Written by Franck Bui-Huu and Rene Scharfe.</p></div>
 577 </div>
 578 <h2 id="_documentation">Documentation</h2>
 579 <div class="sectionbody">
 580 <div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
 581 </div>
 582 <h2 id="_git">GIT</h2>
 583 <div class="sectionbody">
 584 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 585 </div>
 586 <div id="footer">
 587 <div id="footer-text">
 588 Last updated 2009-12-06 04:02:42 UTC
 589 </div>
 590 </div>
 591 </body>
 592 </html>