update manpage for pyreverse

This commit is contained in:
Emile Anclin 2008-08-25 10:55:04 +02:00
parent ec49e5344a
commit ca49a4413d

View File

@ -5,7 +5,7 @@ them.
.SH SYNOPSIS .SH SYNOPSIS
.B pyreverse .B pyreverse
.I {dot|tests|vcg|xmi} .I {diagram|test|xmi}
.I [options] .I [options]
<modules> <modules>
@ -13,8 +13,7 @@ them.
.B pyreverse .B pyreverse
is a python source analyzer. It can parse a python package and produce UML is a python source analyzer. It can parse a python package and produce UML
diagrams in different output formats. (dot, all formats available for dot, diagrams in different output formats. (dot, all formats available for dot,
vcg and xmi). and vcg). (For now, the 'xmi' and 'tests' commands are not under developpement.)
(For now, the 'xmi' and 'tests' commands are not under developpement.)
With different options, you can have fine tuning on what and how modules, With different options, you can have fine tuning on what and how modules,
classes and attributes will be shown in the diagram. classes and attributes will be shown in the diagram.
@ -31,12 +30,12 @@ them.
.IP "-i<file>, --ignore=<file>" .IP "-i<file>, --ignore=<file>"
add <file> (may be a directory) to the black list (not parsed) add <file> (may be a directory) to the black list (not parsed)
.IP "-f<mode>, --filter-mode=<mode>" .IP "-f<mode>, --filter-mode=<mode>"
filter attributes and functions according to <mode>. You can combine filter attributes and functions according to <mode>. You can combine
modes using '+' like 'SPECIAL+OTHER'. Correct modes are : modes using '+' like 'SPECIAL+OTHER'. Correct modes are :
'PUB_ONLY' filter all non public attributes (default) 'PUB_ONLY' filter all non public attributes (default)
'ALL' no filter 'ALL' no filter
'SPECIAL' filter Python special functions except constructor 'SPECIAL' filter Python special functions except constructor
'OTHER' filter protected and private attributes 'OTHER' filter protected and private attributes
.IP "-d<file>, --diadefs=<file>" .IP "-d<file>, --diadefs=<file>"
create diagram according to the diagrams definitions in <file> create diagram according to the diagrams definitions in <file>
@ -45,31 +44,32 @@ filter attributes and functions according to <mode>. You can combine
the class must be in the file <modules>. By default, this will include all the class must be in the file <modules>. By default, this will include all
ancestors of <class> and include module names (i.e. '-my' ). ancestors of <class> and include module names (i.e. '-my' ).
.IP "-l <depth>, --search-level=<depth>" .IP "-l <depth>, --search-level=<depth>"
limit depth of search for associated classes [default: not limited]. In combination with
(<depth>=1 will only take classes directly related to the classes in the project, .B -c
while <depth>=2 will also take all classes related to those fecthed by=1) , limit depth of search for associated classes [default: not limited].
For example, <depth>=1 will only take classes directly related to the classes
in the project, while <depth>=2 will also take all classes related to those
fecthed by<depth>=1.
.IP "-m [yn], --module-names=[yn]" .IP "-m [yn], --module-names=[yn]"
include module name in representation of classes include module name in representation of classes [current: none]
[current: none]
.IP "-b [yn], --builtin=[yn]" .IP "-b [yn], --builtin=[yn]"
include builtin objects in representation of classes include builtin objects in representation of classes [current: none]
[current: none]
.SH DOT, VCG OPTIONS .SH PYREVERSE DIAGRAM
If no -c and no --diadefs option specified, pyreverse {dot|vcg} will create If no -c and no --diadefs option specified,
\- a diagram 'classes_<name>.{dot|vcg}' for the classes in <modules> and .B pyreverse diagram
\- a diagram 'packages_<name>.{dot|vcg}' for the packages in <modules>. will create
\- a diagram 'classes_<name>' for the classes in <modules> and
\- a diagram 'packages_<name>' for the packages in <modules>.
.SH DOT OPTIONS With -c,
creates a dot diagram for packages and a dot file for classes. .B pyreverse diagram
creates a diagram for each <class> with same name (adding an output file extension).
.IP "-o <format>, --output=<format>" .IP "-o <format>, --output=<format>"
create an additionnal *.<format> output file if format available create a *.<format> output file if format available. Available formats
[default: None] are all formats that dot can produce and
.B vcg.
[default: dot]
.SH VCG OPTIONS
.IP "-u, --uml"
make a UML like diagram [default: no]
.SH REQUIRES .SH REQUIRES
Python Python