plantuml — plantuml - a tool that allows to quickly write UML diagrams
Plantuml generates UML and other diagrams from text.
You can use the following wildcards in files/dirs:
*means any characters but '/'
?one and only one character but '/'
**means any characters (used to recurse through directories)
where options include:
-guiTo run the graphical user interface
-tpngTo generate images using PNG format (default)
-tsvgTo generate images using SVG format
-tepsTo generate images using EPS format
-tpdfTo generate images using PDF format
-tvdxTo generate images using VDX format
-txmiTo generate XMI file for class diagram
-thtmlTo generate HTML files for class diagram
-ttxtTo generate images with ASCII art
-tutxtTo generate images with ASCII art using Unicode characters
-o[utput] "dir"To generate images in the specified directory
-DVAR1=valueTo set a preprocessing variable as if '!define VAR1 value' were used
-Sparam1=valueTo set a skin parameter as if 'skinparam param1 value' were used
-r[ecurse]recurse through directories
-config "file"To read the provided config file before each diagram
-charset xxxTo use a specific charset (default is UTF-8)
-e[x]clude patternTo exclude files that match the provided pattern
-metadataTo retrieve PlantUML sources from PNG images
-versionTo display information about PlantUML and Java versions
-checkversionTo check if a newer version is available for download
-v[erbose]To have log information
-quietTo NOT print error message into the console
-keepfilesTo NOT delete temporary files after process
-h[elp]To display this help message
-testdotTo test the installation of graphviz
-graphvizdot "exe"To specify dot executable
-p[ipe]To use stdin for PlantUML source and stdout for PNG/SVG/EPS generation
-encodesprite 4|8|16[z] "file"To encode a sprite at gray level (z for compression) from an image
-computeurl|-encodeurlTo compute the encoded URL of a PlantUML source file
-decodeurlTo retrieve the PlantUML source from an encoded URL
-syntaxTo report any syntax error from standard input without generating images
-languageTo print the list of PlantUML keywords
-nosuggestengineTo disable the suggest engine when errors in diagrams
-checkonlyTo check the syntax of files without generating images
-failfastTo stop processing as soon as a syntax error in diagram occurs
-failfast2To do a first syntax check before processing files, to fail even faster
-patternTo print the list of Regular Expression used by PlantUML
-durationTo print the duration of complete diagrams processing
-nbthread NTo use (N) threads for processing
-nbthread autoTo use 4 threads for processing
-author[s]To print information about PlantUML authors
-overwriteTo allow to overwrite read only files
-printfontsTo print fonts available on your system
If needed, you can setup the environment variable GRAPHVIZ_DOT.
See PDF file file:///usr/share/doc/packages/plantuml/PlantUML_Language_Reference_Guide.pdf for more information.