← Back to branch summary

~ubuntu-branches/debian/lenny/fpc/lenny

« back to all changes in this revision

Viewing changes to docs/README.DOCS

  • Committer: Bazaar Package Importer
  • Author(s): Mazen Neifer, Torsten Werner, Mazen Neifer
  • Date: 2008-05-17 17:12:11 UTC
  • mfrom: (3.1.9 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080517171211-9qi33xhd9evfa0kg
Tags: 2.2.0-dfsg1-9
http://bugs.debian.org/477743
[ Torsten Werner ]
* Add Mazen Neifer to Uploaders field.

[ Mazen Neifer ]
* Moved FPC sources into a version dependent directory from /usr/share/fpcsrc
  to /usr/share/fpcsrc/${FPCVERSION}. This allow installing more than on FPC
  release.
* Fixed far call issue in compiler preventing building huge binearies.
  (closes: #477743)
* Updated building dependencies, recomennded and suggested packages.
* Moved fppkg to fp-utils as it is just a helper tool and is not required by
  compiler.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/README.DOCS
1
 
This is the README for the Free Pascal documentation.
2
 
 
3
 
All documentation is stored here, in LaTeX format. 
4
 
it uses special style files (fpc*.sty) which are also in the directory.
5
 
 
6
 
do a 'make dvi' to produce the dvi format of the docs.
7
 
a 'make html' will produce the html version (using latex2html).
8
 
a 'make ps' will produce PostScript documents.
9
 
a 'make pdf' will produce PDF (Portable Document Format) documents.
10
 
a 'make txt' will produce plain text documents.
11
 
 
12
 
If you want to produce dos docs, you can do a 'make htm' this will convert
13
 
the .html files to .htm files (including all references), suitable for a 8:3
14
 
format.
15
 
 
16
 
The rest of this document is only interesting if you want to write docs.
17
 
Otherwise, you can bail out now.
18
 
 
19
 
THE DOCS...
20
 
 
21
 
Why LaTeX ? 
22
 
- because I like a printed copy of the manuals, HTML just isn't good enough 
23
 
  for this.
24
 
- I know LaTeX very well :) (mind you : html also !)
25
 
- It converts to many other formats.
26
 
- many other reasons.
27
 
 
28
 
In order to translate the things to HTML, I use latex2html, since it is the
29
 
most powerful and flexible, although sluggish... 
30
 
For it to be able to use the fpc.sty, I had to write a fpc.perl script
31
 
which it loads. The script seems to run fine when used standalone, but in
32
 
conjunction with latex2html, I get a out of memory... ??
33
 
I'm not familiar with perl, so if someone is, and can fix the thing, please
34
 
do. (and let me know :) )
35
 
 
36
 
Then how to proceed ?
37
 
If you just want to write latex docs, just use fpc.sty. (you don't need
38
 
html.sty)
39
 
If you want to be able to convert to html, (you need html.sty) the following 
40
 
fixes the perl-problem :
41
 
In the preamble of  your document, type :
42
 
 
43
 
\usepackage{html}
44
 
\latex{\usepackage{fpc}}
45
 
\html{\input{fpc-html.tex}}
46
 
 
47
 
The fpc-html.tex defines the same commands as fpc.sty, only in a language
48
 
that latex2html understands.
49
 
 
50
 
fpc.sty.doc describes what fpc.sty does. (one day I'll integrate them using
51
 
the doc package, but I need some time for it)
52
 
 
53
 
Happy TeXing,
54
 
Michael.
 
 
b'\\ No newline at end of file'