keros 1.2

Table Of Contents

• Summary
• Details
• Property Declarations
• Depends List

Import Summary

Task Definition Summary

Macro Definition Summary

Script Definition Summary

Target Summary

Macro Definition Details

ant2html

Converts Ant to HTML.

Attributes
@{basedir} = the directory in which to start searching for Ant scripts.
@{dest-dir} = the directory in which the transformation will occur.
@{includes} = the file pattern to include when transforming.
@{version} = the version number/value to include in the heading.
@{description} = information about calling this macro.

antDoc

Will take a directory and recursively apply "Ant Doc" (ie just like JavaDoc) to all the files found.

Attributes
@{dir} = the directory to start recursively applying AntDoc.
@{description} = information about calling this macro.

assert-dir-exists

Determines if @{dir} exists and if not, fails with @{error-msg}.

Attributes
@{dir} = the name of the directory that should exist.
@{error-msg} = the message to display if @{dir} does not exist.
@{description} = information about calling this macro.

assert-equal

Determines if @{str1} is equal to @{str2}. If the two are not equal, message defined in @{error-msg} is displayed.

Attributes
@{str1} = compared to @{str2}.
@{str2} = compared to @{str1}.
@{error-msg} = if @{str1} not equal to @{str2}, the message when failing will be displayed.
@{description} = information about calling this macro.

assert-file-exists

Determines if @{file} exists and if not, fails with @{error-msg}.

Attributes
@{file} = the file that should exist.
@{error-msg} = if @{dir} does not exist, the message to display.
@{description} = information about calling this macro.

assert-is-number

Determines if @{number} is a number. If @{number} is not a number, @{error-msg} is displayed.

Attributes
@{number} = used to determine if a number.
@{error-msg} = if @{number} is not a number, the message to be displayed.
@{description} = information about calling this macro.

assert-not-equal

Determines if @{str1} is not equal to @{str2}. If the two are equal, message defined in @{error-msg} is displayed.

Attributes
@{str1} = compared to @{str2}.
@{str2} = compared to @{str1}.
@{error-msg} = if @{str1} equal to @{str2}, the message when failing will be displayed.
@{description} = information about calling this macro.

assert-ref-id

Determines if @{ref-id} is a ref id and if not fails with an error message defined in @{error-msg}.

Attributes
@{ref-id} = the name of the ref id that "should" be a ref id.
@{error-msg} = if @{property} is not set, the message when failing will be displayed.
@{description} = information about calling this macro.

auto-property

Define setting properties using either environment variables or default values. The property entitled @{property} will not be re-set if it is currently defined (set).

Attributes
@{property} = the name of the property to set.
@{default} = default value to use if the property named @{property} is not set.
@{description} = information about calling this macro.

basename

Same as Ant's stock basename task - however, this allows the property to be reset.

Attributes
@{file} = the path to take the basename of.
@{property} = the name of the property to set.
@{suffix} = the suffix to remove from the resulting basename (specified either with or without the ".").
@{prepend} = information to prepend to property's value.
@{append} = information to append to property's value.
@{description} = information about calling this macro.

compute-branch

Compute the branch based upon a root dir, @{root}, and full path, @{full-path}. The branch represents the full path minus the root dir. Please note: if @{root} does not exist in @{full-path}, @{property} will be set with an empty value.

Attributes
@{root} = the root of the path defined in @{full-path}.
@{full-path} = the absolute path for which @{root} is the root of the path and the branch computed is this path minus the root.
@{property} = the property to set with the branch.
@{description} = information about calling this macro.

Example
@{root} = /foo/bar/alpha
@{full-path} = /foo/bar/alpha/beta/theta/zeta

Result
@{property} = beta/theta/zeta.

Example
@{root} = /hello/world
@{full-path} = /foo/bar/alpha/beta/theta/zeta

Result
@{property} =

compute-class-branch

Compute the class' branch information converting dots to OS file separator. By "branch" the meaning is to convey the branch in the CLASSPATH. The path representation of @{class-name} is stored in property @{property}

