mailto(karel@icce.rug.nl)
latexoptions(dina4)

COMMENT(
	urg, html breaks...
        (PIPETHROUGH(echo -n `date '+%d/%b/%y'|tr '[a-z]' '[A-Z]'`)())
)
manpage(yodlconverters)
       (1)
       (25AUG98)
       (The Yodl Package)
       (Yodl)

manpagename(yodl2...)(miscellaneous Yodl converters)

manpagesynopsis()

    bf(yodl2...) [OPTION]... FILE

manpagedescription()

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

    startdit()

        dit(yodl2html:) converts to HTML, writes a file with the extension
	bf(.html).

        dit(yodl2man:) converts to nroff `man' format, writes bf(.man). Can be
        further processed with e.g. bf(nroff -Tascii -man) em(file)bf(.man).
        
        dit(yodl2ms:) converts to nroff `ms' format, writes bf(.ms). Can be
        further processed with e.g. bf(nroff -T)em(format) bf(-mgs) 
        em(file)bf(.ms); em(format) being e.g., bf(ascii) or bf(ps).

        dit(yodl2sgml:) converts to SGML, writes bf(.sgml). Implemented for
        backward compatibility at our site, producing output for our `hacked 
        Linuxdoc-SGML mutant'.

        dit(yodl2tex:) converts to LaTeX output, writes bf(.tex). Can be
	further processed with, e.g., bf(latex) em(file)bf(.tex) and bf(xdvi)
	em(file)bf(.dvi). This is the most complete Yodl converter.

        dit(yodl2texinfo:) converts to texinfo, the GNU document standard. 
	writes bf(.texinfo).

        dit(yodl2txt:) converts to plain ASCII, writes bf(.txt). This is a
        very rudimentary converter, a last-resort.

    enddit()

    The following second-stage converters are also implemented:

    startdit()

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

        dit(yodl2manless:) runs bf(yodl2man), and nroff's the output, piping 
        into a `less'-like pager.
        
        dit(yodl2msless:) runs bf(yodl2ms), and nroff's the output into a 
        `less'-like pager.

    enddit()
    
    Appropriate converters for given output formats, with examples, are:
    
    startdit()
    
        dit(For plain ASCII output:) nl()
	For manual pages: bf(yodl2manless) em(file) bf(>outfile), nl()
	or gzipped: bf(yodl2manless) em(file) bf(| gzip -c >outfile.gz). nl()
        For other document types: bf(yodl2msless) em(file) bf(>outfile). nl()
        Optionally, you can pipe the tt(yodl2..less) output through
        tt(striproff) to strip ASCII control characters such as underline or
        boldface. 
    
        dit(For LaTeX and bf(.dvi) output:) nl()
	bf(yodl2tex) em(file) to write em(file)bf(.tex), or nl()
        bf(yodl2dvi) em(file) to write em(file)bf(.tex) and em(file)bf(.dvi).
        
        dit(For PostScript output:) nl()
	bf(yodl2msps) em(file), or nl()
	bf(yodl2dvi) em(file) followed by bf(dvips -o)em(file)bf(.ps)
	em(file)bf(.dvi).)
    
    enddit()

manpageoptions()

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

    includefile(../include/yodl-options)

manpagefiles()

    Each bf(yodl2)em(format) converter requires a file em(format)bf(.yo) in
    the standard include directory bf(/home/fred/usr/share/yodl). This file is 
    auto-loaded to make the conversion to em(format) possible.
    
    Each em(format)bf(.yo) file in the standard include directory expects 
    other files; e.g., bf(shared.yo), bf(aux-macros.yo).

    The output then goes to a file with an extension em(.format). 
    
    Some converters require post-processors, which are located in the standard 
    include directory and named bf(yodl2)em(format)bf(-post).

manpageseealso()
gagmacrowarning(yodl yodlmacros yodlmanpage striproff)

    startit()

        it() bf(yodl(1)): the first step converter.
        
        it() bf(yodlmacros(7)): short description of the macros of the 
        converters.

        it() bf(yodlmanpage(1)): description of the bf(manpage) document type.

        it() bf(striproff(1)): description of the tt(striproff) program.

    endit()

manpagediagnostics()

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

manpagebugs()

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

    Send bug reports and fixes to the Yodl list: email(yodl@icce.rug.nl)

manpageauthor()
Please consult the documentation file file(AUTHORS.txt) for more detailed
information, and small contributions. 

itemize(
it()nemail(Karel Kubat)(karel@icce.rug.nl)
    lurl(http://www.icce.rug.nl/karel/karel.html)
it()nemail(Jan Nieuwenhuizen)(janneke@gnu.org)
    lurl(http://www.xs4all.nl/~jantien)
)

