Browse Source

place examples in <blockquote> blocks

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277837 13f79535-47bb-0310-9956-ffa450edef68
master
Peter Reilly 20 years ago
parent
commit
a1a8c3c21c
10 changed files with 148 additions and 130 deletions
  1. +37
    -37
      docs/manual/CoreTasks/ant.html
  2. +17
    -17
      docs/manual/CoreTasks/antcall.html
  3. +32
    -29
      docs/manual/CoreTasks/apt.html
  4. +15
    -11
      docs/manual/CoreTasks/available.html
  5. +11
    -4
      docs/manual/CoreTasks/basename.html
  6. +6
    -2
      docs/manual/CoreTasks/buildnumber.html
  7. +11
    -11
      docs/manual/CoreTasks/checksum.html
  8. +1
    -1
      docs/manual/CoreTasks/chmod.html
  9. +6
    -6
      docs/manual/CoreTasks/pack.html
  10. +12
    -12
      docs/manual/CoreTasks/unpack.html

+ 37
- 37
docs/manual/CoreTasks/ant.html View File

@@ -198,72 +198,72 @@ details:</p>
</table>

<h3>Examples</h3>
<pre>
&lt;ant antfile=&quot;subproject/subbuild.xml&quot; dir=&quot;subproject&quot; target=&quot;compile&quot;/&gt;
<blockquote><pre>
&lt;ant antfile=&quot;subproject/subbuild.xml&quot;
dir=&quot;subproject&quot; target=&quot;compile&quot;/&gt;

&lt;ant dir=&quot;subproject&quot;/&gt;
&lt;ant dir=&quot;subproject&quot;/&gt;

&lt;ant antfile=&quot;subproject/property_based_subbuild.xml&quot;&gt;
&lt;property name=&quot;param1&quot; value=&quot;version 1.x&quot;/&gt;
&lt;property file=&quot;config/subproject/default.properties&quot;/&gt;
&lt;/ant&gt;

&lt;ant inheritAll=&quot;false&quot; antfile=&quot;subproject/subbuild.xml&quot;&gt;
&lt;property name=&quot;output.type&quot; value=&quot;html&quot;/&gt;
&lt;/ant&gt;
</pre>
&lt;ant antfile=&quot;subproject/property_based_subbuild.xml&quot;&gt;
&lt;property name=&quot;param1&quot; value=&quot;version 1.x&quot;/&gt;
&lt;property file=&quot;config/subproject/default.properties&quot;/&gt;
&lt;/ant&gt;

&lt;ant inheritAll=&quot;false&quot; antfile=&quot;subproject/subbuild.xml&quot;&gt;
&lt;property name=&quot;output.type&quot; value=&quot;html&quot;/&gt;
&lt;/ant&gt;
</pre></blockquote>
<p>The build file of the calling project defines some
<code>&lt;path&gt;</code> elements like this:</p>

<pre>
&lt;path id="path1"&gt;
<blockquote><pre>
&lt;path id="path1"&gt;
...
&lt;/path&gt;
&lt;path id="path2"&gt;
&lt;/path&gt;
&lt;path id="path2"&gt;
...
&lt;/path&gt;
</pre>
&lt;/path&gt;
</pre></blockquote>

<p>and the called build file (<code>subbuild.xml</code>) also defines
a <code>&lt;path&gt;</code> with the id <code>path1</code>, but
<code>path2</code> is not defined:</p>

<pre>
&lt;ant antfile=&quot;subbuild.xml&quot; inheritrefs=&quot;true&quot;/&gt;
</pre>
<blockquote><pre>
&lt;ant antfile=&quot;subbuild.xml&quot; inheritrefs=&quot;true&quot;/&gt;
</pre></blockquote>

<p>will not override <code>subbuild</code>'s definition of
<code>path1</code>, but make the parent's definition of
<code>path2</code> available in the subbuild.</p>

<pre>
&lt;ant antfile=&quot;subbuild.xml&quot;/&gt;
</pre>
<blockquote><pre>
&lt;ant antfile=&quot;subbuild.xml&quot;/&gt;
</pre></blockquote>

<p>as well as</p>

<pre>
&lt;ant antfile=&quot;subbuild.xml&quot; inheritrefs=&quot;false&quot;/&gt;
</pre>
<blockquote><pre>
&lt;ant antfile=&quot;subbuild.xml&quot; inheritrefs=&quot;false&quot;/&gt;
</pre></blockquote>

