fpc/docs
2002-09-08 15:07:46 +00:00
..
buttons * binary flag 2001-10-18 21:42:37 +00:00
crtex
dosex * Renamefest 2002-06-02 09:59:01 +00:00
dynlibex + Initial implementation 2000-08-18 19:20:06 +00:00
go32ex erged from fixbranch 2000-09-24 08:21:35 +00:00
gpmex + Initial implementation 2000-06-15 20:22:57 +00:00
graphex * display some info at the end 2002-04-11 21:33:10 +00:00
gtk1ex + Initial check-in 2001-07-10 21:54:31 +00:00
gtk3ex + Added third gdk article 2001-03-26 19:45:36 +00:00
gtk4ex + Initial check-in 2001-07-10 21:54:31 +00:00
gtk5ex + Initial images 2001-07-11 14:23:08 +00:00
heapex
internal * only PDF target is supported 2002-02-10 15:07:01 +00:00
ipcex
kbdex + Now actually demonstrates GetKeyEventCode 2001-10-10 20:14:09 +00:00
linuxex + Added NanoSleep example 2002-08-30 06:32:14 +00:00
mathex + Finished chapter on math 2000-07-08 17:10:53 +00:00
mmouseex + Initial import 2000-07-13 09:10:03 +00:00
mouseex + Corrected example 2001-10-16 10:36:31 +00:00
objectex + Fixed example 2000-07-11 06:15:25 +00:00
old
optex
packages + Initial import 2000-07-13 09:10:03 +00:00
pics * adapt to change in IDE for low chars 2002-03-25 14:12:22 +00:00
printex * Renamefest 2002-06-02 09:59:01 +00:00
progex + Cosmetic changes 2000-06-15 20:05:56 +00:00
refex + Added Octstr example 2002-08-30 06:37:00 +00:00
sockex * added setsocketoptions + pulled it through source beautifier 2000-06-05 07:19:32 +00:00
stringex
syntax * bugfix for report 1790 2002-09-08 15:07:46 +00:00
sysutex * renamefest 2002-06-02 11:12:25 +00:00
typinfex * small fixes to test really the int64 stuff 2001-11-18 18:27:15 +00:00
videoex * fix bug report #1934 2002-05-12 18:42:33 +00:00
.latex2html-init * fixed latex2html settings 2001-10-18 21:41:26 +00:00
classchart.ps + Initial import 2000-07-13 09:10:03 +00:00
classes.xml + Documented TAbstractObjectReader 2002-02-21 22:26:12 +00:00
crt.tex + updated information on sound routine 2001-10-03 00:47:43 +00:00
dos.tex + More information on floppy mappings 2001-12-20 04:00:59 +00:00
dxeload.tex + Added dxeload and emu387 2000-07-03 14:43:53 +00:00
emu387.tex + Added dxeload and emu387 2000-07-03 14:43:53 +00:00
fakehtml.sty * bugfix of Latex environment (first character would be considered a parameter) 2001-09-22 00:40:30 +00:00
foot.sed
fpc-html.tex + updated \fpcversion to 1.0.6 2001-11-16 04:37:24 +00:00
fpc.sty + Added ver2 environment 2002-08-21 09:47:58 +00:00
fpc.sty.doc
fpctoc.html + add tag for IDE 2002-03-14 17:00:20 +00:00
getopts.tex + Implemented large part of TODO list. Too much to denote 2000-05-16 21:07:55 +00:00
go32.tex
gpm.tex * fixed a typo. A backslash was missing in label name in line 414 2000-07-10 13:53:42 +00:00
graph.tex * clarification of ellipse routine 2002-03-07 21:52:49 +00:00
gtk1.tex + Added first and fourth article 2001-07-10 21:52:18 +00:00
gtk2.tex + removed blankstring line 2001-07-19 13:21:50 +00:00
gtk3.tex + Added 3rd article 2001-07-10 21:53:11 +00:00
gtk4.tex + Added first and fourth article 2001-07-10 21:52:18 +00:00
gtk5.tex + First complete version of article 2001-07-11 14:23:51 +00:00
heaptrc.tex + Initial import 2000-07-13 09:10:03 +00:00
ide.tex + Added -t option. 2002-05-20 12:03:19 +00:00
internal.tex * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +00:00
ipc.tex + Added some more constants 2000-05-26 18:14:50 +00:00
keyboard.tex + Fixed some typos, added some more introduction 2001-10-10 20:14:40 +00:00
keys.tex + Finished keyboard scan code tables 2001-09-16 09:47:12 +00:00
linux.tex + Added NanoSleep 2002-08-30 06:37:15 +00:00
linux.xpm
Makefile + removed fcl target in HTML 2002-04-23 18:03:50 +00:00
makehtm
math.tex * Corrected prototype of rgexp(), now conforms to Delphi 2001-12-20 03:59:39 +00:00
messages.tex * Updated compiler messages 2001-10-29 22:14:48 +00:00
mkkeytab.pp + Finished keyboard scan code tables 2001-09-16 09:47:12 +00:00
mmx.tex + Implemented large part of TODO list. Too much to denote 2000-05-16 21:07:55 +00:00
mouse.tex + Fixed some errors 2001-11-05 18:42:01 +00:00
msmouse.tex + Switched to FPCexample. Added remark about mouse unit 2001-10-15 21:28:58 +00:00
objects.tex + Implemented large part of TODO list. Too much to denote 2000-05-16 21:07:55 +00:00
onechap.tex + Last typos before 1.0.6 2001-11-05 20:36:10 +00:00
ports.tex + Initial implementation 2000-07-04 19:54:55 +00:00
pp2tex
pp2tex.bat
preamble.book * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +00:00
preamble.html * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +00:00
preamble.report * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +00:00
printer.tex + Implemented large part of TODO list. Too much to denote 2000-05-16 21:07:55 +00:00
prog.tex * cardinal -> longword 2002-09-08 14:14:04 +00:00
README.DOCS
ref.tex * fix property example 2002-09-08 15:06:15 +00:00
reserved.tex
search.html
sockets.tex + Implemented large part of TODO list. Too much to denote 2000-05-16 21:07:55 +00:00
strings.tex + Implemented large part of TODO list. Too much to denote 2000-05-16 21:07:55 +00:00
sysutils.tex * fixed typos from webbugs 2002-01-19 12:00:35 +00:00
tab.tex
table.eps + Some cleaning up 2001-07-10 22:01:15 +00:00
table.fig + Some cleaning up 2001-07-10 22:01:15 +00:00
tex2htex * fixed grep for FPCexampledir 2001-10-16 20:58:34 +00:00
TODO
typinfo.tex + Added copytight statement 2001-10-04 20:57:32 +00:00
units.tex + Updated version to 1.9 2001-12-13 20:21:01 +00:00
user.tex + added some missing options 2002-04-14 12:29:20 +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.