Attributes
@{class-name} = the fully qualified class name to convert.
@{property} = the property to store the class branch information.
@{description} = information about calling this macro.

Example
@{class-name} = com.foo.bar.Alpha

Result
@{property} = com/foo/bar/Alpha

compute-class-info

Compute information about a class - namely its parent dir and file name (less the .class).

Attributes
@{class-name} = the fully qualified name of a class for which the directory name and file name are sought.
@{dir-property} = the name of the property that will hold the directory of @{class-name}.
@{file-property} = the name of the property to store the file name of @{class-name}.
@{description} = information about calling this macro.

Example
@{class-name} = com.foo.bar.Alpha

Result
@{dir-property} = com/foo/bar
@{file-property} = Alpha

compute-file-extension

Compute the extension of a file and store in @{property}.

Attributes
@{file} = the name of the file for whom we wish to compute the extension.
@{property} = the name of the property to set.
@{description} = information about calling this macro.

compute-number-left-trim

Trim preceeding 0's from @{number} and store in the property

Attributes
@{property} = the name of the property to store the results of triming preceeding 0's from @{number}.
@{number} = the number who will have preceeding 0's trimmed.
@{description} = information about calling this macro.

Example
@{number} = 0030006

Result
@{property} = 30006

compute-number-right-trim

Trim postceeding 0's from @{number} after decimal and store in the property entitled @{property}.

Attributes
@{property} = the name of the property to store the results of triming postceeding 0's from @{number}.
@{number} = the number who will have preceeding 0's trimmed.
@{description} = information about calling this macro.

Example
@{number} = 30006.123980192830000

Result
@{property} = 30006.12398019283

compute-number-trim

Trim preceeding 0's/postceeding 0's from @{number} after decimal and store in the property entitled @{property}.

Attributes
@{property} = the name of the property to store the results of triming postceeding 0's from @{number}.
@{number} = the number who will have preceeding 0's trimmed.
@{description} = information about calling this macro.

Example
@{number} = 000030006.123980192830000

Result
@{property} = 30006.12398019283

compute-replacement

Replace characters from @{str}. The characters to be replaced are contained in @{to-replace}. The replacement characters are contained in @{replacement}. The replaced data is stored in property @{property}. Please note: if @{str} does not contain any data in @{to-replace} the value of @{property} will be @{str}.

Attributes
@{str} = the string containing characters to be replaced.
@{to-replace} = the characters to replace in @{str}.
@{replacement} = replacement characters that will replace @{to-replace} in @{str}.
@{property} = the property to store the class branch information.
@{description} = information about calling this macro.

Example
@{str} = Hello World
@{to-replace} = lo Wo
@{replacement} = YES

Result
@{property} = HelYESrld

compute-timestamp

Compute the current time stamp in YYYY-MM-DD_HH-MM-SS

Attributes
@{property} = the property to set with the current time stamp.
@{prefix} = the prefix for property when time stamp is computed and stored in @{property}.
@{suffix} = the suffix for property when time stamp is computed and stored in @{property}.
@{description} = information about calling this macro.

Example
@{prefix} = foo_
@{suffix} = _bar
current time = February 10, 2005 11:05:30 am

Result
@{property} = foo_2005-02-10_11-05-30_bar

conditional-set-property

Sets a value for a property named @{name}. If @{property} is set, then the value of @{set} is used, otherwise the value of @{unset} is used.

Attributes
@{name} = the name of the property to set.
@{property} = the name of the property to examine to see if set.
@{set} = the value to use if @{property} is set.
@{unset} = the value to use if @{property} is not set.
@{is-warnable} = a flag, if true implies a warning should be displayed (if @{property} is currently set), or false no warning message.
@{warning-msg} = if set to anything and the property named, name, is set, will echo the value of this param. Please note, the property will still be set.
@{description} = information about calling this macro.

console-input

