1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
WebMagick Documentation
This directory contains documentation (webmagick.texinfo) which
is written in GNU's TeXInfo format. Provided that a texinfo.tex
macro file is available, this file may be translated into a DVI
file and from there into Postscript or some other output format
for which a DVI driver exists. The GNU texinfo package (currently
at version 3.11 provides a 'makeinfo' command which translates
the TeXInfo file into 'info' format so that it may be browsed
with the stand-anone 'info' program, viewed in Emacs, or viewed
with the 'xinfo' program. High quality HTML output may be created
via Lionel Cons's 'texi2html' program which is available from the
URL "http://wwwcn.cern.ch/dci/texi2html/".
If you lack a TeX installation, use the instructions found in
`ftp://ftp.tug.org/tex/unixtex.ftp' and proceed from there. These
instructions talk about individual packages. In my experience,
obtaining and installing the packages 'texmflib.tar.gz' and
'texk-7.0.tar.gz', plus the graphicx packages (see below) provide
sufficient TeX capabilities in order to format the WebMagick
documentation (in addition to the aforementioned GNU
texinfo-3.11.tar.gz package).
In order to handle the EPS figures used throughout the document
you must install a recent dvips driver (included in texk-7.0.tar.gz)
Which may be obtained from the CTAN network.
ftp.tex.ac.uk is a represenative CPAN site with its CPAN files
rooted under "/ctan/tex-archive/". Another site is ftp.cdrom.com
with files rooted under "/pub/tex/ctan/".
If you really don't want to bother with installing TeX but want
typeset output, then look at the 'webmagick.me' target in the
Makefile which uses 'texi2roff' instead. The output is not as
nice but is seems to work ok. The 'texi2roff' program takes only
a few minutes to compile and install.
Documentation processing paths are similar to the following:
Postscript:
===========
webmagick.texinfo-->texi2dvi-->webmagick.dvi-->dvips-->webmagick.ps
The provided Postscript file is optimized for printers with the
"CX" engine which include most 300DPI HP printers and clones. If
your printer differs, you may want to generate your own
Postscript file (presuming you have a TeX installation).
Without a TeX installation Postscript can be generated via a combination
of texi2roff and groff (see the 'webmagick.me' target in the Makefile):
webmagick.texinfo-->texi2roff-->webmagick.me-->groff -me>webmagick_me.ps
Info:
=====
webmagick.texinfo-->makeinfo-->webmagick.info*
HTML:
=====
webmagick.texinfo-->texi2html-->webmagick*.html
Documentation may be viewed on line via:
o Using 'xdvi' on the DVI file
o Using 'ghostview' on the Postscript file
o Using 'info', 'xinfo', or 'emacs' on the Info file
o Using 'nroff -me' on a generated webmagick.me troff file
o Using a Web browser to view the HTML files
|