fpc/docs
1998-03-25 11:26:49 +00:00
..
crtex Initial revision 1998-03-25 11:26:49 +00:00
dosex Initial revision 1998-03-25 11:26:49 +00:00
linuxex Initial revision 1998-03-25 11:26:49 +00:00
optex Initial revision 1998-03-25 11:26:49 +00:00
printex Initial revision 1998-03-25 11:26:49 +00:00
refex Initial revision 1998-03-25 11:26:49 +00:00
sockex Initial revision 1998-03-25 11:26:49 +00:00
stringex Initial revision 1998-03-25 11:26:49 +00:00
.log Initial revision 1998-03-25 11:26:49 +00:00
crt.tex Initial revision 1998-03-25 11:26:49 +00:00
dos.tex Initial revision 1998-03-25 11:26:49 +00:00
foot.sed Initial revision 1998-03-25 11:26:49 +00:00
fpctoc.html Initial revision 1998-03-25 11:26:49 +00:00
fpk-html.tex Initial revision 1998-03-25 11:26:49 +00:00
fpk.perl Initial revision 1998-03-25 11:26:49 +00:00
fpk.sty Initial revision 1998-03-25 11:26:49 +00:00
fpk.sty.doc Initial revision 1998-03-25 11:26:49 +00:00
fpkman.sty Initial revision 1998-03-25 11:26:49 +00:00
getopts.tex Initial revision 1998-03-25 11:26:49 +00:00
go32.tex Initial revision 1998-03-25 11:26:49 +00:00
graph.tex Initial revision 1998-03-25 11:26:49 +00:00
html.sty Initial revision 1998-03-25 11:26:49 +00:00
linux.tex Initial revision 1998-03-25 11:26:49 +00:00
Makefile Initial revision 1998-03-25 11:26:49 +00:00
makehtm Initial revision 1998-03-25 11:26:49 +00:00
mmx.tex Initial revision 1998-03-25 11:26:49 +00:00
onechap.tex Initial revision 1998-03-25 11:26:49 +00:00
printer.tex Initial revision 1998-03-25 11:26:49 +00:00
prog.tex Initial revision 1998-03-25 11:26:49 +00:00
progpdf.tex Initial revision 1998-03-25 11:26:49 +00:00
README.DOCS Initial revision 1998-03-25 11:26:49 +00:00
ref.tex Initial revision 1998-03-25 11:26:49 +00:00
refpdf.tex Initial revision 1998-03-25 11:26:49 +00:00
sockets.tex Initial revision 1998-03-25 11:26:49 +00:00
strings.tex Initial revision 1998-03-25 11:26:49 +00:00
units.tex Initial revision 1998-03-25 11:26:49 +00:00
unitspdf.tex Initial revision 1998-03-25 11:26:49 +00:00
user.tex Initial revision 1998-03-25 11:26:49 +00:00
userpdf.tex Initial revision 1998-03-25 11:26:49 +00:00

This is the README for the FPK linux documentation.

All documentation is stored here, in LaTeX format. 
it uses special style files (fpk*.sty) which are also in the directory.

do a 'make dvi' to produce the dvi format of the docs.
a 'make html' will produce the html version (using latex2html).
a 'make ps' will produce PostScript documents.

If you want to produce dos docs, you can do a 'make htm' this will convert
the .htl files to .htm files (including all references), suitable for a 8:3
format.

The rest of this document is only interesting if you want to write docs.
Otherwise, you can bail out now.

THE DOCS...

Why LaTeX ? 
- because I like a printed copy of the manuals, HTML just isn't good enough 
  for this.
- I know LaTeX very well :) (mind you : html also !)
- many other reasons.

In order to translate the things to HTML, I use latex2html, since it is the
most powerful and flexible. 
For it to be able to use the fpk.sty, I had to write a fpk.perl script
which it loads. The script seems to run fine when used standalone, but in
conjunction with latex2html, I get a out of memory... ??
I'm not familiar with perl, so if someone is, and can fix the thing, please
do. (and let me know :) )

Then how to proceed ?
If you just want to write latex docs, just use fpk.sty. (you don't need
html.sty)
If you want to be able to convert to html, (you need html.sty) the following 
fixes the perl-problem :
In the preamble of  your document, type :

\usepackage{html}
\latex{\usepackage{fpk}}
\html{\input{fpk-html.tex}}

The fpk-html.tex defines the same commands as fpk.sty, only in a language
that latex2html understands.

fpk.sty.doc describes what fpk.sty does. (one day I'll integrate them using
the doc package, but I need some time for it)

Happy TeXing,
Michael.