eddie-0.5.1: eddie.1

.TH "eddie" "1" "" "" ""
.SH NAME
.PP
eddie \- run haskell filters from the command line
.SH SYNOPSYS
.PP
\f[B]eddie\f[] [ \f[I]options\f[] ] [ \f[I]expr\f[] ] \f[I]file\f[] ...
.SH DESCRIPTION
.PP
\f[B]eddie\f[] evalutes the provided \f[I]expression\f[] on either the
contents of \f[I]the file\f[] arguments concatenated together, or
standard input if no *file arguments are present.
.PP
The \f[B]\-\-line\f[], \f[B]\-\-file\f[] and \f[B]\-\-list\f[] options
can be used to cause \f[I]expression\f[] to be used to process each
line, each file, or a list of files or lines respectively.
.PP
The prelude, \f[C]Data.List\f[] and \f[C]Data.Char\f[] modules are
available for building expressions.
Other modules may be added with the \f[B]\-\-Modules\f[] and
\f[B]\-\-modules\f[] options.
.SH OPTIONS
.TP
.B \f[B]\-\-expr\f[]
The \f[B]\-\-expr\f[] \f[I]expr\f[] (short form \f[B]\-e\f[]
\f[I]expr\f[] ) option concatenates it\[aq]s value to the haskell
expression being evaluated with a newline separator.
Multiple occurrences can be used to build up a multi\-line expression.
.RS
.PP
If no \f[B]\-e\f[] \f[I]expr\f[] option is present, the first non\-flag
argument will be used for the haskell expression.
.RE
.TP
.B \f[B]\-\-line\f[]
The \f[B]\-\-line\f[] (short form \f[B]\-l\f[]) option causes
\f[B]eddie\f[] to process input line at a time.
The \f[I]expr\f[] will be run on each line and the results concatenated
together (using unlines).
.RS
.PP
The command
.IP
.nf
\f[C]
eddie\ \-l\ *expr\ file*\ ...
\f[]
.fi
.PP
is equivalent to the command
.IP
.nf
\f[C]
eddie\ "unlines\ .\ map\ *expr*\ \ .\ lines"\ *file*\ ...
\f[]
.fi
.RE
.TP
.B \f[B]\-\-file\f[]
The \f[B]\-\-file\f[] (short form \f[B]\-f\f[]) causes each file to be
processed individually.
.RS
.PP
Note that the \f[B]\-l\f[] and \f[B]\-f\f[] options cannot be used
together.
.RE
.TP
.B \f[B]\-\-list\f[]
The \f[B]\-\-list\f[] (short form \f[B]\-L\f[]) option causes
\f[B]eddie\f[] to pass the expression a list of lines or files.
This requires one of the \f[B]\-l\f[] or \f[B]\-f\f[] options be used.
.RS
.PP
The command
.IP
.nf
\f[C]
eddie\ \-lL\ *expr\ file*\ ...
\f[]
.fi
.PP
is equivalent to the command
.IP
.nf
\f[C]
eddie\ "unlines\ .\ *expr*\ .\ lines"\ filei\ ...
\f[]
.fi
.RE
.TP
.B \f[B]\-\-binary\f[]
The \f[B]\-\-binary\f[] (short form \f[B]\-b\f[]) option switches the
output mode to binary.
It also disables the maybe newline processing.
Normally \f[B]eddie\f[] will output a final newline if the last
character of the input is not a newline to place the prompt properly.
If the \f[B]\-b\f[] option is used, the final newline will not be
output.
.RS
.RE
.TP
.B \f[B]\-\-modules\f[]
The \f[B]\-\-modules\f[] \f[I]name\f[] (short form \f[B]\-m\f[]
\f[I]name\f[]) option is used to import module \f[I]name\f[] into
haskell before evaluating the expression.
.RS
.RE
.TP
.B \f[B]\-\-Modules\f[]
The \f[B]\-\-Modules\f[] \f[I]name\f[],\f[I]as\f[] (short form
\f[B]\-M\f[] \f[I]name\f[],\f[I]as\f[]) option imports the \f[I]name\f[]
module using a qualified import with an as clause, with \f[I]as\f[]
being the value for the as clause.
.RS
.RE
.SH DIAGNOSTICS
.PP
If the command runs with no problems, eddie will exit with a status of
0.
If there are problems with the options, such that the expression is
never evaluated, then eddie will exit with a status of 1.
If haskell returns an error \- probably a compilation problem \- then
eddie will exit with the status of 2.
.SH SEE ALSO
.PP
The wiki at <https://chiselapp.com/user/mwm/repository/eddie/wcontent>
for examples.
.SH BUGS
.PP
See the issues list at
<https://chiselapp.com/user/mwm/repository/eddie/rptview?rn=1>.
.SH AUTHOR
.PP
Mike Meyer <mwm@mired.org>