sourCEntral - mobile manpages

pdf

ALLEGRO

NAME

allegro-makedoc - script to generate Allegro documentation

SYNOPSIS

allegro-makedoc [−ascii OUTFILE] [−html OUTFILE|−htm OUTFILE] [−texi OUTFILE|−txi OUTFILE] [−rtf OUTFILE] [−man OUTFILE] [−part] [−warn] INFILE

DESCRIPTION

allegro-makedoc is the Allegro library’s documentation generator. It simplifies producing the documentation in various formats (ASCII, HTML, TexInfo, and RTF). It converts from a weird layout that is basically a kind of stripped down HTML with a few extra markers (the _tx files), and automates a few things like constructing indexes and splitting HTML files into multiple parts.

Be warned that allegro-makedoc is not pretty, elegant, or well written, and is liable to get upset if it doesn’t like the input data.

EXAMPLE

allegro-makedoc -html output.html -ascii output.txt input._tx

Reads input._tx and output an HTML documentation to output.html and an ASCII documentation to output.txt.

OPTIONS

allegro-makedoc accepts the following options:

−part

Partial output.

−warn

Output warning messages.

−html OUTFILE, −htm OUTFILE

Output HTML documentation to OUTFILE. If no file extension is provided, .html or .htm will be used, depending on the flag used.

−texi OUTFILE, −txi OUTFILE

Output TexInfo documentation to OUTFILE. If no file extension is provided,
.texi or .txi will be used, depending on the flag used.

−rtf OUTFILE

Output RTF documentation to OUTFILE.

−man OUTFILE

Output documentation in manual page format to OUTFILE.

SEE ALSO

allegro-dev-tools(1)
The allegro info entry

COPYRIGHT

This manual page was written by Sam Hocevar <sam AT zoy DOT org> for the Debian system (but may be used by others).

pdf