From e8acf2f07558f234b317a5acb2b4169272a2218d Mon Sep 17 00:00:00 2001 From: Matthew Jason Benson Date: Wed, 31 Mar 2004 21:47:42 +0000 Subject: [PATCH] Forgot manual page. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@276269 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTypes/redirector.html | 149 ++++++++++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 docs/manual/CoreTypes/redirector.html diff --git a/docs/manual/CoreTypes/redirector.html b/docs/manual/CoreTypes/redirector.html new file mode 100644 index 000000000..45ccec4c9 --- /dev/null +++ b/docs/manual/CoreTypes/redirector.html @@ -0,0 +1,149 @@ + + + + +Redirector Type + + + + +

I/O redirection

+

For many tasks, input and output can be defined in a fairly +straightforward fashion. The exec +task, used to execute an external process, stands as a very +basic example. The executed process may accept input, produce +output, or do either or both depending upon various circumstances. +Output may be classified as "output" or as "error +output." The <redirector> type provides a concrete means +of redirecting input and output featuring the use of +File Mappers to specify +source (input) and destination (output/error) files. Since Ant 1.6.2 +

The <redirector> element accepts the following attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
outputName of a file to which to write the output. If the error stream + is not also redirected to a file or property, it will appear in this output.No
errorThe file to which the standard error of the + command should be redirected.No
logErrorThis attribute is used when you wish to see error output in Ant's + log and you are redirecting output to a file/property. The error + output will not be included in the output file/property. If you + redirect error with the error or errorProperty + attributes, this will have no effect.No
appendWhether output and error files should be appended to or overwritten. + Defaults to false.No
createemptyfilesWhether output and error files should be created even when empty. + Defaults to true.No
outputpropertyThe name of a property in which the output of the + command should be stored. Unless the error stream is redirected to a separate + file or stream, this property will include the error output.No
errorpropertyThe name of a property in which the standard error of the + command should be stored.No
inputA file from which the executed command's standard input + is taken. This attribute is mutually exclusive with the + inputstring attribute.No
inputstringA string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input attribute.No
inputencodingThe input encoding.No
outputencodingThe output encoding.No
errorencodingThe error encoding.No
+

Parameters specified as nested elements

+

inputmapper

+

A single File Mapper used to redirect process +input. Multiple mapping results should concatenate all mapped files as input. +Mapping will ordinarily be performed on a task-specified sourcefile; +consult the documentation of the individual task for more details. +A nested <inputmapper> is not compatible with either of the +input or inputstring attributes.

+

outputmapper

+

A single File Mapper used to redirect process +output. Mapping will ordinarily be performed on a task-specified sourcefile; +consult the documentation of the individual task for more details. +A nested <outputmapper> is not compatible with the +output attribute.

+

errormapper

+

A single File Mapper used to redirect error +output. Mapping will ordinarily be performed on a task-specified sourcefile; +consult the documentation of the individual task for more details. +A nested <errormapper> is not compatible with the +error attribute.

+

inputfilterchain

+

One or more FilterChains can be +applied to the process input.

+

outputfilterchain

+

One or more FilterChains can be +applied to the process output.

+

errorfilterchain

+

One or more FilterChains can be +applied to the error output.

+

Usage

+Tasks known to support I/O redirection: + +

The expected behavior of a <redirector> is to a great degree +dependent on the supporting task. Any possible points of confusion +should be noted at the task level. +

+

Copyright © 2004 The Apache Software Foundation. All rights +Reserved.

+ + + +