fpc/docs
2004-12-22 08:47:31 +00:00
..
bunixex + Initial check-in 2004-10-22 21:57:33 +00:00
buttons
crtex * more architecture independance 2004-07-17 21:43:08 +00:00
dosex * running ex9.pp fixed 2004-07-18 09:49:19 +00:00
dynlibex * more architecture independance 2004-07-17 21:43:08 +00:00
go32ex * more architecture independance 2004-07-17 21:43:08 +00:00
gpmex * more architecture independance 2004-07-17 21:43:08 +00:00
graphex * more architecture independance 2004-07-17 21:43:08 +00:00
gtk1ex
gtk3ex
gtk4ex
gtk5ex
heapex * more architecture independance 2004-07-17 21:43:08 +00:00
internal
ipcex * more architecture independance 2004-07-17 21:43:08 +00:00
kbdex + Added missing translatekeyevent after getkey, thanks to Pierre Pomes 2004-09-11 14:41:26 +00:00
linuxex + Adapted to new docs 2004-10-22 21:56:57 +00:00
mathex * more architecture independance 2004-07-17 21:43:08 +00:00
mmouseex * more architecture independance 2004-07-17 21:43:08 +00:00
mouseex * use getmousebutton 2004-11-06 20:03:53 +00:00
objectex * more architecture independance 2004-07-17 21:43:08 +00:00
old
olinuxex + Initial move 2004-10-16 13:14:03 +00:00
optex * more architecture independance 2004-07-17 21:43:08 +00:00
packages + version 1.0 of listings package 2003-03-18 00:17:19 +00:00
pics * final version 2003-10-25 16:43:27 +00:00
printex * more architecture independance 2004-07-17 21:43:08 +00:00
progex * more architecture independance 2004-07-17 21:43:08 +00:00
refex * typecast to get it compiling again 2004-07-18 09:54:39 +00:00
sockex * some 1.9.x fixes 2004-07-17 22:00:37 +00:00
stringex * more architecture independance 2004-07-17 21:43:08 +00:00
strutex + initial check-in 2004-12-18 13:15:40 +00:00
styles + latest version of listings. package (1.0) 2003-03-18 00:07:22 +00:00
syntax + Added threadvars keyword and varargs modifier 2004-05-18 22:04:29 +00:00
sysutex + Changed to current dir 2004-12-14 19:38:13 +00:00
typinfex * more architecture independance 2004-07-17 21:43:08 +00:00
unixex + Initial check-in 2004-10-22 21:57:33 +00:00
unutilex + initial check-in 2004-10-22 22:00:26 +00:00
videoex * made sources nicer 2004-10-03 16:27:31 +00:00
.latex2html-init
baseunix.xml + Updates for missing identifiers 2004-12-10 00:40:16 +00:00
chart.tex + First page no longer empty 2004-05-23 14:47:48 +00:00
classchart.ps
classes.xml + Some small fixes 2004-10-19 21:31:57 +00:00
convert.sed + Some corrections 2004-12-14 21:47:36 +00:00
crt.xml + Initial check-in 2004-09-09 20:17:07 +00:00
dateutils.xml + short descriptions for unit (typo fixed) 2004-12-21 23:01:09 +00:00
dos.xml + Initial check-in 2004-09-09 20:17:07 +00:00
dxeload.xml + Some fixes 2004-10-16 16:12:36 +00:00
dynlibs.xml + Finished units 2004-10-22 20:45:36 +00:00
emu387.xml + Initial check-in 2004-09-13 19:30:56 +00:00
fakehtml.sty
fcl.tex + Initial implementation 2003-03-18 21:26:17 +00:00
foot.sed
fpc-hevea.tex
fpc-html.tex
fpc.sty + Updates for 1.9.4. Mostly MACPas related 2004-05-18 22:10:56 +00:00
fpc.sty.doc
fpctoc.html + Many changes for 2.0 beta 2003-11-16 00:03:03 +00:00
fpdoc.tex + Updated fpdoc and makeskel command-line option description 2004-08-28 18:30:39 +00:00
getopts.xml + better unit description 2004-09-13 19:27:49 +00:00
go32.xml + Some fixes 2004-10-16 16:12:36 +00:00
gpm.xml + Some fixes 2004-10-16 16:12:36 +00:00
graph.xml + Fixed complete graph unit documentation 2004-10-14 18:59:34 +00:00
gtk1.tex
gtk2.tex
gtk3.tex
gtk4.tex
gtk5.tex
heaptrc.xml + better unit description 2004-09-13 19:27:49 +00:00
ide.tex + Added note suggested by Florian that fp.dsk files may change between releases 2003-11-09 13:42:41 +00:00
internal.tex
ipc.xml + better unit description 2004-09-13 19:27:49 +00:00
keyboard.xml + better unit description 2004-09-13 19:27:49 +00:00
keys.tex + Fixed some glitch when creating HTML 2004-01-03 16:30:04 +00:00
linux.xml + Finished units 2004-10-22 20:45:36 +00:00
linux.xpm
Makefile * bsd system unit location fix. Hope it works for Darwin too 2004-12-22 08:47:31 +00:00
Makefile.4ht * fix include dependencies 2004-12-20 16:21:50 +00:00
Makefile.hev * fix include dependencies 2004-12-20 16:21:50 +00:00
Makefile.l2h + Many changes for 2.0 beta 2003-11-16 00:03:03 +00:00
makehtm.pp + added delete option 2004-12-14 21:43:08 +00:00
math.xml + Updates for missing identifiers 2004-12-10 00:40:16 +00:00
messages.tex
mkkeytab.pp
mmx.xml + better unit description 2004-09-13 19:27:49 +00:00
mouse.xml + Initial check-in 2004-09-09 20:17:07 +00:00
msmouse.tex + Many changes for 2.0 beta 2003-11-16 00:03:03 +00:00
objects.xml + better unit description 2004-09-13 19:27:49 +00:00
objpas.xml + Converted to XML 2004-12-18 13:01:16 +00:00
oldlinux.xml + Corrected example directories 2004-10-22 22:03:17 +00:00
onechap.tex
options.tex
ports.xml + better unit description 2004-09-13 19:27:49 +00:00
pp2tex
pp2tex.bat
preamble.book
preamble.hevea
preamble.html
preamble.report fpc.sty 2003-03-17 08:28:38 +00:00
preamble.ts3 + Forgot to commit 2003-03-17 17:13:21 +00:00
preamble.ts4 + Forgot to commit 2003-03-17 17:13:21 +00:00
printer.xml + Updated 2004-12-14 19:36:05 +00:00
prog.tex + Small nuance in thread availability 2004-05-27 22:05:50 +00:00
README.DOCS
ref.tex + Removed system unit stuff 2004-12-14 21:46:35 +00:00
reserved.tex
rtl.tex + initial check-in 2004-10-22 23:14:32 +00:00
search.html
sockets.xml + Updates for missing identifiers 2004-12-10 00:40:16 +00:00
strings.xml + backslashes removed 2004-09-01 19:06:19 +00:00
strutils.xml + Some fixes 2004-10-16 16:12:36 +00:00
system.xml + Updates for missing identifiers 2004-12-10 00:40:16 +00:00
systhrds.xml + Initial implementation 2004-07-25 22:37:59 +00:00
sysutils.xml + Updated 2004-12-14 19:36:05 +00:00
table.eps
table.fig
tex2htex
tex4ht.env + Better quality of images 2003-03-22 16:52:38 +00:00
TODO
typinfo.xml + Some small fixes 2004-10-19 21:31:57 +00:00
units.tex + Updates for 1.9.4. Mostly MACPas related 2004-05-18 22:10:56 +00:00
unix.xml + Updates for missing identifiers 2004-12-10 00:40:16 +00:00
unixtype.xml + initial full implementation 2004-10-17 15:34:07 +00:00
unixutil.xml + Updates for missing identifiers 2004-12-10 00:40:16 +00:00
user.tex + Updates for 1.9.4. Mostly MACPas related 2004-05-18 22:10:56 +00:00
video.xml + Initial check-in 2004-09-09 20:17:07 +00:00
win.xpm
x86.xml + Finished units 2004-10-22 20:45:36 +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.