fpc/docs
2003-05-29 10:25:51 +00:00
..
buttons * binary flag 2001-10-18 21:42:37 +00:00
crtex + Better example 2003-01-05 20:54:10 +00:00
dosex * update makefiles for testing 2002-11-10 12:22:10 +00:00
dynlibex * update makefiles for testing 2002-11-10 12:22:10 +00:00
go32ex * update makefiles for testing 2002-11-10 12:22:10 +00:00
gpmex
graphex * update makefiles for testing 2002-11-10 12:22:10 +00:00
gtk1ex
gtk3ex
gtk4ex
gtk5ex
heapex * update makefiles for testing 2002-11-10 12:22:10 +00:00
internal * Replace 220 -> 219 2002-10-15 19:23:43 +00:00
ipcex * update makefiles for testing 2002-11-10 12:22:10 +00:00
kbdex * update makefiles for testing 2002-11-10 12:22:10 +00:00
linuxex * many stuff related to RTL fixed 2003-01-20 22:21:36 +00:00
mathex * update makefiles for testing 2002-11-10 12:22:10 +00:00
mmouseex * update makefiles for testing 2002-11-10 12:22:10 +00:00
mouseex * update makefiles for testing 2002-11-10 12:22:10 +00:00
objectex * The test was wrong, the values to insert into the collections are pstrings, not pchar. 2002-11-10 22:54:37 +00:00
old
optex * update makefiles for testing 2002-11-10 12:22:10 +00:00
packages + version 1.0 of listings package 2003-03-18 00:17:19 +00:00
pics double.eps 2003-03-17 17:25:55 +00:00
printex * update makefiles for testing 2002-11-10 12:22:10 +00:00
progex * update makefiles for testing 2002-11-10 12:22:10 +00:00
refex * update makefiles for testing 2002-11-10 12:22:10 +00:00
sockex * update makefiles for testing 2002-11-10 12:22:10 +00:00
stringex * update makefiles for testing 2002-11-10 12:22:10 +00:00
styles + latest version of listings. package (1.0) 2003-03-18 00:07:22 +00:00
syntax + Line break before and after diagram 2003-03-22 15:28:12 +00:00
sysutex + Corrected time: not mm but nn ! 2003-03-25 08:18:03 +00:00
typinfex * update makefiles for testing 2002-11-10 12:22:10 +00:00
videoex * update makefiles for testing 2002-11-10 12:22:10 +00:00
.latex2html-init * fixed latex2html settings 2001-10-18 21:41:26 +00:00
classchart.ps
classes.xml + Almost Complete now. Almost all classes/functions documented 2002-10-20 22:52:59 +00:00
crt.tex + Preparations for version 1.0.8 2003-02-24 23:37:52 +00:00
dos.tex * support for hevea 2003-03-16 15:22:18 +00:00
dxeload.tex
emu387.tex
fakehtml.sty * bugfix of Latex environment (first character would be considered a parameter) 2001-09-22 00:40:30 +00:00
fcl.tex + Initial implementation 2003-03-18 21:26:17 +00:00
foot.sed
fpc-hevea.tex * support for hevea 2003-03-16 15:22:18 +00:00
fpc-html.tex + updated \fpcversion to 1.0.6 2001-11-16 04:37:24 +00:00
fpc.sty + Added fcl docs and fpdoc 2003-03-18 21:25:23 +00:00
fpc.sty.doc
fpctoc.html + Added fcl docs and fpdoc 2003-03-18 21:25:23 +00:00
fpdoc.tex + Added fpdoc 2003-03-18 00:14:51 +00:00
getopts.tex * support for hevea 2003-03-16 15:22:18 +00:00
go32.tex * support for hevea 2003-03-16 15:22:18 +00:00
gpm.tex * support for hevea 2003-03-16 15:22:18 +00:00
graph.tex + Preparations for version 1.0.8 2003-02-24 23:37:52 +00:00
gtk1.tex
gtk2.tex
gtk3.tex
gtk4.tex
gtk5.tex
heaptrc.tex * support for hevea 2003-03-16 15:22:18 +00:00
ide.tex + fixed some chars that confused tex4ht. 2003-03-17 18:19:59 +00:00
internal.tex
ipc.tex * support for hevea 2003-03-16 15:22:18 +00:00
keyboard.tex + Fixed some typos, added some more introduction 2001-10-10 20:14:40 +00:00
keys.tex
linux.tex + Added NanoSleep 2002-08-30 06:37:15 +00:00
linux.xpm
Makefile * allow to specify FPCSRCDIR and FPDOC 2003-05-29 10:25:51 +00:00
Makefile.4ht + Added fpdoc 2003-03-18 00:14:51 +00:00
Makefile.hev + Added fpdoc 2003-03-18 00:14:51 +00:00
Makefile.l2h + Added fpdoc 2003-03-18 00:14:51 +00:00
makehtm
math.tex + Preparations for version 1.0.8 2003-02-24 23:37:52 +00:00
messages.tex * Updated compiler messages 2001-10-29 22:14:48 +00:00
mkkeytab.pp
mmx.tex
mouse.tex + Preparations for version 1.0.8 2003-02-24 23:37:52 +00:00
msmouse.tex + Switched to FPCexample. Added remark about mouse unit 2001-10-15 21:28:58 +00:00
objects.tex * support for hevea 2003-03-16 15:22:18 +00:00
onechap.tex + Preparations for version 1.0.8 2003-02-24 23:37:52 +00:00
options.tex * support for hevea 2003-03-16 15:22:18 +00:00
ports.tex
pp2tex
pp2tex.bat
preamble.book
preamble.hevea * support for hevea 2003-03-16 15:22:18 +00:00
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.tex * support for hevea 2003-03-16 15:22:18 +00:00
prog.tex + More include identifiers and solved double string character in tex3ht overview 2003-03-22 15:28:47 +00:00
README.DOCS
ref.tex + Added section about forward type declarations 2003-04-23 21:03:17 +00:00
reserved.tex
search.html
sockets.tex * support for hevea 2003-03-16 15:22:18 +00:00
strings.tex + Fixed typo in stralloc reported by Mark Emerson; Other cosmetic changes. 2002-12-30 09:19:32 +00:00
sysutils.tex + Preparations for version 1.0.8 2003-02-24 23:37:52 +00:00
tab.tex
table.eps
table.fig
tex2htex * fixed grep for FPCexampledir 2001-10-16 20:58:34 +00:00
tex4ht.env + Better quality of images 2003-03-22 16:52:38 +00:00
TODO
typinfo.tex * support for hevea 2003-03-16 15:22:18 +00:00
units.tex fpc.sty 2003-03-17 08:28:38 +00:00
user.tex * support for hevea 2003-03-16 15:22:18 +00:00
video.tex * bugfix report 2068 2002-09-08 15:02:58 +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.