1UMLWRITER(1)                                                      UMLWRITER(1)
2
3
4

NAME

6       umlwriter - Create UML class diagrams from your PHP source
7

SYNOPSIS

9       umlwriter [options] command [arguments]
10

DESCRIPTION

12       The umlwriter(1) command parse any data source, and return UML diagram
13       statements in processor format.
14

OPTIONS

16       -h, --help
17           Display this help message.
18
19       -q, --quiet
20           Do not output any message.
21
22       -v|vv|v, --verbose
23           Increase the verbosity of messages: 1 for normal output, 2 for more
24           verbose output and 3 for debug.
25
26       -V, --version
27           Display this application version.
28
29       --ansi
30           Force ANSI output.
31
32       --no-ansi
33           Disable ANSI output.
34
35       --manifest
36           Show which versions of dependencies are bundled (PHAR version
37           only).
38

DIAGRAM:RENDER COMMAND

40       The umlwriter(1) diagram:render command is used to generate diagram
41       about all objects, present in a data source
42
43       Usage:
44
45           umlwriter diagram:render [--reflector[="..."]] [--processor[="..."]] source
46
47       Where:
48
49       source Identify a data source. File or directory
50
51       --reflector Reverse-engine compatible (case insensitive) (default:
52       "reflect")
53
54       --processor Diagram processor (case insensitive)
55

DIAGRAM:RENDER:CLASS COMMAND

57       The umlwriter(1) diagram:render:class command is used to generate
58       diagram about a single class, and its direct dependencies, present in a
59       data source
60
61       Usage:
62
63           umlwriter diagram:render:class [--reflector[="..."]] [--processor[="..."]] source object
64
65       Where:
66
67       source Identify a data source. File or directory
68
69       object Identify the class (fully qualified name)
70
71       --reflector Reverse-engine compatible (case insensitive) (default:
72       "reflect")
73
74       --processor Diagram processor (case insensitive)
75

DIAGRAM:RENDER:NAMESPACE COMMAND

77       The umlwriter(1) diagram:render:namespace command is used to generate
78       diagram about a single namespace, with all its objects, present in a
79       data source
80
81       Usage:
82
83           umlwriter diagram:render:namespace [--reflector[="..."]] [--processor[="..."]] source object
84
85       Where:
86
87       source Identify a data source. File or directory
88
89       object Identify the namespace
90
91       --reflector Reverse-engine compatible (case insensitive) (default:
92       "reflect")
93
94       --processor Diagram processor (case insensitive)
95

EXIT STATUS

97       0
98           Success
99
100       1
101           Failure (syntax or usage error; configuration error; unexpected
102           error).
103

BUGS

105       Report any issue at https://github.com/llaville/umlwriter/issues
106

AUTHORS

108       The Command-Line Interface (CLI) version was introduced in version 1.0
109       and is written by Laurent Laville.
110

SEE ALSO

112       Main web site: http://php5.laurent-laville.org/umlwriter/
113

115       Copyright (C) 2015 Laurent Laville.
116

LICENSE

118       Free use of this software is granted under the terms of the BSD
119       3-clause license.
120
121
122
123  1.0.0                           2015-04-02                      UMLWRITER(1)
Impressum