diff --git a/docs/index.html b/docs/index.html index 0d2f8884a..888f4cf2b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -30,6 +30,7 @@
Copyright © 2000 Apache Software Foundation. All rights Reserved.
+Compiles a NetRexx +source tree within the running (Ant) VM.
+The source and destination directory will be recursively scanned for +NetRexx source files to compile. Only NetRexx files that have no corresponding +class file or where the class file is older than the java file will be compiled.
+Files in the source tree are copied to the destination directory, +allowing support files to be located properly in the classpath. The source +files are copied because the NetRexx compiler cannot produce class files in a +specific directory via parameters
+The directory structure of the source tree should follow the package +hierarchy.
+It is possible to refine the set of files that are being compiled/copied. +This can be done with the includes, excludes and +defaultexcludes attributes. With the includes attribute you +specify the files you want to have included by using patterns. The +exclude attribute is used to specify the files you want to have +excluded. This is also done with patterns. And finally with the +defaultexcludes attribute, you can specify whether you +want to use default exclusions or not. See the section on directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns. The +patterns are relative to the srcDir directory.
+ +Attribute | +Description | +Required | +
binary | +Whether literals are treated as the java binary + type rather than the NetRexx types | +No | +
classpath | +The classpath to use during compilation | +No | +
comments | +Whether comments are passed through to the + generated java source | +No | +
compact | +Whether error messages come out in compact or + verbose format | +No | +
compile | +Whether the NetRexx compiler should compile the + generated java code | +No | +
console | +Whether or not messages should be displayed on the + 'console' | +No | +
crossref | +Whether variable cross references are generated | +No | +
decimal | +Whether decimal arithmetic should be used for the + NetRexx code | +No | +
defaultexcludes | +indicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when + omitted. | +No | +
destDir | +the destination directory into which the NetRexx + source files should be copied and then compiled | +Yes | +
diag | +Whether diagnostic information about the compile is + generated | +No | +
excludes | +comma separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when + omitted. | +No | +
explicit | +Whether variables must be declared explicitly + before use | +No | +
format | +Whether the generated java code is formatted nicely + or left to match NetRexx line numbers for call stack debugging | +No | +
includes | +comma separated list of patterns of files that must be + included. All files are included when omitted. | +No | +
java | +Whether the generated java code is produced | +No | +
keep | +Sets whether the generated java source file should be kept + after compilation. The generated files will have an extension of + .java.keep, not .java | +No | +
logo | +Whether the compiler text logo is displayed when + compiling | +No | +
replace | +Whether the generated .java file should be replaced + when compiling | +No | +
savelog | +Whether the compiler messages will be written to + NetRexxC.log as well as to the console | +No | +
sourcedir | +Tells the NetRexx compiler to store the class files in the + same directory as the source files. The alternative is the working + directory | +No | +
srcDir | +Set the source dir to find the source Netrexx + files | +Yes | +
strictargs | +Tells the NetRexx compiler that method calls always
+ need parentheses, even if no arguments are needed, e.g.
+ aStringVar.getBytes vs.
+ aStringVar.getBytes() |
+ No | +
strictassign | +Tells the NetRexx compile that assignments must + match exactly on type | +No | +
strictcase | +Specifies whether the NetRexx compiler should be + case sensitive or not | +No | +
strictimport | +Whether classes need to be imported explicitly using an
+ import statement. By default the NetRexx compiler will
+ import certain packages automatically |
+ No | +
strictprops | +Whether local properties need to be qualified
+ explicitly using this |
+ No | +
strictsignal | +Whether the compiler should force catching of + exceptions by explicitly named types | +No | +
symbols | +Whether debug symbols should be generated into the + class file | +No | +
time | +Asks the NetRexx compiler to print compilation + times to the console | +No | +
trace | +Turns on or off tracing and directs the resultant + trace output | +No | +
utf8 | +Tells the NetRexx compiler that the source is in UTF8 | +No | +
verbose | +Whether lots of warnings and error messages should + be generated | +Yes | +
+++
<netrexxc srcDir="/source/project" + includes="vnr/util/*" + destDir="/source/project/build" + classpath="/source/project2/proj.jar" + comments="true" + crossref="false" replace="true" + keep="true" />
+
Renames files in the srcDir
directory ending with the
+fromExtension
string so that they end with the
+toExtension
string. Files are only replaced if
+replace
is true
+
See the section on +directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns. The +patterns are relative to the srcDir directory.
+Attribute | +Description | +Required | +
defaultexcludes | +indicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when + omitted. | +No | +
excludes | +comma separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when + omitted. | +No | +
fromExtention | +The string that files must end in to be renamed | +Yes | +
includes | +comma separated list of patterns of files that must be + included. All files are included when omitted. | +No | +
replace | +Whether the file being renamed to should be + replaced if it already exists | +No | +
srcDir | +The starting directory for files to search in | +Yes | +
toExtension | +The string that renamed files will end with on + completion | +Yes | +
++ ++
<renameext srcDir="/source/project1" + includes="**" + excludes="**/samples/*" + fromExtension=".java.keep" + toExtension=".java" + replace="true" /> +
+
Execute a script in a + BSF supported language. +
All items (tasks, targets, etc) of the running project are accessible +from the script. +
Attribute | +Description | +Required | +
language | +The programming language the script is written in. + Must be a supported BSF language | +No | +
src | +The location of the script as a file, if not inline | +No | +
++None yet available
+