• CommandLine

PasDoc is called like

pasdoc <options> <parameters>

where <parameters> are the files to process and <options> is a combination of directives from the following list.

Please note that the short single-letter version is case-sensitive. Defaults are in brackets.

• -?, –help

  • Show pasdoc help text: pasdoc version and short summary of available command-line options. Pretty much something like this wiki page you're reading now.

• –version

  • Show pasdoc version (and related info)

• -v, –verbosity

  • Set log verbosity (0-6) [2]

• -D, --define

  • Define conditional

• -d, --conditionals

  • Read conditionals from this file

• -R, --description

  • Read description from this file

• -I, --include

  • Include search path

• -S, –source

  • Read source filenames from file, - (single dash) means standard input.

• –html-help-contents

  • Read Contents for HTML-Help from file

• -N, --name

  • Project name, this determines output documentation filename (only if documentation format is not HTML)

• -T, --title

  • Documentation title

• -F, --footer

  • Include file as footer

• -H, --header

  • Include file as header

• -O, –format

  • Output format:

  • html (see HtmlOutput)

  • htmlhelp (see HtmlHelp)

  • latex (see LatexOutput)

  • latex2rtf (see Latex2RtfOutput)

  • simplexml (in development version only, will be included in next release)

• -E, --output

  • Specify output path

• -X, --exclude-generator

  • Exclude generator information

• -L, --language

  • Set output language

• --staronly

  • Parse only {**, (*** and //** style comments

• --marker

  • Parse only {<marker>, (*<marker> and //<marker> comments. Overrides the staronly option, which is a shortcut for '–marker=**'

• --marker-optional

  • Do not require the markers given in –marker but remove them from the comment if they exist.

• –numericfilenames

  • Causes the html generator to create numeric filenames

• -M, --visible-members

  • Include / Exclude class Members by visiblity

• --write-uses-list

  • Write uses list of a unit into output

• --graphviz-uses

  • Write a GVUses.dot file that can be used for the dot program from GraphViz to generate a unit dependency graph

• --link-gv-uses

  • Add a link to the GVUses to the overview frame

• --graphviz-classes

  • Write a GVClasses.dot file that can be used for the dot program from GraphViz to generate a class hierarchy graph

• --link-gv-classes

  • Add a link to GVClasses to the overview frame

• –abbreviations

  • Abbreviation file, format is "[name] value", value is trimmed, lines that do not start with [ (or whitespace before that) are ignored

• --aspell

  • Enable aspell, give language as parameter

• --spell-check-ignore-words

  • When spell-checking, ignore the words in that file. The file should contain one word on every line

• --cache-dir

  • Cache directory for parsed files (default not set)

• --link-look

  • How multipart links (like @link(Unit.Procedure)) look like in output

• --full-link

  • Obsolete name for --link-look=full option.

• --auto-abstract

  • Automatically deduce @abstract description of item from 1st sentence of it's full description

• --css

  • Use the code of your cascading style sheet in replacement of default one.

• --use-tipue-search

  • Use tipue search engine in HTML output.

• --sort

  • Specifies what groups of items are sorted.

• --introduction

  • Specify the name of a text file to use as introduction in your documentation.

• --conclusion

  • Specify the name of a text file to use as conclusion in your documentation.

• –latex-head

  • Specify the name of a text file that should 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 turn your identifiers into links, without the need to enclose them in @link tag.

• --auto-link-exclude

  • Fine-tune the --auto-link behavior: Prevent automatic linking for the specified identifiers.

Confused? Maybe some Examples can help.