synopsis1

Simple frontend to the synopsis framework, a multi-language source code introspection tool that provides a variety of representations for the parsed code, to enable further processing such as documentation extraction, reverse engineering, and source-to-source translation.

Overview

Usage : synopsis [options] <input files>

List of options:

-h, --help: Display usage summary.

-V, --version: Display version information.

-v --verbose: Operate verbosely.

-d --debug: Operate in debug mode.

-P --profile: Profile execution.

-o <file>, --output=<file>: Write output to <file>.

-p <lang>, --parser=<lang>: Select a parser for <lang>.

-Wp,<arg>[,<arg>...]: Send <args> to the parser.

-t [<markup>]

--translate[=<markup>]: Translate comments to doc-strings, processing it as <markup> (typical values are 'javadoc' or 'rst').

--cfilter=<filter>: Specify a comment filter.

--cprocessor=<processor>: Specify a comment processor.

-Wc,<arg>[,<arg>...]: Send <args> to the comment translator.

-l: Run the linker.

-Wl,<arg>[,<arg>...]: Send <args> to the linker.

--linker=<processor>: Link, and invoke <processor>.

-f <type>,

--formatter=<type>: Select a formatter for <type>.

-Wf,<arg>[,<arg>...]: Send <args> to the formatter.

-I <path>: Add <path> to list of include paths.

-D <macro>: Add <macro> to list of predefined macros.

-s <directory>,

--sxr=<directory>: Specify sxr directory. If given, process source cross-references.

--probe: Probe the specified processor.

History

Debian 10 (Buster) to Debian 6.0 (Squeeze): the text shown here
Debian 5.0 (Lenny) to Debian 4.0 (Etch)
Debian 3.1 (Sarge)

--cfilter since Debian 6.0 (Squeeze); --cprocessor since Debian 6.0 (Squeeze); --debug since Debian 4.0 (Etch); --linker since Debian 4.0 (Etch); --output since Debian 4.0 (Etch); --probe since Debian 6.0 (Squeeze); --profile since Debian 6.0 (Squeeze); --sxr since Debian 6.0 (Squeeze); --translate since Debian 6.0 (Squeeze); -D since Debian 4.0 (Etch); -I since Debian 4.0 (Etch); -P since Debian 6.0 (Squeeze); -d since Debian 4.0 (Etch).

--config until Debian 3.1 (Sarge); --javadoc until Debian 5.0 (Lenny); --list until Debian 3.1 (Sarge); -M until Debian 3.1 (Sarge); -c until Debian 3.1 (Sarge); -f until Debian 5.0 (Lenny); -j until Debian 5.0 (Lenny); -m until Debian 3.1 (Sarge); -s until Debian 3.1 (Sarge).