Will prompt for input if property not set (or if the @{always} attribute is true). If @{always} is true and @{property} is set and @{default} is empty, the value of @{property} becomes the @{default} value. If the attribute @{required} is true and no value is set for @{property}, this macro will cause a fail to be invoked. Please note that if @{default} is set and input is prompted but the user does not enter anything, the value of @{default} will be used to set the property!

Attributes
@{prompt} = when requesting input, the message to display.
@{property} = the property to set.
@{default} = the default value to use if upon input, nothing entered.
@{always} = if true will prompt for input regardless if property has been set.
@{required} = if true, after input the property must be set or failure will occur.
@{error-msg} = if @{property} is required and no value set, the error message to display.
@{description} = information about calling this macro.

copy

This will copy from @{src} to @{dest-dir}. If @{src} represents:
• a file, the file will be copied.
• a directory, the directory's contents will be copied.
• a path ref, the contents of each element will be copied (meaning a file will copy the file, a directory will copy the contents of the directory, etc).
Please note: if @{dest-dir} does not exist, it will be created.

Attributes
@{src} = the source to copy from - be it a file dir or ref id.
@{dest-dir} = the directory to copy files to.
@{error-msg} = the error message to display if @{src} does not exist or is not a file, dir or ref id.
@{description} = information about calling this macro.

copy-dir

This will copy the contents of a directory from @{src-dir} to @{dest-dir}. Please note: if @{dest-dir} does not exist, it will be created.

Attributes
@{src-dir} = the source to copy from.
@{dest-dir} = the directory to copy files to.
@{error-msg} = the error message to display if @{src-dir} does not exist.
@{description} = information about calling this macro.

copy-ref-id

This will copy from @{src-ref-id} to @{dest-dir}. Please note: if @{dest-dir} does not exist, it will be created.

Attributes
@{src-ref-id} = the source ref id to copy from.
@{dest-dir} = the directory to copy files to.
@{error-msg} = the error message to display if @{src-ref-id} is not a ref-id.
@{description} = information about calling this macro.

delete-file

Deletes @{file} if @{is-deletable} is yes or true.

Attributes
@{file} = the file to be deleted.
@{is-deletable} = flag, if true/yes (case insensitive) @{file} will be deleted.
@{description} = information about calling this macro.

dirname

Same as Ant's stock dirname task - however, this allows the property to be reset.

Attributes
@{file} = the path to take the dirname of.
@{property} = the name of the property to set.
@{prepend} = information to prepend to property's value.
@{append} = information to append to property's value.
@{description} = information about calling this macro.

equality-set-property

Sets the value of the property entitled @{name} based upon a comparison to the value contained by the property ${property}. If @{property} equals @{value}, @{name} will be set to @{equal}, otherwise it will be set to @{unequal}.

Attributes
@{name} = the name of the property to set.
@{property} = the name of the property to examine to see if set.
@{value} = the value to compare @{property} to.
@{equal} = the value to use if @{property} equals @{value}.
@{unequal} = the value to use if @{property} is not equal to @{value}.
@{is-warnable} = a flag, if true states a warning should be displayed - anything else no warning is outputted.
@{warning-msg} = The message to emit if @{name} is currently set.
@{description} = information about calling this macro.

execute-java-app

Execute a java class whose class name is @{class-property}. If this property is not set, the user will be prompted for the class name.

Attributes
class-property = the name of the property who has the fully qualified class name to execute.
class-path-ref = the class path for executing the java app.
args-property = the name of the property who has the arguments to pass to the class.
class-prompt-msg = the message to use if the property defined by class-property name has not been set.
args-prompt-msg = the message to use if the property defined by args-property name has not been set.
@{description} = information about calling this macro.

for

This implements a for loop with starting and ending values for the loop.

Attributes
@{property} = the name of the property that will contain the current value of the loop.
@{start} = the start value of the loop.
@{end} = the end value of the loop.
@{inc} = value to increment (or decrement) while looping.
@{description} = information about calling this macro.

Elements
@{loop} = the children will be executed for each iteration of the loop.

HtmlAnchor

Emits an HTML anchor to @{file}. Please see the attributes for real HTML anchor for a description of attributes charset - type.

