You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

zip.html 27 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561
  1. <!--
  2. Licensed to the Apache Software Foundation (ASF) under one or more
  3. contributor license agreements. See the NOTICE file distributed with
  4. this work for additional information regarding copyright ownership.
  5. The ASF licenses this file to You under the Apache License, Version 2.0
  6. (the "License"); you may not use this file except in compliance with
  7. the License. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. -->
  15. <html>
  16. <head>
  17. <meta http-equiv="Content-Language" content="en-us">
  18. <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
  19. <title>Zip Task</title>
  20. </head>
  21. <body>
  22. <h2><a name="zip">Zip</a></h2>
  23. <h3>Description</h3>
  24. <p>Creates a zipfile.</p>
  25. <p>The <i>basedir</i> attribute is the reference directory from where to zip.</p>
  26. <p>Note that file permissions will not be stored in the resulting zipfile.</p>
  27. <p>It is possible to refine the set of files that are being zipped. This can be
  28. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  29. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  30. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  31. the files you want to have excluded. This is also done with patterns. And
  32. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  33. want to use default exclusions or not. See the section on <a
  34. href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on how the
  35. inclusion/exclusion of files works, and how to write patterns. </p>
  36. <p>This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and
  37. supports most attributes of <code>&lt;fileset&gt;</code>
  38. (<code>dir</code> becomes <code>basedir</code>) as well as the nested
  39. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and
  40. <code>&lt;patternset&gt;</code> elements.</p>
  41. <p>Or, you may place within it nested file sets, or references to file sets.
  42. In this case <code>basedir</code> is optional; the implicit file set is <i>only used</i>
  43. if <code>basedir</code> is set. You may use any mixture of the implicit file set
  44. (with <code>basedir</code> set, and optional attributes like <code>includes</code>
  45. and optional subelements like <code>&lt;include&gt;</code>); explicit nested
  46. <code>&lt;fileset&gt;</code> elements so long as at least one fileset total is specified. The ZIP file will
  47. only reflect the relative paths of files <i>within</i> each fileset. The Zip task and its derivatives know a special form of a fileset named zipfileset that has additional attributes (described below). </p>
  48. <p>The Zip task also supports the merging of multiple zip files into the zip file.
  49. This is possible through either the <i>src</i> attribute of any nested filesets
  50. or by using the special nested fileset <i>zipgroupfileset</i>.</p>
  51. <p>The <code>update</code> parameter controls what happens if the ZIP
  52. file already exists. When set to <code>yes</code>, the ZIP file is
  53. updated with the files specified. (New files are added; old files are
  54. replaced with the new versions.) When set to <code>no</code> (the
  55. default) the ZIP file is overwritten if any of the files that would be
  56. added to the archive are newer than the entries inside the archive.
  57. Please note that ZIP files store file modification times with a
  58. granularity of two seconds. If a file is less than two seconds newer
  59. than the entry in the archive, Apache Ant will not consider it newer.</p>
  60. <p>The <code>whenempty</code> parameter controls what happens when no files match.
  61. If <code>skip</code> (the default), the ZIP is not created and a warning is issued.
  62. If <code>fail</code>, the ZIP is not created and the build is halted with an error.
  63. If <code>create</code>, an empty ZIP file (explicitly zero entries) is created,
  64. which should be recognized as such by compliant ZIP manipulation tools.</p>
  65. <p>This task will now use the platform's default character encoding
  66. for filenames - this is consistent with the command line ZIP tools,
  67. but causes problems if you try to open them from within Java and your
  68. filenames contain non US-ASCII characters. Use the encoding attribute
  69. and set it to UTF8 to create zip files that can safely be read by
  70. Java. For a more complete discussion,
  71. see <a href="#encoding">below</a></p>
  72. <p>Starting with Ant 1.5.2, <code>&lt;zip&gt;</code> can store Unix permissions
  73. inside the archive (see description of the filemode and dirmode
  74. attributes for <a href="../Types/zipfileset.html">&lt;zipfileset&gt;</a>).
  75. Unfortunately there is no portable way to store these permissions.
  76. Ant uses the algorithm used by <a href="http://www.info-zip.org">Info-Zip's</a>
  77. implementation of the zip and unzip commands - these are the default
  78. versions of zip and unzip for many Unix and Unix-like systems.</p>
  79. <p><b>Please note that the zip format allows multiple files of the same
  80. fully-qualified name to exist within a single archive. This has been
  81. documented as causing various problems for unsuspecting users. If you wish
  82. to avoid this behavior you must set the <code>duplicate</code> attribute
  83. to a value other than its default, <code>&quot;add&quot;</code>.</b></p>
  84. <p><b>Please also note</b> that different ZIP tools handle timestamps
  85. differently when it comes to applying timezone offset calculations of
  86. files. Some ZIP libraries will store the timestamps as they've been
  87. read from the filesystem while others will modify the timestamps both
  88. when reading and writing the files to make all timestamps use the same
  89. timezone. A ZIP archive created by one library may extract files with
  90. "wrong timestamps" when extracted by another library.</p>
  91. <p>Ant's ZIP classes use the same algorithm as the InfoZIP tools and
  92. zlib (timestamps get adjusted), Windows' "compressed folders" function
  93. and WinZIP don't change the timestamps. This means that using the
  94. unzip task on files created by Windows' compressed folders function
  95. may create files with timestamps that are "wrong", the same is true if
  96. you use Windows' functions to extract an Ant generated ZIP
  97. archive.</p>
  98. <h3>Parameters</h3>
  99. <table border="1" cellpadding="2" cellspacing="0">
  100. <tr>
  101. <td valign="top"><b>Attribute</b></td>
  102. <td valign="top"><b>Description</b></td>
  103. <td valign="top" align="center"><b>Required</b></td>
  104. </tr>
  105. <tr>
  106. <td valign="top">destfile</td>
  107. <td valign="top">the zip-file to create.</td>
  108. <td align="center" valign="top" rowspan="2">Exactly one of the two.</td>
  109. </tr>
  110. <tr>
  111. <td valign="top">zipfile</td>
  112. <td valign="top">the <i>deprecated</i> old name of destfile.</td>
  113. </tr>
  114. <tr>
  115. <td valign="top">basedir</td>
  116. <td valign="top">the directory from which to zip the files.</td>
  117. <td align="center" valign="top">No</td>
  118. </tr>
  119. <tr>
  120. <td valign="top">compress</td>
  121. <td valign="top">Not only store data but also compress them,
  122. defaults to true. Unless you set the <em>keepcompression</em>
  123. attribute to false, this will apply to the entire archive, not
  124. only the files you've added while updating.</td>
  125. <td align="center" valign="top">No</td>
  126. </tr>
  127. <tr>
  128. <td valign="top">keepcompression</td>
  129. <td valign="top">For entries coming from existing archives (like
  130. nested <em>zipfileset</em>s or while updating the archive), keep
  131. the compression as it has been originally instead of using the
  132. <em>compress</em> attribute. Defaults false. <em>Since Ant
  133. 1.6</em></td>
  134. <td align="center" valign="top">No</td>
  135. </tr>
  136. <tr>
  137. <td valign="top">encoding</td>
  138. <td valign="top">The character encoding to use for filenames
  139. inside the zip file. For a list of possible values see the <a
  140. href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">Supported Encodings</a>.<br/>
  141. Defaults to the platform's default character encoding.
  142. <br/>See also the <a href="#encoding">discussion below</a></td>
  143. <td align="center" valign="top">No</td>
  144. </tr>
  145. <tr>
  146. <td valign="top">filesonly</td>
  147. <td valign="top">Store only file entries, defaults to false</td>
  148. <td align="center" valign="top">No</td>
  149. </tr>
  150. <tr>
  151. <td valign="top">includes</td>
  152. <td valign="top">comma- or space-separated list of patterns of files that must be
  153. included. All files are included when omitted.</td>
  154. <td valign="top" align="center">No</td>
  155. </tr>
  156. <tr>
  157. <td valign="top">includesfile</td>
  158. <td valign="top">the name of a file. Each line of this file is
  159. taken to be an include pattern</td>
  160. <td valign="top" align="center">No</td>
  161. </tr>
  162. <tr>
  163. <td valign="top">excludes</td>
  164. <td valign="top">comma- or space-separated list of patterns of files that must be
  165. excluded. No files (except default excludes) are excluded when omitted.</td>
  166. <td valign="top" align="center">No</td>
  167. </tr>
  168. <tr>
  169. <td valign="top">excludesfile</td>
  170. <td valign="top">the name of a file. Each line of this file is
  171. taken to be an exclude pattern</td>
  172. <td valign="top" align="center">No</td>
  173. </tr>
  174. <tr>
  175. <td valign="top">defaultexcludes</td>
  176. <td valign="top">indicates whether default excludes should be used or not
  177. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  178. <td valign="top" align="center">No</td>
  179. </tr>
  180. <tr>
  181. <td valign="top">update</td>
  182. <td valign="top">indicates whether to update or overwrite
  183. the destination file if it already exists. Default is &quot;false&quot;.</td>
  184. <td valign="top" align="center">No</td>
  185. </tr>
  186. <tr>
  187. <td valign="top">whenempty</td>
  188. <td valign="top">behavior when no files match. Valid values are &quot;fail&quot;, &quot;skip&quot;, and &quot;create&quot;. Default is &quot;skip&quot;.</td>
  189. <td valign="top" align="center">No</td>
  190. </tr>
  191. <tr>
  192. <td valign="top">duplicate</td>
  193. <td valign="top">behavior when a duplicate file is found. Valid values are &quot;add&quot;, &quot;preserve&quot;, and &quot;fail&quot;. The default value is &quot;add&quot;. </td>
  194. <td valign="top" align="center">No</td>
  195. </tr>
  196. <tr>
  197. <td valign="top">roundup</td>
  198. <td valign="top">Whether the file modification times will be
  199. rounded up to the next even number of seconds.<br>
  200. Zip archives store file modification times with a granularity of
  201. two seconds, so the times will either be rounded up or down. If
  202. you round down, the archive will always seem out-of-date when you
  203. rerun the task, so the default is to round up. Rounding up may
  204. lead to a different type of problems like JSPs inside a web
  205. archive that seem to be slightly more recent than precompiled
  206. pages, rendering precompilation useless.<br>
  207. Defaults to true. <em>Since Ant 1.6.2</em></td>
  208. <td align="center" valign="top">No</td>
  209. </tr>
  210. <tr>
  211. <td valign="top">comment</td>
  212. <td valign="top">Comment to store in the archive. <em>Since Ant 1.6.3</em></td>
  213. <td valign="top" align="center">No</td>
  214. </tr>
  215. <tr>
  216. <td valign="top">level</td>
  217. <td valign="top">Non-default level at which file compression should be
  218. performed. Valid values range from 0 (no compression/fastest) to 9
  219. (maximum compression/slowest). <em>Since Ant 1.7</em></td>
  220. <td valign="top" align="center">No</td>
  221. </tr>
  222. <tr>
  223. <td valign="top">preserve0permissions</td>
  224. <td valign="top">when updating an archive or adding entries from a
  225. different archive Ant will assume that a Unix permissions value of
  226. 0 (nobody is allowed to do anything to the file/directory) means
  227. that the permissions haven't been stored at all rather than real
  228. permissions and will instead apply its own default values.<br/>
  229. Set this attribute to true if you really want to preserve the
  230. original permission field.<em>since Ant 1.8.0</em>
  231. </td>
  232. <td valign="top" align="center">No, default is false</td>
  233. </tr>
  234. <tr>
  235. <td valign="top">useLanguageEncodingFlag</td>
  236. <td valign="top">Whether to set the language encoding flag if the
  237. encoding is UTF-8. This setting doesn't have any effect if the
  238. encoding is not UTF-8.
  239. <em>Since Ant 1.8.0</em>.
  240. <br/>See also the <a href="#encoding">discussion below</a></td>
  241. <td align="center" valign="top">No, default is true</td>
  242. </tr>
  243. <tr>
  244. <td valign="top">createUnicodeExtraFields</td>
  245. <td valign="top">Whether to create unicode extra fields to store
  246. the file names a second time inside the entry's metadata.
  247. <br>Possible values are "never", "always" and "not-encodeable"
  248. which will only add Unicode extra fields if the file name cannot
  249. be encoded using the specified encoding.
  250. <em>Since Ant 1.8.0</em>.
  251. <br/>See also the <a href="#encoding">discussion below</a></td>
  252. <td align="center" valign="top">No, default is "never"</td>
  253. </tr>
  254. <tr>
  255. <td valign="top">fallbacktoUTF8</td>
  256. <td valign="top">Whether to use UTF-8 and the language encoding
  257. flag instead of the specified encoding if a file name cannot be
  258. encoded using the specified encoding.
  259. <em>Since Ant 1.8.0</em>.
  260. <br/>See also the <a href="#encoding">discussion below</a></td>
  261. <td align="center" valign="top">No, default is false</td>
  262. </tr>
  263. <tr>
  264. <td valign="top">zip64Mode</td>
  265. <td valign="top">When to use Zip64 extensions for entries. The
  266. possible values are "never", "always" and "as-needed".
  267. <em>Since Ant 1.9.1</em>.
  268. <br/>See also the <a href="#zip64">discussion below</a></td>
  269. <td align="center" valign="top">No, default is "as-needed"</td>
  270. </tr>
  271. <tr>
  272. <td valign="top">modificationtime</td>
  273. <td valign="top">Set all stored file modification times to the
  274. given time. This can either be a number interpreted as
  275. milliseconds since 1970-01-01T00:00:00Z or a string that can be
  276. parsed as a ISO 8601 timestamp with optional timezone.
  277. <em>Since Ant 1.9.10</em>.
  278. </td>
  279. <td align="center" valign="top">No</td>
  280. </tr>
  281. </table>
  282. <h3><a name="encoding">Encoding of File Names</a></h3>
  283. <p>Traditionally the ZIP archive format uses CodePage 437 as encoding
  284. for file name, which is not sufficient for many international
  285. character sets.</p>
  286. <p>Over time different archivers have chosen different ways to work
  287. around the limitation - the <code>java.util.zip</code> packages
  288. simply uses UTF-8 as its encoding for example.</p>
  289. <p>Ant has been offering the encoding attribute of the zip and unzip
  290. task as a way to explicitly specify the encoding to use (or expect)
  291. since Ant 1.4. It defaults to the platform's default encoding for
  292. zip and UTF-8 for jar and other jar-like tasks (war, ear, ...) as
  293. well as the unzip family of tasks.</p>
  294. <p>More recent versions of the ZIP specification introduce something
  295. called the &quot;language encoding flag&quot; which can be used to
  296. signal that a file name has been encoded using UTF-8. Starting with
  297. Ant 1.8.0 all zip-/jar- and similar archives written by Ant will set
  298. this flag, if the encoding has been set to UTF-8. Our
  299. interoperabilty tests with existing archivers didn't show any ill
  300. effects (in fact, most archivers ignore the flag to date), but you
  301. can turn off the "language encoding flag" by setting the attribute
  302. <code>useLanguageEncodingFlag</code> to <code>false</code> on the
  303. zip-task if you should encounter problems.</p>
  304. <p>The unzip (and similar tasks) -task will recognize the language
  305. encoding flag and ignore the encoding set on the task if it has been
  306. found.</p>
  307. <p>The InfoZIP developers have introduced new ZIP extra fields that
  308. can be used to add an additional UTF-8 encoded file name to the
  309. entry's metadata. Most archivers ignore these extra fields. The
  310. zip family of tasks support an
  311. option <code>createUnicodeExtraFields</code> since Ant 1.8.0 which
  312. makes Ant write these extra fields either for all entries ("always")
  313. or only those whose name cannot be encoded using the specified
  314. encoding (not-encodeable), it defaults to "never" since the extra
  315. fields create bigger archives.</p>
  316. <p>The fallbackToUTF8 attribute of zip can be used to create archives
  317. that use the specified encoding in the majority of cases but UTF-8 and
  318. the language encoding flag for filenames that cannot be encoded
  319. using the specified encoding.</p>
  320. <p>The unzip-task will recognize the unicode extra fields by default
  321. and read the file name information from them, unless you set the
  322. optional attribute <code>scanForUnicodeExtraFields</code> to
  323. false.</p>
  324. <h4>Recommendations for Interoperability</h4>
  325. <p>The optimal setting of flags depends on the archivers you expect as
  326. consumers/producers of the ZIP archives. Below are some test
  327. results which may be superseeded with later versions of each
  328. tool.</p>
  329. <ul>
  330. <li>The java.util.zip package used by the jar executable or to read
  331. jars from your CLASSPATH reads and writes UTF-8 names, it doesn't
  332. set or recognize any flags or unicode extra fields.</li>
  333. <li>Starting with Java7 <code>java.util.zip</code> writes UTF-8 by
  334. default and uses the language encoding flag. It is possible to
  335. specify a different encoding when reading/writing ZIPs via new
  336. constructors. The package now recognizes the language encoding
  337. flag when reading and ignores the Unicode extra fields.</li>
  338. <li>7Zip writes CodePage 437 by default but uses UTF-8 and the
  339. language encoding flag when writing entries that cannot be encoded
  340. as CodePage 437 (similar to the zip task with fallbacktoUTF8 set
  341. to true). It recognizes the language encoding flag when reading
  342. and ignores the unicode extra fields.</li>
  343. <li>WinZIP writes CodePage 437 and uses unicode extra fields by
  344. default. It recognizes the unicode extra field and the language
  345. encoding flag when reading.</li>
  346. <li>Windows' "compressed folder" feature doesn't recognize any flag
  347. or extra field and creates archives using the platforms default
  348. encoding - and expects archives to be in that encoding when reading
  349. them.</li>
  350. <li>InfoZIP based tools can recognize and write both, it is a
  351. compile time option and depends on the platform so your mileage
  352. may vary.</li>
  353. <li>PKWARE zip tools recognize both and prefer the language encoding
  354. flag. They create archives using CodePage 437 if possible and UTF-8
  355. plus the language encoding flag for file names that cannot be
  356. encoded as CodePage 437.</li>
  357. </ul>
  358. <p>So, what to do?</p>
  359. <p>If you are creating jars, then java.util.zip is your main
  360. consumer. We recommend you set the encoding to UTF-8 and keep the
  361. language encoding flag enabled. The flag won't help or hurt
  362. java.util.zip prior to Java7 but archivers that support it will show
  363. the correct file names.</p>
  364. <p>For maximum interop it is probably best to set the encoding to
  365. UTF-8, enable the language encoding flag and create unicode extra
  366. fields when writing ZIPs. Such archives should be extracted
  367. correctly by java.util.zip, 7Zip, WinZIP, PKWARE tools and most
  368. likely InfoZIP tools. They will be unusable with Windows'
  369. "compressed folders" feature and bigger than archives without the
  370. unicode extra fields, though.</p>
  371. <p>If Windows' "compressed folders" is your primary consumer, then
  372. your best option is to explicitly set the encoding to the target
  373. platform. You may want to enable creation of unicode extra fields
  374. so the tools that support them will extract the file names
  375. correctly.</p>
  376. <h3><a name="zip64">Zip64 extensions</a></h3>
  377. <p>Zip64 extensions provide a way to create archives bigger than 4GB
  378. or holding more than 65535 entries - or add individual entries
  379. bigger than 4GB using the ZIP extension field mechanism. These
  380. extensions are supported by most modern ZIP implementations.</p>
  381. <p>When Ant writes compressed entries into the archive it creates it
  382. doesn't know the compressed size of an entry before it has been
  383. written. Unfortunately the decision whether a Zip64 extra field
  384. will be written has to be made before writing the entry's
  385. content.</p>
  386. <p>Starting with Ant 1.9.0 Ant supports Zip64 extensions but didn't
  387. provide any control over their usage, starting with Ant 1.9.1 a
  388. new <em>zip64mode</em> attribute was added to the <code>zip</code>
  389. family of tasks. It supports three values:
  390. <ul>
  391. <li><em>never</em> means no Zip64 extra fields will ever be
  392. written, this is the behavior of Ant 1.8.x and earlier and the
  393. default behavior of <code>jar</code>, <code>ear</code>
  394. and <code>war</code> starting with Ant 1.9.1.</li>
  395. <li><em>always</em> means Zip64 extra fields are written for all
  396. entries.</li>
  397. <li><em>as-needed</em> means Zip64 extra fields are written for all
  398. compressed entries to the "local file header" (by default these
  399. are all files but not the directories) but only written to the
  400. central directory if the entry really required Zip64 features.
  401. This is the default behavior of Ant 1.9.0 and remains the default
  402. behavior of the <code>zip</code> task.</li>
  403. </ul>
  404. <p><em>as-needed</em> provides a good compromise if you don't know
  405. whether you archive will exceed the limits of traditional zip files
  406. but don't want to waste too much space (the Zip64 extensions take up
  407. extra space). Unfortunately some ZIP implementations don't
  408. understand Zip64 extra fields or fail to parse archives with extra
  409. fields in local file headers that are not present in the central
  410. directory, one such implementation is the java.util.zip package of
  411. Java5, that's why the <code>jar</code> tasks default
  412. to <em>never</em>. Archives created with <em>as-needed</em> can be
  413. read without problems with Java6 and later.</p>
  414. <h3>Parameters specified as nested elements</h3>
  415. <h4>any resource collection</h4>
  416. <p><a href="../Types/resources.html#collection">Resource
  417. Collection</a>s are used to select groups of files to archive.</p>
  418. <p>Prior to Ant 1.7 only <code>&lt;fileset&gt;</code> and
  419. <code>&lt;zipfileset&gt;</code> have been supported as nested elements.</p>
  420. <a name="zipgroupfileset" />
  421. <h4>zipgroupfileset</h4>
  422. <p>A <code>&lt;zipgroupfileset&gt;</code> allows for multiple zip files to be
  423. merged into the archive. Each file found in this fileset is added to the archive
  424. the same way that <i>zipfileset src</i> files are added.</p>
  425. <p><code>&lt;zipgroupfileset&gt;</code> is
  426. a <a href="../Types/fileset.html">fileset</a> and supports all
  427. of its attributes and nested elements.</a>
  428. <h3>Examples</h3>
  429. <pre> &lt;zip destfile=&quot;${dist}/manual.zip&quot;
  430. basedir=&quot;htdocs/manual&quot;
  431. /&gt;</pre>
  432. <p>zips all files in the <code>htdocs/manual</code> directory into a file called <code>manual.zip</code>
  433. in the <code>${dist}</code> directory.</p>
  434. <pre> &lt;zip destfile=&quot;${dist}/manual.zip&quot;
  435. basedir=&quot;htdocs/manual&quot;
  436. update=&quot;true&quot;
  437. /&gt;</pre>
  438. <p>zips all files in the <code>htdocs/manual</code> directory into a file called <code>manual.zip</code>
  439. in the <code>${dist}</code> directory. If <code>manual.zip</code>
  440. doesn't exist, it is created; otherwise it is updated with the
  441. new/changed files.</p>
  442. <pre> &lt;zip destfile=&quot;${dist}/manual.zip&quot;
  443. basedir=&quot;htdocs/manual&quot;
  444. excludes=&quot;mydocs/**, **/todo.html&quot;
  445. /&gt;</pre>
  446. <p>zips all files in the <code>htdocs/manual</code> directory. Files in the directory <code>mydocs</code>,
  447. or files with the name <code>todo.html</code> are excluded.</p>
  448. <pre> &lt;zip destfile=&quot;${dist}/manual.zip&quot;
  449. basedir=&quot;htdocs/manual&quot;
  450. includes=&quot;api/**/*.html&quot;
  451. excludes=&quot;**/todo.html&quot;
  452. /&gt;</pre>
  453. <p>zips all files in the <code>htdocs/manual</code> directory. Only html files under the directory <code>api</code>
  454. are zipped, and files with the name <code>todo.html</code> are excluded.</p>
  455. <pre> &lt;zip destfile=&quot;${dist}/manual.zip&quot;&gt;
  456. &lt;fileset dir=&quot;htdocs/manual&quot;/&gt;
  457. &lt;fileset dir=&quot;.&quot; includes=&quot;ChangeLog.txt&quot;/&gt;
  458. &lt;/zip&gt;</pre>
  459. <p>zips all files in the <code>htdocs/manual</code> directory, and also adds the file <code>ChangeLog.txt</code> in the
  460. current directory. <code>ChangeLog.txt</code> will be added to the top of the ZIP file, just as if
  461. it had been located at <code>htdocs/manual/ChangeLog.txt</code>.</p>
  462. <pre> &lt;zip destfile=&quot;${dist}/manual.zip&quot;&gt;
  463. &lt;zipfileset dir=&quot;htdocs/manual&quot; prefix=&quot;docs/user-guide&quot;/&gt;
  464. &lt;zipfileset dir=&quot;.&quot; includes=&quot;ChangeLog27.txt&quot; fullpath=&quot;docs/ChangeLog.txt&quot;/&gt;
  465. &lt;zipfileset src=&quot;examples.zip&quot; includes=&quot;**/*.html&quot; prefix=&quot;docs/examples&quot;/&gt;
  466. &lt;/zip&gt;</pre>
  467. <p>zips all files in the <code>htdocs/manual</code> directory into the <code>docs/user-guide</code> directory
  468. in the archive, adds the file <code>ChangeLog27.txt</code> in the
  469. current directory as <code>docs/ChangeLog.txt</code>, and includes all the html files in <code>examples.zip</code>
  470. under <code>docs/examples</code>. The archive might end up containing the files:</p>
  471. <pre> docs/user-guide/html/index.html
  472. docs/ChangeLog.txt
  473. docs/examples/index.html
  474. </pre>
  475. <p>
  476. The code
  477. <pre>
  478. &lt;zip destfile=&quot;${dist}/manual.zip&quot;&gt;
  479. &lt;zipfileset dir=&quot;htdocs/manual&quot; prefix=&quot;docs/user-guide&quot;/&gt;
  480. &lt;zipgroupfileset dir=&quot;.&quot; includes=&quot;examples*.zip&quot;/&gt;
  481. &lt;/zip&gt;
  482. </pre>
  483. <p>
  484. <p>zips all files in the <code>htdocs/manual</code> directory into the <code>docs/user-guide</code> directory in the archive and includes all the files in any file that matches <code>examples*.zip</code>, such as all files within <code>examples1.zip</code> or <code>examples_for_brian.zip</code>.
  485. The same can be achieved with
  486. <pre>
  487. &lt;zip destfile=&quot;${dist}/manual.zip&quot;&gt;
  488. &lt;mappedresources&gt;
  489. &lt;fileset dir=&quot;htdocs/manual&quot;/&gt;
  490. &lt;globmapper from="*" to="docs/user-guide/*"/&gt;
  491. &lt;/mappedresources&gt;
  492. &lt;archives&gt;
  493. &lt;zips&gt;
  494. &lt;fileset dir=&quot;.&quot; includes=&quot;examples*.zip&quot;/&gt;
  495. &lt;/zips&gt;
  496. &lt;/archives&gt;
  497. &lt;/zip&gt;
  498. </pre>
  499. The next example
  500. <pre>
  501. &lt;zip destfile="release.zip"&gt;
  502. &lt;tarfileset src="release.tar"/&gt;
  503. &lt;/zip&gt;
  504. </pre>
  505. <p>re-packages a TAR archive as a ZIP archive. If Unix file
  506. permissions have been stored as part of the TAR file, they will be
  507. retained in the resulting ZIP archive.</p>
  508. </body>
  509. </html>