The sources of the Free Pascal compiler, RTL, packages and utilities. See https://www.freepascal.org/ for more info.
Go to file
2005-01-09 16:35:41 +00:00
compiler + linker response file is now removed after linking 2005-01-09 16:35:41 +00:00
demo * added nwsnut demo for netware 2005-01-04 11:44:47 +00:00
docs + Template fpdoc. Copied to needed dirs when creating docs 2005-01-02 16:22:16 +00:00
fcl + Moved ownerstream to classes unit 2005-01-09 13:15:56 +00:00
fv + tview.draw clears the back ground 2005-01-07 22:29:48 +00:00
ide * updated version and copyright 2005-01-08 13:43:44 +00:00
install * fix linebreak 2005-01-09 15:19:03 +00:00
installer * fix writing of -T<targetos> 2005-01-07 16:48:14 +00:00
packages * sparc/linux uses 64 bit CORE_ADDR always it seems 2005-01-07 18:47:33 +00:00
rtl + Added TOwnerStream 2005-01-09 13:15:37 +00:00
tests *** empty log message *** 2005-01-08 15:42:31 +00:00
utils + Split out latex writer to linear and latex writer 2005-01-09 15:59:50 +00:00
Makefile * copy also fv,ide for deb and rpm 2004-12-30 20:55:15 +00:00
Makefile.fpc * copy also fv,ide for deb and rpm 2004-12-30 20:55:15 +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.