Attributes
@{file} = the file to write the anchor to.
@{text} = the text for the anchor
@{description} = information about calling this macrodef.

HtmlAttribute

Emits an HTML attribute name and value to file @{file}. If value is empty ("") nothing is emitted to @{file}.

Attributes
@{file} = the file to write the attribute to.
@{name} = the name of the attribute.
@{value} = the value of the attribute.
@{description} = information about calling this macrodef.

Example
@{file} = /foo/bar.html
@{name} = theta
@{value} = beta

Result
/foo/bar.html will now contain theta="beta"

HtmlBreak

Emits an HTML break to file @{file}.

Attributes
@{file} = the file to write the break to.
@{description} = information about calling this macrodef.

Example
@{file} = /foo/bar.html

Result
/foo/bar.html will now contain <br></br>

HtmlDiv

Emits an HTML div to @{file}. Please see the attributes for real HTML div for a description of attributes charset - type.

Attributes
@{file} = the file to write the div to.
@{description} = information about calling this macrodef.

HtmlDocument

Emits an HTML html element to @{file}.

Attributes
@{file} = the file to write the html element to.
@{description} = information about calling this macrodef.

Elements
@{HtmlDocumentBody} = the body of the HTML dcoument element.

Example
@{file} = /foo/bar.html
@{name} = Theta

Result
/foo/bar.html will now contain <html>[whatever is contained in HtmlDocumentBody]</html>

HtmlElement

Emits an HTML element to file @{file}. Please note, this macrodef will not generate leaf nodes like: <Foo/> as it has no way of knowing if there are any elements (via the @{HtmlElementBody} subelement). So, this macrodef will always generate opening and closing leafs like <Foo> </Foo>

Attributes
@{file} = the file to write the attribute to.
@{name} = the name of the element.
@{description} = information about calling this macrodef.

Elements
@{HtmlAttributes} = if defined, should contain HtmlAttribute elements.
@{HtmlElementBody} = the body of the HTML element.

Example
@{file} = /foo/bar.html
@{name} = Theta

Result
/foo/bar.html will now contain <[value of @{name}] [whatever contained in HtmlAttributes]>[whatever is contained in HtmlElementBody]</[value of @{name}]>

HtmlFrame

Emits an HTML frame to @{file}. Please see the attributes for real HTML frame for a description of attributes frameborder - src.

Attributes
@{file} = the file to write the frame to.
@{description} = information about calling this macrodef.

HtmlFrameSet

Emits an HTML frame set to @{file}. Please see the attributes for real HTML frame set for a description of attributes cols - rows.

Attributes
@{file} = the file to write the frame set to.
@{description} = information about calling this macrodef.

Elements
@{FrameSetBody} = The contents of the frame set.

HtmlHeader

Emits an HTML header to file @{file}.

Attributes
@{file} = the file to write the header to.
@{description} = information about calling this macrodef.

Example
@{file} = /foo/bar.html
@{number} = 1
@{text} = Hello World

Result
/foo/bar.html will now contain <h1>Hello World</h1>

HtmlLeafElement

Emits an HTML leaf element (meaning no children) to file @{file}.

Attributes
@{file} = the file to write the attribute to.
@{name} = the name of the element.
@{description} = information about calling this macrodef.

Elements
@{HtmlAttributes} = if defined, should contain HtmlAttribute elements.
@{HtmlElementBody} = the body of the HTML element.

Example
@{file} = /foo/bar.html
@{name} = Theta

Result
/foo/bar.html will now contain <[value of @{name}] [whatever contained in HtmlAttributes]>[whatever is contained in HtmlElementBody]</[value of @{name}]>

HtmlLink

Emits an HTML link to @{file}. Please see the attributes for real HTML links for a description of attributes charset - type.

Attributes
@{file} = the file to write the link to.
@{description} = information about calling this macrodef.

HtmlText

Emits text to file @{file}.

Attributes
@{file} = the file to write the text to.
@{text} = the text to emit to @{file}.
@{description} = information about calling this macrodef.

