cvs commit: ant/docs/manual/CoreTasks echo.html genkey.html java.html mail.html style.html tar.html unzip.html waitfor.html

[peterreilly]

peterreilly    2005/03/10 05:01:55

  Modified:    docs/manual/CoreTasks echo.html genkey.html java.html
                        mail.html style.html tar.html unzip.html
                        waitfor.html
  Log:
  some fixes to align examples
  
  Revision  Changes    Path
  1.14      +1 -1      ant/docs/manual/CoreTasks/echo.html
  
  Index: echo.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTasks/echo.html,v
  retrieving revision 1.13
  retrieving revision 1.14
  diff -u -r1.13 -r1.14
  --- echo.html 7 Mar 2005 18:09:09 -0000       1.13
  +++ echo.html 10 Mar 2005 13:01:55 -0000      1.14
  @@ -86,7 +86,7 @@
   
   <pre>&lt;echo file="runner.csh" append="false"&gt;#\!/bin/tcsh
   java-1.3.1 -mx1024m ${project.entrypoint} $$*
  -</echo></pre>
  +&lt;/echo&gt;</pre>
   Generate a shell script by echoing to a file.
   Note the use of a double $ symbol to stop Ant
   filtering out the single $ during variable expansion   
  
  
  
  1.11      +7 -6      ant/docs/manual/CoreTasks/genkey.html
  
  Index: genkey.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTasks/genkey.html,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- genkey.html       7 Mar 2005 18:09:09 -0000       1.10
  +++ genkey.html       10 Mar 2005 13:01:55 -0000      1.11
  @@ -86,20 +86,21 @@
   <p>The following two examples are identical: </p>
   
   <h3>Examples</h3>
  -<blockquote>
  -  <p><code>&lt;genkey alias=&quot;apache-group&quot; 
storepass=&quot;secret&quot; 
  -  dname=&quot;CN=Ant Group, OU=Jakarta Division, O=Apache.org, 
C=US&quot;/&gt;</code></p>
  -</blockquote>
  +<blockquote><pre>
  +&lt;genkey alias=&quot;apache-group&quot; storepass=&quot;secret&quot; 
  +  dname=&quot;CN=Ant Group, OU=Jakarta Division, O=Apache.org, 
C=US&quot;/&gt;
  +</pre></blockquote>
   
   <blockquote>
  -  <pre><code>&lt;genkey alias=&quot;apache-group&quot; 
storepass=&quot;secret&quot; &gt;
  +  <pre>
  +&lt;genkey alias=&quot;apache-group&quot; storepass=&quot;secret&quot; &gt;
     &lt;dname&gt;
       &lt;param name=&quot;CN&quot; value=&quot;Ant Group&quot;/&gt;
       &lt;param name=&quot;OU&quot; value=&quot;Jakarta Division&quot;/&gt;
       &lt;param name=&quot;O&quot;  value=&quot;Apache.Org&quot;/&gt;
       &lt;param name=&quot;C&quot;  value=&quot;US&quot;/&gt;
     &lt;/dname&gt;
  -&lt;/genkey&gt;</code></pre>
  +&lt;/genkey&gt;</pre>
   </blockquote>
   <hr>
   <p align="center">Copyright &copy; 2000-2001,2003,2005 Apache Software 
Foundation. All rights
  
  
  
  1.38      +6 -3      ant/docs/manual/CoreTasks/java.html
  
  Index: java.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTasks/java.html,v
  retrieving revision 1.37
  retrieving revision 1.38
  diff -u -r1.37 -r1.38
  --- java.html 7 Mar 2005 18:09:09 -0000       1.37
  +++ java.html 10 Mar 2005 13:01:55 -0000      1.38
  @@ -302,7 +302,8 @@
   </pre>
   Run a class in this JVM with a new jar on the classpath
   
  -<pre>        &lt;java jar=&quot;dist/test.jar&quot;
  +<pre>
  +       &lt;java jar=&quot;dist/test.jar&quot;
              fork="true"
              failonerror="true"
              maxmemory="128m"
  @@ -318,7 +319,8 @@
   using the manifest supplied entry point, forking (as required),
   and with a maximum memory of 128MB. Any non zero return code breaks the 