<p>will neither override <code>path1</code> nor copy
<code>path2</code>.</p>

<pre>
&lt;ant antfile=&quot;subbuild.xml&quot; inheritrefs=&quot;false&quot;&gt;
&lt;reference refid=&quot;path1&quot;/&gt;
&lt;/ant&gt;
</pre>
<blockquote><pre>
&lt;ant antfile=&quot;subbuild.xml&quot; inheritrefs=&quot;false&quot;&gt;
&lt;reference refid=&quot;path1&quot;/&gt;
&lt;/ant&gt;
</pre></blockquote>

<p>will override <code>subbuild</code>'s definition of
<code>path1</code>.</p>

<pre>
&lt;ant antfile=&quot;subbuild.xml&quot; inheritrefs=&quot;false&quot;&gt;
&lt;reference refid=&quot;path1&quot; torefid=&quot;path2&quot;/&gt;
&lt;/ant&gt;
</pre>
<blockquote><pre>
&lt;ant antfile=&quot;subbuild.xml&quot; inheritrefs=&quot;false&quot;&gt;
&lt;reference refid=&quot;path1&quot; torefid=&quot;path2&quot;/&gt;
&lt;/ant&gt;
</pre></blockquote>

<p>will copy the parent's definition of <code>path1</code> into the
new project using the id <code>path2</code>.</p>


+ 17
- 17
docs/manual/CoreTasks/antcall.html View File

@@ -147,24 +147,24 @@ targets so specified, in the order specified.</p>
<p><em>since Ant 1.6.3</em>.</p>

<h3>Examples</h3>
<pre>
&lt;target name=&quot;default&quot;&gt;
&lt;antcall target=&quot;doSomethingElse&quot;&gt;
&lt;param name=&quot;param1&quot; value=&quot;value&quot;/&gt;
&lt;/antcall&gt;
&lt;/target&gt;
&lt;target name=&quot;doSomethingElse&quot;&gt;
&lt;echo message=&quot;param1=${param1}&quot;/&gt;
&lt;/target&gt;
</pre>
<blockquote><pre>
&lt;target name=&quot;default&quot;&gt;
&lt;antcall target=&quot;doSomethingElse&quot;&gt;
&lt;param name=&quot;param1&quot; value=&quot;value&quot;/&gt;
&lt;/antcall&gt;
&lt;/target&gt;
&lt;target name=&quot;doSomethingElse&quot;&gt;
&lt;echo message=&quot;param1=${param1}&quot;/&gt;
&lt;/target&gt;
</pre></blockquote>
<p>Will run the target 'doSomethingElse' and echo 'param1=value'.</p>

<pre>
&lt;antcall ... &gt;
&lt;reference refid=&quot;path1&quot; torefid=&quot;path2&quot;/&gt;
&lt;/antcall&gt;
</pre>
<blockquote><pre>
&lt;antcall ... &gt;
&lt;reference refid=&quot;path1&quot; torefid=&quot;path2&quot;/&gt;
&lt;/antcall&gt;
</pre></blockquote>

<p>will copy the parent's definition of <code>path1</code> into the
new project using the id <code>path2</code>.</p>
@@ -173,4 +173,4 @@ new project using the id <code>path2</code>.</p>
Reserved.</p>

</body>
</html>
</html>

+ 32
- 29
docs/manual/CoreTasks/apt.html View File

@@ -84,15 +84,17 @@
</tbody></table>

<h3>Examples</h3>
<pre> &lt;apt srcdir="${src}"
destdir="${build}"
classpath="xyz.jar"
debug="on"
compile="true"
factory="com.mycom.MyAnnotationProcessorFactory"
factorypathref="my.factorypath.id"
preprocessdir="${preprocess.dir}"&gt;
&lt;/apt&gt;</pre>
<blockquote><pre>
&lt;apt srcdir="${src}"
destdir="${build}"
classpath="xyz.jar"
debug="on"
compile="true"
factory="com.mycom.MyAnnotationProcessorFactory"
factorypathref="my.factorypath.id"
preprocessdir="${preprocess.dir}"&gt;
&lt;/apt&gt;
</pre></blockquote>
<p>compiles all <code>.java</code> files under the <code>${src}</code>
directory, and stores
the <code>.class</code> files in the <code>${build}</code> directory.
@@ -121,26 +123,27 @@ The inherited "compiler" attribute is ignored, as it is forced to use the Apt co
<code>&lt;javac&gt;</code> task to compile first your original source code, and then the
generated source code:</p>

