table of contents
other versions
| SYNOPSIS(1) | User Commands | SYNOPSIS(1) |
NAME¶
synopsis - 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.
DESCRIPTION¶
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.
| April 2009 | synopsis version devel (revision unknown) |