Example
@{file} = /foo/bar.html
@{text} = Theta

Result
/foo/bar.html will now contain Theta

HtmlUnorderedList

Emits an HTML unordered list to @{file}. Please see the attributes for real HTML unordered list for a description of attributes class - tabindex.

Attributes
@{file} = the file to write the unordered to.
@{description} = information about calling this macrodef.

if-dir-exists

Can determine if a directory exists, and act accordingly.

Attributes
@{dir} = the to directory examine for its existance.
@{description} = information about calling this macro.

Elements
@{then} = the block of code to execute if @{dir} exists.
@{else} = the block of code to execute if @{dir} does not exist.

if-file-exists

Can determine if a file exists, and act accordingly.

Attributes
@{file} = the to file examine for its existance.
@{description} = information about calling this macro.

Elements
@{then} = the block of code to execute if @{file} exists.
@{else} = the block of code to execute if @{file} does not exist.

install-tar-bz2

Downloads and unpacks a tar.bz2.

Attributes
@{url} = the name of the directory that should exist.
@{download-dir} = directory to perform download
@{download-file} = file name of @{url} for download
@{install-dir} = installation directory
@{description} = information about calling this macro.

Elements
@{depends} = All dependency work should be placed within this element.

install-tar-gz

Downloads and unpacks a tar.gz.

Attributes
@{url} = the name of the directory that should exist.
@{download-dir} = directory to perform download
@{download-file} = file name of @{url} for download
@{install-dir} = installation directory
@{description} = information about calling this macro.

Elements
@{depends} = All dependency work should be placed within this element.

javacc2java

Defines a simpler javacc - acting similar to javacc. One does not need to specify each and every JavaCC file - simply provide a "root" or @{src-dir} location from which to start finding javacc files for invocation with the javacc task. The branch directory from @{dest-dir} is computed from @{src-dir} and the javacc files found.

Attributes
@{src-dir} = the directory from which to start searching for javacc files.
@{javacc-home} = the directory containing JavaCC.
@{dest-dir} = the directory where javacc should generate - this is really the root directory from which javacc generation will be relative.
@{static} = static generation flag for javacc.
@{listfiles} = if set to true, information will be displayed as to which files are being javacc'd.
@{description} = information about calling this macro.

Example
@{src-dir} = /foo/bar
@{dest-dir} = /beta/theta
javacc file found at /foo/bar/alpha/zeta/SomeFile.jj

Result
javacc generation will occur to /beta/theta/alpha/zeta

lib-install-file

Install a library file from an application.

Attributes
@{url} = the name of the directory that should exist.
@{download-dir} = directory to perform download
@{download-file} = file name of @{url} for download
@{lib-dir} = library directory where @{includes} will be copied
@{description} = information about calling this macro.

Elements
@{depends} = All dependency work should be placed within this element.

lib-install-tar-bz2

Install a library from an application. Library is in tar.bz2 format.

Attributes
@{url} = the name of the directory that should exist.
@{download-dir} = directory to perform download
@{download-file} = file name of @{url} for download
@{install-dir} = installation directory
@{lib-dir} = library directory where @{includes} will be copied
@{description} = information about calling this macro.

Elements
@{includes} = Resource collection from @{install-dir} that will be copied to !{lib-dir}.
@{depends} = All dependency work should be placed within this element.

lib-install-tar-gz

Install a library from an application. Library is in tar.gz format.

Attributes
@{url} = the name of the directory that should exist.
@{download-dir} = directory to perform download
@{download-file} = file name of @{url} for download
@{install-dir} = installation directory
@{lib-dir} = library directory where @{includes} will be copied
@{description} = information about calling this macro.

Elements
@{includes} = Resource collection from @{install-dir} that will be copied to !{lib-dir}.
@{depends} = All dependency work should be placed within this element.

lib-install-zip

Install a library from an application. Library is in zip format.

