.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
.TH SYNOPSIS "1" "April 2009" "synopsis version devel (revision unknown)" "User Commands"
.SH 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.
.SH DESCRIPTION
Usage : synopsis [options] <input files>
.SS "List of options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Display usage summary.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version information.
.TP
\fB\-v\fR  \fB\-\-verbose\fR
Operate verbosely.
.TP
\fB\-d\fR  \fB\-\-debug\fR
Operate in debug mode.
.TP
\fB\-P\fR  \fB\-\-profile\fR
Profile execution.
.TP
\fB\-o\fR <file>, \fB\-\-output=\fR<file>
Write output to <file>.
.TP
\fB\-p\fR <lang>, \fB\-\-parser=\fR<lang>
Select a parser for <lang>.
.TP
\fB\-Wp\fR,<arg>[,<arg>...]
Send <args> to the parser.
.HP
\fB\-t\fR [<markup>]
.TP
\fB\-\-translate[=\fR<markup>]
Translate comments to doc\-strings, processing it as
<markup> (typical values are 'javadoc' or 'rst').
.TP
\fB\-\-cfilter=\fR<filter>
Specify a comment filter.
.TP
\fB\-\-cprocessor=\fR<processor>
Specify a comment processor.
.TP
\fB\-Wc\fR,<arg>[,<arg>...]
Send <args> to the comment translator.
.TP
\fB\-l\fR
Run the linker.
.TP
\fB\-Wl\fR,<arg>[,<arg>...]
Send <args> to the linker.
.TP
\fB\-\-linker=\fR<processor>
Link, and invoke <processor>.
.HP
\fB\-f\fR <type>,
.TP
\fB\-\-formatter=\fR<type>
Select a formatter for <type>.
.TP
\fB\-Wf\fR,<arg>[,<arg>...]
Send <args> to the formatter.
.TP
\fB\-I\fR <path>
Add <path> to list of include paths.
.TP
\fB\-D\fR <macro>
Add <macro> to list of predefined macros.
.HP
\fB\-s\fR <directory>,
.TP
\fB\-\-sxr=\fR<directory>
Specify sxr directory. If given, process source cross\-references.
.TP
\fB\-\-probe\fR
Probe the specified processor.