Scroll to navigation

PASDOC(1) User Commands PASDOC(1)

NAME

PasDoc - documentation tool for Pascal source code

SYNOPSIS

pasdoc [options] [files]

DESCRIPTION

PasDoc 0.16.0 [2021-02-07|FPC 3.2.0|Linux|64] Documentation generator for Pascal source

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Valid options are:

@<path to config file>
Read options from specified file and insert them at current position. File must contain one option per line. Format is "name[=value]", options are named just like in the command line but without leading dashes. Option values with spaces must NOT be quoted
-?, --help
Show this help
Show pasdoc version (and related info)
Set log verbosity (0-6) [2]
Define conditional
Read description from this file
Read conditionals from this file
Includes search path
Read source filenames from file
Read Contents for HtmlHelp from file
Include file as header for HTML output
Include file as footer for HTML output
Include file to use inside HTML <head>
Include file to use right after HTML <body>
Include file to use right before HTML </body>
Name for documentation
Documentation title
Output format: html, simplexml, latex, latex2rtf or htmlhelp
Output path
Exclude generator information
Include creation time in the docs
Lowercase all literal tag keywords (@nil, @false, @true)
Output language. Valid languages are: ba: Bosnian (Codepage 1250) br.1252: Brazilian (Codepage 1252) br.utf8: Brazilian (Codepage UTF-8) bg: Bulgarian (Codepage UTF-8) ct: Catalan gb2312: Chinese (Simple, gb2312) hr: Croatian dk: Danish nl: Dutch en: English fr: French (iso-8859-15) fr.utf8: French (UTF-8) de: German (iso-8859-15) de.utf8: German (UTF-8) id: Indonesian it: Italian jv: Javanese pl.cp1250: Polish (Codepage CP1250) pl.iso-8859-2: Polish (Codepage ISO 8859-2) ru.1251: Russian (Codepage 1251) ru.utf8: Russian (Codepage UTF-8) ru.866: Russian (Codepage 866) ru.koi8r: Russian (KOI-8) sk: Slovak (Codepage 1250) es: Spanish se: Swedish hu.1250: Hungarian (Codepage 1250) cz: Czech (Codepage 1250) cz.iso-8859-2: Czech (Codepage ISO 8859-2)
Parse only {**, (*** and //** style comments
Parse only {<marker>, (*<marker> and //<marker> comments. Overrides the staronly option, which is a shortcut for '--marker=**'
Skip comments starting with <marker> (that is, {<marker>, (*<marker> and //<marker> comments)
Do not require the markers given in --marker but remove them from the comment if they exist.
Ignore leading <ignore-leading> characters in comments.
Causes the html generator to create numeric filenames
Include / Exclude class Members by visiblity
Put uses list into output
Write a GVUses.dot file that can be used for the `dot` program from GraphViz to generate a unit dependency graph
Write a GVClasses.dot file that can be used for the `dot` program from GraphViz to generate a class hierarchy graph
Add a link to a GVUses.<format> file generated by the `dot` program where <format> is any extension that `dot` can generate (e.g. jpg). (currently only for HTML output)
Add a link to a GVClasses.<format> file generated by the `dot` program where <format> is any extension that `dot` can generate (e.g. jpg). (currently only for HTML output)
Abbreviation file, format is "[name] value", value is trimmed, lines that do not start with '[' (or whitespace before that) are ignored
Enable spell-checking by Aspell, specify language by the --language option
When spell-checking, ignore the words in that file. The file should contain one word on every line
Deprecated, use --spell-check. Enable spell checking by Aspell, giving language as parameter
Cache directory for parsed files (default not set)
How links are displayed in documentation: "default" (show the complete link name, as specified by @link), "full" (show the complete link name, and try to make each part of it a link), or "stripped" (show only last part of the link)
Obsolete name for --link-look=full
CSS file for HTML files (copied into output tree)
If set, pasdoc will automatically make abstract description of every item from the first sentence of description of this item
Use tipue search engine in HTML output
Specifies what groups of items are sorted (the rest is presented in the same order they were declared in your source files)
The name of a text file with introductory materials for the project
The name of a text file with concluding materials for the project
The name of a text file with addition materials for the project
The name of a text file that includes lines to be inserted into the preamble of a LaTeX file
How pasdoc should handle class members within default class visibility
Turn FPC macro support off
Automatically create links, without the need to explicitly use @link tags
Consider //-style comments after an identifier in the same line as description of that identifier.
Even when --auto-link is on, never automatically create links to identifiers in the specified file. The file should contain one identifier on every line
File defining hierarchy of classes not included in your source code, for more complete class tree diagrams
Decode Markdown syntax
Read implementation section of units and merge info to that taken from interface section. Option value determines how info is merged:
none - Do not read implementation comments.
implementation comments. Use whichever comment is non-empty. If they are both non-empty, use the interface comment.
comments and concatenate them. If the interface comment is also present (repeated) at the beginning of the implementation comment, it will be ignored (to not repeat 2x the same text in the concatenated result)
interface", but if both comments are non-empty, use the implementation comment
April 2021 PasDoc 0.16.0 [2021-02-07|FPC 3.2.0|Linux|64]