build.
   
  -<pre>        &lt;java
  +<pre>
  +       &lt;java
              dir="${exec.dir}"
              jar=&quot;${exec.dir}/dist/test.jar&quot;
              fork="true"
  @@ -339,7 +341,8 @@
   
   
   <pre>  &lt;java classname=&quot;test.Main&quot;/&gt;</pre>
  -<pre>  &lt;java classname=&quot;test.Main&quot;
  +<pre>
  +  &lt;java classname=&quot;test.Main&quot;
           fork=&quot;yes&quot; &gt;
       &lt;sysproperty key=&quot;DEBUG&quot; value=&quot;true&quot;/&gt;
       &lt;arg value=&quot;-h&quot;/&gt;
  
  
  
  1.28      +20 -12    ant/docs/manual/CoreTasks/mail.html
  
  Index: mail.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTasks/mail.html,v
  retrieving revision 1.27
  retrieving revision 1.28
  diff -u -r1.27 -r1.28
  --- mail.html 7 Mar 2005 18:09:09 -0000       1.27
  +++ mail.html 10 Mar 2005 13:01:55 -0000      1.28
  @@ -10,18 +10,26 @@
   
   <h2><a name="mail">Mail</a></h2>
   <h3>Description</h3>
  -<p>A task to send SMTP email.<br></br><br></br>
  -This task can send mail using either plain
  -text, UU encoding, or MIME format mail, depending on what is 
available.<br></br><br></br>
  -<br>
  -SMTP auth and SSL/TLS require JavaMail and are only available in MIME 
format.<br></br><br></br>
  -Attachments may be sent using nested
  -<a href="../CoreTypes/fileset.html">fileset</a> elements.</p>
  -<p><strong>Note:</strong> This task may depend on external libraries
  -that are not included
  -in the Ant distribution.  See <a href="../install.html#librarydependencies">
  -Library Dependencies</a> for more information.
  -</p>
  +  <p>
  +    A task to send SMTP email.
  +  </p>
  +  <p>
  +    This task can send mail using either plain
  +    text, UU encoding, or MIME format mail, depending on what is available.
  +  </p>
  +  <p>
  +    SMTP auth and SSL/TLS require JavaMail and are only available in MIME 
format.
  +  </p>
  +  <p>
  +    Attachments may be sent using nested
  +    <a href="../CoreTypes/fileset.html">fileset</a> elements.
  +  </p>
  +  <p>
  +    <strong>Note:</strong> This task may depend on external libraries
  +    that are not included in the Ant distribution. 
  +    See <a href="../install.html#librarydependencies">Library 
Dependencies</a>
  +    for more information.
  +  </p>
   
   <h3>Parameters</h3>
   <table border="1" cellpadding="2" cellspacing="0">
  
  
  
  1.35      +14 -7     ant/docs/manual/CoreTasks/style.html
  
  Index: style.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTasks/style.html,v
  retrieving revision 1.34
  retrieving revision 1.35
  diff -u -r1.34 -r1.35
  --- style.html        7 Mar 2005 18:09:09 -0000       1.34
  +++ style.html        10 Mar 2005 13:01:55 -0000      1.35
  @@ -306,7 +306,8 @@
   &lt;style basedir=&quot;doc&quot; destdir=&quot;build/doc&quot;
          extension=&quot;.html&quot; 
style=&quot;style/apache.xsl&quot;/&gt;</pre>
     <h4>Using an xmlcatalog</h4>
  -  <pre>&lt;xslt basedir=&quot;doc&quot; destdir=&quot;build/doc&quot;
  +  <pre>
  +&lt;xslt basedir=&quot;doc&quot; destdir=&quot;build/doc&quot;
         extension=&quot;.html&quot; style=&quot;style/apache.xsl&quot;&gt;
     &lt;xmlcatalog refid=&quot;mycatalog&quot;/&gt;
   &lt;/xslt&gt;
  @@ -318,9 +319,11 @@
            publicId=&quot;-//ArielPartners//DTD XML Article V1.0//EN&quot;
            
