fpc/docs
2000-03-04 07:47:28 +00:00
..
buttons + Inistial implementation 1999-02-03 13:40:58 +00:00
crtex
dosex
go32ex + Removed underscores from filenames. 1999-06-04 19:29:47 +00:00
heapex
ipcex Initial implementation of IPC docs 1999-01-14 15:43:52 +00:00
linuxex + Added ex59 1999-11-14 20:01:36 +00:00
mouseex
objectex Added examples 27-40 1999-01-17 15:08:43 +00:00
old * html creation works again 1999-06-03 00:06:42 +00:00
optex
packages Initial import 2000-02-28 08:49:09 +00:00
pics * optimzed the gif pictures 2000-03-03 14:34:44 +00:00
printex
refex * Changes after comments translator 2000-01-19 22:21:37 +00:00
search * htmlzip,htmzip,htmltar updates 1999-06-15 13:53:16 +00:00
sockex * Added shutdown() call before close 2000-01-21 09:15:38 +00:00
stringex
syntax + Fixed typo 1999-12-20 18:49:06 +00:00
sysutex + Added last examples 1999-06-05 10:49:59 +00:00
.latex2html-init + Installed javascript in top navigation panel 1999-02-12 12:53:33 +00:00
classchart.ps + Added /lclonly command and iostreams 1999-11-18 21:16:42 +00:00
crt.tex + Update to version 0.19 of listings package 1999-06-25 22:12:10 +00:00
dos.tex * changed returnparameter of diskfree and disksize to int64 2000-02-21 14:11:14 +00:00
foot.sed
fpc-html.tex * fixed remark 2000-02-20 15:08:58 +00:00
fpc.sty * removed hyperref as it conflicts with latest latex2html 2000-02-26 13:43:04 +00:00
fpc.sty.doc
fpctoc.html Added search engine 1999-01-18 14:34:05 +00:00
getopts.tex + Remarks from translator 2000-01-19 22:30:50 +00:00
go32.tex + Remarks from translator 2000-01-19 22:30:50 +00:00
graph.tex
heaptrc.tex + Documented heaptrc and lineinfo 2000-02-07 11:21:06 +00:00
help1.gif + Added search page 1999-01-18 13:14:21 +00:00
help2.gif + Added search page 1999-01-18 13:14:21 +00:00
help.html + Added search page 1999-01-18 13:14:21 +00:00
ide.tex * some corrections and some new stuff 2000-03-04 07:47:28 +00:00
internal.tex * removed hyperref which is included from fpc.sty already 2000-02-26 13:41:43 +00:00
ipc.tex + Update to version 0.19 of listings package 1999-06-25 22:12:10 +00:00
linux.tex + Added pause and alarm, now all examples use FPCExample 1999-11-14 20:01:04 +00:00
linux.xpm
Makefile * htmlinstall fixes 2000-02-20 16:27:38 +00:00
makehtm
messages.tex + Remarks from translator 2000-01-19 22:30:50 +00:00
mmx.tex
mouse.tex + Update to version 0.19 of listings package 1999-06-25 22:12:10 +00:00
objects.tex + Update to version 0.19 of listings package 1999-06-25 22:12:10 +00:00
onechap.tex * Comments by Luk Vandelaer 1999-06-30 21:48:23 +00:00
pp2tex
pp2tex.bat
printer.tex + Update to version 0.19 of listings package 1999-06-25 22:12:10 +00:00
prog.tex + Meer veranderingen aan fpcmake 2000-01-21 23:48:57 +00:00
README.DOCS Makefile 1999-05-16 20:16:31 +00:00
ref.tex + Changes after remarks from Christopher Oezbek 1999-12-21 09:13:56 +00:00
reserved.tex
search.html + Added search page 1999-01-18 13:14:21 +00:00
sockets.tex + Update to version 0.19 of listings package 1999-06-25 22:12:10 +00:00
strings.tex + Update to version 0.19 of listings package 1999-06-25 22:12:10 +00:00
sysutils.tex * type reference command changes 1999-08-29 22:36:16 +00:00
tab.tex Initial implementation 2000-01-19 22:32:04 +00:00
TODO
units.tex * removed hyperref which is included from fpc.sty already 2000-02-26 13:41:43 +00:00
user.tex + Documented heaptrc and lineinfo 2000-02-07 11:21:06 +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.