<pre> &lt;apt srcdir="${src}"
destdir="${build}"
classpath="xyz.jar"
debug="true"
compile="false"
factory="com.mycom.MyAnnotationProcessorFactory"
factorypathref="my.factorypath.id"
preprocessdir="${preprocess.dir}"&gt;
&lt;/apt&gt;

&lt;javac srcdir="${src}"
destdir="${build}"
classpath="xyz.jar"
debug="on"/&gt;

&lt;javac srcdir="${preprocess.dir}"
destdir="${build}"
classpath="xyz.jar"
debug="true"/&gt;
</pre>
<blockquote><pre>
&lt;apt srcdir="${src}"
destdir="${build}"
classpath="xyz.jar"
debug="true"
compile="false"
factory="com.mycom.MyAnnotationProcessorFactory"
factorypathref="my.factorypath.id"
preprocessdir="${preprocess.dir}"&gt;
&lt;/apt&gt;

&lt;javac srcdir="${src}"
destdir="${build}"
classpath="xyz.jar"
debug="on"/&gt;

&lt;javac srcdir="${preprocess.dir}"
destdir="${build}"
classpath="xyz.jar"
debug="true"/&gt;
</pre></blockquote>

This may involve more build file coding, but the speedup gained from switching
to jikes may justify the effort.


+ 15
- 11
docs/manual/CoreTasks/available.html View File

@@ -87,37 +87,41 @@ href="../using.html#path">path-like structure</a> and can also be set via a nest
href="../using.html#path">path-like structure</a> and can also be set via a nested
<code>&lt;filepath&gt;</code> element.</p>
<h3>Examples</h3>
<pre> &lt;available classname=&quot;org.whatever.Myclass&quot; property=&quot;Myclass.present&quot;/&gt;</pre>
<blockquote><pre>
&lt;available classname=&quot;org.whatever.Myclass&quot; property=&quot;Myclass.present&quot;/&gt;
</pre></blockquote>
<p>sets the <code>Myclass.present</code> property to the value &quot;true&quot;
if the class <code>org.whatever.Myclass</code> is found in Ant's classpath.</p>
<pre>
<blockquote><pre>
&lt;property name=&quot;jaxp.jar&quot; value=&quot;./lib/jaxp11/jaxp.jar&quot;/&gt;
&lt;available file=&quot;${jaxp.jar}&quot; property=&quot;jaxp.jar.present&quot;/&gt;
</pre>
</pre></blockquote>
<p>sets the <code>jaxp.jar.present</code> property to the value &quot;true&quot;
if the file <code>./lib/jaxp11/jaxp.jar</code> is found.</p>
<pre>
&lt;available file=&quot;/usr/local/lib&quot; type=&quot;dir&quot; property=&quot;local.lib.present&quot;/&gt;
</pre>
<blockquote><pre>
&lt;available file=&quot;/usr/local/lib&quot; type=&quot;dir&quot;
property=&quot;local.lib.present&quot;/&gt;
</pre></blockquote>
<p>sets the <code>local.lib.present</code> property to the value &quot;true&quot;
if the directory <code>/usr/local/lib</code> is found.</p>
<pre>
<blockquote><pre>
...in project ...
&lt;property name=&quot;jaxp.jar&quot; value=&quot;./lib/jaxp11/jaxp.jar&quot;/&gt;
&lt;path id=&quot;jaxp&quot; location=&quot;${jaxp.jar}&quot;/&gt;
...in target ...
&lt;available classname=&quot;javax.xml.transform.Transformer&quot; classpathref=&quot;jaxp&quot; property=&quot;jaxp11.present&quot;/&gt;
</pre>
&lt;available classname=&quot;javax.xml.transform.Transformer&quot;
classpathref=&quot;jaxp&quot; property=&quot;jaxp11.present&quot;/&gt;
</pre></blockquote>
<p>sets the <code>jaxp11.present</code> property to the value &quot;true&quot;
if the class <code>javax.xml.transform.Transformer</code> is found in the classpath referenced by <code>jaxp</code> (in this case, <code>./lib/jaxp11/jaxp.jar</code>).
</p>
<pre>
<blockquote><pre>
&lt;available property=&quot;have.extras&quot; resource=&quot;extratasks.properties&quot;&gt;
&lt;classpath&gt;
&lt;pathelement location=&quot;/usr/local/ant/extra.jar/&gt;
&nbsp;&nbsp;&lt;/classpath&gt;
&lt;/available&gt;
</pre>
</pre></blockquote>
<p>sets the <code>have.extras</code> property to the value &quot;true&quot;
if the resource-file <code>extratasks.properties</code> is found.
</p>


