1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
=head1 NAME
plantuml - generate UML diagrams from a text description
=head1 SYNOPSIS
B<plantuml> [I<options>] I<files/dirs>...
=head1 DESCRIPTION
I<PlantUML> is used to draw UML diagrams using a simple and human
readable text description.
Note that B<graphviz> is required to be installed for generation of
all diagrams except sequence diagrams.
When files/directories are given, they are processed in batch mode.
Otherwise, a GUI window appears. It allows user to browse directories and
view diagrams generated from suitable files (must have one of the
following extensions: I<.txt>, I<.tex>, I<.java>, I<.htm>, I<.html>, I<.c>,
I<.h>, I<.cpp>).
You can use the following wildcards in files/dirs:
=over
=item B<*>
means any characters but '/'
=item B<?>
one and only one character but '/'
=item B<**>
means any characters (used to recurse through directories)
=back
=head1 OPTIONS
=over
=item B<-t>I<format>
Generate images in one of the following formats:
=over
=item B<png>
PNG image (default)
=item B<svg>
SVG image
=item B<eps>
EPS image
=item B<pdf>
PDF image
=item B<vdx>
VDX image
=item B<xmi>
XMI file for class diagram
=item B<scxml>
SCXML file for state diagram
=item B<html>
HTML file for class diagram
=item B<txt>
ASCII art
=item B<utxt>
ASCII art using Unicode characters
=item B<latex>
LaTeX/TikZ format
=item B<latex:nopreamble>
LaTeX/TikZ format without preamble
=back
=item B<-output> I<dir>, B<-o> I<dir>
Generate images in the specified directory.
=item B<-config> I<file>
Read the provided config file before each diagram.
=item B<-charset> I<encoding>
Use a specific encoding (default is UTF-8).
=item B<-exclude> I<pattern>, B<-x> I<pattern>
Exclude files that match the provided pattern.
=item B<-metadata>
Retrieve I<PlantUML sources from PNG images.>
=item B<-version>
Display information about I<PlantUML and Java versions.>
=item B<-verbose>, B<-v>
Be more verbose.
=item B<-quiet>
Don't print error messages.
=item B<-keepfiles>
Do NOT delete temporary files after process.
=item B<-help>, B<-h>
Display a help message.
=item B<-testdot>
Test the installation of B<graphviz>.
=item B<-graphvizdot> I<path>
Specify the B<dot> executable path.
=item B<-pipe>, B<-p>
Use stdin for I<PlantUML> source and stdout for PNG/SVG
generation.
=item B<-computeurl>
Compute the encoded URL of a I<PlantUML> source file.
=item B<-decodeurl>
Retrieve the I<PlantUML> source from an encoded URL.
=back
This list of options is not exhaustive. For more information, run B<plantuml -help>.
For more documentation, see the I<PlantUML>'s website: L<< https://plantuml.com/command-line >>.
=head1 ENVIRONMENT
=over
=item I<DISPLAY>
If not set or empty, uses Java's headless mode to run I<PlantUML>.
=item I<GRAPHVIZ_DOT>
Similarly to B<-graphvizdot>, can be used to specify the path to the B<dot> executable. If both I<GRAPHVIZ_DOT> and B<-graphvizdot> are used, the command-line setting takes the precedence.
=back
=head1 NOTES
The Debian package for I<PlantUML> comes without Easter eggs, XEarth diagram support or inbuilt FTP server, Telnet server or a Sudoku game.
=head1 SEE ALSO
L<graphviz(1)>
=head1 AUTHOR
I<PlantUML> was written by Arnaud Roques L<< <plantuml@gmail.com> >>.
This manual page was written by Ilya Paramonov L<< <ivparamonov@gmail.com> >>
and updated by Andrej Shadura L<< <andrewsh@debian.org> >>, for the Debian project (and may be used by others).
|
