← Back to branch summary

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

« back to all changes in this revision

Viewing changes to install/man/man1/makeskel.1

  • 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:
install/man/man1/makeskel.1
 
1
.TH makeskel 1 "11 November 2004" "Free Pascal" "FPC unit description file generator"
 
2
.SH NAME
 
3
makeskel \- generate description file for 
 
4
.B fpdoc.
 
5
 
 
6
.SH SYNOPSIS
 
7
 
 
8
\fBmakeskel\fP [--descr=filename] [--disable-arguments] 
 
9
[--disable-errors] [--disable-function-results] 
 
10
[--disable-private] [--disable-protected] 
 
11
[--disable-seealso] [--emit-class-separator] 
 
12
[--help] [--lang=language] [--output=filename] 
 
13
[--update]
 
14
--package=name --input=cmdline
 
15
 
 
16
.SH Description
 
17
 
 
18
.B makeskel
 
19
scans a Free Pascal unit source file and generates a skeleton description
 
20
file for it. It generates nodes for all identifiers found in the interface
 
21
section of the unit, although this behaviour can be adjusted with some
 
22
options. It can also update an existing XML file, and then emits only nodes
 
23
for identifiers for which no node exists yet.
 
24
 
 
25
.SH Usage
 
26
 
 
27
You can invoke 
 
28
.B makeskel
 
29
with as the only required arguments the 
 
30
.B input
 
31
and
 
32
.B package
 
33
arguments. It should at least contain the name of the unit file for which 
 
34
documentation should be generated and the name of the package to which the
 
35
unit belongs. The output of 
 
36
.B makeskel 
 
37
will go to standard output by default.
 
38
 
 
39
.SH Options
 
40
 
 
41
.B makeskel
 
42
has many options, most of them optional, defaults will be used in most
 
43
cases.
 
44
 
 
45
.TP
 
46
.BI \-\-descr=descfile
 
47
This option must be used in conjunction with the 
 
48
.I update 
 
49
option. It specifies the name of a description file
 
50
.B descfile
 
51
which must be updated. Note that the file must contain valid XML, or the
 
52
update will fail. This option can be specified more than once.
 
53
.TP
 
54
.BI \-\-disable-arguments
 
55
If this option is specified, 
 
56
.B makeskel
 
57
will not emit nodes for the arguments of functions and procedures. By
 
58
default, documentation nodes are emitted for functions and procedures as
 
59
well.
 
60
.TP
 
61
.BI \-\-disable-errors
 
62
By default, each documentation node will contain a 
 
63
.I errors
 
64
node as well (excep for identifiers where this has no use, such as function
 
65
arguments). If this option is specified, no 
 
66
.I errors
 
67
node will be generated.
 
68
.TP
 
69
.BI \-\-disable-function-results
 
70
By default, for functions, a 
 
71
.I result
 
72
node will be generated, to describe the result of the function. If this
 
73
option is specified, no function result node will be generated.
 
74
.TP
 
75
.BI \-\-disable-private
 
76
By default, documentation nodes are also generated for private fields or methods 
 
77
of a class. if this option is specified, the generation of nodes for private
 
78
fields or methods is skipped.
 
79
.TP
 
80
.B \-\-disable-protected
 
81
By default, documentation nodes are also generated for protected fields or
 
82
methods of a class. if this option is specified, the generation of nodes 
 
83
for protected fields or methods is skipped.
 
84
.TP
 
85
.B \-\-emit-class-separator
 
86
If this option is specified, a visible comment with the name of the class
 
87
for which documentation nodes will follow, is inserted between the nodes
 
88
of two classes, making navigation easier.
 
89
.TP
 
90
.BI \-\-help
 
91
Emit a short help text and exit.
 
92
.TP
 
93
.BI \-\-input=cmd
 
94
The input (source) file to process. Multiple input files can be specified.
 
95
The command may contain valid compiler options, currently the 
 
96
.I \-Fipath
 
97
(search path) and
 
98
.I \-dmacro
 
99
(define macro) options are recognized. 
 
100
.TP
 
101
.BI \-\-lang=language
 
102
Sets the language for the output file. This will mainly set the strings used
 
103
for the headers in various parts of the documentation files (by default
 
104
they're in english). Currently, valid options are
 
105
.RS
 
106
.TP
 
107
.I de 
 
108
German.
 
109
.TP
 
110
.I fr
 
111
French.
 
112
.TP
 
113
.I nl
 
114
Dutch.
 
115
.RE
 
116
.TP
 
117
.BI \-\-output=filename 
 
118
This option tells 
 
119
.B makeskel
 
120
where the output should go. If this option is not specified, the output is
 
121
sent to standard output (the screen).
 
122
.TP
 
123
.BI \-\-package=packagename
 
124
This option is required. It specifies the name of the package. All nodes
 
125
will be generated inside a node with 
 
126
.B name 
 
127
attribute
 
128
.I packagename.
 
129
.TP
 
130
.BI \-\-update
 
131
Turns on update mode. In this mode, the output is a file which contains only
 
132
the missing nodes to complete the documentation of the input files. The
 
133
existing nodes must be specified with the
 
134
.B descr
 
135
argument. Note that the output file may 
 
136
.I not
 
137
be the same as the input (description) nodes; A separate file must be
 
138
specified (or no file, in which case output goes to standard output.
 
139
 
 
140
.SH SEE ALSO
 
141
.IP 
 
142
.BR  ppc386 (1)
 
143
.BR  latex (1)
 
144
.BR  fpdoc (1)