fpc/docs
2001-09-20 18:00:48 +00:00
..
buttons + Merged from fixbranch 2001-07-19 15:03:34 +00:00
crtex
dosex
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 + initial implementation 2000-07-08 21:54:29 +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
ipcex
kbdex + Added examples 4 to 7 2001-09-12 22:39:49 +00:00
linuxex * ex71 2000-10-12 10:36:08 +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 * changed name of mouse unit to msmouse 2000-04-14 08:11:21 +00:00
objectex + Fixed example 2000-07-11 06:15:25 +00:00
old * html creation works again 1999-06-03 00:06:42 +00:00
optex
packages + Initial import 2000-07-13 09:10:03 +00:00
pics add some ansi files 2001-09-09 23:03:02 +00:00
printex
progex + Cosmetic changes 2000-06-15 20:05:56 +00:00
refex + Added latest files from fixbranch 2000-09-24 08:09:08 +00:00
sockex * added setsocketoptions + pulled it through source beautifier 2000-06-05 07:19:32 +00:00
stringex
syntax + updated for correct available modifiers 2001-08-19 15:43:12 +00:00
sysutex + Added ex88 2001-07-19 15:06:48 +00:00
typinfex + Added SetToString example 2001-09-09 09:22:06 +00:00
.latex2html-init
classchart.ps + Initial import 2000-07-13 09:10:03 +00:00
classes.xml + Initial import in main branch 2001-07-19 13:18:46 +00:00
crt.tex + Fixed typo 2001-07-19 13:19:03 +00:00
dos.tex + updated credit for Amiga version 2001-08-19 15:45:46 +00:00
double.eps * graph for data format 2001-09-10 03:02:42 +00:00
double.png * graph for data format 2001-09-10 03:02:42 +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 + Initial import in main branch 2001-07-19 13:18:46 +00:00
foot.sed
fpc-html.tex + Merged from fixbranch 2001-07-19 15:03:34 +00:00
fpc.sty + Changed secnumdepth and added stringspaces for listings 2001-09-09 15:23:57 +00:00
fpc.sty.doc
fpctoc.html + removed search engine 2001-07-19 13:20:09 +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 + added function list by category 2000-07-09 14:51:13 +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 + Merged from fixbranch 2001-07-19 15:03:34 +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 + Finished keyboard scan code tables 2001-09-16 09:47:12 +00:00
keys.tex + Finished keyboard scan code tables 2001-09-16 09:47:12 +00:00
linux.tex * merged 2000-09-02 17:36:02 +00:00
linux.xpm
Makefile * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +00:00
makehtm
math.tex + Added functional overview 2000-07-09 08:01:31 +00:00
messages.tex + Minor changes 2001-07-19 15:02:52 +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 + Implemented large part of TODO list. Too much to denote 2000-05-16 21:07:55 +00:00
objects.tex + Implemented large part of TODO list. Too much to denote 2000-05-16 21:07:55 +00:00
onechap.tex * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +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 + Fixed 2 typos reported by Sergey Korshunoff 2001-09-20 18:00:48 +00:00
README.DOCS Makefile 1999-05-16 20:16:31 +00:00
ref.tex * fix my messup! 2001-09-10 03:00:59 +00:00
reserved.tex
search.html
single.eps + for programmer's reference (single ieee format) 2001-09-10 03:04:49 +00:00
single.png + for programmer's reference (single ieee format) 2001-09-10 03:04:49 +00:00
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 + Merged from fixbranch 2001-07-19 15:03:34 +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 * added 2000-09-02 17:38:20 +00:00
TODO
typinfo.tex + Completed unit documentation, all examples added 2001-09-09 09:30:16 +00:00
units.tex * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +00:00
user.tex * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +00:00
video.tex +Initial check-in 2001-09-16 22:38:19 +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.