yodl(1)

NAME
yodl - main YODL converter

SYNOPSIS

yodl [-DNAME] [-IDIR] [-oFILE] [-PCMD] [-pPASS] [-t] [-v] [-w] [-h] [-lNR] [-?] inputfile[.yo] [inputfile...]

DESCRIPTION

This manual page describes the yodl program, the main converter of the YODL package. This program is used by the yodl2.... shell scripts, e.g., yodl2tex or yodl2html. The yodl program serves as the first step in the conversions.

OPTIONS

-DNAME
    Defines symbol NAME.

-IDIR
    Overrules the standard include directory (default /usr/local/lib/yodl) with DIR.

-lNR
    Defines the live data policy. The default, -l0, suppresses SYSTEM and PIPETHROUGH macro usage. -l1 requires user confirmation. -l2 does not require user confirmation, but displays the macro in question. -l3 does not require confirmation and does not display the macro.

    In respect to the danger of live data (imagine someone giving you a YODL document with a SYSTEM(rm *) in it), it is suggested to use the default -l0 or optionally -l1, until a document has proven `secure'.

-oFILE
    Specifies FILE as the output file (default is stdout).

-PCMD
    `Preloads' command CMD, as if CMD was the first line of the input.

-pPASS
    Defines PASS as the maximum number of `passes'; when this number is exceeded, yodl aborts.

-t  Enables tracing mode. Useful for debugging.

-v  Raises the verbosity mode. Useful for debugging.

-w  Enables warning. When enabled, yodl will warn when it sees inconsistencies.

-h, -?
    Shows usage information.

inputfile
    File to process, use - to instruct yodl to read from stdin.

FILES

The yodl program requires no files, but `normal' usage of the YODL package requires macro files installed in /usr/local/lib/yodl. The files in this directory are included by the converters yodl2txt etc..

SEE ALSO

o   yodlconverters(1): information on yodl2tex, yodl2html, yodl2man, etc., these are the conversion programs for specific destination formats LaTeX, HTML, man, ...

o   yodlmacros(7): short description of the macros of the converters.

o   yodlmanpage(7): specific description of the manpage document type.

DIAGNOSTICS

Warnings and errors of yodl are too many to enumerate, but all errors are printed to stderr after which yodl exits with a non-zero status.

BUGS

There may be bugs in the yodl program, but that's not very likely. More likely you'll encounter bugs or omissions in the macro package itself.

AUTHOR

Karel Kubat (karel@icce.rug.nl)