The sources of the Free Pascal compiler, RTL, packages and utilities. See https://www.freepascal.org/ for more info.
Go to file
peter 594c8943eb * new bugs
* added $mode fpc
2005-04-04 16:29:44 +00:00
compiler * fix register allocation in second_assert 2005-04-04 16:04:47 +00:00
demo + First demo for macos toolbox 2005-02-22 22:17:32 +00:00
docs * fixes from Thomas Schatzl. 2005-03-31 12:48:49 +00:00
fcl + Patch from Jesus reyes to notify changes to DisplayFormat 2005-04-04 07:30:51 +00:00
fv * $mode fpc 2005-04-04 16:16:58 +00:00
ide * use res instead of result 2005-04-04 16:16:09 +00:00
install * higher OS/2 requirements due to new as.exe 2005-04-03 18:24:11 +00:00
installer * util_s_os2.zip 2005-03-06 18:00:07 +00:00
packages * regenned on unix 2005-04-04 09:11:14 +00:00
rtl * don't use keywords for variables 2005-04-04 16:14:09 +00:00
tests * new bugs 2005-04-04 16:29:44 +00:00
utils + Fixed subsection/section writing 2005-03-10 20:32:16 +00:00
Makefile * no /install/binos2/*.h necessary 2005-03-06 16:02:11 +00:00
Makefile.fpc + documented 'make all' 2005-03-08 20:47:12 +00:00

This is the README for the Free Pascal documentation.

All documentation is stored here, in LaTeX format and in fpdoc 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... 

Why fpdoc ?
- Because it always creates up-to-date documentation.
- The documentation is separate from the units contrary to many other
  documentation tools which require comments in the sources, which makes
  the source unreadable.
- It's written in FPC.



Then how to proceed ?
If you just want to write general latex docs, just use fpc.sty. 
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)

If you want to document units, use fpdoc. It is documented fairly complete,
and you can have a look at the many .xml units for examples on how to use
it.

Happy TeXing,

Michael.