PASDOC(1)

📦
version 1.0.4 · 6 versions
, in ubuntu stonking

👑 PASDOC(1) — User Commands 💅

okay bestie, sit down, hydrate, and let me tell you about PasDoc — the documentation tool for Pascal source code. yes. it reads your Pascal. it makes docs. it's iconic, it's free software, and it's about to be your whole personality.

🌸 NAME 🌸

PasDoc — a documentation tool for Pascal source code. she parses, she documents, she slays. periodt.

✨ SYNOPSIS ✨

pasdoc [options] [files]

that's it. options, then your files. go off.

💖 DESCRIPTION 💖

PasDoc 1.0.4 [2026-04-04|FPC 3.2.2|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. (ngl that's the standard legal drama, but fr fr, no warranty, bestie, not even for FITNESS FOR A PARTICULAR PURPOSE.) 🫶

🎀 Valid options are: 🎀

  • @<path to config file> — read your options from the file you point at and drop them in right at this exact position. the file has to have one option per line, and the format is "name[=value]" — options are named just like they are on the command line, but with the leading dashes OFF. and listen: option values with spaces must NOT be quoted. no quotes. do not do it. 🙈
  • -?, --help — show this help. the classic. the blueprint. 💅
  • --version — show the pasdoc version (plus the related info that comes with it).
  • -v, --verbosity — set how chatty the log is. range is 0-6. default is 2.
  • -D, --define — define a conditional.
  • -R, --description — read the description from this file.
  • -d, --conditionals — read the conditionals from this file.
  • -I, --include — includes search path.
  • -S, --source — read source filenames from a file.
  • --html-help-contents — read the Contents for HtmlHelp from a file.
  • -H, --header — include a file as the header for the HTML output.
  • -F, --footer — include a file as the footer for the HTML output.
  • --html-head — include a file to use inside the HTML <head>.
  • --html-body-begin — include a file to use right after the HTML <body>.
  • --html-body-end — include a file to use right before the HTML </body>.
  • -N, --name — name for the documentation.
  • -T, --title — documentation title.
  • -O, --format — output format, and your choices are: html, simplexml, latex, latex2rtf, htmlhelp, php.
  • -E, --output — output path.
  • -X, --exclude-generator — exclude the generator information.
  • --include-creation-time — include the creation time in the docs.
  • --lowercase-keywords — lowercase all literal tag keywords (@nil, @false, @true).
  • -L, --language — output language. the valid languages are, and I'm listing every single one because we do not skip, we do not summarise, we are thorough girlies:
    • 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)
  • --staronly — parse only {**, (*** and //** style comments.
  • --marker — parse only {<marker>, (*<marker> and //<marker> comments. overrides the staronly option, which is a shortcut for '--marker=**'. yes, she ate and left no crumbs. 🔥
  • --ignore-marker — skip comments starting with <marker> (that is, {<marker>, (*<marker> and //<marker> comments).
  • --marker-optional — don't require the markers you gave in --marker, but still remove them from the comment if they're there.
  • --ignore-leading — ignore leading <ignore-leading> characters in comments.
  • --numericfilenames — makes the html generator create numeric filenames.
  • -M, --visible-members — include / exclude class Members by visibility.
  • --write-uses-list — put the uses list into the output.
  • --graphviz-uses — write a GVUses.dot file that can be used for the dot program from GraphViz to generate a unit dependency graph.
  • --graphviz-classes — write a GVClasses.dot file that can be used for the dot program from GraphViz to generate a class hierarchy graph. the class tree diagram is giving main character energy.
  • --link-gv-uses — 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)
  • --link-gv-classes — 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)
  • --abbreviations — abbreviation file. the format is "[name] value", the value gets trimmed, and any lines that don't start with '[' (or whitespace before that '[') are ignored.
  • --spell-check — enable spell-checking by Aspell, and specify the language with the --language option.
  • --spell-check-ignore-words — when spell-checking, ignore the words in that file. the file should have one word on every line.
  • --aspell — Deprecated, use --spell-check. this one enables spell checking by Aspell but gives the language as a parameter.
  • --cache-dir — cache directory for parsed files (default: not set).
  • --link-look — how links are displayed in the documentation. it's one of "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 the last part of the link).
  • --inherited-members — show inherited members (in HTML). possible values: "never", "default-show", "default-hide".
  • --full-link — obsolete name for --link-look=full. girl, that option's been superseded, move on. 💀
  • --css — CSS file for HTML output. the CSS file you give gets copied into the output tree as pasdoc.css. Bootstrap CSS is not used.
  • --css-based-on-bootstrap — use a custom CSS file in addition to Bootstrap for the HTML output. Cannot be used together with --css. pick a lane, bestie.
  • --auto-abstract — Deprecated, this behaviour is now the default anyway.
  • --no-auto-abstract — disable automatic abstract determination from the first sentence of each description.
  • --use-tipue-search — use the tipue search engine in HTML output.
  • --sort — specifies what groups of items are sorted (the rest get presented in the same order they were declared in your source files, which, ngl, is a whole vibe of its own).
  • --introduction — the name of a text file with introductory materials for the project.
  • --conclusion — the name of a text file with concluding materials for the project.
  • -A, --additional — the name of a text file with addition materials for the project.
  • --latex-head — the name of a text file that includes lines to be inserted into the preamble of a LaTeX file.
  • --implicit-visibility — how pasdoc should handle class members within default class visibility.
  • --no-macro — turn FPC macro support off.
  • --auto-link — automatically create links, without needing to explicitly use @link tags. automatic. effortless. iconic. ✨
  • --auto-back-comments — consider //-style comments after an identifier in the same line as a description of that identifier.
  • --auto-link-exclude — 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.
  • --external-class-hierarchy — a file defining the hierarchy of classes not included in your source code, for more complete class tree diagrams.
  • --markdown — decode Markdown syntax.
  • --implementation-comments — read the implementation section of units and merge that info with what was taken from the interface section. the option value decides how the info is merged:
    • none — do not read implementation comments.
    • prefer-interface — read both interface and implementation comments. use whichever comment is non-empty. if they're both non-empty, use the interface comment.
    • prefer-implementation — read both interface and implementation comments. use whichever comment is non-empty. if they're both non-empty, use the implementation comment.
    • 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 gets ignored (so we don't repeat the same text 2x in the concatenated result). we love a girl who doesn't repeat herself. 🎀
  • --show-source-position — show source filename and line number in the documentation output.
  • --source-url-pattern — URL pattern for linking source positions (only used if --show-source-position). use {FILE} for the filename and {LINE} for the line number. example:
https://github.com/owner/repo/blob/main/{FILE}#L{LINE}
  • --source-root — root path for source files (only used if --show source-position). leave it empty and --show source-position will just take the final filename part to show.

okay that's the whole page, every flag, every default, every value, no crumbs left behind. you're so ready to document some Pascal and honestly? obsessed. 💜🦋🌸

anyway, this was PasDoc 1.0.4 [2026-04-04|FPC 3.2.2|Linux|64], from April 2026 — and yeah, we were in the PASDOC(1) manual, User Commands section, the whole time. bye bestie, go generate some docs. 💅✨🌈

📦 where this page comes from