You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2018/02/28 07:02:00 UTC
[45/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/changelog.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/changelog.html b/manual/Tasks/changelog.html
index b09e1c0..c2aee22 100644
--- a/manual/Tasks/changelog.html
+++ b/manual/Tasks/changelog.html
@@ -26,242 +26,228 @@
<h2 id="changelog">CvsChangeLog</h2>
<h3>Description</h3>
-<p>Generates an XML-formatted report file of the change logs recorded in a
-<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository.</p>
-<p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get
-an error (such as error <code>2</code> on Windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code>
-from the command line in the target directory in which you are working.
-Also note that this task assumes that the cvs executable is compatible
-with the Unix version, this is not completely true
-for certain other CVS clients - like CVSNT for example - and some
-operation may fail when using such an incompatible client.
-</p>
+<p>Generates an XML-formatted report file of the change logs recorded in
+a <a href="https://www.nongnu.org/cvs/" target="_top">CVS</a> repository.</p>
+<p><strong>Important</strong>: This task needs <code>cvs</code> on the path. If it isn't, you will get
+an error (such as error <code>2</code> on Windows). If <code><cvs></code> doesn't work, try to
+execute <code>cvs.exe</code> from the command line in the target directory in which you are working.
+Also note that this task assumes that the cvs executable is compatible with the Unix version, this
+is not completely true for certain other CVS clients—like CVSNT for example—and some
+operation may fail when using such an incompatible client.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td colspan="3">Attributes from parent Cvs task which are meaningful here<br>
- <em>Since Apache Ant 1.6.1</em></td>
+ <td colspan="3" class="left">Attributes from parent <code><cvs></code> task which are
+ meaningful here<br/><em>Since Apache Ant 1.6.1</em></td>
</tr>
<tr>
- <td valign="top">cvsRoot</td>
- <td valign="top">the <code>CVSROOT</code> variable.</td>
- <td align="center" valign="top">No</td>
+ <td>cvsRoot</td>
+ <td>the <code>CVSROOT</code> variable.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">cvsRsh</td>
- <td valign="top">the <code>CVS_RSH</code> variable.</td>
- <td align="center" valign="top">No</td>
+ <td>cvsRsh</td>
+ <td>the <code>CVS_RSH</code> variable.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">package</td>
- <td valign="top">the package/module to check out. <strong>Note</strong>:
- multiple attributes can be split using spaces. Use a nested
- <module> element if you want to specify a module with
- spaces in its name.</td>
- <td align="center" valign="top">No</td>
+ <td>package</td>
+ <td>the package/module to check out. <strong>Note</strong>: multiple attributes can be split
+ using spaces. Use a nested <code><module></code> element if you want to specify a
+ module with spaces in its name.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">port</td>
- <td valign="top">Port used by CVS to communicate with the server.</td>
- <td align="center" valign="top">No, default port 2401.</td>
+ <td>port</td>
+ <td>Port used by CVS to communicate with the server.</td>
+ <td>No; defaults to <q>2401</q></td>
</tr>
<tr>
- <td valign="top">passfile</td>
- <td valign="top">Password file to read passwords from.</td>
- <td align="center" valign="top">No, default file <code>~/.cvspass</code>.</td>
+ <td>passfile</td>
+ <td>Password file to read passwords from.</td>
+ <td>No; defaults to <q>~/.cvspass</q></td>
</tr>
<tr>
- <td valign="top">failonerror</td>
- <td valign="top">Stop the build process if the command exits with a
- return code other than <code>0</code>. Defaults to false</td>
- <td align="center" valign="top">No</td>
+ <td>failonerror</td>
+ <td>Stop the build process if the command exits with a return code other
+ than <code>0</code></td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">tag</td>
- <td valign="top">query the changelog for a specific branch.</td>
- <td align="center" valign="top">No</td>
+ <td>tag</td>
+ <td>query the changelog for a specific branch.</td>
+ <td>No</td>
</tr>
<tr>
- <td colspan="3">Specific attributes</td>
+ <td colspan="3" class="left">Specific attributes</td>
</tr>
<tr>
- <td valign="top">dir</td>
- <td valign="top">The directory from which to run the CVS <em>log</em>
- command.</td>
- <td align="center" valign="top">No; defaults to ${basedir}.</td>
+ <td>dir</td>
+ <td>The directory from which to run the CVS <em>log</em> command.</td>
+ <td>No; defaults to <q>${basedir}</q></td>
</tr>
<tr>
- <td valign="top">destfile</td>
- <td valign="top">The file in which to write the change log report.</td>
- <td align="center" valign="top">Yes</td>
+ <td>destfile</td>
+ <td>The file in which to write the change log report.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">usersfile</td>
- <td valign="top">Property file that contains name-value pairs mapping
- user IDs and names that should be used in the report in place of
- the user ID.</td>
- <td align="center" valign="top">No</td>
+ <td>usersfile</td>
+ <td>Property file that contains name-value pairs mapping user IDs and names that should be used
+ in the report in place of the user ID.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">daysinpast</td>
- <td valign="top">Sets the number of days into the past for which the
- change log information should be retrieved.</td>
- <td align="center" valign="top">No</td>
+ <td>daysinpast</td>
+ <td>Sets the number of days into the past for which the change log information should be
+ retrieved.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">start</td>
- <td valign="top">The earliest date from which change logs are to be
- included in the report.</td>
- <td align="center" valign="top">No</td>
+ <td>start</td>
+ <td>The earliest date from which change logs are to be included in the report.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">end</td>
- <td valign="top">The latest date to which change logs are to be
- included in the report.</td>
- <td align="center" valign="top">No</td>
+ <td>end</td>
+ <td>The latest date to which change logs are to be included in the report.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">remote</td>
- <td valign="top">If set to true, works against the repository
- (using rlog) without a working copy. Default is
- false. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No</td>
+ <td>remote</td>
+ <td>If set to true, works against the repository (using <code>rlog</code>) without a working
+ copy. <em>Since Ant 1.8.0</em></td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">startTag</td>
- <td valign="top">The start of a tag range. If endTag is also
- specified, they must both be on the same branch. If endTag is not
- specified, the end of the range will be the latest on the same
- branch on which startTag lives. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No</td>
+ <td>startTag</td>
+ <td>The start of a tag range. If <var>endTag</var> is also specified, they must both be on the
+ same branch. If <var>endTag</var> is not specified, the end of the range will be the latest on
+ the same branch on which <var>startTag</var> lives. <em>Since Ant 1.8.0</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">endTag</td>
- <td valign="top">The end of a tag range. If startTag is also
- specified, they must both be on the same branch. If startTag is
- not specified, the start of the range will be the top of the
- branch on which endTag lives. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No</td>
+ <td>endTag</td>
+ <td>The end of a tag range. If <var>startTag</var> is also specified, they must both be on the
+ same branch. If <var>startTag</var> is not specified, the start of the range will be the top
+ of the branch on which <var>endTag</var> lives. <em>Since Ant 1.8.0</em></td>
+ <td>No</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4 id="user">user</h4>
-<p>The nested <code><user></code> element allows you to specify a
-mapping between a user ID as it appears on the CVS server and a name to
-include in the formatted report.
-Anytime the specified user ID has made a change in the repository, the
-<code><author></code> tag in the report file will include
-the name specified in <code>displayname</code> rather than the user ID.
-</p>
+<p>The nested <code><user></code> element allows you to specify a mapping between a user ID as
+it appears on the CVS server and a name to include in the formatted report. Anytime the specified
+user ID has made a change in the repository, the <code><author></code> tag in the report file
+will include the name specified in <var>displayname</var> rather than the user ID.</p>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">displayname</td>
- <td valign="top">The name to be used in the CVS change log report.</td>
- <td valign="top" align="center">Yes</td>
+ <td>displayname</td>
+ <td>The name to be used in the CVS change log report.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">userid</td>
- <td valign="top">The userid of the person as it exists on the CVS server.
+ <td>userid</td>
+ <td>The user ID of the person as it exists on the CVS server.
</td>
- <td valign="top" align="center">Yes</td>
+ <td>Yes</td>
</tr>
</table>
<h4>module</h4>
-<p>Specifies a package/module to work on, unlike the package attribute
- modules specified using this attribute can contain spaces in their
- name.</p>
+<p>Specifies a package/module to work on, unlike the package attribute modules specified using this
+attribute can contain spaces in their name.</p>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">name</td>
- <td valign="top">The module's/package's name.</td>
- <td align="center" valign="top">Yes.</td>
+ <td>name</td>
+ <td>The module's/package's name.</td>
+ <td>Yes</td>
</tr>
</table>
<h3>Examples</h3>
-<pre> <cvschangelog dir="dve/network"
- destfile="changelog.xml"/></pre>
+<pre>
+<cvschangelog dir="dve/network"
+ destfile="changelog.xml"/></pre>
-<p>Generates a change log report for all the changes that have been made
-under the <code>dve/network</code> directory.
-It writes these changes into the file <code>changelog.xml</code>.</p>
+<p>Generates a change log report for all the changes that have been made under
+the <samp>dve/network</samp> directory. It writes these changes into the
+file <samp>changelog.xml</samp>.</p>
-<pre> <cvschangelog dir="dve/network"
- destfile="changelog.xml"
- daysinpast="10"/></pre>
+<pre>
+<cvschangelog dir="dve/network"
+ destfile="changelog.xml"
+ daysinpast="10"/></pre>
-<p>Generates a change log report for any changes that were made
-under the <code>dve/network</code> directory in the past 10 days.
-It writes these changes into the file <code>changelog.xml</code>.</p>
+<p>Generates a change log report for any changes that were made under the <samp>dve/network</samp>
+directory in the past 10 days. It writes these changes into the
+file <samp>changelog.xml</samp>.</p>
-<pre> <cvschangelog dir="dve/network"
- destfile="changelog.xml"
- start="20 Feb 2002"
- end="20 Mar 2002"/></pre>
+<pre>
+<cvschangelog dir="dve/network"
+ destfile="changelog.xml"
+ start="20 Feb 2002"
+ end="20 Mar 2002"/></pre>
-<p>Generates a change log report for any changes that were made
-between February 20, 2002 and March 20, 2002
-under the <code>dve/network</code> directory.
-It writes these changes into the file <code>changelog.xml</code>.</p>
+<p>Generates a change log report for any changes that were made between February 20, 2002 and March
+20, 2002 under the <samp>dve/network</samp> directory. It writes these changes into the
+file <samp>changelog.xml</samp>.</p>
-<pre> <cvschangelog dir="dve/network"
- destfile="changelog.xml"
- start="20 Feb 2002"/></pre>
+<pre>
+<cvschangelog dir="dve/network"
+ destfile="changelog.xml"
+ start="20 Feb 2002"/></pre>
-<p>Generates a change log report for any changes that were made
-after February 20, 2002 under the <code>dve/network</code> directory.
-It writes these changes into the file <code>changelog.xml</code>.</p>
+<p>Generates a change log report for any changes that were made after February 20, 2002 under
+the <samp>dve/network</samp> directory. It writes these changes into the
+file <samp>changelog.xml</samp>.</p>
-<pre> <cvschangelog dir="dve/network"
- destfile="changelog.xml">
- <user displayname="Peter Donald" userid="donaldp"/>
- </cvschangelog></pre>
+<pre>
+<cvschangelog dir="dve/network"
+ destfile="changelog.xml">
+ <user displayname="Peter Donald" userid="donaldp"/>
+</cvschangelog></pre>
-<p>Generates a change log report for all the changes that were made
-under the <code>dve/network</code> directory, substituting the name
-"Peter Donald" in the <code><author></code> tags
-anytime it encounters a change made by the user ID "donaldp".
-It writes these changes into the file <code>changelog.xml</code>.</p>
+<p>Generates a change log report for all the changes that were made under
+the <code>dve/network</code> directory, substituting the name <samp>Peter Donald</samp> in
+the <code><author></code> tags anytime it encounters a change made by the user
+ID <samp>donaldp</samp>. It writes these changes into the file <samp>changelog.xml</samp>.</p>
<p>Generates a change log report on the <code>ANT_16_BRANCH</code>.</p>
<pre>
- <cvschangelog dir="c:/dev/asf/ant.head" passfile="c:/home/myself/.cvspass"
- destfile="changelogant.xml" tag="ANT_16_BRANCH"/>
-</pre>
+<cvschangelog dir="c:/dev/asf/ant.head" passfile="c:/home/myself/.cvspass"
+ destfile="changelogant.xml" tag="ANT_16_BRANCH"/></pre>
<h4>Generate Report</h4>
-<p>Ant includes a basic XSLT stylesheet that you can use to generate
-a HTML report based on the xml output. The following example illustrates
-how to generate a HTML report from the XML report.</p>
+<p>Ant includes a basic XSLT stylesheet that you can use to generate a HTML report based on the xml
+output. The following example illustrates how to generate a HTML report from the XML report.</p>
<pre>
- <style in="changelog.xml"
- out="changelog.html"
- style="${ant.home}/etc/changelog.xsl">
- <param name="title" expression="Ant ChangeLog"/>
- <param name="module" expression="ant"/>
- <param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/>
- </style>
-</pre>
+<style in="changelog.xml"
+ out="changelog.html"
+ style="${ant.home}/etc/changelog.xsl">
+ <param name="title" expression="Ant ChangeLog"/>
+ <param name="module" expression="ant"/>
+ <param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/>
+</style></pre>
<h4>Sample Output</h4>
<pre>
@@ -279,8 +265,7 @@ how to generate a HTML report from the XML report.</p>
This allows templates to be stored inside jar]]></msg>
</entry>
-</changelog>
-</pre>
+</changelog></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/checksum.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/checksum.html b/manual/Tasks/checksum.html
index cf7bb87..8e63c34 100644
--- a/manual/Tasks/checksum.html
+++ b/manual/Tasks/checksum.html
@@ -26,110 +26,92 @@
<h2 id="checksum">Checksum</h2>
<h3>Description</h3>
-<p>
-Generates checksum for files. This task can also be used to
-perform checksum verifications.
-</p>
-
-<p>Note that many popular message digest functions - including MD5 and
-SHA-1 - have been broken recently. If you are going to use the task
-to create checksums used in an environment where security is
-important, please take some time to investigate the algorithms offered
-by your JCE provider. Note also that some JCE providers like the one
-by <a href="http://www.bouncycastle.org/">The Legion of the Bouncy
-Castle</a>, the <a href="http://www.gnu.org/software/gnu-crypto/">GNU
-project</a> or <a
-href="http://jce.iaik.tugraz.at/products/01_jce/index.php">the
-Technical University Graz</a> offer more digest algorithms than those
-built-in into your JDK.</p>
-
-<p>
-Warning: the case of the extension is that of the algorithm used.
-If you ask for "SHA1", you get a .SHA1 extension; if you ask for "sha1", you
-get a file ending in .sha1. The Java Crypto Engines are case-insensitive
-in matching algorithms, so choose a name to match your desired output extension,
-or set the <tt>fileext</tt> attribute. The names of common hashing algorithms can be located on the
-<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest">Cryptography Architecture Standard Algorithm Name Documentation</a>
-</p>
+<p>Generates checksum for files. This task can also be used to perform checksum verifications.</p>
+
+<p>Note that many popular message digest functions—including MD5 and SHA-1—have been
+broken recently. If you are going to use the task to create checksums used in an environment where
+security is important, please take some time to investigate the algorithms offered by your JCE
+provider. Note also that some JCE providers like the one
+by <a href="https://www.bouncycastle.org/">The Legion of the Bouncy Castle</a>,
+the <a href="https://www.gnu.org/software/gnu-crypto/">GNU project</a>
+or <a href="https://jce.iaik.tugraz.at/sic/Products">the Technical University Graz</a> offer more
+digest algorithms than those built-in into your JDK.</p>
+
+<p>Warning: the case of the extension is that of the algorithm used. If you ask
+for <samp>SHA1</samp>, you get a <samp>.SHA1</samp> extension; if you ask for <samp>sha1</samp>, you
+get a file ending in <samp>.sha1</samp>. The Java Crypto Engines are case-insensitive in matching
+algorithms, so choose a name to match your desired output extension, or set the <var>fileext</var>
+attribute. The names of common hashing algorithms can be located on the <a target="_blank"
+href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#MessageDigest">Cryptography
+Architecture Standard Algorithm Name Documentation</a></p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">The file to generate checksum for.</td>
- <td valign="top" align="center">Yes, unless
- at least one nested (filesystem-only) resource collection is specified.</td>
+ <td>file</td>
+ <td>The file to generate checksum for.</td>
+ <td>Yes, unless at least one nested (filesystem-only) resource collection is specified.</td>
</tr>
<tr>
- <td valign="top">todir</td>
- <td valign="top">The root directory where checksums should be written.</td>
- <td valign="top" align="center">No. If not specified, checksum files
- will be written to the same directory as the files themselves.
- <em>since Apache Ant 1.6</em>
+ <td>todir</td>
+ <td>The root directory where checksums should be written.</td>
+ <td>No. If not specified, checksum files will be written to the same directory as the files
+ themselves. <em>since Apache Ant 1.6</em>
</td>
</tr>
<tr>
- <td valign="top">algorithm</td>
- <td valign="top">Specifies the algorithm to be used to
- compute the checksum. Defaults to "MD5".
- Other <a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest">popular algorithms</a> like "SHA" or "SHA-512" may be used
- as well.
+ <td>algorithm</td>
+ <td>Specifies the algorithm to be used to compute the checksum. Please check the
+ <a target="_blank"
+ href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#MessageDigest">documentation</a>
+ for available algorithm names, like <q>SHA-1</q> or <q>SHA-512</q>.
</td>
- <td valign="top" align="center">No</td>
+ <td>No; defaults to <q>MD5</q></td>
</tr>
<tr>
- <td valign="top">provider</td>
- <td valign="top">Specifies the provider of the algorithm.</td>
- <td valign="top" align="center">No</td>
+ <td>provider</td>
+ <td>Specifies the provider of the algorithm.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">fileext</td>
- <td valign="top">The generated checksum file's name will be the
- original filename with the fileext added to it.
- Defaults to a "." and the algorithm name being used.
+ <td>fileext</td>
+ <td>The generated checksum file's name will be the original filename with the <var>fileext</var>
+ added to it.
</td>
- <td valign="top" align="center">No</td>
+ <td>No; defaults to a <q>.</q> and the algorithm name being used</td>
</tr>
<tr>
- <td valign="top">property</td>
- <td valign="top">This attribute can mean two different things, it
- depends on the presence of the verifyproperty attribute.<br>
- <b>If you don't set the verifyproperty attribute</b>, property
- specifies the name of the property to be set with the generated
- checksum value.<br>
- <b>If you set the verifyproperty attribute</b>, property specifies
- the checksum you expect to be generated (the checksum itself, not
- a name of a property containing the checksum).<br>
- This cannot be specified when fileext is being used or when the
- number of files for which checksums is to be generated is greater
- than 1.
+ <td>property</td>
+ <td>This attribute can mean two different things, it depends on the presence of
+ the <var>verifyproperty</var> attribute.<br/><strong>If you don't set</strong>
+ the <var>verifyproperty</var> attribute, property specifies the name of the property to be set
+ with the generated checksum value.<br/><strong>If you set</strong>
+ the <var>verifyproperty</var> attribute, property specifies the checksum you expect to be
+ generated (the checksum itself, not a name of a property containing the checksum).<br> This
+ cannot be specified when <var>fileext</var> is being used or when the number of files for
+ which checksums are to be generated is greater than 1.
</td>
- <td valign="top" align="center">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">pattern</td>
- <td valign="top">Specifies the pattern to use as a pattern
- suitable
- for <a href="http://download.oracle.com/javase/6/docs/api/java/text/MessageFormat.html">MessageFormat</a>
- where <code>{0}</code> is replaced with the checksum and
- <code>{1}</code> with the file name. <em>Since Ant
- 1.7.0</em><br/>
- <em>Since Ant 1.8.2</em> <code>{2}</code> is replaced by
- the path of the file relative to the checksum file being
- written, <code>{3}</code> with tha path of the file relative to
- the project's basedir and <code>{4}</code> with the absolute
- path of the file.</td>
- <td valign="top" align="center">No - default is "{0}".</td>
+ <td>pattern</td>
+ <td>Specifies the pattern to use as a pattern suitable
+ for <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html">MessageFormat</a>
+ where <code>{0}</code> is replaced with the checksum and <code>{1}</code> with the file
+ name. <em>Since Ant 1.7.0</em><br/><em>Since Ant 1.8.2</em> <code>{2}</code> is replaced by the
+ path of the file relative to the checksum file being written, <code>{3}</code> with tha path of
+ the file relative to the project's <var>basedir</var> and <code>{4}</code> with the absolute
+ path of the file.</td>
+ <td>No; default is <q>{0}</q></td>
</tr>
<tr>
- <td valign="top">format</td>
- <td valign="top">Specifies the pattern to use as one of a
- well-known format. Supported values are
+ <td>format</td>
+ <td>Specifies the pattern to use as one of a well-known format. Supported values are
<table>
<tr>
<th>name</th>
@@ -138,111 +120,103 @@ or set the <tt>fileext</tt> attribute. The names of common hashing algorithms ca
</tr>
<tr>
<td>CHECKSUM</td>
- <td><tt>{0}</tt></td>
+ <td><code>{0}</code></td>
<td>only the checksum itself</td>
</tr>
<tr>
<td>MD5SUM</td>
- <td><tt>{0} *{1}</tt></td>
- <td>the format of GNU textutils md5sum</td>
+ <td><code>{0} *{1}</code></td>
+ <td>the format of GNU textutils <code>md5sum</code></td>
</tr>
<tr>
<td>SVF</td>
- <td><tt>MD5 ({1}) = {0}</tt></td>
- <td>the format of BSDs md5 command</td>
+ <td><code>MD5 ({1}) = {0}</code></td>
+ <td>the format of BSD <code>md5</code> command</td>
</tr>
</table>
- <em>Since Ant 1.7.0</em>
- </td>
- <td valign="top" align="center">No - default is "CHECKSUM".</td>
+ <em>Since Ant 1.7.0</em></td>
+ <td>No; default is <q>CHECKSUM</q></td>
</tr>
<tr>
- <td valign="top">totalproperty</td>
- <td valign="top">If specified, this attribute specifies the name of
- the property that will hold a checksum of all the checksums and
- file paths. The individual checksums and the relative paths to the files
- within the resource collections in which they are defined will be used to
- compute this checksum. (The file separators in the paths will be
- converted to '/' before computation to ensure platform portability).
- <em>since Ant 1.6</em>
- </td>
- <td valign="top" align="center">No</td>
+ <td>totalproperty</td>
+ <td>If specified, this attribute specifies the name of the property that will hold a checksum of
+ all the checksums and file paths. The individual checksums and the relative paths to the files
+ within the resource collections in which they are defined will be used to compute this
+ checksum. (The file separators in the paths will be converted to <q>/</q> before computation
+ to ensure platform portability). <em>since Ant 1.6</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">forceoverwrite</td>
- <td valign="top">Overwrite existing files even if the destination
- files are newer. Defaults to "no".</td>
- <td valign="top" align="center">No</td>
+ <td>forceoverwrite</td>
+ <td>Overwrite existing files even if the destination files are newer.</td>
+ <td>No; defaults to <q>no</q></td>
</tr>
<tr>
- <td valign="top">verifyproperty</td>
- <td valign="top">Specifies the name of the property to be set
- with "true" or "false" depending upon whether
- the generated checksum matches the existing checksum. When
- this is set, the generated checksum is not written to a file or
- property, but rather, the content of the file or property is used to
- check against the generated checksum.
- <td valign="top" align="center">No</td>
+ <td>verifyproperty</td>
+ <td>Specifies the name of the property to be set with <q>true</q> or <q>false</q> depending upon
+ whether the generated checksum matches the existing checksum. When this is set, the generated
+ checksum is not written to a file or property, but rather, the content of the file or property
+ is used to check against the generated checksum.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">readbuffersize</td>
- <td valign="top">The size of the buffer (in bytes) to use when
- reading a file. Defaults to "8192" - you may get a
- better performance on big files if you increase this value.</td>
- <td valign="top" align="center">No</td>
+ <td>readbuffersize</td>
+ <td>The size of the buffer (in bytes) to use when reading a file.</td>
+ <td>No; defaults to <q>8192</q>—you may get a better performance on big files if you
+ increase this value</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>resource collection</h4>
- <p>
- <a href="../Types/resources.html#collection">Resource collections</a> are
- used to select files for which checksums should be generated.
- </p>
+<p><a href="../Types/resources.html#collection">Resource collections</a> are used to select files
+for which checksums should be generated.</p>
<h3>Examples</h3>
-<p><b>Example 1</b></p>
+<p><strong>Example 1</strong></p>
<pre><checksum file="foo.bar"/></pre>
-Generates a MD5 checksum for foo.bar and stores the checksum in the destination file
-foo.bar.MD5. foo.bar.MD5 is overwritten only if foo.bar is newer than itself.
+<p>Generates a MD5 checksum for <samp>foo.bar</samp> and stores the checksum in the destination
+file <samp>foo.bar.MD5</samp>. <samp>foo.bar.MD5</samp> is overwritten only if <samp>foo.bar</samp>
+is newer than itself.</p>
-<p><b>Example 2</b></p>
+<p><strong>Example 2</strong></p>
<pre><checksum file="foo.bar" forceOverwrite="yes"/></pre>
-Generates a MD5 checksum for foo.bar and stores the checksum in foo.bar.MD5.
-If foo.bar.MD5 already exists, it is overwritten.
+<p>Generates a MD5 checksum for <samp>foo.bar</samp> and stores the checksum
+in <samp>foo.bar.MD5</samp>. If <samp>foo.bar.MD5</samp> already exists, it is overwritten.</p>
-<p><b>Example 3</b></p>
+<p><strong>Example 3</strong></p>
<pre><checksum file="foo.bar" property="foobarMD5"/></pre>
-Generates a MD5 checksum for foo.bar and stores it in the Project Property foobarMD5.
+<p>Generates a MD5 checksum for <samp>foo.bar</samp> and stores it in the project
+property <code>foobarMD5</code>.</p>
-<p><b>Example 4</b></p>
+<p><strong>Example 4</strong></p>
<pre><checksum file="foo.bar" verifyProperty="isMD5ok"/></pre>
-Generates a MD5 checksum for foo.bar, compares it against foo.bar.MD5 and sets
-isMD5ok to either true or false, depending upon the result.
+<p>Generates a MD5 checksum for <samp>foo.bar</samp>, compares it against <samp>foo.bar.MD5</samp>
+and sets <code>isMD5ok</code> to either <q>true</q> or <q>false</q>, depending upon the result.</p>
-<p><b>Example 5</b></p>
+<p><strong>Example 5</strong></p>
<pre><checksum file="foo.bar" algorithm="SHA-512" fileext="asc"/></pre>
-Generates a SHA-512 checksum for foo.bar and stores the checksum in the destination file
-foo.bar.asc. foo.bar.asc is overwritten only if foo.bar is newer than itself.
+<p>Generates a SHA-512 checksum for <samp>foo.bar</samp> and stores the checksum in the destination
+file <samp>foo.bar.asc</samp>. <samp>foo.bar.asc</samp> is overwritten only if <samp>foo.bar</samp>
+is newer than itself.</p>
-<p><b>Example 6</b></p>
-<pre>
-<checksum file="foo.bar" property="${md5}" verifyProperty="isEqual"/>
-</pre>
-Generates a MD5 checksum for foo.bar, compares it against the value of the property
-md5, and sets isEqual to either true or false, depending upon the result.
+<p><strong>Example 6</strong></p>
+<pre><checksum file="foo.bar" property="${md5}" verifyProperty="isEqual"/></pre>
+<p>Generates a MD5 checksum for <samp>foo.bar</samp>, compares it against the value of the
+property <code>md5</code>, and sets <code>isEqual</code> to either <q>true</q> or <q>false</q>,
+depending upon the result.</p>
-<p><b>Example 7</b></p>
+<p><strong>Example 7</strong></p>
<pre>
<checksum>
<fileset dir=".">
<include name="foo*"/>
</fileset>
-</checksum>
-</pre>
-Works just like Example 1, but generates a .MD5 file for every file that begins with the name foo.
+</checksum></pre>
+<p>Works just like Example 1, but generates a <samp>.MD5</samp> file for every file that begins with
+the name <samp>foo</samp>.</p>
-<p><b>Example 8</b></p>
+<p><strong>Example 8</strong></p>
<pre>
<condition property="isChecksumEqual">
<checksum>
@@ -250,16 +224,14 @@ Works just like Example 1, but generates a .MD5 file for every file that begins
<include name="foo.bar"/>
</fileset>
</checksum>
-</condition>
-</pre>
-Works like Example 4, but only sets isChecksumEqual to true, if the
-checksum matches - it will never be set to false. This example
-demonstrates use with the Condition task.
-
-<h3>Note:</h3>
-When working with more than one file, if condition and/or verifyproperty is used,
-the result will be true only if the checksums matched correctly for all files being
-considered.
+</condition></pre>
+<p>Works like Example 4, but only sets <code>isChecksumEqual</code> to <q>true</q>, if the checksum
+matches—it will never be set to <q>false</q>. This example demonstrates use with
+the <code>condition</code> task.</p>
+
+<h3>Note</h3>
+<p>When working with more than one file, if condition and/or <var>verifyproperty</var> is used, the
+result will be true only if the checksums matched correctly for all files being considered.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/chgrp.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/chgrp.html b/manual/Tasks/chgrp.html
index fecc783..6fdcd59 100644
--- a/manual/Tasks/chgrp.html
+++ b/manual/Tasks/chgrp.html
@@ -28,120 +28,100 @@
<p><em>Since Apache Ant 1.6</em>.</p>
<h3>Description</h3>
-<p>Changes the group of a file or all files inside specified
-directories. Right now it has effect only under Unix. The group
-attribute is equivalent to the corresponding argument for the chgrp
-command.</p>
-
-<p><a href="../Types/fileset.html">FileSet</a>s,
-<a href="../Types/dirset.html">DirSet</a>s or <a
-href="../Types/filelist.html">FileList</a>s can be specified using
-nested <code><fileset></code>, <code><dirset></code> and
-<code><filelist></code> elements.</p>
-
-<p><em>Since Ant 1.7</em>, this task supports arbitrary <a
-href="../Types/resources.html#collection">Resource Collection</a>s
-as nested elements.</p>
-
-<p>By default this task will use a single invocation of the underlying
-chgrp command. If you are working on a large number of files this may
-result in a command line that is too long for your operating system.
-If you encounter such problems, you should set the maxparallel
-attribute of this task to a non-zero value. The number to use highly
-depends on the length of your file names (the depth of your directory
-tree) and your operating system, so you'll have to experiment a
-little. POSIX recommends command line length limits of at least 4096
-characters, this may give you an approximation for the number you
-could use as initial value for these experiments.</p>
-
-<p>By default this task won't do anything unless it detects it is
- running on a Unix system. If you know for sure that you have a
- "chgrp" executable on your PATH that is command line compatible with
- the Unix command, you can use the task's os attribute and set its
- value to your current os.</p>
+<p>Changes the group of a file or all files inside specified directories. Right now it has effect
+only under Unix. The group attribute is equivalent to the corresponding argument for
+the <code>chgrp</code> command.</p>
+
+<p><a href="../Types/fileset.html">FileSet</a>s, <a href="../Types/dirset.html">DirSet</a>s
+or <a href="../Types/filelist.html">FileList</a>s can be specified using
+nested <code><fileset></code>, <code><dirset></code> and <code><filelist></code>
+elements.</p>
+
+<p><em>Since Ant 1.7</em>, this task supports
+arbitrary <a href="../Types/resources.html#collection">Resource Collection</a>s as nested
+elements.</p>
+
+<p>By default this task will use a single invocation of the underlying <code>chgrp</code> command.
+If you are working on a large number of files this may result in a command line that is too long for
+your operating system. If you encounter such problems, you should set the <var>maxparallel</var>
+attribute of this task to a non-zero value. The number to use highly depends on the length of your
+file names (the depth of your directory tree) and your operating system, so you'll have to
+experiment a little. POSIX recommends command line length limits of at least 4096 characters, this
+may give you an approximation for the number you could use as initial value for these
+experiments.</p>
+
+<p>By default this task won't do anything unless it detects it is running on a Unix system. If you
+know for sure that you have a <code>chgrp</code> executable on your <code>PATH</code> that is
+command line compatible with the Unix command, you can use the task's <var>os</var> attribute and
+set its value to your current OS.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top" align="center"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">the file or directory of which the group must be
- changed.</td>
- <td valign="top" align="center">Yes, unless nested
- <code><fileset|filelist|dirset></code>
- elements are specified</td>
+ <td>file</td>
+ <td>the file or directory of which the group must be changed.</td>
+ <td>Yes, unless nested <code><fileset|filelist|dirset></code> elements are specified</td>
</tr>
<tr>
- <td valign="top">group</td>
- <td valign="top">the new group.</td>
- <td valign="top" align="center">Yes</td>
+ <td>group</td>
+ <td>the new group.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">parallel</td>
- <td valign="top">process all specified files using a single
- <code>chgrp</code> command. Defaults to true.</td>
- <td valign="top" align="center">No</td>
+ <td>parallel</td>
+ <td>process all specified files using a single <code>chgrp</code> command.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">type</td>
- <td valign="top">One of <i>file</i>, <i>dir</i> or
- <i>both</i>. If set to <i>file</i>, only the group of
- plain files are going to be changed. If set to <i>dir</i>, only
- the directories are considered.<br>
- <strong>Note</strong>: The type attribute does not apply to
- nested <i>dirset</i>s - <i>dirset</i>s always implicitly
- assume type to be <i>dir</i>.</td>
- <td align="center" valign="top">No, default is <i>file</i></td>
+ <td>type</td>
+ <td>One of <q>file</q>, <q>dir</q> or <q>both</q>. If set to <q>file</q>, only the group of
+ plain files are going to be changed. If set to <q>dir</q>, only the directories are
+ considered.<br/><strong>Note</strong>: The type attribute does not apply to
+ nested <code>dirset</code>s—<code>dirset</code>s always implicitly assume type to
+ be <q>dir</q>.</td>
+ <td>No; default is <q>file</q></td>
</tr>
<tr>
- <td valign="top">maxparallel</td>
- <td valign="top">Limit the amount of parallelism by passing at
- most this many sourcefiles at once. Set it to <= 0 for
- unlimited. Defaults to unlimited.</td>
- <td align="center" valign="top">No</td>
-
+ <td>maxparallel</td>
+ <td>Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to
+ negative integer for unlimited.</td>
+ <td>No; defaults to unlimited</td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">Whether to print a summary after execution or not.
- Defaults to <code>false</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>verbose</td>
+ <td>Whether to print a summary after execution or not.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">os</td>
- <td valign="top">list of Operating Systems on which the command may be
- executed.</td>
- <td align="center" valign="top">No</td>
+ <td>os</td>
+ <td>list of Operating Systems on which the command may be executed.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">osfamily</td>
- <td valign="top">OS family as used in
- the <a href="../Tasks/conditions.html#os"><os></a>
+ <td>osfamily</td>
+ <td>OS family as used in the <a href="../Tasks/conditions.html#os"><os></a>
condition.</td>
- <td align="center" valign="top">No - defaults to "unix"</td>
+ <td>No; defaults to <q>unix</q></td>
</tr>
-
</table>
<h3>Examples</h3>
-<pre>
-<chgrp file="${dist}/start.sh" group="coders"/>
-</pre>
+<pre><chgrp file="${dist}/start.sh" group="coders"/></pre>
-<p>makes the "start.sh" file belong to the coders group on a
-UNIX system.</p>
+<p>makes the <samp>start.sh</samp> file belong to the <samp>coders</samp> group on a UNIX
+system.</p>
<pre>
<chgrp group="coders">
<fileset dir="${dist}/bin" includes="**/*.sh"/>
-</chgrp>
-</pre>
+</chgrp></pre>
-<p>makes all ".sh" files below <code>${dist}/bin</code>
-belong to the coders group on a UNIX system.</p>
+<p>makes all <samp>.sh</samp> files below <samp>${dist}/bin</samp> belong to the <samp>coders</samp>
+group on a UNIX system.</p>
<pre>
<chgrp group="coders">
@@ -152,13 +132,11 @@ belong to the coders group on a UNIX system.</p>
</chgrp>
</pre>
-<p>makes all files below <code>shared/sources1</code> (except those
-below any directory named trial) belong to the coders group on a UNIX
-system. In addition all files belonging to a FileSet
-with <code>id</code> <code>other.shared.sources</code> get the same
+<p>makes all files below <samp>shared/sources1</samp> (except those below any directory
+named <samp>trial</samp>) belong to the <samp>coders</samp> group on a UNIX system. In addition all
+files belonging to a FileSet with <var>id</var> <samp>other.shared.sources</samp> get the same
group.</p>
-
<pre>
<chgrp group="webdev" type="file">
<fileset dir="/web">
@@ -168,13 +146,12 @@ group.</p>
<dirset dir="/web">
<include name="**/test_*"/>
</dirset>
-</chmod>
-</pre>
+</chmod></pre>
-<p>makes all <code>.test.jsp</code>, and <code>.new</code> files belong to
-group webdev. Directories beginning with <code>test_</code> also will belong
-to webdev, but if there is a directory that ends in <code>.new</code> or a file
-that begins with <code>test_</code> it will be unaffected.</p>
+<p>makes all <samp>.test.jsp</samp>, and <samp>.new</samp> files belong to
+group <samp>webdev</samp>. Directories with names beginning with <samp>test_</samp> also will belong
+to <samp>webdev</samp>, but if there is a directory name that ends in <samp>.new</samp> or a file
+name that begins with <samp>test_</samp> it will be unaffected.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/chmod.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/chmod.html b/manual/Tasks/chmod.html
index c1c0f11..b983f26 100644
--- a/manual/Tasks/chmod.html
+++ b/manual/Tasks/chmod.html
@@ -26,151 +26,129 @@
<h2 id="chmod">Chmod</h2>
<h3>Description</h3>
-<p>Changes the permissions of a file or all files inside specified
-directories. Right now it has effect only under Unix or NonStop Kernel (Tandem).
-The permissions are also UNIX style, like the argument for the chmod command.</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 holds an implicit <a
-href="../Types/fileset.html">FileSet</a> and supports all of
-FileSet's attributes and nested elements directly. More sets can be
-specified using nested <code><fileset></code> or
-<code><dirset></code> (<em>since Apache Ant 1.6</em>) elements.</p>
-
-<p><em>Since Ant 1.6</em>, this task also supports nested <a
-href="../Types/filelist.html">filelist</a>s.</p>
-
-<p><em>Since Ant 1.7</em>, this task supports arbitrary <a
-href="../Types/resources.html#collection">Resource Collection</a>s
-as nested elements.</p>
-
-<p>By default this task will use a single invocation of the underlying
-chmod command. If you are working on a large number of files this may
-result in a command line that is too long for your operating system.
-If you encounter such problems, you should set the maxparallel
-attribute of this task to a non-zero value. The number to use highly
-depends on the length of your file names (the depth of your directory
-tree) and your operating system, so you'll have to experiment a
-little. POSIX recommends command line length limits of at least 4096
-characters, this may give you an approximation for the number you
-could use as initial value for these experiments.</p>
-
-<p>By default this task won't do anything unless it detects it is
- running on a Unix system. If you know for sure that you have a
- "chmod" executable on your PATH that is command line compatible with
- the Unix command, you can use the task's os attribute and set its
- value to your current os.</p>
-
-<p>See the <a href="setpermissions.html">setpermissions</a> task for a
- platform independent alternative.</p>
+<p>Changes the permissions of a file or all files inside specified directories. Right now it has
+effect only under Unix or NonStop Kernel (Tandem). The permissions are also UNIX style, like the
+argument for the <code>chmod</code> command.</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 holds an implicit <a href="../Types/fileset.html">FileSet</a> and supports all of
+FileSet's attributes and nested elements directly. More sets can be specified using
+nested <code><fileset></code> or <code><dirset></code> (<em>since Apache Ant 1.6</em>)
+elements.</p>
+
+<p><em>Since Ant 1.6</em>, this task also supports
+nested <a href="../Types/filelist.html">filelist</a>s.</p>
+
+<p><em>Since Ant 1.7</em>, this task supports
+arbitrary <a href="../Types/resources.html#collection">Resource Collection</a>s as nested
+elements.</p>
+
+<p>By default this task will use a single invocation of the underlying <code>chmod</code> command.
+If you are working on a large number of files this may result in a command line that is too long for
+your operating system. If you encounter such problems, you should set the <var>maxparallel</var>
+attribute of this task to a non-zero value. The number to use highly depends on the length of your
+file names (the depth of your directory tree) and your operating system, so you'll have to
+experiment a little. POSIX recommends command line length limits of at least 4096 characters, this
+may give you an approximation for the number you could use as initial value for these
+experiments.</p>
+
+<p>By default this task won't do anything unless it detects it is running on a Unix system. If you
+know for sure that you have a <code>chmod</code> executable on your <code>PATH</code> that is
+command line compatible with the Unix command, you can use the task's <var>os</var> attribute and
+set its value to your current OS.</p>
+
+<p>See the <a href="setpermissions.html">setpermissions</a> task for a platform independent
+alternative.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top" align="center"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">the file or single directory of which the permissions
- must be changed.</td>
- <td valign="top" align="center" rowspan="2">Exactly one of the two, or nested <code><fileset/list></code>s</td>
+ <td>file</td>
+ <td>the file or single directory of which the permissions must be changed.</td>
+ <td rowspan="2">Exactly one of the two, or nested <code><fileset/list></code>s</td>
</tr>
<tr>
- <td valign="top">dir</td>
- <td valign="top">the directory which holds the files whose permissions
- must be changed.<br/>
- <strong>Note</strong>: for backwards compatibility
- reasons <code><chmod dir="some-dir"/></code> will
- only change the permissions on "some-dir" but not recurse into
- it, unless you also specify any patterns.</td>
+ <td>dir</td>
+ <td class="left">the directory which holds the files whose permissions must be
+ changed.<br/><strong>Note</strong>: for backwards compatibility reasons <code><chmod
+ dir="some-dir"/></code> will only change the permissions on <samp>some-dir</samp> but not
+ recurse into it, unless you also specify any patterns.</td>
</tr>
<tr>
- <td valign="top">perm</td>
- <td valign="top">the new permissions.</td>
- <td valign="top" align="center">Yes</td>
+ <td>perm</td>
+ <td>the new permissions.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">includes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- included.</td>
- <td valign="top" align="center">No</td>
+ <td>includes</td>
+ <td>comma- or space-separated list of patterns of files that must be included.</td>
+ <td>No; defaults to all (<q>**</q>)</td>
</tr>
<tr>
- <td valign="top">excludes</td>
- <td valign="top">comma- or space-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>
+ <td>excludes</td>
+ <td>comma- or space-separated list of patterns of files that must be excluded.</td>
+ <td>No; defaults to default excludes or none if <var>defaultexcludes</var> is <q>no</q></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>
+ <td>defaultexcludes</td>
+ <td>indicates whether default excludes should be used or not (<q>yes|no</q>).</td>
+ <td>No; defaults to <q>yes</q></td>
</tr>
<tr>
- <td valign="top">parallel</td>
- <td valign="top">process all specified files using a single
- <code>chmod</code> command. Defaults to true.</td>
- <td valign="top" align="center">No</td>
+ <td>parallel</td>
+ <td>process all specified files using a single <code>chmod</code> command.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">type</td>
- <td valign="top">One of <i>file</i>, <i>dir</i> or
- <i>both</i>. If set to <i>file</i>, only the permissions of
- plain files are going to be changed. If set to <i>dir</i>, only
- the directories are considered.<br>
- <strong>Note</strong>: The type attribute does not apply to
- nested <i>dirset</i>s - <i>dirset</i>s always implicitly
- assume type to be <i>dir</i>.</td>
- <td align="center" valign="top">No, default is <i>file</i></td>
+ <td>type</td>
+ <td>One of <q>file</q>, <q>dir</q> or <q>both</q>. If set to <q>file</q>, only the permissions
+ of plain files are going to be changed. If set to <q>dir</q>, only the directories are
+ considered.<br/><strong>Note</strong>: The type attribute does not apply to
+ nested <code>dirset</code>s—<code>dirset</code>s always implicitly assume type to
+ be <q>dir</q>.</td>
+ <td>No; default is <q>file</q></td>
</tr>
<tr>
- <td valign="top">maxparallel</td>
- <td valign="top">Limit the amount of parallelism by passing at
- most this many sourcefiles at once. Set it to <= 0 for
- unlimited. Defaults to unlimited. <em>Since Ant 1.6</em>.</td>
- <td align="center" valign="top">No</td>
+ <td>maxparallel</td>
+ <td>Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to
+ negative integer for unlimited. <em>Since Ant 1.6</em>.</td>
+ <td>No; defaults to unlimited</td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">Whether to print a summary after execution or not.
- Defaults to <code>false</code>. <em>Since Ant 1.6</em>.</td>
- <td align="center" valign="top">No</td>
+ <td>verbose</td>
+ <td>Whether to print a summary after execution or not. <em>Since Ant 1.6</em>.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">os</td>
- <td valign="top">list of Operating Systems on which the command may be
- executed.</td>
- <td align="center" valign="top">No</td>
+ <td>os</td>
+ <td>list of Operating Systems on which the command may be executed.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">osfamily</td>
- <td valign="top">OS family as used in
- the <a href="conditions.html#os"><os></a> condition.</td>
- <td align="center" valign="top">No - defaults to "unix"</td>
+ <td>osfamily</td>
+ <td>OS family as used in the <a href="conditions.html#os"><os></a> condition.</td>
+ <td>No; defaults to <q>unix</q></td>
</tr>
</table>
<h3>Examples</h3>
- <pre>
-<chmod file="${dist}/start.sh" perm="ugo+rx"/>
-</pre>
-<p>makes the "start.sh" file readable and executable for anyone on a
-UNIX system.</p>
-<pre>
-<chmod file="${dist}/start.sh" perm="700"/>
-</pre>
-<p>makes the "start.sh" file readable, writable and executable only for the owner on a
+<pre><chmod file="${dist}/start.sh" perm="ugo+rx"/></pre>
+<p>makes the <samp>start.sh</samp> file readable and executable for anyone on a UNIX system.</p>
+
+<pre><chmod file="${dist}/start.sh" perm="700"/></pre>
+<p>makes the <samp>start.sh</samp> file readable, writable and executable only for the owner on a
UNIX system.</p>
+
<pre>
<chmod dir="${dist}/bin" perm="ugo+rx"
- includes="**/*.sh"/>
-</pre>
-<p>makes all ".sh" files below <code>${dist}/bin</code>
-readable and executable for anyone on a UNIX system.</p>
+ includes="**/*.sh"/></pre>
+<p>makes all <samp>.sh</samp> files below <samp>${dist}/bin</samp> readable and executable for
+anyone on a UNIX system.</p>
<pre>
<chmod perm="g+w">
@@ -178,13 +156,11 @@ readable and executable for anyone on a UNIX system.</p>
<exclude name="**/trial/**"/>
</fileset>
<fileset refid="other.shared.sources"/>
-</chmod>
-</pre>
-<p>makes all files below <code>shared/sources1</code> (except those
-below any directory named trial) writable for members of the same
-group on a UNIX system. In addition all files belonging to a FileSet
-with <code>id</code> <code>other.shared.sources</code> get the same
-permissions.</p>
+</chmod></pre>
+<p>makes all files below <samp>shared/sources1</samp> (except those below any directory named trial)
+writable for members of the same group on a UNIX system. In addition all files belonging to a
+FileSet with <var>id</var> <samp>other.shared.sources</samp> get the same permissions.</p>
+
<pre>
<chmod perm="go-rwx" type="file">
<fileset dir="/web">
@@ -194,26 +170,17 @@ permissions.</p>
<dirset dir="/web">
<include name="**/private_*"/>
</dirset>
-</chmod>
-</pre>
-<p>keeps non-owners from touching cgi scripts, files with a <code>.old</code>
-extension or directories beginning with <code>private_</code>. A directory
-ending in <code>.old</code> or a file beginning with private_ would remain
-unaffected.</p>
-
- <h3>Note on maxparallel attribute</h3>
- <p>
- Some shells have a limit of the number of characters that
- a command line may contain.
- This maximum limit varies from shell to shell and from operating
- system to operating system.
- If one has a large number of files to change mode on, consider
- using the <em>maxparallel</em> attribute. For example
- when using AIX and the limit is reached, the system responds
- with a warning: "Warning:
- UNIXProcess.forkAndExec native error: The parameter or environment lists
- are too long". A value of about 300 seems to result in a
- command line that is acceptable.
- </p>
+</chmod></pre>
+<p>keeps non-owners from touching cgi scripts, files with a <samp>.old</samp> extension or
+directories beginning with <samp>private_</samp>. A directory ending in <samp>.old</samp> or a file
+beginning with <samp>private_</samp> would remain unaffected.</p>
+
+<h3>Note on <var>maxparallel</var> attribute</h3>
+<p>Some shells have a limit of the number of characters that a command line may contain. This
+maximum limit varies from shell to shell and from operating system to operating system. If one has
+a large number of files to change mode on, consider using the <var>maxparallel</var> attribute. For
+example when using AIX and the limit is reached, the system responds with a warning: <code>"Warning:
+UNIXProcess.forkAndExec native error: The parameter or environment lists are too long"</code>. A
+value of about 300 seems to result in a command line that is acceptable.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/chown.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/chown.html b/manual/Tasks/chown.html
index a0194c0..002cacb 100644
--- a/manual/Tasks/chown.html
+++ b/manual/Tasks/chown.html
@@ -28,117 +28,99 @@
<p><em>Since Apache Ant 1.6</em>.</p>
<h3>Description</h3>
-<p>Changes the owner of a file or all files inside specified
-directories. Right now it has effect only under Unix. The owner
-attribute is equivalent to the corresponding argument for the chown
-command.</p>
-
-<p><a href="../Types/fileset.html">FileSet</a>s,
-<a href="../Types/dirset.html">DirSet</a>s or <a
-href="../Types/filelist.html">FileList</a>s can be specified using
-nested <code><fileset></code>, <code><dirset></code> and
-<code><filelist></code> elements.</p>
-
-<p><em>Since Ant 1.7</em>, this task supports arbitrary <a
-href="../Types/resources.html#collection">Resource Collection</a>s
-as nested elements.</p>
-
-<p>By default this task will use a single invocation of the underlying
-chown command. If you are working on a large number of files this may
-result in a command line that is too long for your operating system.
-If you encounter such problems, you should set the maxparallel
-attribute of this task to a non-zero value. The number to use highly
-depends on the length of your file names (the depth of your directory
-tree) and your operating system, so you'll have to experiment a
-little. POSIX recommends command line length limits of at least 4096
-characters, this may give you an approximation for the number you
-could use as initial value for these experiments.</p>
-
-<p>By default this task won't do anything unless it detects it is
- running on a Unix system. If you know for sure that you have a
- "chown" executable on your PATH that is command line compatible with
- the Unix command, you can use the task's os attribute and set its
- value to your current os.</p>
+<p>Changes the owner of a file or all files inside specified directories. Right now it has effect
+only under Unix. The owner attribute is equivalent to the corresponding argument for
+the <code>chown</code> command.</p>
+
+<p><a href="../Types/fileset.html">FileSet</a>s, <a href="../Types/dirset.html">DirSet</a>s
+or <a href="../Types/filelist.html">FileList</a>s can be specified using
+nested <code><fileset></code>, <code><dirset></code> and <code><filelist></code>
+elements.</p>
+
+<p><em>Since Ant 1.7</em>, this task supports
+arbitrary <a href="../Types/resources.html#collection">Resource Collection</a>s as nested
+elements.</p>
+
+<p>By default this task will use a single invocation of the underlying <code>chown</code> command.
+If you are working on a large number of files this may result in a command line that is too long for
+your operating system. If you encounter such problems, you should set the <var>maxparallel</var>
+attribute of this task to a non-zero value. The number to use highly depends on the length of your
+file names (the depth of your directory tree) and your operating system, so you'll have to
+experiment a little. POSIX recommends command line length limits of at least 4096 characters, this
+may give you an approximation for the number you could use as initial value for these
+experiments.</p>
+
+<p>By default this task won't do anything unless it detects it is running on a Unix system. If you
+know for sure that you have a <code>chown</code> executable on your <code>PATH</code> that is
+command line compatible with the Unix command, you can use the task's os attribute and set its value
+to your current os.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">the file or directory of which the owner must be
+ <td>file</td>
+ <td>the file or directory of which the owner must be
changed.</td>
- <td valign="top" align="center">Yes or nested
+ <td>Yes or nested
<code><fileset/list></code> elements.</td>
</tr>
<tr>
- <td valign="top">owner</td>
- <td valign="top">the new owner.</td>
- <td valign="top" align="center">Yes</td>
+ <td>owner</td>
+ <td>the new owner.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">parallel</td>
- <td valign="top">process all specified files using a single
- <code>chown</code> command. Defaults to true.</td>
- <td valign="top" align="center">No</td>
+ <td>parallel</td>
+ <td>process all specified files using a single <code>chown</code> command.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">type</td>
- <td valign="top">One of <i>file</i>, <i>dir</i> or
- <i>both</i>. If set to <i>file</i>, only the owner of
- plain files are going to be changed. If set to <i>dir</i>, only
- the directories are considered.<br>
- <strong>Note</strong>: The type attribute does not apply to
- nested <i>dirset</i>s - <i>dirset</i>s always implicitly
- assume type to be <i>dir</i>.</td>
- <td align="center" valign="top">No, default is <i>file</i></td>
+ <td>type</td>
+ <td>One of <q>file</q>, <q>dir</q> or <q>both</q>. If set to <q>file</q>, only the owner of
+ plain files are going to be changed. If set to <q>dir</q>, only the directories are
+ considered.<br/><strong>Note</strong>: The <var>type</var> attribute does not apply to
+ nested <code>dirset</code>s—<code>dirset</code>s always implicitly assume type to
+ be <q>dir</q>.</td>
+ <td>No; default is <q>file</q></td>
</tr>
<tr>
- <td valign="top">maxparallel</td>
- <td valign="top">Limit the amount of parallelism by passing at
- most this many sourcefiles at once. Set it to <= 0 for
- unlimited. Defaults to unlimited.</td>
- <td align="center" valign="top">No</td>
-
+ <td>maxparallel</td>
+ <td>Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to
+ negative integer for unlimited.</td>
+ <td>No; defaults to unlimited</td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">Whether to print a summary after execution or not.
- Defaults to <code>false</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>verbose</td>
+ <td>Whether to print a summary after execution or not.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">os</td>
- <td valign="top">list of Operating Systems on which the command may be
- executed.</td>
- <td align="center" valign="top">No</td>
+ <td>os</td>
+ <td>list of Operating Systems on which the command may be executed.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">osfamily</td>
- <td valign="top">OS family as used in
- the <a href="../Tasks/conditions.html#os"><os></a>
+ <td>osfamily</td>
+ <td>OS family as used in the <a href="../Tasks/conditions.html#os"><os></a>
condition.</td>
- <td align="center" valign="top">No - defaults to "unix"</td>
+ <td>No; defaults to <q>unix</q></td>
</tr>
-
</table>
<h3>Examples</h3>
-<pre>
-<chown file="${dist}/start.sh" owner="coderjoe"/>
-</pre>
-<p>makes the "start.sh" file belong to coderjoe on a
-UNIX system.</p>
+<pre><chown file="${dist}/start.sh" owner="coderjoe"/></pre>
+<p>makes the <samp>start.sh</samp> file belong to <samp>coderjoe</samp> on a UNIX system.</p>
<pre>
- <chown owner="coderjoe">
- <fileset dir="${dist}/bin" includes="**/*.sh"/>
- </chown>
-</pre>
-<p>makes all ".sh" files below <code>${dist}/bin</code>
-belong to coderjoe on a UNIX system.</p>
+<chown owner="coderjoe">
+ <fileset dir="${dist}/bin" includes="**/*.sh"/>
+</chown></pre>
+<p>makes all <samp>.sh</samp> files below <samp>${dist}/bin</samp> belong to <samp>coderjoe</samp>
+on a UNIX system.</p>
<pre>
<chown owner="coderjoe">
@@ -146,13 +128,10 @@ belong to coderjoe on a UNIX system.</p>
<exclude name="**/trial/**"/>
</fileset>
<fileset refid="other.shared.sources"/>
-</chown>
-</pre>
-<p>makes all files below <code>shared/sources1</code> (except those
-below any directory named trial) belong to coderjoe on a UNIX
-system. In addition all files belonging to a FileSet
-with <code>id</code> <code>other.shared.sources</code> get the same
-owner.</p>
+</chown></pre>
+<p>makes all files below <samp>shared/sources1</samp> (except those below any directory
+named <samp>trial</samp>) belong to <samp>coderjoe</samp> on a UNIX system. In addition all files
+belonging to a FileSet with <var>id</var> <code>other.shared.sources</code> get the same owner.</p>
<pre>
<chown owner="webadmin" type="file">
@@ -163,12 +142,10 @@ owner.</p>
<dirset dir="/web">
<include name="**/private_*"/>
</dirset>
-</chmod>
-</pre>
-<p>makes cgi scripts, files with a <code>.old</code> extension or
-directories beginning with <code>private_</code> belong to the user named
-webadmin. A directory ending in <code>.old</code> or a file beginning with
-<code>private_</code> would remain unaffected.</p>
+</chmod></pre>
+<p>makes <samp>cgi</samp> scripts, files with a <samp>.old</samp> extension or directories beginning
+with <samp>private_</samp> belong to the user named <samp>webadmin</samp>. A directory ending
+in <samp>.old</samp> or a file beginning with <samp>private_</samp> would remain unaffected.</p>
</body>
</html>