mirror of
https://github.com/apache/ant.git
synced 2025-05-18 22:14:47 +00:00
b6a3e9df36
(1) Make sure there is a Copyright notice on all visible files. (2) Make sure all years in which the file has been modified are listed. (3) Make sure the format is consistent, i.e. separate consecutive years with a dash, not a comma. When Stephane changed starteam.html it has been 2001 in France but 2002 in Australia - does that mean we add 2002 to the Copyright line or not? ;-) git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@270652 13f79535-47bb-0310-9956-ffa450edef68
131 lines
4.7 KiB
HTML
131 lines
4.7 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
<title>Apache Ant User Manual</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h2><a name="cab">Cab</a></h2>
|
|
<h3>Description</h3>
|
|
<p>The cab task creates Microsoft cab archive files. It is invoked
|
|
similar to the <a href="../CoreTasks/jar.html">jar</a> or <a href="../CoreTasks/zip.html">zip</a> tasks.
|
|
This task will work on Windows using the external cabarc tool (provided by Microsoft)
|
|
which must be located in your executable path.</p>
|
|
<p>To use this task on other platforms you need to download and compile libcabinet from
|
|
<a href="http://trill.cis.fordham.edu/~barbacha/cabinet_library/">
|
|
http://trill.cis.fordham.edu/~barbacha/cabinet_library/</a>.</p>
|
|
<p>See the section on <a href="../dirtasks.html#directorybasedtasks">directory based
|
|
tasks</a>, on how the inclusion/exclusion of files works, and how to
|
|
write patterns.</p>
|
|
<p>This task forms an implicit <a href="../CoreTypes/fileset.html">FileSet</a> and
|
|
supports all attributes of <code><fileset></code>
|
|
(<code>dir</code> becomes <code>basedir</code>) as well as the nested
|
|
<code><include></code>, <code><exclude></code> and
|
|
<code><patternset></code> elements.</p>
|
|
<h3>Parameters</h3>
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td valign="top"><b>Attribute</b></td>
|
|
<td valign="top"><b>Description</b></td>
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">cabfile</td>
|
|
<td valign="top">the name of the cab file to create.</td>
|
|
<td valign="top" align="center">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">basedir</td>
|
|
<td valign="top">the directory to start archiving files from.</td>
|
|
<td valign="top" align="center">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">verbose</td>
|
|
<td valign="top">set to "yes" if you want to see the output from
|
|
the cabarc tool. defaults to "no".</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">compress</td>
|
|
<td valign="top">set to "no" to store files without compressing.
|
|
defaults to "yes".</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">options</td>
|
|
<td valign="top">use to set additional command-line options for
|
|
the cabarc tool. should not normally be necessary.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">includes</td>
|
|
<td valign="top">comma separated list of patterns of files that
|
|
must be included. All files are included when omitted.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">includesfile</td>
|
|
<td valign="top">the name of a file. Each line of this file is
|
|
taken to be an include pattern</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">excludes</td>
|
|
<td valign="top">comma separated list of patterns of files that
|
|
must be excluded. No files (except default excludes) are excluded
|
|
when omitted.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">excludesfile</td>
|
|
<td valign="top">the name of a file. Each line of this file is
|
|
taken to be an exclude pattern</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">defaultexcludes</td>
|
|
<td valign="top">indicates whether default excludes should be used
|
|
or not ("yes"/"no"). Default excludes are used when omitted.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
</table>
|
|
<h3>Examples</h3>
|
|
<blockquote><pre>
|
|
<cab cabfile="${dist}/manual.cab"
|
|
basedir="htdocs/manual"
|
|
/>
|
|
</pre></blockquote>
|
|
<p>cabs all files in the htdocs/manual directory into a file called
|
|
manual.cab in the ${dist} directory.</p>
|
|
<blockquote><pre>
|
|
<cab cabfile="${dist}/manual.cab"
|
|
basedir="htdocs/manual"
|
|
excludes="mydocs/**, **/todo.html"
|
|
/>
|
|
</pre></blockquote>
|
|
<p>cabs all files in the htdocs/manual directory into a file called
|
|
manual.cab in the ${dist} directory. Files in the directory mydocs,
|
|
or files with the name todo.html are excluded.</p>
|
|
<blockquote><pre>
|
|
<cab cabfile="${dist}/manual.cab"
|
|
basedir="htdocs/manual"
|
|
includes="api/**/*.html"
|
|
excludes="**/todo.html"
|
|
verbose="yes"
|
|
/>
|
|
</pre></blockquote>
|
|
<p>Cab all files in the htdocs/manual directory into a file called
|
|
manual.cab in the ${dist} directory. Only html files under the
|
|
directory api are archived, and files with the name todo.html are
|
|
excluded. Output from the cabarc tool is displayed in the build
|
|
output.</p>
|
|
<hr>
|
|
<p align="center">Copyright © 2001 Apache Software Foundation. All rights
|
|
Reserved.</p>
|
|
|
|
</body>
|
|
</html>
|
|
|