fpc/docs
2004-09-18 16:58:03 +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 * template updated 2004-07-18 19:26:59 +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 * more architecture independance 2004-07-17 21:43:08 +00:00
objectex * more architecture independance 2004-07-17 21:43:08 +00:00
old
optex * more architecture independance 2004-07-17 21:43:08 +00:00
packages
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
styles
syntax + Added threadvars keyword and varargs modifier 2004-05-18 22:04:29 +00:00
sysutex * more architecture independance 2004-07-17 21:43:08 +00:00
typinfex * more architecture independance 2004-07-17 21:43:08 +00:00
videoex * fix for architecture dependance 2004-07-17 21:41:45 +00:00
.latex2html-init
chart.tex + First page no longer empty 2004-05-23 14:47:48 +00:00
classchart.ps
classes.xml
convert.sed + Initial check-in 2004-08-29 15:35:21 +00:00
crt.tex
crt.xml + Initial check-in 2004-09-09 20:17:07 +00:00
dateutils.xml + initial check-in 2004-08-29 15:34:16 +00:00
dos.tex * overloaded ExecuteProcess added, EnvStr param changed to longint 2004-02-15 21:26:36 +00:00
dos.xml + Initial check-in 2004-09-09 20:17:07 +00:00
dxeload.tex
dxeload.xml + Initial check-in 2004-09-13 19:30:56 +00:00
emu387.tex
emu387.xml + Initial check-in 2004-09-13 19:30:56 +00:00
fakehtml.sty
fcl.tex
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.tex
getopts.xml + better unit description 2004-09-13 19:27:49 +00:00
go32.tex
gpm.tex
gpm.xml + initial check-in 2004-09-18 16:58:03 +00:00
graph.tex + Many changes for 2.0 beta 2003-11-16 00:03:03 +00:00
gtk1.tex
gtk2.tex
gtk3.tex
gtk4.tex
gtk5.tex
heaptrc.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.tex
ipc.xml + better unit description 2004-09-13 19:27:49 +00:00
keyboard.tex + Fixed some glitch when creating HTML 2004-01-03 16:30:04 +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.tex
linux.xpm
Makefile * x86 dependancy fixed, reported by Claviola 2004-07-17 21:00:21 +00:00
Makefile.4ht + Many changes for 2.0 beta 2003-11-16 00:03:03 +00:00
Makefile.hev
Makefile.l2h + Many changes for 2.0 beta 2003-11-16 00:03:03 +00:00
makehtm
math.tex
messages.tex
mkkeytab.pp
mmx.tex
mmx.xml + better unit description 2004-09-13 19:27:49 +00:00
mouse.tex
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.tex
objects.xml + better unit description 2004-09-13 19:27:49 +00:00
onechap.tex
options.tex
ports.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
preamble.ts3
preamble.ts4
printer.tex
printer.xml + better unit description 2004-09-13 19:27:49 +00:00
prog.tex + Small nuance in thread availability 2004-05-27 22:05:50 +00:00
README.DOCS
ref.tex Fixed typo, bug #3319 2004-09-13 19:03:04 +00:00
reserved.tex
search.html
sockets.tex
sockets.xml + Initial check-in 2004-09-09 20:17:07 +00:00
strings.tex
strings.xml + backslashes removed 2004-09-01 19:06:19 +00:00
strutils.xml + Initial implementation 2004-07-25 22:37:59 +00:00
systhrds.xml + Initial implementation 2004-07-25 22:37:59 +00:00
sysutils.tex + Many changes for 2.0 beta 2003-11-16 00:03:03 +00:00
sysutils.xml + All PChar routines documented, and backslashes removed 2004-09-01 19:05:09 +00:00
table.eps
table.fig
tex2htex
tex4ht.env
TODO
typinfo.tex
typinfo.xml + better unit description 2004-09-13 19:27:49 +00:00
units.tex + Updates for 1.9.4. Mostly MACPas related 2004-05-18 22:10:56 +00:00
user.tex + Updates for 1.9.4. Mostly MACPas related 2004-05-18 22:10:56 +00:00
video.tex
video.xml + Initial check-in 2004-09-09 20:17:07 +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.