git-archive.html - external/gitster/git-htmldocs - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <meta name="generator" content="AsciiDoc 7.0.2" />
 <style type="text/css">
 /* Debug borders */
 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
 /*
  border: 1px solid red;
 */
 }

 body {
  margin: 1em 5% 1em 5%;
 }

 a { color: blue; }
 a:visited { color: fuchsia; }

 em {
  font-style: italic;
 }

 strong {
  font-weight: bold;
 }

 tt {
  color: navy;
 }

 h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  font-family: sans-serif;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
 }

 h1 {
  border-bottom: 2px solid silver;
 }
 h2 {
  border-bottom: 2px solid silver;
  padding-top: 0.5em;
 }

 div.sectionbody {
  font-family: serif;
  margin-left: 0;
 }

 hr {
  border: 1px solid silver;
 }

 p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
 }

 pre {
  padding: 0;
  margin: 0;
 }

 span#author {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  font-size: 1.2em;
 }
 span#email {
 }
 span#revision {
  font-family: sans-serif;
 }

 div#footer {
  font-family: sans-serif;
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
 }
 div#footer-text {
  float: left;
  padding-bottom: 0.5em;
 }
 div#footer-badges {
  float: right;
  padding-bottom: 0.5em;
 }

 div#preamble,
 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 div.admonitionblock {
  margin-right: 10%;
  margin-top: 1.5em;
  margin-bottom: 1.5em;
 }
 div.admonitionblock {
  margin-top: 2.5em;
  margin-bottom: 2.5em;
 }

 div.content { /* Block element content. */
  padding: 0;
 }

 /* Block element titles. */
 div.title, caption.title {
  font-family: sans-serif;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
 }
 div.title + * {
  margin-top: 0;
 }

 td div.title:first-child {
  margin-top: 0.0em;
 }
 div.content div.title:first-child {
  margin-top: 0.0em;
 }
 div.content + div.title {
  margin-top: 0.0em;
 }

 div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }

 div.listingblock > div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock > div.content {
  padding-left: 2.0em;
 }
 div.quoteblock .attribution {
  text-align: right;
 }

 div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
 }
 div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 2px solid silver;
 }

 div.exampleblock > div.content {
  border-left: 2px solid silver;
  padding: 0.5em;
 }

 div.verseblock div.content {
  white-space: pre;
 }

 div.imageblock div.content { padding-left: 0; }
 div.imageblock img { border: 1px solid silver; }
 span.image img { border-style: none; }

 dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: italic;
 }
 dd > *:first-child {
  margin-top: 0;
 }

 ul, ol {
  list-style-position: outside;
 }
 ol.olist2 {
  list-style-type: lower-alpha;
 }

 div.tableblock > table {
  border-color: #527bbd;
  border-width: 3px;
 }
 thead {
  font-family: sans-serif;
  font-weight: bold;
 }
 tfoot {
  font-weight: bold;
 }

 div.hlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 td.hlist1 {
  vertical-align: top;
  font-style: italic;
  padding-right: 0.8em;
 }
 td.hlist2 {
  vertical-align: top;
 }

 @media print {
  div#footer-badges { display: none; }
 }
 include::./stylesheets/xhtml11-manpage.css[]
 /* Workarounds for IE6's broken and incomplete CSS2. */

 div.sidebar-content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }
 div.sidebar-title, div.image-title {
  font-family: sans-serif;
  font-weight: bold;
  margin-top: 0.0em;
  margin-bottom: 0.5em;
 }

 div.listingblock div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock-content {
  padding-left: 2.0em;
 }

 div.exampleblock-content {
  border-left: 2px solid silver;
  padding-left: 0.5em;
 }
 </style>
 <title>git-archive(1)</title>
 </head>
 <body>
 <div id="header">
 <h1>
 git-archive(1) Manual Page
 </h1>
 <h2>NAME</h2>
 <div class="sectionbody">
 <p>git-archive -
  Creates an archive of files from a named tree
 </p>
 </div>
 </div>
 <h2>SYNOPSIS</h2>
 <div class="sectionbody">
 <p><em>git-archive</em> --format=&lt;fmt&gt; [--list] [--prefix=&lt;prefix&gt;/] [&lt;extra&gt;]
  [--remote=&lt;repo&gt;] &lt;tree-ish&gt; [path&#8230;]</p>
 </div>
 <h2>DESCRIPTION</h2>
 <div class="sectionbody">
 <p>Creates an archive of the specified format containing the tree
 structure for the named tree. If &lt;prefix&gt; is specified it is
 prepended to the filenames in the archive.</p>
 <p><em>git-archive</em> behaves differently when given a tree ID versus when
 given a commit ID or tag ID. In the first case the current time is
 used as modification time of each file in the archive. In the latter
 case the commit time as recorded in the referenced commit object is
 used instead. Additionally the commit ID is stored in a global
 extended pax header if the tar format is used; it can be extracted
 using <em>git-get-tar-commit-id</em>. In ZIP files it is stored as a file
 comment.</p>
 </div>
 <h2>OPTIONS</h2>
 <div class="sectionbody">
 <dl>
 <dt>
 --format=&lt;fmt&gt;
 </dt>
 <dd>
 <p>
  Format of the resulting archive: <em>tar</em>, <em>zip</em>&#8230; The default
  is <em>tar</em>.
 </p>
 </dd>
 <dt>
 --list, -l
 </dt>
 <dd>
 <p>
  Show all available formats.
 </p>
 </dd>
 <dt>
 --verbose, -v
 </dt>
 <dd>
 <p>
  Report progress to stderr.
 </p>
 </dd>
 <dt>
 --prefix=&lt;prefix&gt;/
 </dt>
 <dd>
 <p>
  Prepend &lt;prefix&gt;/ to each filename in the archive.
 </p>
 </dd>
 <dt>
 &lt;extra&gt;
 </dt>
 <dd>
 <p>
  This can be any options that the archiver backend understand.
  See next section.
 </p>
 </dd>
 <dt>
 --remote=&lt;repo&gt;
 </dt>
 <dd>
 <p>
  Instead of making a tar archive from local repository,
  retrieve a tar archive from a remote repository.
 </p>
 </dd>
 <dt>
 &lt;tree-ish&gt;
 </dt>
 <dd>
 <p>
  The tree or commit to produce an archive for.
 </p>
 </dd>
 <dt>
 path
 </dt>
 <dd>
 <p>
  If one or more paths are specified, include only these in the
  archive, otherwise include all files and subdirectories.
 </p>
 </dd>
 </dl>
 </div>
 <h2>BACKEND EXTRA OPTIONS</h2>
 <div class="sectionbody">
 <h3>zip</h3>
 <dl>
 <dt>
 -0
 </dt>
 <dd>
 <p>
  Store the files instead of deflating them.
 </p>
 </dd>
 <dt>
 -9
 </dt>
 <dd>
 <p>
  Highest and slowest compression level. You can specify any
  number from 1 to 9 to adjust compression speed and ratio.
 </p>
 </dd>
 </dl>
 </div>
 <h2>CONFIGURATION</h2>
 <div class="sectionbody">
 <p>By default, file and directories modes are set to 0666 or 0777 in tar
 archives. It is possible to change this by setting the "umask" variable
 in the repository configuration as follows :</p>
 <div class="literalblock">
 <div class="content">
 <pre><tt>umask = 002 ;# group friendly</tt></pre>
 </div></div>
 <p>The special umask value "user" indicates that the user's current umask
 will be used instead. The default value remains 0, which means world
 readable/writable files and directories.</p>
 </div>
 <h2>EXAMPLES</h2>
 <div class="sectionbody">
 <dl>
 <dt>
 git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ &amp;&amp; tar xf -)
 </dt>
 <dd>
 <p>
  Create a tar archive that contains the contents of the
  latest commit on the current branch, and extracts it in
  <tt>/var/tmp/junk</tt> directory.
 </p>
 </dd>
 <dt>
 git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip &gt;git-1.4.0.tar.gz
 </dt>
 <dd>
 <p>
  Create a compressed tarball for v1.4.0 release.
 </p>
 </dd>
 <dt>
 git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} | gzip &gt;git-1.4.0.tar.gz
 </dt>
 <dd>
 <p>
  Create a compressed tarball for v1.4.0 release, but without a
  global extended pax header.
 </p>
 </dd>
 <dt>
 git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ &gt; git-1.4.0-docs.zip
 </dt>
 <dd>
 <p>
  Put everything in the current head's Documentation/ directory
  into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.
 </p>
 </dd>
 </dl>
 </div>
 <h2>Author</h2>
 <div class="sectionbody">
 <p>Written by Franck Bui-Huu and Rene Scharfe.</p>
 </div>
 <h2>Documentation</h2>
 <div class="sectionbody">
 <p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
 </div>
 <h2>GIT</h2>
 <div class="sectionbody">
 <p>Part of the <a href="git.html">git(7)</a> suite</p>
 </div>
 <div id="footer">
 <div id="footer-text">
 Last updated 20-Apr-2007 07:19:54 UTC
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<meta name="generator" content="AsciiDoc 7.0.2" />
	<style type="text/css">
	/* Debug borders */
	p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
	/*
	border: 1px solid red;
	*/
	}

	body {
	margin: 1em 5% 1em 5%;
	}

	a { color: blue; }
	a:visited { color: fuchsia; }

	em {
	font-style: italic;
	}

	strong {
	font-weight: bold;
	}

	tt {
	color: navy;
	}

	h1, h2, h3, h4, h5, h6 {
	color: #527bbd;
	font-family: sans-serif;
	margin-top: 1.2em;
	margin-bottom: 0.5em;
	line-height: 1.3;
	}

	h1 {
	border-bottom: 2px solid silver;
	}
	h2 {
	border-bottom: 2px solid silver;
	padding-top: 0.5em;
	}

	div.sectionbody {
	font-family: serif;
	margin-left: 0;
	}

	hr {
	border: 1px solid silver;
	}

	p {
	margin-top: 0.5em;
	margin-bottom: 0.5em;
	}

	pre {
	padding: 0;
	margin: 0;
	}

	span#author {
	color: #527bbd;
	font-family: sans-serif;
	font-weight: bold;
	font-size: 1.2em;
	}
	span#email {
	}
	span#revision {
	font-family: sans-serif;
	}

	div#footer {
	font-family: sans-serif;
	font-size: small;
	border-top: 2px solid silver;
	padding-top: 0.5em;
	margin-top: 4.0em;
	}
	div#footer-text {
	float: left;
	padding-bottom: 0.5em;
	}
	div#footer-badges {
	float: right;
	padding-bottom: 0.5em;
	}

	div#preamble,
	div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
	div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
	div.admonitionblock {
	margin-right: 10%;
	margin-top: 1.5em;
	margin-bottom: 1.5em;
	}
	div.admonitionblock {
	margin-top: 2.5em;
	margin-bottom: 2.5em;
	}

	div.content { /* Block element content. */
	padding: 0;
	}

	/* Block element titles. */
	div.title, caption.title {
	font-family: sans-serif;
	font-weight: bold;
	text-align: left;
	margin-top: 1.0em;
	margin-bottom: 0.5em;
	}
	div.title + * {
	margin-top: 0;
	}

	td div.title:first-child {
	margin-top: 0.0em;
	}
	div.content div.title:first-child {
	margin-top: 0.0em;
	}
	div.content + div.title {
	margin-top: 0.0em;
	}

	div.sidebarblock > div.content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}

	div.listingblock > div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock > div.content {
	padding-left: 2.0em;
	}
	div.quoteblock .attribution {
	text-align: right;
	}

	div.admonitionblock .icon {
	vertical-align: top;
	font-size: 1.1em;
	font-weight: bold;
	text-decoration: underline;
	color: #527bbd;
	padding-right: 0.5em;
	}
	div.admonitionblock td.content {
	padding-left: 0.5em;
	border-left: 2px solid silver;
	}

	div.exampleblock > div.content {
	border-left: 2px solid silver;
	padding: 0.5em;
	}

	div.verseblock div.content {
	white-space: pre;
	}

	div.imageblock div.content { padding-left: 0; }
	div.imageblock img { border: 1px solid silver; }
	span.image img { border-style: none; }

	dl {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	dt {
	margin-top: 0.5em;
	margin-bottom: 0;
	font-style: italic;
	}
	dd > *:first-child {
	margin-top: 0;
	}

	ul, ol {
	list-style-position: outside;
	}
	ol.olist2 {
	list-style-type: lower-alpha;
	}

	div.tableblock > table {
	border-color: #527bbd;
	border-width: 3px;
	}
	thead {
	font-family: sans-serif;
	font-weight: bold;
	}
	tfoot {
	font-weight: bold;
	}

	div.hlist {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	td.hlist1 {
	vertical-align: top;
	font-style: italic;
	padding-right: 0.8em;
	}
	td.hlist2 {
	vertical-align: top;
	}

	@media print {
	div#footer-badges { display: none; }
	}
	include::./stylesheets/xhtml11-manpage.css[]
	/* Workarounds for IE6's broken and incomplete CSS2. */

	div.sidebar-content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}
	div.sidebar-title, div.image-title {
	font-family: sans-serif;
	font-weight: bold;
	margin-top: 0.0em;
	margin-bottom: 0.5em;
	}

	div.listingblock div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock-content {
	padding-left: 2.0em;
	}

	div.exampleblock-content {
	border-left: 2px solid silver;
	padding-left: 0.5em;
	}
	</style>
	<title>git-archive(1)</title>
	</head>
	<body>
	<div id="header">
	<h1>
	git-archive(1) Manual Page
	</h1>
	<h2>NAME</h2>
	<div class="sectionbody">
	<p>git-archive -
	Creates an archive of files from a named tree
	</p>
	</div>
	</div>
	<h2>SYNOPSIS</h2>
	<div class="sectionbody">
	<p><em>git-archive</em> --format=<fmt> [--list] [--prefix=<prefix>/] [<extra>]
	[--remote=<repo>] <tree-ish> [path…]</p>
	</div>
	<h2>DESCRIPTION</h2>
	<div class="sectionbody">
	<p>Creates an archive of the specified format containing the tree
	structure for the named tree. If <prefix> is specified it is
	prepended to the filenames in the archive.</p>
	<p><em>git-archive</em> behaves differently when given a tree ID versus when
	given a commit ID or tag ID. In the first case the current time is
	used as modification time of each file in the archive. In the latter
	case the commit time as recorded in the referenced commit object is
	used instead. Additionally the commit ID is stored in a global
	extended pax header if the tar format is used; it can be extracted
	using <em>git-get-tar-commit-id</em>. In ZIP files it is stored as a file
	comment.</p>
	</div>
	<h2>OPTIONS</h2>
	<div class="sectionbody">
	<dl>
	<dt>
	--format=<fmt>
	</dt>
	<dd>
	<p>
	Format of the resulting archive: <em>tar</em>, <em>zip</em>… The default
	is <em>tar</em>.
	</p>
	</dd>
	<dt>
	--list, -l
	</dt>
	<dd>
	<p>
	Show all available formats.
	</p>
	</dd>
	<dt>
	--verbose, -v
	</dt>
	<dd>
	<p>
	Report progress to stderr.
	</p>
	</dd>
	<dt>
	--prefix=<prefix>/
	</dt>
	<dd>
	<p>
	Prepend <prefix>/ to each filename in the archive.
	</p>
	</dd>
	<dt>
	<extra>
	</dt>
	<dd>
	<p>
	This can be any options that the archiver backend understand.
	See next section.
	</p>
	</dd>
	<dt>
	--remote=<repo>
	</dt>
	<dd>
	<p>
	Instead of making a tar archive from local repository,
	retrieve a tar archive from a remote repository.
	</p>
	</dd>
	<dt>
	<tree-ish>
	</dt>
	<dd>
	<p>
	The tree or commit to produce an archive for.
	</p>
	</dd>
	<dt>
	path
	</dt>
	<dd>
	<p>
	If one or more paths are specified, include only these in the
	archive, otherwise include all files and subdirectories.
	</p>
	</dd>
	</dl>
	</div>
	<h2>BACKEND EXTRA OPTIONS</h2>
	<div class="sectionbody">
	<h3>zip</h3>
	<dl>
	<dt>
	-0
	</dt>
	<dd>
	<p>
	Store the files instead of deflating them.
	</p>
	</dd>
	<dt>
	-9
	</dt>
	<dd>
	<p>
	Highest and slowest compression level. You can specify any
	number from 1 to 9 to adjust compression speed and ratio.
	</p>
	</dd>
	</dl>
	</div>
	<h2>CONFIGURATION</h2>
	<div class="sectionbody">
	<p>By default, file and directories modes are set to 0666 or 0777 in tar
	archives. It is possible to change this by setting the "umask" variable
	in the repository configuration as follows :</p>
	<div class="literalblock">
	<div class="content">
	<pre><tt>umask = 002 ;# group friendly</tt></pre>
	</div></div>
	<p>The special umask value "user" indicates that the user's current umask
	will be used instead. The default value remains 0, which means world
	readable/writable files and directories.</p>
	</div>
	<h2>EXAMPLES</h2>
	<div class="sectionbody">
	<dl>
	<dt>
	git archive --format=tar --prefix=junk/ HEAD \| (cd /var/tmp/ && tar xf -)
	</dt>
	<dd>
	<p>
	Create a tar archive that contains the contents of the
	latest commit on the current branch, and extracts it in
	<tt>/var/tmp/junk</tt> directory.
	</p>
	</dd>
	<dt>
	git archive --format=tar --prefix=git-1.4.0/ v1.4.0 \| gzip >git-1.4.0.tar.gz
	</dt>
	<dd>
	<p>
	Create a compressed tarball for v1.4.0 release.
	</p>
	</dd>
	<dt>
	git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} \| gzip >git-1.4.0.tar.gz
	</dt>
	<dd>
	<p>
	Create a compressed tarball for v1.4.0 release, but without a
	global extended pax header.
	</p>
	</dd>
	<dt>
	git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip
	</dt>
	<dd>
	<p>
	Put everything in the current head's Documentation/ directory
	into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.
	</p>
	</dd>
	</dl>
	</div>
	<h2>Author</h2>
	<div class="sectionbody">
	<p>Written by Franck Bui-Huu and Rene Scharfe.</p>
	</div>
	<h2>Documentation</h2>
	<div class="sectionbody">
	<p>Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.</p>
	</div>
	<h2>GIT</h2>
	<div class="sectionbody">
	<p>Part of the <a href="git.html">git(7)</a> suite</p>
	</div>
	<div id="footer">
	<div id="footer-text">
	Last updated 20-Apr-2007 07:19:54 UTC
	</div>
	</div>
	</body>
	</html>