.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.3. .TH PASDOC "1" "April 2021" "PasDoc 0.16.0 [2021-02-07|FPC 3.2.0|Linux|64]" "User Commands" .SH NAME PasDoc \- documentation tool for Pascal source code .SH SYNOPSIS .B pasdoc [\fI\,options\/\fR] [\fI\,files\/\fR] .SH DESCRIPTION PasDoc 0.16.0 [2021\-02\-07|FPC 3.2.0|Linux|64] Documentation generator for Pascal source .PP This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .SS "Valid options are:" .TP @ 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 .TP \-?, \fB\-\-help\fR Show this help .TP \fB\-\-version\fR Show pasdoc version (and related info) .TP \fB\-v\fR, \fB\-\-verbosity\fR Set log verbosity (0\-6) [2] .TP \fB\-D\fR, \fB\-\-define\fR Define conditional .TP \fB\-R\fR, \fB\-\-description\fR Read description from this file .TP \fB\-d\fR, \fB\-\-conditionals\fR Read conditionals from this file .TP \fB\-I\fR, \fB\-\-include\fR Includes search path .TP \fB\-S\fR, \fB\-\-source\fR Read source filenames from file .TP \fB\-\-html\-help\-contents\fR Read Contents for HtmlHelp from file .TP \fB\-H\fR, \fB\-\-header\fR Include file as header for HTML output .TP \fB\-F\fR, \fB\-\-footer\fR Include file as footer for HTML output .TP \fB\-\-html\-head\fR Include file to use inside HTML .TP \fB\-\-html\-body\-begin\fR Include file to use right after HTML .TP \fB\-\-html\-body\-end\fR Include file to use right before HTML .TP \fB\-N\fR, \fB\-\-name\fR Name for documentation .TP \fB\-T\fR, \fB\-\-title\fR Documentation title .TP \fB\-O\fR, \fB\-\-format\fR Output format: html, simplexml, latex, latex2rtf or htmlhelp .TP \fB\-E\fR, \fB\-\-output\fR Output path .TP \fB\-X\fR, \fB\-\-exclude\-generator\fR Exclude generator information .TP \fB\-\-include\-creation\-time\fR Include creation time in the docs .TP \fB\-\-lowercase\-keywords\fR Lowercase all literal tag keywords (@nil, @false, @true) .TP \fB\-L\fR, \fB\-\-language\fR 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) .TP \fB\-\-staronly\fR Parse only {**, (*** and //** style comments .TP \fB\-\-marker\fR Parse only {, (* and // comments. Overrides the staronly option, which is a shortcut for '\-\-marker=**' .TP \fB\-\-ignore\-marker\fR Skip comments starting with (that is, {, (* and // comments) .TP \fB\-\-marker\-optional\fR Do not require the markers given in \fB\-\-marker\fR but remove them from the comment if they exist. .TP \fB\-\-ignore\-leading\fR Ignore leading characters in comments. .TP \fB\-\-numericfilenames\fR Causes the html generator to create numeric filenames .TP \fB\-M\fR, \fB\-\-visible\-members\fR Include / Exclude class Members by visiblity .TP \fB\-\-write\-uses\-list\fR Put uses list into output .TP \fB\-\-graphviz\-uses\fR Write a GVUses.dot file that can be used for the `dot` program from GraphViz to generate a unit dependency graph .TP \fB\-\-graphviz\-classes\fR Write a GVClasses.dot file that can be used for the `dot` program from GraphViz to generate a class hierarchy graph .TP \fB\-\-link\-gv\-uses\fR Add a link to a GVUses. file generated by the `dot` program where is any extension that `dot` can generate (e.g. jpg). (currently only for HTML output) .TP \fB\-\-link\-gv\-classes\fR Add a link to a GVClasses. file generated by the `dot` program where is any extension that `dot` can generate (e.g. jpg). (currently only for HTML output) .TP \fB\-\-abbreviations\fR Abbreviation file, format is "[name] value", value is trimmed, lines that do not start with \&'[' (or whitespace before that) are ignored .TP \fB\-\-spell\-check\fR Enable spell\-checking by Aspell, specify language by the \fB\-\-language\fR option .TP \fB\-\-spell\-check\-ignore\-words\fR When spell\-checking, ignore the words in that file. The file should contain one word on every line .TP \fB\-\-aspell\fR Deprecated, use \fB\-\-spell\-check\fR. Enable spell checking by Aspell, giving language as parameter .TP \fB\-\-cache\-dir\fR Cache directory for parsed files (default not set) .TP \fB\-\-link\-look\fR 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) .TP \fB\-\-full\-link\fR Obsolete name for \fB\-\-link\-look\fR=\fI\,full\/\fR .TP \fB\-\-css\fR CSS file for HTML files (copied into output tree) .TP \fB\-\-auto\-abstract\fR If set, pasdoc will automatically make abstract description of every item from the first sentence of description of this item .TP \fB\-\-use\-tipue\-search\fR Use tipue search engine in HTML output .TP \fB\-\-sort\fR Specifies what groups of items are sorted (the rest is presented in the same order they were declared in your source files) .TP \fB\-\-introduction\fR The name of a text file with introductory materials for the project .TP \fB\-\-conclusion\fR The name of a text file with concluding materials for the project .TP \fB\-A\fR, \fB\-\-additional\fR The name of a text file with addition materials for the project .TP \fB\-\-latex\-head\fR The name of a text file that includes lines to be inserted into the preamble of a LaTeX file .TP \fB\-\-implicit\-visibility\fR How pasdoc should handle class members within default class visibility .TP \fB\-\-no\-macro\fR Turn FPC macro support off .TP \fB\-\-auto\-link\fR Automatically create links, without the need to explicitly use @link tags .TP \fB\-\-auto\-back\-comments\fR Consider //\-style comments after an identifier in the same line as description of that identifier. .TP \fB\-\-auto\-link\-exclude\fR Even when \fB\-\-auto\-link\fR is on, never automatically create links to identifiers in the specified file. The file should contain one identifier on every line .TP \fB\-\-external\-class\-hierarchy\fR File defining hierarchy of classes not included in your source code, for more complete class tree diagrams .TP \fB\-\-markdown\fR Decode Markdown syntax .TP \fB\-\-implementation\-comments\fR Read implementation section of units and merge info to that taken from interface section. Option value determines how info is merged: .IP none \- Do not read implementation comments. .TP prefer\-interface \- Read both interface and implementation comments. Use whichever comment is non\-empty. If they are both non\-empty, use the interface comment. .TP join \- Read both interface and implementation 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) .TP prefer\-implementation \- Just like "prefer interface", but if both comments are non\-empty, use the implementation comment