1SYNOPSIS(1)                      User Commands                     SYNOPSIS(1)
2
3
4

NAME

6       synopsis  - simple frontend to the Synopsis framework, a multi-language
7       source code introspection tool that provides a variety  of  representa‐
8       tions  for  the parsed code, to enable further processing such as docu‐
9       mentation extraction, reverse engineering, and source-to-source  trans‐
10       lation.
11

DESCRIPTION

13       Usage : synopsis [options] <input files>
14
15   List of options:
16       -h, --help
17              Display usage summary.
18
19       -V, --version
20              Display version information.
21
22       -v  --verbose
23              Operate verbosely.
24
25       -d  --debug
26              Operate in debug mode.
27
28       -P  --profile
29              Profile execution.
30
31       -o <file>, --output=<file>
32              Write output to <file>.
33
34       -p <lang>, --parser=<lang>
35              Select a parser for <lang>.
36
37       -Wp,<arg>[,<arg>...]
38              Send <args> to the parser.
39
40       -t [<markup>]
41
42       --translate[=<markup>]
43              Translate  comments  to  doc-strings,  processing it as <markup>
44              (typical values are 'javadoc' or 'rst').
45
46       --cfilter=<filter>
47              Specify a comment filter.
48
49       --cprocessor=<processor>
50              Specify a comment processor.
51
52       -Wc,<arg>[,<arg>...]
53              Send <args> to the comment translator.
54
55       -l     Run the linker.
56
57       -Wl,<arg>[,<arg>...]
58              Send <args> to the linker.
59
60       --linker=<processor>
61              Link, and invoke <processor>.
62
63       -f <type>,
64
65       --formatter=<type>
66              Select a formatter for <type>.
67
68       -Wf,<arg>[,<arg>...]
69              Send <args> to the formatter.
70
71       -I <path>
72              Add <path> to list of include paths.
73
74       -D <macro>
75              Add <macro> to list of predefined macros.
76
77       -s <directory>,
78
79       --sxr=<directory>
80              Specify sxr directory. If  given,  process  source  cross-refer‐
81              ences.
82
83       --probe
84              Probe the specified processor.
85
86
87
88synopsis version devel (revision unAkpnroiwln)2009                       SYNOPSIS(1)
Impressum