location=&quot;com/arielpartners/knowledgebase/dtd/article.dtd&quot;/&gt;
      &lt;/xmlcatalog&gt;
  -&lt;/xslt&gt;</pre>
  +&lt;/xslt&gt;
  +</pre>
     <h4>Using XSL parameters</h4>
  -<pre>&lt;xslt basedir=&quot;doc&quot; destdir=&quot;build/doc&quot;
  +<pre>
  +&lt;xslt basedir=&quot;doc&quot; destdir=&quot;build/doc&quot;
         extension=&quot;.html&quot; style=&quot;style/apache.xsl&quot;&gt;
     &lt;param name=&quot;date&quot; expression=&quot;07-01-2000&quot;/&gt;
   &lt;/xslt&gt;</pre>
  @@ -331,16 +334,19 @@
     </p>
   
     <h4>Using output properties</h4>
  -<pre>&lt;xslt in=&quot;doc.xml&quot; out=&quot;build/doc/output.xml&quot;
  +<pre>
  +&lt;xslt in=&quot;doc.xml&quot; out=&quot;build/doc/output.xml&quot;
         style=&quot;style/apache.xsl&quot;&gt;
     &lt;outputproperty name=&quot;method&quot; value=&quot;xml&quot;;/&gt;
     &lt;outputproperty name=&quot;standalone&quot; value=&quot;yes&quot;/&gt;
     &lt;outputproperty name=&quot;encoding&quot; 
value=&quot;iso8859_1&quot;/&gt;
     &lt;outputproperty name=&quot;indent&quot; value=&quot;yes&quot;/&gt;
  -&lt;/xslt&gt;</pre>
  +&lt;/xslt&gt;
  +</pre>
   
     <h4>Using factory settings</h4>
  -<pre>&lt;xslt in=&quot;doc.xml&quot; out=&quot;build/doc/output.xml&quot;
  +<pre>
  +&lt;xslt in=&quot;doc.xml&quot; out=&quot;build/doc/output.xml&quot;
         style=&quot;style/apache.xsl&quot;&gt;
     &lt;factory 
name=&quot;org.apache.xalan.processor.TransformerFactoryImpl&quot;&gt;
       &lt;attribute 
name=&quot;http://xml.apache.org/xalan/features/optimize&quot; 
value=&quot;true&quot;/&gt;
  @@ -348,7 +354,8 @@
   &lt;/xslt&gt;</pre>
   
     <h4>Using a mapper</h4>
  -<pre>&lt;xslt basedir=&quot;in&quot; destdir=&quot;out&quot;
  +<pre>
  +&lt;xslt basedir=&quot;in&quot; destdir=&quot;out&quot;
         style=&quot;style/apache.xsl&quot;&gt;
     &lt;mapper type=&quot;glob&quot; from=&quot;*.xml.en&quot; 
to=&quot;*.html.en&quot;/&gt;
   &lt;/xslt&gt;</pre>
  
  
  
  1.23      +12 -8     ant/docs/manual/CoreTasks/tar.html
  
  Index: tar.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTasks/tar.html,v
  retrieving revision 1.22
  retrieving revision 1.23
  diff -u -r1.22 -r1.23
  --- tar.html  7 Mar 2005 18:09:09 -0000       1.22
  +++ tar.html  10 Mar 2005 13:01:55 -0000      1.23
  @@ -182,15 +182,17 @@
   </table>
   
   <h3>Examples</h3>
  -<pre>  &lt;tar tarfile=&quot;${dist}/manual.tar&quot; 
basedir=&quot;htdocs/manual&quot;/&gt;
  -  &lt;gzip zipfile=&quot;${dist}/manual.tar.gz&quot; 
src=&quot;${dist}/manual.tar&quot;/&gt;</pre>
  +<pre>
  +&lt;tar tarfile=&quot;${dist}/manual.tar&quot; 
basedir=&quot;htdocs/manual&quot;/&gt;
  +&lt;gzip zipfile=&quot;${dist}/manual.tar.gz&quot; 
