doc/source/en/TortoiseGit/git_doc/git-archive.html.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-archive(1)">\r
   5 <articleinfo>\r
   6     <title>git-archive(1)</title>\r
   7         <indexterm>\r
   8                 <primary>git-archive(1)</primary>\r
   9         </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-archive - Create an archive of files from a named tree</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git archive</emphasis> --format=&lt;fmt&gt; [--list] [--prefix=&lt;prefix&gt;/] [&lt;extra&gt;]\r
  19               [--remote=&lt;repo&gt; [--exec=&lt;git-upload-archive&gt;]] &lt;tree-ish&gt;\r
  20               [path&#8230;]</literallayout>\r
  21 </blockquote>\r
  22 </simplesect>\r
  23 <simplesect id="_description">\r
  24 <title>DESCRIPTION</title>\r
  25 <simpara>Creates an archive of the specified format containing the tree\r
  26 structure for the named tree, and writes it out to the standard\r
  27 output.  If &lt;prefix&gt; is specified it is\r
  28 prepended to the filenames in the archive.</simpara>\r
  29 <simpara><emphasis>git-archive</emphasis> behaves differently when given a tree ID versus when\r
  30 given a commit ID or tag ID.  In the first case the current time is\r
  31 used as modification time of each file in the archive.  In the latter\r
  32 case the commit time as recorded in the referenced commit object is\r
  33 used instead.  Additionally the commit ID is stored in a global\r
  34 extended pax header if the tar format is used; it can be extracted\r
  35 using <emphasis>git-get-tar-commit-id</emphasis>. In ZIP files it is stored as a file\r
  36 comment.</simpara>\r
  37 </simplesect>\r
  38 <simplesect id="_options">\r
  39 <title>OPTIONS</title>\r
  40 <variablelist>\r
  41 <varlistentry>\r
  42 <term>\r
  43 --format=&lt;fmt&gt;\r
  44 </term>\r
  45 <listitem>\r
  46 <simpara>\r
  47         Format of the resulting archive: <emphasis>tar</emphasis> or <emphasis>zip</emphasis>.  The default\r
  48         is <emphasis>tar</emphasis>.\r
  49 </simpara>\r
  50 </listitem>\r
  51 </varlistentry>\r
  52 <varlistentry>\r
  53 <term>\r
  54 -l\r
  55 </term>\r
  56 <term>\r
  57 --list\r
  58 </term>\r
  59 <listitem>\r
  60 <simpara>\r
  61         Show all available formats.\r
  62 </simpara>\r
  63 </listitem>\r
  64 </varlistentry>\r
  65 <varlistentry>\r
  66 <term>\r
  67 -v\r
  68 </term>\r
  69 <term>\r
  70 --verbose\r
  71 </term>\r
  72 <listitem>\r
  73 <simpara>\r
  74         Report progress to stderr.\r
  75 </simpara>\r
  76 </listitem>\r
  77 </varlistentry>\r
  78 <varlistentry>\r
  79 <term>\r
  80 --prefix=&lt;prefix&gt;/\r
  81 </term>\r
  82 <listitem>\r
  83 <simpara>\r
  84         Prepend &lt;prefix&gt;/ to each filename in the archive.\r
  85 </simpara>\r
  86 </listitem>\r
  87 </varlistentry>\r
  88 <varlistentry>\r
  89 <term>\r
  90 --submodules[=&lt;spec&gt;]\r
  91 </term>\r
  92 <listitem>\r
  93 <simpara>\r
  94         Include the content of submodules in the archive. The specification\r
  95         of which submodules to include can be either <emphasis>checkedout</emphasis> (default)\r
  96         or <emphasis>all</emphasis>.\r
  97 </simpara>\r
  98 </listitem>\r
  99 </varlistentry>\r
 100 <varlistentry>\r
 101 <term>\r
 102 &lt;extra&gt;\r
 103 </term>\r
 104 <listitem>\r
 105 <simpara>\r
 106         This can be any options that the archiver backend understand.\r
 107         See next section.\r
 108 </simpara>\r
 109 </listitem>\r
 110 </varlistentry>\r
 111 <varlistentry>\r
 112 <term>\r
 113 --remote=&lt;repo&gt;\r
 114 </term>\r
 115 <listitem>\r
 116 <simpara>\r
 117         Instead of making a tar archive from local repository,\r
 118         retrieve a tar archive from a remote repository.\r
 119 </simpara>\r
 120 </listitem>\r
 121 </varlistentry>\r
 122 <varlistentry>\r
 123 <term>\r
 124 --exec=&lt;git-upload-archive&gt;\r
 125 </term>\r
 126 <listitem>\r
 127 <simpara>\r
 128         Used with --remote to specify the path to the\r
 129         <emphasis>git-upload-archive</emphasis> on the remote side.\r
 130 </simpara>\r
 131 </listitem>\r
 132 </varlistentry>\r
 133 <varlistentry>\r
 134 <term>\r
 135 &lt;tree-ish&gt;\r
 136 </term>\r
 137 <listitem>\r
 138 <simpara>\r
 139         The tree or commit to produce an archive for.\r
 140 </simpara>\r
 141 </listitem>\r
 142 </varlistentry>\r
 143 <varlistentry>\r
 144 <term>\r
 145 path\r
 146 </term>\r
 147 <listitem>\r
 148 <simpara>\r
 149         If one or more paths are specified, include only these in the\r
 150         archive, otherwise include all files and subdirectories.\r
 151 </simpara>\r
 152 </listitem>\r
 153 </varlistentry>\r
 154 </variablelist>\r
 155 </simplesect>\r
 156 <simplesect id="_backend_extra_options">\r
 157 <title>BACKEND EXTRA OPTIONS</title>\r
 158 <simplesect id="_zip">\r
 159 <title>zip</title>\r
 160 <variablelist>\r
 161 <varlistentry>\r
 162 <term>\r
 163 -0\r
 164 </term>\r
 165 <listitem>\r
 166 <simpara>\r
 167         Store the files instead of deflating them.\r
 168 </simpara>\r
 169 </listitem>\r
 170 </varlistentry>\r
 171 <varlistentry>\r
 172 <term>\r
 173 -9\r
 174 </term>\r
 175 <listitem>\r
 176 <simpara>\r
 177         Highest and slowest compression level.  You can specify any\r
 178         number from 1 to 9 to adjust compression speed and ratio.\r
 179 </simpara>\r
 180 </listitem>\r
 181 </varlistentry>\r
 182 </variablelist>\r
 183 </simplesect>\r
 184 </simplesect>\r
 185 <simplesect id="_configuration">\r
 186 <title>CONFIGURATION</title>\r
 187 <variablelist>\r
 188 <varlistentry>\r
 189 <term>\r
 190 tar.umask\r
 191 </term>\r
 192 <listitem>\r
 193 <simpara>\r
 194         This variable can be used to restrict the permission bits of\r
 195         tar archive entries.  The default is 0002, which turns off the\r
 196         world write bit.  The special value "user" indicates that the\r
 197         archiving user&#8217;s umask will be used instead.  See umask(2) for\r
 198         details.\r
 199 </simpara>\r
 200 </listitem>\r
 201 </varlistentry>\r
 202 </variablelist>\r
 203 </simplesect>\r
 204 <simplesect id="_examples">\r
 205 <title>EXAMPLES</title>\r
 206 <variablelist>\r
 207 <varlistentry>\r
 208 <term>\r
 209 git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ &amp;&amp; tar xf -)\r
 210 </term>\r
 211 <listitem>\r
 212 <simpara>\r
 213         Create a tar archive that contains the contents of the\r
 214         latest commit on the current branch, and extracts it in\r
 215         <literal>/var/tmp/junk</literal> directory.\r
 216 </simpara>\r
 217 </listitem>\r
 218 </varlistentry>\r
 219 <varlistentry>\r
 220 <term>\r
 221 git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip &gt;git-1.4.0.tar.gz\r
 222 </term>\r
 223 <listitem>\r
 224 <simpara>\r
 225         Create a compressed tarball for v1.4.0 release.\r
 226 </simpara>\r
 227 </listitem>\r
 228 </varlistentry>\r
 229 <varlistentry>\r
 230 <term>\r
 231 git archive --format=tar --prefix=git-1.4.0/ v1.4.0&#94;{tree} | gzip &gt;git-1.4.0.tar.gz\r
 232 </term>\r
 233 <listitem>\r
 234 <simpara>\r
 235         Create a compressed tarball for v1.4.0 release, but without a\r
 236         global extended pax header.\r
 237 </simpara>\r
 238 </listitem>\r
 239 </varlistentry>\r
 240 <varlistentry>\r
 241 <term>\r
 242 git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ &gt; git-1.4.0-docs.zip\r
 243 </term>\r
 244 <listitem>\r
 245 <simpara>\r
 246         Put everything in the current head&#8217;s Documentation/ directory\r
 247         into <emphasis>git-1.4.0-docs.zip</emphasis>, with the prefix <emphasis>git-docs/</emphasis>.\r
 248 </simpara>\r
 249 </listitem>\r
 250 </varlistentry>\r
 251 </variablelist>\r
 252 </simplesect>\r
 253 <simplesect id="_author">\r
 254 <title>Author</title>\r
 255 <simpara>Written by Franck Bui-Huu and Rene Scharfe.</simpara>\r
 256 </simplesect>\r
 257 <simplesect id="_documentation">\r
 258 <title>Documentation</title>\r
 259 <simpara>Documentation by David Greaves, Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
 260 </simplesect>\r
 261 <simplesect id="_git">\r
 262 <title>GIT</title>\r
 263 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
 264 </simplesect>\r
 265 </article>\r