.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "PLANTUML 1" .TH PLANTUML 1 2024-04-23 "" "" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME plantuml \- generate UML diagrams from a text description .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBplantuml\fR [\fIoptions\fR] \fIfiles/dirs\fR... .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fIPlantUML\fR is used to draw UML diagrams using a simple and human readable text description. .PP Note that \fBgraphviz\fR is required to be installed for generation of all diagrams except sequence diagrams. .PP 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: \fI.txt\fR, \fI.tex\fR, \fI.java\fR, \fI.htm\fR, \fI.html\fR, \fI.c\fR, \&\fI.h\fR, \fI.cpp\fR). .PP You can use the following wildcards in files/dirs: .IP "\fB*\fR means any characters but '/'" 4 .IX Item "* means any characters but '/'" .PD 0 .IP "\fB?\fR one and only one character but '/'" 4 .IX Item "? one and only one character but '/'" .IP "\fB**\fR means any characters (used to recurse through directories)" 4 .IX Item "** means any characters (used to recurse through directories)" .PD .SH OPTIONS .IX Header "OPTIONS" .IP \fB\-t\fR\fIformat\fR 4 .IX Item "-tformat" Generate images in one of the following formats: .RS 4 .IP "\fBpng\fR PNG image (default)" 4 .IX Item "png PNG image (default)" .PD 0 .IP "\fBsvg\fR SVG image" 4 .IX Item "svg SVG image" .IP "\fBeps\fR EPS image" 4 .IX Item "eps EPS image" .IP "\fBpdf\fR PDF image" 4 .IX Item "pdf PDF image" .IP "\fBvdx\fR VDX image" 4 .IX Item "vdx VDX image" .IP "\fBxmi\fR XMI file for class diagram" 4 .IX Item "xmi XMI file for class diagram" .IP "\fBscxml\fR SCXML file for state diagram" 4 .IX Item "scxml SCXML file for state diagram" .IP "\fBhtml\fR HTML file for class diagram" 4 .IX Item "html HTML file for class diagram" .IP "\fBtxt\fR ASCII art" 4 .IX Item "txt ASCII art" .IP "\fButxt\fR ASCII art using Unicode characters" 4 .IX Item "utxt ASCII art using Unicode characters" .IP "\fBlatex\fR LaTeX/TikZ format" 4 .IX Item "latex LaTeX/TikZ format" .IP "\fBlatex:nopreamble\fR LaTeX/TikZ format without preamble" 4 .IX Item "latex:nopreamble LaTeX/TikZ format without preamble" .RE .RS 4 .RE .IP "\fB\-output\fR \fIdir\fR, \fB\-o\fR \fIdir\fR" 4 .IX Item "-output dir, -o dir" .PD Generate images in the specified directory. .IP "\fB\-config\fR \fIfile\fR" 4 .IX Item "-config file" Read the provided config file before each diagram. .IP "\fB\-charset\fR \fIencoding\fR" 4 .IX Item "-charset encoding" Use a specific encoding (default is UTF\-8). .IP "\fB\-exclude\fR \fIpattern\fR, \fB\-x\fR \fIpattern\fR" 4 .IX Item "-exclude pattern, -x pattern" Exclude files that match the provided pattern. .IP \fB\-metadata\fR 4 .IX Item "-metadata" Retrieve \fIPlantUML sources from PNG images.\fR .IP \fB\-version\fR 4 .IX Item "-version" Display information about \fIPlantUML and Java versions.\fR .IP "\fB\-verbose\fR, \fB\-v\fR" 4 .IX Item "-verbose, -v" Be more verbose. .IP \fB\-quiet\fR 4 .IX Item "-quiet" Don't print error messages. .IP \fB\-keepfiles\fR 4 .IX Item "-keepfiles" Do NOT delete temporary files after process. .IP "\fB\-help\fR, \fB\-h\fR Display a help message." 4 .IX Item "-help, -h Display a help message." .PD 0 .IP "\fB\-testdot\fR Test the installation of \fBgraphviz\fR." 4 .IX Item "-testdot Test the installation of graphviz." .IP "\fB\-graphvizdot\fR \fIpath\fR Specify the \fBdot\fR executable path." 4 .IX Item "-graphvizdot path Specify the dot executable path." .IP "\fB\-pipe\fR, \fB\-p\fR Use stdin for \fIPlantUML\fR source and stdout for PNG/SVG generation." 4 .IX Item "-pipe, -p Use stdin for PlantUML source and stdout for PNG/SVG generation." .IP "\fB\-computeurl\fR Compute the encoded URL of a \fIPlantUML\fR source file." 4 .IX Item "-computeurl Compute the encoded URL of a PlantUML source file." .IP "\fB\-decodeurl\fR Retrieve the \fIPlantUML\fR source from an encoded URL." 4 .IX Item "-decodeurl Retrieve the PlantUML source from an encoded URL." .PD .PP This list of options is not exhaustive. For more information, run \fBplantuml \-help\fR. .PP For more documentation, see the \fIPlantUML\fR's website: . .SH ENVIRONMENT .IX Header "ENVIRONMENT" .IP \fIDISPLAY\fR 4 .IX Item "DISPLAY" If not set or empty, uses Java's headless mode to run \fIPlantUML\fR. .IP \fIGRAPHVIZ_DOT\fR 4 .IX Item "GRAPHVIZ_DOT" Similarly to \fB\-graphvizdot\fR, can be used to specify the path to the \fBdot\fR executable. If both \fIGRAPHVIZ_DOT\fR and \fB\-graphvizdot\fR are used, the command-line setting takes the precedence. .SH NOTES .IX Header "NOTES" The Debian package for \fIPlantUML\fR comes without Easter eggs, XEarth diagram support or inbuilt FTP server, Telnet server or a Sudoku game. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBgraphviz\fR\|(1) .SH AUTHOR .IX Header "AUTHOR" \&\fIPlantUML\fR was written by Arnaud Roques . .PP This manual page was written by Ilya Paramonov and updated by Andrej Shadura , for the Debian project (and may be used by others).