+ 11
- 4
docs/manual/CoreTasks/basename.html View File

@@ -48,16 +48,23 @@ the basename will be the simple file name, without any directory elements.
</table>

<h3>Examples</h3>
<pre> &lt;basename property=&quot;jar.filename&quot; file=&quot;${lib.jarfile}&quot;/&gt;</pre>
<blockquote><pre>
&lt;basename property=&quot;jar.filename&quot; file=&quot;${lib.jarfile}&quot;/&gt;
</pre></blockquote>
will set <code>jar.filename</code> to
<code>myjar.jar</code>, if <code>lib.jarfile</code> is defined as either a
full-path filename (eg., <code>/usr/local/lib/myjar.jar</code>),
a relative-path filename (eg., <code>lib/myjar.jar</code>),
or a simple filename (eg., <code>myjar.jar</code>).
<pre> &lt;basename property=&quot;cmdname&quot; file=&quot;D:/usr/local/foo.exe&quot; suffix=&quot;.exe&quot;/&gt;</pre>
<blockquote><pre>
&lt;basename property=&quot;cmdname&quot; file=&quot;D:/usr/local/foo.exe&quot;
suffix=&quot;.exe&quot;/&gt;
</pre></blockquote>
will set <code>cmdname</code> to <code>foo</code>.
<pre> &lt;property environment=&quot;env&quot;/&gt;
&lt;basename property=&quot;temp.dirname&quot; file=&quot;${env.TEMP}&quot;/&gt;</pre>
<blockquote><pre>
&lt;property environment=&quot;env&quot;/&gt;
&lt;basename property=&quot;temp.dirname&quot; file=&quot;${env.TEMP}&quot;/&gt;
</pre></blockquote>

will set <code>temp.dirname</code> to the last directory element of
the path defined for the <code>TEMP</code> environment variable.</p>


+ 6
- 2
docs/manual/CoreTasks/buildnumber.html View File

@@ -37,12 +37,16 @@ the number format.)
</table>

<h3>Examples</h3>
<pre> &lt;buildnumber/&gt;</pre>
<blockquote><pre>
&lt;buildnumber/&gt;
</pre></blockquote>

<p>Read, increment, and write a build number to the default file,
<code>build.number</code>.</p>

<pre> &lt;buildnumber file=&quot;mybuild.number&quot;/&gt;</pre>
<blockquote><pre>
&lt;buildnumber file=&quot;mybuild.number&quot;/&gt;
</pre></blockquote>

<p>Read, increment, and write a build number to the file
<code>mybuild.number</code>.</p>


+ 11
- 11
docs/manual/CoreTasks/checksum.html View File

@@ -150,48 +150,48 @@ built-in into your JDK.</p>

<h3>Examples</h3>
<p><b>Example 1</b></p>
<pre>&lt;checksum file=&quot;foo.bar&quot;/&gt;</pre>
<blockquote><pre>&lt;checksum file=&quot;foo.bar&quot;/&gt;</pre></blockquote>
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><b>Example 2</b></p>
<pre>&lt;checksum file=&quot;foo.bar&quot; forceOverwrite=&quot;yes&quot;/&gt;</pre>
<blockquote><pre>&lt;checksum file=&quot;foo.bar&quot; forceOverwrite=&quot;yes&quot;/&gt;</pre></blockquote>
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><b>Example 3</b></p>
<pre>&lt;checksum file=&quot;foo.bar&quot; property=&quot;foobarMD5&quot;/&gt;</pre>
<blockquote><pre>&lt;checksum file=&quot;foo.bar&quot; property=&quot;foobarMD5&quot;/&gt;</pre></blockquote>
Generates a MD5 checksum for foo.bar and stores it in the Project Property foobarMD5.