Attributes
@{url} = the name of the directory that should exist.
@{download-dir} = directory to perform download
@{download-file} = file name of @{url} for download
@{install-dir} = installation directory
@{lib-dir} = library directory where @{includes} will be copied
@{description} = information about calling this macro.

Elements
@{includes} = Resource collection from @{install-dir} that will be copied to !{lib-dir}.
@{depends} = All dependency work should be placed within this element.

load-file

This will load a file into a property. If @{property} was already set, it will be overridden.

Attributes
@{src-file} = the location of the file to load and store in @{property}.
@{property} = the property to hold @{src-file}.
@{description} = information about calling this macro.

NavDef

Emits two HTML files - one containing a table of contents, the other containing a frameset that holds both contents and a table of contents (left pane).

Attributes
@{main-file} = the main file containing the frameset.
@{cols} = the cols attribute of the frameset.
@{toc-file} = the table of contents file.
@{toc-title} = the header (title) for the table of contents.
@{toc-name} = the name of the frame that holds the table of contents.
@{content-name} = the name of the frame that holds the contents.
@{description} = information about calling this macrodef.

Elements
@{NavDefBody} = contents of the navdef.

NavItem

Emits an HTML anchor and break to @{toc-file}. Should be used in conjunction with NavDef.

Attributes
@{toc-file} = the file to write the anchor and break to.
@{text} = text of the HTML anchor.
@{href} = link for the HTML anchor.
@{target} = target of the HTML anchor.
@{description} = information about calling this macrodef.

NavItemIndent

Emits an HTML anchor and break to @{toc-file}. Should be used in conjunction with NavDef.

Attributes
@{toc-file} = the file to write the anchor and break to.
@{text} = text of the HTML anchor.
@{href} = link for the HTML anchor.
@{target} = target of the HTML anchor.
@{description} = information about calling this macrodef.

number-compare

This implements a simplistic switch/case for comparing two numbers - less than, greater than or equal to. Execution will occur based on the comparison. For instance, if the two args are equal and an equal child element is defined, execution will happen for that block.

Attributes
@{arg1} = compared against @{arg2}.
@{arg2} = compared against @{arg1}.
@{description} = information about calling this macro.

Elements
@{equal} = the block of code to execute if @{arg1} = @{arg2}.
@{not-equal} = the block of code to execute if @{arg1} != @{arg2}.
@{less} = the block of code to execute if @{arg1} < @{arg2}.
@{greater} = the block of code to execute if @{arg1} > @{arg2}.

print-ref-id

Print the contents of @{ref-id} to the console.

Attributes
@{refid} = the name of the ref id to display.
@{indent} = string to use for indenting the contents of refid.
@{error-msg} = when printing @{ref-id}, if a directory does not exist, an error is raised by Ant. Instead of that error being displayed, the value of @{error-msg} is displayed instead.
@{description} = information about calling this macro.

process-list

This allows one to iterate over a list/files and for each element in the list, have the previous, current and next elements set in the properties named in @{previous}, @{current} and @{next}.

Attributes
@{list} = list to process.
@{delimiter} = separator for elements in @{list}.
@{previous} = name of property that will hold the previous element.
@{current} = name of property that will hold the current element.
@{next} = name of property that will hold the next element.
@{description} = information about calling this macro.

Elements
@{path} = should hold a file list to process.
@{process} = called for each iteration of elements in the list. The various elements can be accessed via the properties named in @{previous}, @{current} and @{next}.

property-default

Give the property @{property} the value @{value} if @{property} has not been set. This macrodef is library agnostic - it requires no third party libraries.

Attributes
@{dir} = the name of the directory that should exist.
@{error-msg} = the message to display if @{dir} does not exist.
@{description} = information about calling this macro.

release

This will create a release that will have a tar, zip, bzip and gzip files.

Attributes
@{dir} = the directory to create the release files.
@{stage-dir} = the staging directory where the created release files will be copied when completed.
@{base-file} = the base name of the tar, zip, bzip and gzip files.
@{base-dir} = Directory name where the release when unpacked will reside.
@{description} = information about calling this macro.

