ant/docs/manual/CoreTasks/manifest.html
Stefan Bodewig 1eb5ef27e1 improve documentation of manifest task, using Conor's patch that
caught me mid-flight as a basis.

We really should coordinate from time to time 8-)


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@270132 13f79535-47bb-0310-9956-ffa450edef68
2001-12-12 11:05:34 +00:00

109 lines
3.1 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>Manifest Task</title>
</head>
<body>
<h2><a name="manifest">Manifest</a></h2>
<h3>Description</h3>
<p>Creates a manifest file.</p>
<p>This task can be used to write a Manifest file, optionally
replacing or updating an existing file.</p>
<p>Manifests are processed according to the
<a href="http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html">Jar
file specification.</a>. Specifically, a manifest element consists of
a set of attributes and sections. These sections in turn may contain
attributes. Note in particular that this may result in manifest lines
greater than 72 bytes being wrapped and continued on the next
line.</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">file</td>
<td valign="top">the manifest-file to create/update.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">mode</td>
<td valign="top">One of "update" or "replace", default is "replace".</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h3>Nested elements</h3>
<h4><a name="attribute">attribute</h4></h4>
<p>One attribute for the manifest file. Those attributes that are
not nested into a section will be added to the "Main" section.</p>
<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">name</td>
<td valign="top">the name of the attribute.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">value</td>
<td valign="top">the name of the attribute.</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<h4>section</h4>
<p>A manifest section - you can nest <a
href="#attribute">attribute</a> elements into sections.</p>
<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">name</td>
<td valign="top">the name of the section.</td>
<td valign="top" align="center">No, if ommitted it will be assumed
to be the main section.</td>
</tr>
</table>
<h3>Examples</h3>
<pre>
&lt;manifest file=&quot;MANIFEST.MF&quot;&gt;
&lt;attribute name=&quot;Built-By&quot; value=&quot;${user.name}&quot;/&gt;
&lt;section name=&quot;common/class1.class&quot;&gt;
&lt;attribute name=&quot;Sealed&quot; value=&quot;false&quot;/&gt;
&lt;/section&gt;
&lt;/manifest&gt;
</pre>
<p>Creates or replaces the file MANIFEST.MF. Note that the Built-By
attribute will take the value of the Ant property ${user.name}. The
manifest produced by the above would look like this:
</p>
<pre><code>Manifest-Version: 1.0
Built-By: bodewig
Created-By: Apache Ant 1.5alpha
Name: common/class1.class
Sealed: false</code></pre>
</body>
</html>