.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PLANTUML 1"
.TH PLANTUML 1 "2023-03-08" "" ""
.\" 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 \s-1UML\s0 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 \s-1GUI\s0 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 \s-1PNG\s0 image (default)" 4
.IX Item "png PNG image (default)"
.PD 0
.IP "\fBsvg\fR \s-1SVG\s0 image" 4
.IX Item "svg SVG image"
.IP "\fBeps\fR \s-1EPS\s0 image" 4
.IX Item "eps EPS image"
.IP "\fBpdf\fR \s-1PDF\s0 image" 4
.IX Item "pdf PDF image"
.IP "\fBvdx\fR \s-1VDX\s0 image" 4
.IX Item "vdx VDX image"
.IP "\fBxmi\fR \s-1XMI\s0 file for class diagram" 4
.IX Item "xmi XMI file for class diagram"
.IP "\fBscxml\fR \s-1SCXML\s0 file for state diagram" 4
.IX Item "scxml SCXML file for state diagram"
.IP "\fBhtml\fR \s-1HTML\s0 file for class diagram" 4
.IX Item "html HTML file for class diagram"
.IP "\fBtxt\fR \s-1ASCII\s0 art" 4
.IX Item "txt ASCII art"
.IP "\fButxt\fR \s-1ASCII\s0 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 \s-1UTF\-8\s0).
.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 \s-1PNG\s0 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 \s-1NOT\s0 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 \s-1PNG/SVG\s0 generation." 4
.IX Item "-pipe, -p Use stdin for PlantUML source and stdout for PNG/SVG generation."
.IP "\fB\-computeurl\fR Compute the encoded \s-1URL\s0 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 \s-1URL.\s0" 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: <https://plantuml.com/command\-line>.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\fI\s-1DISPLAY\s0\fR" 4
.IX Item "DISPLAY"
If not set or empty, uses Java's headless mode to run \fIPlantUML\fR.
.IP "\fI\s-1GRAPHVIZ_DOT\s0\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 \fI\s-1GRAPHVIZ_DOT\s0\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 \s-1FTP\s0 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 <plantuml@gmail.com>.
.PP
This manual page was written by Ilya Paramonov <ivparamonov@gmail.com>
and updated by Andrej Shadura <andrewsh@debian.org>, for the Debian project (and may be used by others).