fpc/docs
1999-05-20 15:32:05 +00:00
..
buttons + Inistial implementation 1999-02-03 13:40:58 +00:00
crtex Final changes before release 1998-09-09 16:54:14 +00:00
dosex moved to main dir 1998-09-08 12:40:51 +00:00
go32ex - tex files 1998-09-10 16:36:33 +00:00
heapex removed underscores 1998-12-15 23:59:59 +00:00
ipcex Initial implementation of IPC docs 1999-01-14 15:43:52 +00:00
linuxex POpen opened files should not be rewritten 1999-04-25 19:24:27 +00:00
mouseex moved to main dir 1998-09-08 12:40:51 +00:00
objectex Added examples 27-40 1999-01-17 15:08:43 +00:00
optex Final changes before release 1998-09-09 16:54:14 +00:00
packages + Initial implementation 1998-09-21 10:22:15 +00:00
pics
printex moved to main dir 1998-09-08 12:40:51 +00:00
refex Added library example 1998-12-30 22:05:41 +00:00
search Initial version 1999-02-16 18:56:24 +00:00
sockex moved to main dir 1998-09-08 12:40:51 +00:00
stringex minor fixes 1998-09-08 12:42:46 +00:00
syntax + reoved extra empty environment 1998-12-30 22:10:24 +00:00
sysutex * small type fixed 1999-05-19 16:45:36 +00:00
.latex2html-init + Installed javascript in top navigation panel 1999-02-12 12:53:33 +00:00
a4.sty + init 1999-05-04 10:42:40 +00:00
classchart.ps + A few adaptations, all implemented classes should be there 1998-10-04 13:37:50 +00:00
crt.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
date.inc + init 1999-05-04 10:42:40 +00:00
dos.tex Makefile 1999-05-16 20:16:31 +00:00
foot.sed
fpc-html.tex * Last-minute changes so it can be texed 1999-02-12 14:14:56 +00:00
fpc.perl
fpc.sty Makefile 1999-05-16 20:16:31 +00:00
fpc.sty.doc
fpcman.sty Makefile 1999-05-16 20:16:31 +00:00
fpctoc.html Added search engine 1999-01-18 14:34:05 +00:00
getopts.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
go32.tex Makefile 1999-05-16 20:16:31 +00:00
graph.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
heaptrc.tex * Some updates 1998-12-15 23:50:51 +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
html.sty
internal.tex * some stuff to the overview added 1998-09-20 23:52:34 +00:00
ipc.tex + Documented shared memory 1999-01-17 21:11:06 +00:00
linux.tex * Added remark that popen opened files should not be reset 1999-04-25 19:28:02 +00:00
linux.xpm + Initial implementation 1998-11-17 23:49:24 +00:00
lstdelphi.sty + Initial impelmentation 1998-11-17 23:47:53 +00:00
lstfpc.sty + Initial impelmentation 1998-11-17 23:47:53 +00:00
lsttp.sty + Initial impelmentation 1998-11-17 23:47:53 +00:00
Makefile + Added sysutils 1999-04-10 14:57:43 +00:00
makehtm
messages.tex * new messages file generated. 1999-04-10 14:45:57 +00:00
mmx.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
mouse.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
objects.tex * Completed TStringList and TStrListMaker objects 1999-04-10 21:36:56 +00:00
onechap.tex Makefile 1999-05-16 20:16:31 +00:00
pp2tex + correct executable mode 1998-09-10 16:37:46 +00:00
pp2tex.bat
printer.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
prog.tex + Added appendix on compiling the compiler 1999-05-20 15:32:05 +00:00
README.DOCS Makefile 1999-05-16 20:16:31 +00:00
ref.tex Makefile 1999-05-16 20:16:31 +00:00
reserved.tex + Fixed remarks by Alexander stohr 1998-10-20 22:14:49 +00:00
search.html + Added search page 1999-01-18 13:14:21 +00:00
sockets.tex Makefile 1999-05-16 20:16:31 +00:00
strings.tex Makefile 1999-05-16 20:16:31 +00:00
sysutils.tex Makefile 1999-05-16 20:16:31 +00:00
TODO
units.tex Makefile 1999-05-16 20:16:31 +00:00
user.tex Makefile 1999-05-16 20:16:31 +00:00
win.xpm + Initial implementation 1998-11-17 23:49:24 +00:00

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.