src=&quot;${dist}/manual.tar&quot;/&gt;</pre>
   <p>tars all files in the <code>htdocs/manual</code> directory into a file 
called <code>manual.tar</code>
   in the <code>${dist}</code>  directory, then applies the gzip task to 
compress
   it.</p>
  -<pre>  &lt;tar destfile=&quot;${dist}/manual.tar&quot;
  -       basedir=&quot;htdocs/manual&quot;
  -       excludes=&quot;mydocs/**, **/todo.html&quot;
  -  /&gt;</pre>
  +<pre>
  +&lt;tar destfile=&quot;${dist}/manual.tar&quot;
  +      basedir=&quot;htdocs/manual&quot;
  +      excludes=&quot;mydocs/**, **/todo.html&quot;
  +/&gt;</pre>
   <p>tars all files in the <code>htdocs/manual</code> directory into a file 
called <code>manual.tar</code>
   in the <code>${dist}</code> directory. Files in the directory 
<code>mydocs</code>,
   or files with the name <code>todo.html</code> are excluded.</p>
  @@ -219,7 +221,8 @@
   </p>
   
   
  -<pre>&lt;tar longfile=&quot;gnu&quot;
  +<pre>
  +&lt;tar longfile=&quot;gnu&quot;
        destfile=&quot;${dist.base}/${dist.name}-src.tar&quot; &gt;
     &lt;tarfileset dir=&quot;${dist.name}/..&quot; mode=&quot;755&quot; 
username=&quot;ant&quot; group=&quot;ant&quot;&gt;
       &lt;include name=&quot;${dist.name}/bootstrap.sh&quot;/&gt;
  @@ -230,7 +233,8 @@
       &lt;exclude name=&quot;${dist.name}/bootstrap.sh&quot;/&gt;
       &lt;exclude name=&quot;${dist.name}/build.sh&quot;/&gt;
     &lt;/tarfileset&gt;
  -&lt;/tar&gt; </pre>
  +&lt;/tar&gt;
  +</pre>
   
   <p>This example shows building a tar which uses the GNU extensions for long 
paths and
   where some files need to be marked as executable (mode 755)
  
  
  
  1.17      +15 -20    ant/docs/manual/CoreTasks/unzip.html
  
  Index: unzip.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTasks/unzip.html,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  --- unzip.html        7 Mar 2005 18:09:10 -0000       1.16
  +++ unzip.html        10 Mar 2005 13:01:55 -0000      1.17
  @@ -70,17 +70,15 @@
   
   </table>
   <h3>Examples</h3>
  -<blockquote>
  -  <p><code>&lt;unzip src=&quot;${tomcat_src}/tools-src.zip&quot; 
dest=&quot;${tools.home}&quot;/&gt;</code></p>
  -</blockquote>
  -<blockquote>
  -  <p><code>
  -&lt;gunzip src=&quot;tools.tar.gz&quot;/&gt;<br>
  +<pre>
  +&lt;unzip src=&quot;${tomcat_src}/tools-src.zip&quot; 
dest=&quot;${tools.home}&quot;/&gt;
  +</pre>
  +<p/>
  +<pre>
  +&lt;gunzip src=&quot;tools.tar.gz&quot;/&gt;
   &lt;untar src=&quot;tools.tar&quot; dest=&quot;${tools.home}&quot;/&gt;
  -</code></p>
  -</blockquote>
  -<blockquote>
  -<p><pre>
  +</pre>
  +<pre>
   &lt;unzip src=&quot;${tomcat_src}/tools-src.zip&quot;
          dest=&quot;${tools.home}&quot;&gt;
       &lt;patternset&gt;
  @@ -88,10 +86,9 @@
           &lt;exclude name=&quot;**/Test*.java&quot;/&gt;
       &lt;/patternset&gt;
   &lt;/unzip&gt;
  -</pre></p>
  -</blockquote>
  -<blockquote>
  -<p><pre>
  +</pre>
  +<p/>
  +<pre>
   &lt;unzip dest=&quot;${tools.home}&quot;&gt;
       &lt;patternset&gt;
           &lt;include name=&quot;**/*.java&quot;/&gt;
  @@ -102,18 +99,16 @@
           &lt;exclude name=&quot;**/tmp*.zip&quot;/&gt;
       &lt;/fileset&gt;
   &lt;/unzip&gt;
  -</pre></p>
  -</blockquote>
  -<blockquote>
  -<p><pre>
  +</pre>
  +<p/>
  +<pre>
   &lt;unzip src=&quot;apache-ant-bin.zip&quot; 