Elements
@{pre-processing} = will perform any pre-processing before the release is created.
@{pre-stage-processing} = will perform an pre-stage processing before copying files.
@{release-fileset} = should contain a fileset that will include all release files.
@{post-stage-processing} = will perform an post-stage processing before tar'ing/gzip/bzip/zip work.
@{post-processing} = will perform any post-processing after the release is created.

set-property

Forces a property to be set regardless if it currently is set.

Attributes
@{property} = the name of the property to set.
@{value} = the value to set the property to set.
@{is-warnable} = a flag, if true states a warning should be displayed - anything else no warning is outputted.
@{warning-msg} = if set to anything and the property named, property, is set, will echo the value of this param. Please note, the property will still be set.
@{description} = information about calling this macro.

svn2html

Generates/converts Subversion output to HTML.

Attributes
@{src-dir} = The base directory in which to gather Subversion log information.
@{dest-dir} = The directory in which the transformation will occur.
@{log-file} = The file that will contain the outputted XML.
@{html-file} = The file that will contain HTML conversion from @{log-file}.
@{rev-start} = The Subversion starting revision number.
@{rev-end} = The Subversion ending revision number.
@{rev-end} = The version number/value to include in the heading.
@{version} = the version number/value to include in the heading.
@{description} = information about calling this macro.

svn-xml-log

This will extract the log information from subversion to XML format.

Attributes
@{dir} = the directory in which to start gather log information
@{file} = the file that will contain the outputted XML.
@{rev-start} = the starting revision number.
@{rev-end} = the ending revision number.
@{description} = information about calling this macro.

truncate-file-extension

Truncates the file extension from @{file}.

Attributes
@{file} = the name of the file whose extension will be truncated.
@{property} = the name of the property to set.
@{description} = information about calling this macro.

unpack

Unpacks tar.bz2, tar.gz and zip files - all in one convenient macrodef.

Attributes
@{file} = the file to unpack.
@{uncompress-dir} = the directory where @{file} may uncompress before unpacking.
@{unpack-dir} = the directory where the unpacked file will be expanded.
@{clean-up} = if yes or true (case insensitive), any intermediary files will be removed (for example tar files).
@{description} = information about calling this macro.

unpack-bz2

Unpacks tar.bz2 files.

Attributes
@{bz2-file} = the file to unpack.
@{bunzip-dir} = the directory where @{bz2-file} will be unpacked containing as a tar file.
@{untar-dir} = the directory where @{bz2-file}'s tar file will be unpacked.
@{clean-up} = if yes or true (case insensitive) will remove the gz and tar file.
@{description} = information about calling this macro.

unpack-gz

Unpacks tar.gz files.

Attributes
@{gz-file} = the file to unpack.
@{gunzip-dir} = the directory where @{gz-file} will be unpacked containing as a tar file.
@{untar-dir} = the directory where @{gz-file}'s tar file will be unpacked.
@{clean-up} = if yes or true (case insensitive) will remove the bz2 and tar file.
@{description} = information about calling this macro.

unpack-tar

Unpacks tar files.

Attributes
@{tar-file} = the file to untar.
@{untar-dir} = the directory where @{tar-file}'s file will be untar'd.
@{clean-up} = if yes or true (case insensitive) will remove the tar file.
@{description} = information about calling this macro.

unpack-zip

Unpacks zip files.

Attributes
@{zip-file} = the file to unpack.
@{unzip-dir} = the directory where @{zip-file} will be unpacked.
@{clean-up} = if yes or true (case insensitive) will remove the zip file.
@{description} = information about calling this macro.

Script Definition Details

compute-file-modification-date

Computes the modification date of @{file} and stores in the property denoted as @{property}.

