youys
/
ant

<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>
The Ant team regularly gets complaints that this task in generating invalid
manifests. By and large, this is not the case: we believe that we are following
the specification to the letter. The usual problem is that some third party
manifest reader is not following the same specification as well as they think
they should; we cannot generate invalid manifest files just because one
single application is broken.
</p>  

<p>Manifests are processed according to the 
<a href="http://java.sun.com/j2se/1.5.0/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>
  <tr>
    <td valign="top">encoding</td>
    <td valign="top">The encoding used to read the existing manifest when updating.</td>
    <td valign="top" align="center">No, defaults to UTF-8 encoding.</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 value 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 omitted 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&quot;&gt;
      &lt;attribute name=&quot;Specification-Title&quot; value=&quot;Example&quot;/&gt;
      &lt;attribute name=&quot;Specification-Version&quot; value=&quot;${version}&quot;/&gt;
      &lt;attribute name=&quot;Specification-Vendor&quot; value=&quot;Example Organization&quot;/&gt;
      &lt;attribute name=&quot;Implementation-Title&quot; value=&quot;common&quot;/&gt;
      &lt;attribute name=&quot;Implementation-Version&quot; value=&quot;${version} ${TODAY}&quot;/&gt; 
      &lt;attribute name=&quot;Implementation-Vendor&quot; value=&quot;Example Corp.&quot;/&gt;
    &lt;/section&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
same is true for the ${version} and ${TODAY} properties.  This example
produces a MANIFEST.MF that contains 
<a href="http://java.sun.com/products/jdk/1.2/docs/guide/versioning/index.html">package
version identification</a> for the package <code>common</code>.</p>

<p>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
Specification-Title: Example
Specification-Vendor: Example Organization
Implementation-Vendor: Example Corp.
Specification-Version: 1.1
Implementation-Version: 1.1 February 19 2002
Implementation-Title: common

Name: common/class1.class
Sealed: false

</code></pre>

<hr>
<p align="center">Copyright &copy; 2001-2004 The Apache Software Foundation. All rights
Reserved.</p>
</body>
</html>