<p><b>Example 4</b></p>
<pre>&lt;checksum file=&quot;foo.bar&quot; verifyProperty=&quot;isMD5ok&quot;/&gt;</pre>
<blockquote><pre>&lt;checksum file=&quot;foo.bar&quot; verifyProperty=&quot;isMD5ok&quot;/&gt;</pre></blockquote>
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><b>Example 5</b></p>
<pre>&lt;checksum file=&quot;foo.bar&quot; algorithm=&quot;SHA&quot; fileext=&quot;asc&quot;/&gt;</pre>
<blockquote><pre>&lt;checksum file=&quot;foo.bar&quot; algorithm=&quot;SHA&quot; fileext=&quot;asc&quot;/&gt;</pre></blockquote>
Generates a SHA 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><b>Example 6</b></p>
<pre>
<blockquote><pre>
&lt;checksum file=&quot;foo.bar&quot; property=&quot;${md5}&quot; verifyProperty=&quot;isEqual&quot;/&gt;
</pre>
</pre></blockquote>
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><b>Example 7</b></p>
<pre>
<blockquote><pre>
&lt;checksum&gt;
&lt;fileset dir=&quot;.&quot;&gt;
&lt;include name=&quot;foo*&quot;/&gt;
&lt;/fileset&gt;
&lt;/checksum&gt;
</pre>
</pre></blockquote>
Works just like Example 1, but generates a .MD5 file for every file that begins with the name foo.

<p><b>Example 8</b></p>
<pre>
<blockquote><pre>
&lt;condition property=&quot;isChecksumEqual&quot;&gt;
&lt;checksum&gt;
&lt;fileset dir=&quot;.&quot;&gt;
@@ -199,7 +199,7 @@ Works just like Example 1, but generates a .MD5 file for every file that begins
&lt;/fileset&gt;
&lt;/checksum&gt;
&lt;/condition&gt;
</pre>
</pre></blockquote>
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.


+ 1
- 1
docs/manual/CoreTasks/chmod.html View File

@@ -145,7 +145,7 @@ permissions.</p>
&lt;/dirset&gt;
&lt;/chmod&gt;
</pre>
</blockquote>
</blockquote>blockquote>

<p>keeps non-owners from touching cgi scripts, files with a <code>.old</code>
extension or directories beginning with <code>private_</code>. A directory


+ 6
- 6
docs/manual/CoreTasks/pack.html View File

@@ -36,12 +36,12 @@ file is newer.</p>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<p><code>&lt;gzip src=&quot;test.tar&quot; destfile=&quot;test.tar.gz&quot;/&gt;</code></p>
</blockquote>
<blockquote>
<p><code>&lt;bzip2 src=&quot;test.tar&quot; destfile=&quot;test.tar.bz2&quot;/&gt;</code></p>
</blockquote>
<blockquote><pre>
&lt;gzip src=&quot;test.tar&quot; destfile=&quot;test.tar.gz&quot;/&gt;
</pre></blockquote>
<blockquote><pre>
&lt;bzip2 src=&quot;test.tar&quot; destfile=&quot;test.tar.bz2&quot;/&gt;
</pre></blockquote>
<hr>
<p align="center">Copyright &copy; 2000-2005 The Apache Software Foundation. All rights
Reserved.</p>


+ 12
- 12
docs/manual/CoreTasks/unpack.html View File

@@ -38,21 +38,21 @@ does not exist.</p>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<p><code>&lt;gunzip src=&quot;test.tar.gz&quot;/&gt;</code></p>
</blockquote>
<blockquote><pre>
&lt;gunzip src=&quot;test.tar.gz&quot;/&gt;
</pre></blockquote>
<p>expands <i>test.tar.gz</i> to <i>test.tar</i></p>
<blockquote>
<p><code>&lt;bunzip2 src=&quot;test.tar.bz2&quot;/&gt;</code></p>
</blockquote>
<blockquote><pre>
&lt;bunzip2 src=&quot;test.tar.bz2&quot;/&gt;
</pre></blockquote>
<p>expands <i>test.tar.bz2</i> to <i>test.tar</i></p>
<blockquote>
<p><code>&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;test2.tar&quot;/&gt;</code></p>
</blockquote>
<blockquote><pre>
&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;test2.tar&quot;/&gt;
</pre></blockquote>
<p>expands <i>test.tar.gz</i> to <i>test2.tar</i></p>
<blockquote>
<p><code>&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;subdir&quot;/&gt;</code></p>
</blockquote>
<blockquote><pre>
&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;subdir&quot;/&gt;
</pre></blockquote>
<p>expands <i>test.tar.gz</i> to <i>subdir/test.tar</i> (assuming
subdir is a directory).</p>



Loading…
Cancel
Save