@@ -4,32 +4,32 @@ pyreverse \- parse python sources files and extract diagrams from
4
4
them.
5
5
6
6
.SH SYNOPSIS
7
- .B pyreverse
7
+ .B pyreverse
8
8
.I [options]
9
9
<modules>
10
10
11
11
.SH DESCRIPTION
12
12
.B pyreverse
13
13
is a python source analyzer. It parses python packages and produces UML
14
- diagrams in different output formats. (dot, all formats available for dot,
14
+ diagrams in different output formats. (dot, all formats available for dot,
15
15
and vcg).
16
- With different options, you can have fine tuning on what and how modules,
16
+ With different options, you can have fine tuning on what and how modules,
17
17
classes and attributes will be shown in the diagram.
18
- You can combine several modules in one project (except with
18
+ You can combine several modules in one project (except with
19
19
.B \- c
20
20
).
21
21
22
- If no \- c and no \-\- diadefs option specified,
23
- .B pyreverse
24
- will create
22
+ If no \- c and no \-\- diadefs option specified,
23
+ .B pyreverse
24
+ will create
25
25
\- a diagram 'classes_<name>' for the classes in <modules> and
26
26
( if there is more than one module in <projects> )
27
- \- a diagram 'packages_<name>' for the package dependencies in <modules>
27
+ \- a diagram 'packages_<name>' for the package dependencies in <modules>
28
28
29
29
With \- c <class>,
30
- .B pyreverse
30
+ .B pyreverse
31
31
creates a diagram for that <class> with filename <class>.<format>.
32
- You can do \- c <class1> , \- c <class2>.
32
+ You can do \- c <class1> , \- c <class2>.
33
33
34
34
.SH OPTIONS
35
35
@@ -41,7 +41,7 @@ set project name to <name> if not using \-c option. (default:'No Name')
41
41
add files or directories to the blacklist. They should be base names, not
42
42
paths. [current: CVS]
43
43
.IP " -f<mode>, --filter-mode=<mode>"
44
- filter attributes and functions according to <mode>. You can combine
44
+ filter attributes and functions according to <mode>. You can combine
45
45
modes using '+' like 'SPECIAL+OTHER'. Correct modes are :
46
46
- 'PUB_ONLY' : filter all non public attributes (default)
47
47
- 'ALL' : no filter
@@ -53,7 +53,7 @@ create diagram according to the diagram definitions in <file>
53
53
.IP " -c <class>, --class=<class>"
54
54
create a class diagram with all classes related to <class> [current: none]
55
55
the class must be in the file <modules>. By default, this will include all
56
- ancestors and associated classes of <class> and include module names
56
+ ancestors and associated classes of <class> and include module names
57
57
(i.e. '\- ASmy' ).
58
58
59
59
.IP " -a <ancestor>, --show-ancestors=<ancestor>"
@@ -62,7 +62,7 @@ show <ancestor> generations of ancestor classes not in <projects>
62
62
show all ancestors off all classes in <projects> [current: none]
63
63
.IP " -s <ass_level>, --show-associated=<associated>"
64
64
show <ass_level> associated classes. <ass_level>=1 will only take classes
65
- directly related to the classes in the project, while <ass_level>=2
65
+ directly related to the classes in the project, while <ass_level>=2
66
66
will also take all classes related to those fetched by<depth>=1.
67
67
.IP " -S, --all-associated=[yn]"
68
68
show recursively all associated off all associated classes [current: none]
@@ -74,12 +74,12 @@ include module name in representation of classes. This will include the
74
74
full module path in the class name. [current: none]
75
75
76
76
.IP " -k, --only-classnames"
77
- don't show attributes and methods in the class boxes;
77
+ don't show attributes and methods in the class boxes;
78
78
this disables \- f values [current: False]
79
79
80
80
.IP " -o <format>, --output=<format>"
81
81
create a *.<format> output file if format available. Available formats
82
- are all formats that dot can produce and
82
+ are all formats that dot can produce and
83
83
.B vcg.
84
84
[default: dot]
85
85
@@ -88,8 +88,8 @@ Here are some examples for command line options:
88
88
89
89
.IP " pyreverse <project> -a1 -s1 -m"
90
90
91
- \- a1 \- s1 will include one level of ancestor and associated classes in the
92
- diagram of the <project> modules, while \- m will show the full module
91
+ \- a1 \- s1 will include one level of ancestor and associated classes in the
92
+ diagram of the <project> modules, while \- m will show the full module
93
93
path of each class. You can use the
94
94
.B -a, -s, -A, -S
95
95
options in the same way.
@@ -99,8 +99,8 @@ Note that on class diagrams (using
99
99
100
100
.IP " pyreverse mod/foo.py mod/fee.py -k"
101
101
102
- This is interesting if the diagram for <project>=mod is too complicated:
103
- you can show only the class names (no attributes or methods, option \- k);
102
+ This is interesting if the diagram for <project>=mod is too complicated:
103
+ you can show only the class names (no attributes or methods, option \- k);
104
104
or take only the modules you are interested in (here fee.py and foo.py).
105
105
106
106
.SH REQUIRES
0 commit comments