.TH PYREVERSE 1 "August 18, 2008" pyreverse "User's Manual"
.SH NAME
pyreverse \- parse python sources files and extract diagrams from
them.

.SH SYNOPSIS
.B pyreverse 
.I {dot|tests|vcg|xmi}
.I [options]
<modules>

.SH DESCRIPTION
.B pyreverse
 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, 
 vcg and xmi). 
 (For now, the 'xmi' and 'tests' commands are not under developpement.)

 With different options, you can have fine tuning on what and how modules, 
 classes and attributes will be shown in the diagram.
 You can combine several modules in one project (except with 
.B -c
).

.SH COMMON OPTIONS

.IP "-h, --help"
 show this help message and exit
.IP "-p<name>, --project=<name>"
 set project name to <name> if not using -c option. (default:'No Name')
.IP "-i<file>, --ignore=<file>"
 add <file> (may be a directory) to the black list (not parsed)
.IP "-f<mode>, --filter-mode=<mode>"
filter attributes and functions according to <mode>. You can combine 
 modes using '+' like 'SPECIAL+OTHER'. Correct modes are :
  'PUB_ONLY' filter all non public attributes (default)
  'ALL' no filter
  'SPECIAL' filter Python special functions except constructor
  'OTHER' filter protected and private attributes

.IP "-d<file>, --diadefs=<file>"
 create diagram according to the diagrams definitions in <file>
.IP "-c <class>, --class=<class>"
  create a class diagram with all classes related to <class>  [current: none]
  the class must be in the file <modules>. By default, this will include all
  ancestors of <class> and include module names (i.e. '-my' ).
.IP  "-l <depth>, --search-level=<depth>"
 limit depth of search for associated classes [default: not limited].
 (<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=1)
.IP   "-m [yn], --module-names=[yn]"
                        include module name in representation of classes
                        [current: none]
.IP  "-b [yn], --builtin=[yn]"
                        include builtin objects in representation of classes
                        [current: none]

.SH DOT, VCG OPTIONS
 If no -c and no --diadefs option specified, pyreverse {dot|vcg} will create 
    \- a diagram 'classes_<name>.{dot|vcg}' for the classes in <modules> and
    \- a diagram 'packages_<name>.{dot|vcg}' for the packages in <modules>.


.SH DOT OPTIONS
creates a dot diagram for packages and a dot file for classes.
.IP "-o <format>, --output=<format>"
create an additionnal *.<format> output file if format available
[default: None]

.SH VCG OPTIONS
.IP "-u, --uml"
make a UML like diagram [default: no]

.SH REQUIRES
Python

.SH "SEE ALSO"
.B dot(1), pylint(1)

.I http://www.logilab.org/pyreverse

.SH AUTHORS
Sylvain Thenault, Emile Anclin

This manpage was written by Emile Anclin <emile.anclin@logilab.fr>