fpc/docs
2003-01-20 22:21:36 +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 + Initial implementation 2000-06-15 20:22:57 +00:00
graphex * update makefiles for testing 2002-11-10 12:22: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 * 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 * html creation works again 1999-06-03 00:06:42 +00:00
optex * update makefiles for testing 2002-11-10 12:22:10 +00:00
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 * 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
syntax + Added uses clause to unit interface. Reported by Mark Emerson 2002-12-30 09:20:38 +00:00
sysutex + Added float - string conversion examples 2002-11-28 22:22:11 +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 + Initial import 2000-07-13 09:10:03 +00:00
classes.xml + Almost Complete now. Almost all classes/functions documented 2002-10-20 22:52:59 +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 + Remarks from translator 2000-01-19 22:30:50 +00:00
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 + Initial implementation 1998-11-17 23:49:24 +00:00
Makefile * update makefiles for testing 2002-11-10 12:22:10 +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 * TUnosrtedStrCollection declaration was completely wrong :( 2002-11-10 22:53:56 +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 + correct executable mode 1998-09-10 16:37:46 +00:00
pp2tex.bat * pp2tex and pp2tex.bat moved to main doc directory 1998-09-08 11:53:22 +00:00
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 * remove linux define for BSDs 2003-01-18 13:37:06 +00:00
README.DOCS Makefile 1999-05-16 20:16:31 +00:00
ref.tex * clarified in operator behavior 2002-11-26 21:55:55 +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 + Implemented large part of TODO list. Too much to denote 2000-05-16 21:07:55 +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 + Documented float<>string conversion routines 2002-11-28 23:06:04 +00:00
tab.tex Initial implementation 2000-01-19 22:32:04 +00:00
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 + Initial implementation 1998-04-07 13:38:27 +00:00
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 -gl option 2002-10-21 14:54:20 +00:00
video.tex * bugfix report 2068 2002-09-08 15:02:58 +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.
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.