fpc/docs
1999-01-19 16:10:35 +00:00
..
buttons
crtex
dosex
go32ex
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 fixed assignstream example 1998-12-11 23:13:29 +00:00
mouseex
objectex Added examples 27-40 1999-01-17 15:08:43 +00:00
optex
packages
pics
printex
refex Added library example 1998-12-30 22:05:41 +00:00
sockex
stringex
syntax + reoved extra empty environment 1998-12-30 22:10:24 +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
dos.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
foot.sed
fpc-html.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
fpc.perl
fpc.sty Switched to new fpc style file 1998-12-11 23:18:50 +00:00
fpc.sty.doc
fpchelp.dct + Added search page 1999-01-18 13:14:21 +00:00
fpchelp.hsh + Added search page 1999-01-18 13:14:21 +00:00
fpchelp.ndx + Added search page 1999-01-18 13:14:21 +00:00
fpchelp.toc + Added search page 1999-01-18 13:14:21 +00:00
fpcman.sty
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 * fixed low,high for alloc_global_dos which were wrong 1998-12-28 23:43:30 +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
idksm.class + Added search page 1999-01-18 13:14:21 +00:00
idksmdlg.class + Added search page 1999-01-18 13:14:21 +00:00
idksmeng.class + Added search page 1999-01-18 13:14:21 +00:00
internal.tex
ipc.tex + Documented shared memory 1999-01-17 21:11:06 +00:00
linux.tex Switched to new fpc style file 1998-12-11 23:18:50 +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 examples 27-40 1999-01-17 15:08:43 +00:00
makehtm
messages.tex
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 Added examples 27-40 1999-01-17 15:08:43 +00:00
onechap.tex + PDF changes 1999-01-18 13:48:38 +00:00
onepdf.tex + PDF changes 1999-01-18 13:48:38 +00:00
pp2tex
pp2tex.bat
printer.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
prog.tex * as of 0.99.11, pascal code surrounding assembler blocks is optimized 1999-01-19 16:10:35 +00:00
progpdf.tex + PDF changes 1999-01-18 13:48:38 +00:00
README.DOCS
ref.tex Library and ansistring documentation 1998-12-30 22:03:49 +00:00
refpdf.tex + PDF changes 1999-01-18 13:48:38 +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 Switched to new fpc style file 1998-12-11 23:18:50 +00:00
strings.tex Switched to new fpc style file 1998-12-11 23:18:50 +00:00
TODO
units.tex + Added ipc chapter 1999-01-17 21:18:52 +00:00
unitspdf.tex + PDF changes 1999-01-18 13:48:38 +00:00
user.tex * fixed profiler section 1999-01-15 13:23:45 +00:00
userpdf.tex + PDF changes 1999-01-18 13:48:38 +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.

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 !)
- 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.