fpdoc -V (return code: 1)
FPDoc - Free Pascal Documentation Tool
Version 3.0.2 [2017/09/14]
(c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org
(c) 2005 - 2012 various FPC contributors
No package name specified. Please specify one using the --package option.
Usage: fpdoc-3.0.2 [options]
--content Create content file for package cross-references
--cputarget=value Set the target CPU for the scanner.
--descr=file use file as description file, e.g.:
--descr=c:\WIP\myzipperdoc.xml
This option is allowed more than once
--descr-dir=Dir Add All XML files in Dir to list of description files
--format=fmt Select output format.
--help Show this help.
--hide-protected Do not show protected methods in overview
--import=file Import content file for package cross-references
--input=cmd use cmd as input for the parser, e.g.:
--input=C:\fpc\packages\paszlib\src\zipper.pp
At least one input option is required.
--input-dir=Dir Add All *.pp and *.pas files in Dir to list of input files
--lang=lng Select output language.
--ostarget=value Set the target OS for the scanner.
--output=name use name as the output name.
Each backend interprets this as needed.
--package=name Set the package name for which to create output,
e.g. --package=fcl
--project=file Use file as project file
--show-private Show private methods.
--warn-no-node Warn if no documentation node was found.
--mo-dir=dir Set directory where language files reside to dir
--parse-impl (Experimental) try to parse implementation too
--dont-trim Do not trim XML contents. Useful for preserving
formatting inside e.g <pre> tags
--write-project=file
Do not write documentation, create project file instead
--verbose Write more information on the screen
--dry-run Only parse sources and XML, do not create output
--write-project=file
Write all command-line options to a project file
The following output formats are supported by this fpdoc:
chm - Compressed HTML file output using fpdoc.css stylesheet.
dxml - fpdoc Delphi XML output.
htm - HTM (8.3 filenames) output using fpdoc.css stylesheet.
html - HTML output using fpdoc.css stylesheet.
ipf - Writes output in fpGUI and OS/2's IPF help format
latex - Latex output using fpc.sty class.
man - UNIX man page output.
rtf - RTF output.
txt - Plain text.
xml - fpdoc XML output.
Specify an output format, combined with --help to get more help for this backend.
fpdoc --help (return code: 0)
FPDoc - Free Pascal Documentation Tool
Version 3.0.2 [2017/09/14]
(c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org
(c) 2005 - 2012 various FPC contributors
Usage: fpdoc-3.0.2 [options]
--content Create content file for package cross-references
--cputarget=value Set the target CPU for the scanner.
--descr=file use file as description file, e.g.:
--descr=c:\WIP\myzipperdoc.xml
This option is allowed more than once
--descr-dir=Dir Add All XML files in Dir to list of description files
--format=fmt Select output format.
--help Show this help.
--hide-protected Do not show protected methods in overview
--import=file Import content file for package cross-references
--input=cmd use cmd as input for the parser, e.g.:
--input=C:\fpc\packages\paszlib\src\zipper.pp
At least one input option is required.
--input-dir=Dir Add All *.pp and *.pas files in Dir to list of input files
--lang=lng Select output language.
--ostarget=value Set the target OS for the scanner.
--output=name use name as the output name.
Each backend interprets this as needed.
--package=name Set the package name for which to create output,
e.g. --package=fcl
--project=file Use file as project file
--show-private Show private methods.
--warn-no-node Warn if no documentation node was found.
--mo-dir=dir Set directory where language files reside to dir
--parse-impl (Experimental) try to parse implementation too
--dont-trim Do not trim XML contents. Useful for preserving
formatting inside e.g <pre> tags
--write-project=file
Do not write documentation, create project file instead
--verbose Write more information on the screen
--dry-run Only parse sources and XML, do not create output
--write-project=file
Write all command-line options to a project file
The following output formats are supported by this fpdoc:
chm - Compressed HTML file output using fpdoc.css stylesheet.
dxml - fpdoc Delphi XML output.
htm - HTM (8.3 filenames) output using fpdoc.css stylesheet.
html - HTML output using fpdoc.css stylesheet.
ipf - Writes output in fpGUI and OS/2's IPF help format
latex - Latex output using fpc.sty class.
man - UNIX man page output.
rtf - RTF output.
txt - Plain text.
xml - fpdoc XML output.
Specify an output format, combined with --help to get more help for this backend.