yodl2texinfo-post1

Usage

Overview

This manual page describes the various shell scripts that convert documents in the Yodl language to other formats. The basic converters are:

yodl2html:

converts to HTML, writes a file with the extension .html.

yodl2man:

converts to nroff `man' format, writes .man. Can be further processed with e.g. nroff -Tascii -man file.man.

yodl2ms:

converts to nroff `ms' format, writes .ms. Can be further processed with e.g. nroff -Tformat -mgs file.ms; format being e.g., ascii or ps.

yodl2sgml:

converts to SGML, writes .sgml. Implemented for backward compatibility at our site, producing output for our `hacked Linuxdoc-SGML mutant'.

yodl2tex:

converts to LaTeX output, writes .tex. Can be further processed with, e.g., latex file.tex and xdvi file.dvi. This is the most complete Yodl converter.

yodl2texinfo:

converts to texinfo, the GNU document standard. writes .texinfo.

yodl2txt:

converts to plain ASCII, writes .txt. This is a very rudimentary converter, a last-resort.

The following second-stage converters are also implemented:

yodl2dvi:

runs yodl2tex, and LaTeX-es the output file. When appropriate, re-runs LaTeX to solve labels; the LaTeX job is run up to three times.

yodl2manless:

runs yodl2man, and nroff's the output, piping into a `less'-like pager.

yodl2msless:

runs yodl2ms, and nroff's the output into a `less'-like pager.

Appropriate converters for given output formats, with examples, are:

For plain ASCII output:

For manual pages: yodl2manless file >outfile,
or gzipped: yodl2manless file | gzip -c >outfile.gz.
For other document types: yodl2msless file >outfile.
Optionally, you can pipe the yodl2..less output through striproff to strip ASCII control characters such as underline or boldface.

For LaTeX and .dvi output:

yodl2tex file to write file.tex, or
yodl2dvi file to write file.tex and file.dvi.

For PostScript output:

yodl2msps file, or
yodl2dvi file followed by dvips -ofile.ps file.dvi.)

Options

The options are identical to those of the yodl program, which is the first-phase converter. Options may be:

-D, --define=NAME

define NAME as symbol, same as

DEFINESYMBOL(NAME)

-h, --help

this message

-I, --include=DIR

use directory DIR for system-wide includes files.

-l, --live-data=NR

set

live data

policy to NR [0]:
allow live data:

0:

never (the default)

1:

only when confirmed

2:

issuing warning

3:

always

-o, --output=FILE

send output to FILE instead of <stdout>

-P, --preload=CMD

preload

CMD

-p, --max-pass=NR

set the maximum number of parsing passes to NR.

-t, --trace

trace generated output to <stderr> for each parsing pass

-v, --verbose

increase verbosity (-vv...)

-W, --warranty

show warranty and copyright (It comes with NO WARRANTY!)

-w, --warn

warn about redefinitions

Files

Each yodl2format converter requires a file format.yo in the standard include directory /home/fred/usr/share/yodl. This file is auto-loaded to make the conversion to format possible.

Each format.yo file in the standard include directory expects other files; e.g., shared.yo, aux-macros.yo.

The output then goes to a file with an extension .format.

Some converters require post-processors, which are located in the standard include directory and named yodl2format-post.

Diagnostics

Warnings and errors are too many to enumerate, but all errors are printed to stderr after which the converters exit with a non-zero status.