doc/README

   1 Printing the documentation
   2 ==========================
   3
   4 You need the following programs to generate a printable file from the
   5 LaTeX and FIG sources:
   6
   7   - LaTeX
   8   - fig2dev from the transfig package (optional)
   9
  10 The LaTeX translations of the FIG files are already included in the
  11 distribution, so you can print the documentation without fig2dev.
  12 WARNING: 'make distclean'  removes those pre-built LaTeX files.
  13
  14 You can also omit all drawings by typing  make dummies . The drawings
  15 are only necessary when processing the technical overview document.
  16
  17 To run LaTeX just type
  18
  19   make
  20
  21 LaTeX issues many "Overfull \hbox" warnings. They can be safely ignored.
  22 LaTeX will be run repeatedly until it stops issuing the message
  23 LaTeX Warning: Label(s) may have changed. Rerun to get cross-references
  24 right.
  25
  26 At the end you should get the very old documentation in user.pdf and
  27 tech.pdf.
  28
  29 Generating user.README
  30 ======================
  31
  32 Use the simple tool t2a.pl for converting to ASCII formatted (old) user
  33 documentation:
  34
  35   perl t2a.pl  <user.tex  >user.README
  36
  37 Online documentation
  38 ====================
  39
  40 The (old) documentation can also be found in the web:
  41
  42 http://lilo.alioth.debian.org/olddoc/html/user_21-5.html
  43 http://lilo.alioth.debian.org/olddoc/pdf/user_21-5.pdf
  44
  45 http://lilo.alioth.debian.org/olddoc/html/tech_21-5.html
  46 http://lilo.alioth.debian.org/olddoc/pdf/tech_21-5.pdf
  47
  48
  49 -- Joachim Wiedorn (2011)