<html>
<HEAD>
<TITLE>PipeStream Module</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFF88" TEXT="#000000" LINK="#3333AA" VLINK="#6666FF"> 

<H2>
<A NAME="PipeStream">PipeStream</A>
</H2>
A PipeStream element executes a specified shell command line.  The command
can accept (stdio) data from the input connector, and send (stdout) data
to the output connector.  The command can be executed on demand, by
panel button or trigger input, or can run repeatedly.

<h4>
Inputs
</h4>
<UL Type="none">
<LI> <B>Input</B> -- accepts data (text or bytes) packets as stdio input.
<LI> <B>Trigger Run</B> -- <i>any</i> packet arriving will trigger the command.
</UL>
<h4>
Outputs
</h4>
<UL Type="none">
<LI> <B>Output</B> -- stdout data from the command (packetization may be
arbitrary).
<LI> <B>Input</B> -- Pass-through of arriving input packets.
<LI> <B>Trigger Run</B> -- Pass-through of all packets on trigger input.
</UL>
<P>
<h4>
Control Panel
</h4>
<UL Type="none">
<LI> Text Entry: <B>Command:</B> -- The (shell-style) command line to run.
<LI> Text Entry: <B>Directory:</B> -- The current directory the command will run in.
<LI> Button: <B>Run</B> -- Start the command.
<LI> Button: <B>Stop</B> -- Abort a running command (sends Ctrl-C). Resets
<B>Auto Restart</B> mode to <B>Normal</B>.
<LI> Indicator: <B>Stopped/RUNNING</B> -- Shows current state.
<LI>Popup menu selects the mode:
<UL Type="none">
<LI> <B>Normal</B> -- Command will run once when started; will be terminated
by End-of-Data arriving on the Input.
<LI> <B>Ignore E-O-D</B> -- As Normal, but End-of-Data does not end command. 
<LI> <B>Auto Restart</B> -- Command will be restarted when it terminates.
</UL>
<LI> Button: <B>Dir</B> -- Browse to select entry for Directory.
</UL>
<P>
<BR>

For more information, see
<A HREF="../../Documentation/StreamWeaver_Modules.html#PipeStream">StreamWeaver_Modules.html</A>
in the documentation folder.
<BR>
</body>
</html>
