1PASDOC(1) User commands PASDOC(1)
2
6 pasdoc - documentation generator for Pascal code
7
9 pasdoc [OPTIONS...] [FILES...]
10
12 PasDoc is a documentation tool for Pascal and Object Pascal source
13 code. Documentation is generated from comments found in the source
14 code, or from external files.
15
17 @FILE Read options from FILE and insert them at current position.
18 FILE must contain one option per line. Format is
19 "name[=value]", options are named just like in the command line
20 but without leading dashes. Option values with spaces must NOT
21 be quoted.
22 -?, --help
24 Show a help message and exit.
25 --abbreviations FILE
27 Read list of abbreviations from FILE. Format is "[name] value".
28 Values are trimmed. Lines that do not start with '[' are ig‐
29 nored.
30 -A, --additional FILE
32 Specify the name of a text file with addition materials for the
33 project.
34 --auto-abstract
36 Automatically make an abstract description of every item from
37 the first sentence of description for that item.
38 --auto-back-comments
40 Consider //-style comments after an identifier in the same line
41 as description of that identifier.
42 --auto-link
44 Automatically create links, without the need to explicitly use
45 @link tags.
46 --auto-link-exclude FILE
48 Even when --auto-link is on, never automatically create links to
49 identifiers listed in FILE. The list should contain one identi‐
50 fier per line.
51 --cache-dir DIR
53 Specify cache directory for parsed files.
54 --conclusion FILE
56 Specify the name of a text file with concluding materials for
57 the project.
58 --css STYLESHEET
60 Specify CSS file (will be copied into output tree) to use with
61 HTML output.
62 -D, --define SYMBOL
64 Assume SYMBOL is defined when parsing conditional blocks.
65 -d, --conditionals FILE
67 Similar to --define, but reads the list of symbols from FILE.
68 -E, --output PATH
70 Specify output path.
71 --external-class-hierarchy FILE
73 Specify a file defining the hierarchy of classes not included in
74 your source code, for more complete class tree diagrams.
75 -F, --footer FILE
77 Use the contents of FILE as the footer for HTML output.
78 --graphviz-classes
80 Write a "GVClasses.dot" file that can be used for the dot pro‐
81 gram from GraphViz to generate a class hierarchy graph.
82 --graphviz-uses
84 Write a "GVUses.dot" file that can be used for the dot program
85 from GraphViz to generate a unit dependency graph.
86 -H, --header FILE
88 Use the contents of FILE as the header for HTML output.
89 --html-body-begin FILE
91 In HTML output, put the contents of FILE right after the opening
92 <body> tag.
93 --html-body-end FILE
95 In HTML output, put the contents of FILE right after the closing
96 </body> tag.
97 --html-head FILE
99 In HTML output, put the contents of FILE inside the <head> tag.
100 --html-help-contents FILE
102 Read contents for HtmlHelp from FILE.
103 --ignore-leading LIST
105 Specify a list of leading characters to be ignored in comments.
106 --ignore-marker MARKER
108 Skip comments starting with MARKER (that is, {MARKER, (*MARKER
109 and //MARKER comments).
110 --implementation-comments STRATEGY
112 Read implementation section of units and merge info with that
113 taken from interface section. STRATEGY determines how info is
114 merged:
115 none Do not read implementation comments.
116 prefer-interface
117 Read both interface and implementation comments. Use
118 whichever comment is non-empty. If they are both non-
119 empty, use the interface comment.
120 prefer-implementation
121 Just like "prefer interface", but if both comments are
122 non-empty, use the implementation comment.
123 join Read both interface and implementation comments and con‐
124 catenate them. If the interface comment is also present
125 at the beginning of the implementation comment, it will
126 be ignored (to avoid repetition).
127 --implicit-visibility VISIBILITY
129 Specify how to handle class members within default class visi‐
130 bility, i.e. treat implicit visiblity as VISIBILITY. For a list
131 of recognized values, check the -M option.
132 -I, --include PATH
134 Search inside PATH when evaluating {$INCLUDE} directives.
135 --include-creation-time
137 Include a creation timestamp inside the generated files.
138 --introduction FILE
140 Specify the name of a text file with introductory materials for
141 the project.
142 -L, --language LANG
144 Output language. Valid languages are:
145 ba Bosnian (Codepage 1250)
146 bg Bulgarian (UTF-8)
147 br.1252
148 Brazilian (Codepage 1252)
149 br.utf8
150 Brazilian (UTF-8)
151 ct Catalan
152 cz Czech (Codepage 1250)
153 cz.iso-8859-2
154 Czech (Codepage ISO-8859-2)
155 de German (Codepage ISO-8859-15)
156 de.utf8
157 German (UTF-8)
158 dk Danish
159 en English
160 es Spanish
161 fr French (Codepage ISO-8859-15)
162 fr.utf8
163 French (UTF-8)
164 gb2312 Chinese (Simple, gb2312)
165 hu.1250
166 Hungarian (Codepage 1250)
167 id Indonesian
168 it Italian
169 jv Javanese
170 mr Croatian
171 nl Dutch
172 pl.cp1250
173 Polish (Codepage CP1250)
174 pl.iso-8859-2
175 Polish (Codepage ISO 8859-2)
176 ru.866 Russian (Codepage 866)
177 ru.1251
178 Russian (Codepage 1251)
179 ru.koi8r
180 Russian (KOI-8)
181 ru.utf8
182 Russian (UTF-8)
183 se Swedish
184 sk Slovak (Codepage 1250)
185 --latex-head FILE
187 Specify a file that includes lines to be inserted into the pre‐
188 amble of the output LaTeX file.
189 --link-gv-classes FORMAT
191 Add a link to a "GVClasses.FORMAT" file generated by the dot
192 program, where FORMAT is any extension that dot can generate
193 (e.g. jpg). Currently available only for HTML output.
194 --link-gv-uses FORMAT
196 Add a link to a "GVUses.FORMAT" file generated by the dot pro‐
197 gram, where FORMAT is any extension that dot can generate (e.g.
198 jpg). Currently available only for HTML output.
199 --link-look STYLE
201 Controls how links are displayed in documentation. Possible val‐
202 ues are:
203 default
204 Show the complete link name, as specified by @link.
205 full Show the complete link name, and try to make each part of
206 it a link.
207 stripped
208 Show only last part of the link.
209 --lowercase-keywords
211 Convert all literal tag keywords to lowercase (e.g. @nil,
212 @false, @true).
213 -M, --visible-members LIST
215 Only include members of given visibility. Recognized visibili‐
216 ties are: pulished, public, protected, strictprotected, private,
217 strictprivate, automated, implicit.
218 --markdown
220 Decode Markdown syntax.
221 --marker MARKER
223 Parse only {MARKER, (*MARKER and //MARKER comments. Overrides
224 the --staronly option.
225 --marker-optional
227 Do not require the markers given by the --marker option, but re‐
228 move them from the comment if they exist.
229 -N, --name NAME
231 Specify a name for the documentation.
232 --no-macro
234 Disable support for FPC macros.
235 --numericfilenames
237 Make the HTML generator create numeric filenames.
238 -O, --format FORMAT
240 Specify the output format. Must be one of: html, htmlhelp, la‐
241 tex, latex2rtf or simplexml.
242 -R, --description FILE
244 Read descriptions from FILE.
245 --sort GROUPLIST
247 Specifies which groups of items are sorted (the rest is pre‐
248 sented in the same order they were declared in source files).
249 Recognized groups are: constants, functions, methods, non-
250 record-fields, properties, record-fields, structures, types,
251 variables.
252 -S, --source FILE
254 Read the list of source filenames from FILE.
255 --spell-check
257 Enable spell-checking (via Aspell). Specify language by using
258 the --language option.
259 --spell-check-ignore-words FILE
261 When spell-checking, ignore the words listed inside FILE. The
262 list should contain one word per line.
263 --staronly
265 Parse only {**, (*** and //** style comments.
266 -T, --title TITLE
268 Specify the title of the documentation.
269 --use-tipue-search
271 Use the tipue search engine in HTML output.
272 -v, --verbosity LEVEL
274 Set log verbosity. LEVEL must be a number in the 0-6 range. De‐
275 fault is 2.
276 --version
278 Show version information and exit.
279 --write-uses-list
281 Add the uses list to the output.
282 -X, --exclude-generator
284 Do not include information about PasDoc in the generated files.
285
287 For the full documentation, visit https://pasdoc.github.io/.
288 2021-09-22 PASDOC(1)