fpc/docs
2000-01-06 12:58:00 +00:00
..
buttons
crtex
dosex
go32ex
heapex
ipcex
linuxex + Added ex59 1999-11-14 20:01:36 +00:00
mouseex
objectex
old
optex
packages
pics
printex
refex + Changes after remarks from Christopher Oezbek 1999-12-21 09:07:15 +00:00
search
sockex
stringex
syntax + Fixed typo 1999-12-20 18:49:06 +00:00
sysutex
.latex2html-init
classchart.ps + Added /lclonly command and iostreams 1999-11-18 21:16:42 +00:00
crt.tex
dos.tex
foot.sed
fpc-html.tex
fpc.sty
fpc.sty.doc
fpctoc.html
getopts.tex
go32.tex
graph.tex
heaptrc.tex
help1.gif
help2.gif
help.html
internal.tex
ipc.tex
linux.tex
linux.xpm
Makefile
makehtm
messages.tex
mmx.tex
mouse.tex
objects.tex
onechap.tex
pp2tex
pp2tex.bat
printer.tex
prog.tex * fixed typos 2000-01-06 12:58:00 +00:00
README.DOCS
ref.tex + Changes after remarks from Christopher Oezbek 1999-12-21 09:13:56 +00:00
reserved.tex
search.html
sockets.tex
strings.tex
sysutils.tex
TODO
units.tex
user.tex + CHanged after remarks from translator 1999-12-13 10:51:21 +00:00
win.xpm

This is the README for the Free Pascal documentation.

All documentation is stored here, in LaTeX format. 
it uses special style files (fpc*.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.
a 'make pdf' will produce PDF (Portable Document Format) documents.
a 'make txt' will produce plain text documents.

If you want to produce dos docs, you can do a 'make htm' this will convert
the .html 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 !)
- It converts to many other formats.
- many other reasons.

In order to translate the things to HTML, I use latex2html, since it is the
most powerful and flexible, although sluggish... 
For it to be able to use the fpc.sty, I had to write a fpc.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 fpc.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{fpc}}
\html{\input{fpc-html.tex}}

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

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

Happy TeXing,
Michael.