fpc/docs
peter 081a7283c0 * htmlzip,htmzip,htmltar updates
* include search/ in distro
  * fix paths under linux automaticly
1999-06-15 13:53:16 +00:00
..
buttons + Inistial implementation 1999-02-03 13:40:58 +00:00
crtex
dosex
go32ex + Removed underscores from filenames. 1999-06-04 19:29:47 +00:00
heapex
ipcex Initial implementation of IPC docs 1999-01-14 15:43:52 +00:00
linuxex POpen opened files should not be rewritten 1999-04-25 19:24:27 +00:00
mouseex
objectex Added examples 27-40 1999-01-17 15:08:43 +00:00
old * html creation works again 1999-06-03 00:06:42 +00:00
optex
packages * Added for completion 1999-06-08 14:15:38 +00:00
pics + Added install.pdf 1999-05-30 20:53:44 +00:00
printex
refex added setlength example 1999-06-04 20:08:10 +00:00
search * htmlzip,htmzip,htmltar updates 1999-06-15 13:53:16 +00:00
sockex Fixed typo in portnumber 1999-06-10 08:21:04 +00:00
stringex
syntax + Added message methods 1999-06-05 10:50:44 +00:00
sysutex + Added last examples 1999-06-05 10:49:59 +00:00
.latex2html-init + Installed javascript in top navigation panel 1999-02-12 12:53:33 +00:00
classchart.ps
crt.tex * html creation works again 1999-06-03 00:06:42 +00:00
dos.tex Makefile 1999-05-16 20:16:31 +00:00
foot.sed
fpc-html.tex * html creation works again 1999-06-03 00:06:42 +00:00
fpc.sty * html creation works again 1999-06-03 00:06:42 +00:00
fpc.sty.doc
fpctoc.html Added search engine 1999-01-18 14:34:05 +00:00
getopts.tex
go32.tex + removed underscores from filenames 1999-06-05 10:51:19 +00:00
graph.tex
heaptrc.tex
help1.gif + Added search page 1999-01-18 13:14:21 +00:00
help2.gif + Added search page 1999-01-18 13:14:21 +00:00
help.html + Added search page 1999-01-18 13:14:21 +00:00
internal.tex * html creation works again 1999-06-03 00:06:42 +00:00
ipc.tex + Documented shared memory 1999-01-17 21:11:06 +00:00
linux.tex + fd_clear changed to fd_zero 1999-06-07 11:54:43 +00:00
linux.xpm
Makefile * htmlzip,htmzip,htmltar updates 1999-06-15 13:53:16 +00:00
makehtm
messages.tex * Up to date for release 1999-06-08 14:13:30 +00:00
mmx.tex
mouse.tex
objects.tex * Completed TStringList and TStrListMaker objects 1999-04-10 21:36:56 +00:00
onechap.tex Makefile 1999-05-16 20:16:31 +00:00
pp2tex
pp2tex.bat
printer.tex
prog.tex * changed version to 1.6 1999-06-09 12:33:47 +00:00
README.DOCS Makefile 1999-05-16 20:16:31 +00:00
ref.tex * changed version to 1.6 1999-06-09 12:33:47 +00:00
reserved.tex
search.html + Added search page 1999-01-18 13:14:21 +00:00
sockets.tex Some cosmetic changes, and return values of Connect and Accept corrected 1999-06-08 18:39:37 +00:00
strings.tex Makefile 1999-05-16 20:16:31 +00:00
sysutils.tex + Added last functions 1999-06-05 10:54:53 +00:00
TODO
units.tex * changed version to 1.6 1999-06-09 12:33:47 +00:00
user.tex * changed version to 1.6 1999-06-09 12:33:47 +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.