fpc/docs
carl b1dadc7f1e * spelling mistakes bugfixes
+ added missing modifiers explanation: inline, pascal,safecall
 and interrupt
+ replaced \linux by \linux and \unix compatible operating systems.
- real type will be define in programmer's manual
2001-08-19 15:47:48 +00:00
..
buttons + Merged from fixbranch 2001-07-19 15:03:34 +00:00
crtex
dosex
dynlibex
go32ex erged from fixbranch 2000-09-24 08:21:35 +00:00
gpmex
graphex
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
linuxex * ex71 2000-10-12 10:36:08 +00:00
mathex
mmouseex
mouseex
objectex
old
optex
packages
pics + Readded 2001-07-28 19:46:17 +00:00
printex
progex
refex + Added latest files from fixbranch 2000-09-24 08:09:08 +00:00
sockex
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
.latex2html-init
classchart.ps
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
dxeload.tex
emu387.tex
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 + Merged from fixbranch 2001-07-19 15:03:34 +00:00
fpc.sty.doc
fpctoc.html + removed search engine 2001-07-19 13:20:09 +00:00
getopts.tex
go32.tex
gpm.tex
graph.tex
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
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
linux.tex
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
messages.tex + Minor changes 2001-07-19 15:02:52 +00:00
mmx.tex
mouse.tex
objects.tex
onechap.tex * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +00:00
ports.tex
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
prog.tex * move preamble to separate include file so changes only need to 2001-07-29 20:28:00 +00:00
README.DOCS
ref.tex * spelling mistakes bugfixes 2001-08-19 15:47:48 +00:00
reserved.tex
search.html
sockets.tex
strings.tex
sysutils.tex + Merged from fixbranch 2001-07-19 15:03:34 +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
TODO
typinfo.tex + initial check in 2001-07-19 15:03: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
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.