Attributes
@{file} = the name of the file for which the modification date is desired.`
@{property} = the name of the property to store the modification date or empty if @{file} does not exist.

compute-locale

Computes the locale of the current JVM to the property define as @{property}.

Attributes
@{property} = the name of the property to set to the locale of the current JVM.

replace-url

Replaces all ftp and http URL's to actual links. So, if a file contains no HTML "a" href's (meaning just inline static text), this script will convert that to an actual "a" href.

Attributes
@{file} = fully qualified file name of a file containing non "a" ref URL's.

Target Detail

keros.print-properties

Project Level
keros.build.HOME
keros.project.HOME
keros.properties.FILE
keros.VERSION
keros.state.HOME
keros.version.HOME
keros.ant.HOME
keros.HOME
keros.lib.DIR_NAME
keros.dependency.HOME
keros.lib.HOME
keros.lib.HOME
keros.lib.HOME
keros.lib.HOME
keros.doc.DIR_NAME
keros.resources.DIR_NAME
keros.xsl.DIR_NAME
keros.xsd.DIR_NAME
keros.doc.HOME
keros.resources.HOME
keros.xsl.HOME
keros.xsd.HOME
keros.ivy.HOME
keros.find-bugs.HOME
keros.LOCALE
keros.locale.HOME

Macrodef(s)
property-default
@{name}
install-tar-bz2
install-tar-gz
lib-install-file
lib-install-tar-bz2
lib-install-tar-gz
lib-install-zip
compute-class-branch
@{property}
compute-class-info
@{dir-property}
@{file-property}
keros.compute-class-info.COMPUTE_CLASS_INFO
keros.compute-class-info.COMPUTE_CLASS_INFO_DIR
@{file-property}
@{dir-property}
svn-xml-log
keros.svn-xml-log.SVN_LOG_DIR
keros.svn-xml-log.SVN_LOG_DIR
release
antDoc
ant2html
svn2html
assert-dir-exists
assert-file-exists
compute-branch
keros.compute-branch.COMPUTE_BRANCH
@{property}
auto-property
@{property}
@{property}
set-property
@{property}
conditional-set-property
@{name}
@{name}
equality-set-property
@{name}
@{name}
for
@{property}
@{property}
copy-dir
copy-ref-id
copy
load-file
@{property}
@{property}
console-input
keros.console-input.PROMPT_MSG
keros.console-input.DEFAULT_VALUE
@{property}
execute-java-app
keros.execute-java-app.CLASS_PROPERTY_ERROR_MSG
@{class-property}
@{args-property}
print-ref-id
if-dir-exists
if-file-exists
dirname
@{property}
@{property}
@{property}
@{property}
basename
@{property}
@{property}
@{property}
@{property}
compute-file-extension
keros.compute-file-extension.@{property}
keros.compute-file-extension.@{property}
@{property}
truncate-file-extension
keros.truncate-file-extension.@{property}
keros.truncate-file-extension.@{property}
@{property}
delete-file
unpack-tar
unpack-bz2
keros.unpack-bz2.TAR_FILE_NAME
unpack-gz
keros.unpack-gz.TAR_FILE_NAME
unpack-zip
unpack
keros.unpack.UNPACK_EXTENSION
assert-equal
assert-not-equal
assert-is-number
keros.assert-is-number.ASSERT_IS_NUMBER
assert-ref-id
compute-number-left-trim
@{property}
compute-number-right-trim
@{property}
@{property}
compute-number-trim
@{property}
@{property}
compute-timestamp
keros.compute-timestamp.COMPUTE_TIMESTAMP
@{property}
compute-replacement
keros.compute-replacement.REPLACE_CHARS_REGEX
@{property}
number-compare
process-list
@{previous}
@{current}
@{next}
@{current}
@{next}
@{previous}
@{current}
@{next}
javacc2java
keros.javacc2java.JAVACC_DEST_DIR_BRANCH
keros.javacc2java.JAVACC_GENERATED_DIR
HtmlAttribute
HtmlElement
HtmlLeafElement
HtmlText
HtmlDocument
HtmlBreak
HtmlHeader
HtmlAnchor
HtmlUnorderedList
HtmlDiv
HtmlLink
HtmlFrame
HtmlFrameSet
NavItem
NavItemIndent
NavDef

Target(s)
keros.print-properties