dest=&quot;${tools.home}&quot;&gt;
       &lt;patternset&gt;
           &lt;include name=&quot;apache-ant/lib/ant.jar&quot;/&gt;
       &lt;/patternset&gt;
       &lt;mapper type=&quot;flatten&quot;/&gt;
   &lt;/unzip&gt;
  -</pre></p>
  -</blockquote>
  +</pre>
   <hr>
   <p align="center">Copyright &copy; 2000-2005 The Apache Software Foundation. 
All rights
   Reserved.</p>
  
  
  
  1.9       +18 -18    ant/docs/manual/CoreTasks/waitfor.html
  
  Index: waitfor.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTasks/waitfor.html,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- waitfor.html      7 Mar 2005 18:09:10 -0000       1.8
  +++ waitfor.html      10 Mar 2005 13:01:55 -0000      1.9
  @@ -86,27 +86,27 @@
   <a href="conditions.html">here</a> for the full list.</p>
   
   <h3>Examples</h3>
  -<blockquote>
  -  <p><code>&lt;waitfor maxwait=&quot;30&quot; 
maxwaitunit=&quot;second&quot;&gt;<br>
  -    &nbsp;&nbsp;&nbsp;&nbsp;&lt;available file="errors.log"/&gt;<br>
  -    &lt;/waitfor&gt;</code></p>
  -</blockquote>
  +<blockquote><pre>
  +&lt;waitfor maxwait="30" maxwaitunit="second"&gt;
  +        &lt;available file="errors.log"/&gt;
  +&lt;/waitfor&gt;
  +</pre></blockquote>
   <p>waits up to 30 seconds for a file called errors.log to appear.</p>
  -<blockquote>
  -  <p><code>&lt;waitfor maxwait=&quot;3&quot; maxwaitunit=&quot;minute&quot; 
checkevery=&quot;500&quot;&gt;<br>
  -    &nbsp;&nbsp;&nbsp;&nbsp;&lt;http 
url=&quot;http://localhost/myapp/index.html&quot;/&gt;<br>
  -    &lt;/waitfor&gt;</code></p>
  -</blockquote>
  +<blockquote><pre>
  +&lt;waitfor maxwait="3" maxwaitunit="minute" checkevery="500"&gt;
  +        &lt;http url="http://localhost/myapp/index.html"/&gt;
  +&lt;/waitfor&gt;
  +</pre></blockquote>
   <p>waits up to 3 minutes (and checks every 500 milliseconds) for a web 
server on localhost
     to serve up the specified URL.</p>
  -<blockquote>
  -  <p><code>&lt;waitfor maxwait=&quot;10&quot; 
maxwait=&quot;second&quot;&gt;<br>
  -    &nbsp;&nbsp;&nbsp;&nbsp;&lt;and&gt;<br>
  -    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;socket 
server=&quot;dbserver&quot; port=&quot;1521&quot;/&gt;<br>
  -    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;http 
url=&quot;http://webserver/mypage.html&quot;/&gt;<br>
  -    &nbsp;&nbsp;&nbsp;&nbsp;&lt;/and&gt;<br>
  -    &lt;/waitfor&gt;</code></p>
  -</blockquote>
  +<blockquote><pre>
  +&lt;waitfor maxwait="10" maxwait="second"&gt;
  +        &lt;and&gt;
  +            &lt;socket server="dbserver" port="1521"/&gt;
  +            &lt;http url="http://webserver/mypage.html"/&gt;
  +        &lt;/and&gt;
  +&lt;/waitfor&gt;
  +</pre></blockquote>
   <p>waits up to 10 seconds for a server on the dbserver machine to begin 
listening
     on port 1521 and for the http://webserver/mypage.html web page
     to become available.</p>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]