Linux Certif

Toute la documentation sur la certification Linux LPI

synopsis

NAME

synopsis - Source code introspection tool

SYNOPSIS

synopsis [options] <input files>

DESCRIPTION

synopsis is the command line interface to Synopsis, a multi-language source code introspection tool. Synopsis provides a variety of representations for the parsed code to enable further processing such as documentation extraction, reverse engineering, and source-to-source translation.

synopsis can be used to send source files through the Synopsis processing pipeline. The pipeline consists of three stages: the parser, the linker and the formatter. It is possible to select from various processors for each stage.

OPTIONS

synopsis accepts the following options:

-h, --help

Print the list of options.

-V, --version

Print version info and exit.

-v --verbose

Operate verbosely.

-d --debug

Operate in debug mode.

-o, --output

Set the output file or directory.

-p, --parser <parser>

Select a parser.

Currently Synopsis contains parsers for C ( C ), C++ ( Cpp , Cxx ), IDL ( IDL ) and Python ( Python ).

-Wp,<arg>[,<arg>...]

Send parameters to the parser.

-l, --linker

Also perform the linking stage.

-Wl,<arg>[,<arg>...]

Send parameters to the linker.

-f, --formatter <formatter>

Select a formatter.

Currently Synopsis contains formatters for HTML ( HTML ), Docbook ( Docbook ) and Dot ( Dot ) output. It also contains formatters to print the Abstract Syntax Tree in an ASCII format ( ASCII ) or an XML format ( Dump ).

-Wf,<arg>[,<arg>...]

Send parameters to the formatter.

-I <path>

Specify the include path.

-D <macro>

Specify macro for the parser.

-j --javadoc

Process javadoc tags in comments.

EXAMPLES

synopsis -p Python -f HTML -o html *.py

Parses all .py files in the current directory with the Python parser, formats the result with the HTML formatter and writes the resulting .html files into the html subdirectory.

synopsis -p Cxx -f Dump -o result.xml *.cpp

Parses all .cpp files in the current directory with the Cxx parser, formats the Abstract Syntax Tree with the Dump formatter and writes the result into the file result.xml