命令行

您也可以使用下面的命令行运行PlantUML:

java -jar plantuml.jar file1 file2 file3

这将在 file1, file2file3 中寻找 @startXYZ。 对于每个图表, 都将创建一个 .png 文件。

对于处理整个文件夹, 您可以使用:

java -jar plantuml.jar "c:/directory1" "c:/directory2"

此命令将寻找 @startXYZ@endXYZ 位于 c:/directory1c:/directory2 目录中的 .c, .h, .cpp, .txt, .pu, .tex, .html, .htm.java 文件。 This command will search for ``@startXYZ`` and ``@endXYZ`` into ``.txt``, ``.tex``, ``.java``, ``.htm``, ``.html``, ``.c``, ``.h``, ``.cpp``, ``.apt``, ``.pu``, ``.puml``, ``.hpp`` or ``.hh`` files of the ``c:/directory1`` and ``c:/directory2`` directories.

WARNING
 This translation need to be updated. 
WARNING

通配符

您也可以使用通过符 :

  • 对于单个字符,用 ?
  • 对于零个或多个字符, 用 *
  • 对于零个或多个字符, (包括 /\), 用一对 **

所以处理所有以 dummy 开始的目录的任意 .cpp 文件:

java -jar plantuml.jar "dummy*/*.cpp"

和处理以 dummy 开始的目录及其子目录中的任意 .cpp 文件 :

java -jar plantuml.jar "dummy*/**.cpp"

排除文件

您可以使用 -x 选项来排除处理队列中的某些文件:

java -jar plantuml.jar -x "**/common/**" -x "**/test/Test*" "dummy*/**/*.cpp"

输出目录

您可以使用 -o 开关来指定一个输出所有图片的目录:

java -jar plantuml.jar -o "c:/outputPng" "c:/directory2"

如果您递归进入几个目录,如果为此输出目录提供绝对路径或相对路径,则会略有不同。

  • 绝对路径: 将使用唯一的输出目录,在其中生成所有图像
  • 相对路径: 将在文件树中使用多个输出目录。

* If you provide a relative path then the images is placed in that directory relative to the location of the input file, not the current directory (note: this applies even if the path begins with a `.`). When Plantuml processes files from multiple directores then the corresponding directory structure is created under the computed output directory.
WARNING
 This translation need to be updated. 
WARNING

Types of Output File

Images for your diagrams can be exported in a variety of different formats. By default the format will be a PNG file but another type can be selected using the following extensions:

Param name Short param name Output format Comment
-tpng-png PNG Default
-tsvg-svg SVG Further details can be found here
-teps-eps EPS Further details can be found here
-teps:text-eps:text EPS This option keeps text as text
-tpdf-pdf PDF Further details can be found here
-tvdx-vdx VDX Microsoft Visio Document
-txmi-xmi XMI Further details can be found here
-tscxml-scxml SCXML
-thtml-html HTML Alpha feature: do not use
-ttxt-txt ATXT ASCII art. Further details can be found here
-tutxt-utxt UTXT ASCII art using Unicode characters
-tlatex-latex LATEX Further details can be found here
-tlatex:nopreamble-latex:nopreamble LATEX Contains no LaTeX preamble creating a document
-tbraille-braille PNG Braille image

Example:

java -jar plantuml.jar yourdiagram.txt -ttxt

配置文件

您还可以在每个图表之前提供将包含的配置文件:

java -jar plantuml.jar -config "./config.cfg" dir1

Metadata

After all preprocessing (includes etc), PlantUML saves the diagram's source code in the generated PNG Metadata in the form of encoded text.
  • It is possible to retrieve this source with the -metadata option. This means that the PNG is almost "editable": you can post it on a corporate wiki where you cannot install plugins, and someone in the future can update the diagram by getting the metadata, editing and re-uploading again. Also, the diagram is stand-alone.
  • Conversely, the -checkmetadata option checks whether the target PNG has the same source and if there are no changes, doesn't regenerate the PNG, thus saving all processing time. This allows you to run PlantUML on a whole folder (or tree with the -recursive option) incrementally.

Sounds like magic! No, merely clever engineering :-)

Example:

  java -jar plantuml.jar -metadata diagram.png > diagram.puml

Unfortunately this option works only with local files. It doesn't work with -pipe so you cannot fetch a URL with eg curl and feed the PNG to PlantUML.

However, the Plantuml server has a similar feature, where it can get a PNG from a URL and extract its metadata.

WARNING
 This translation need to be updated. 
WARNING

退出代码

当图表中存在一些错误时,该命令会返回错误 (-1) 退出代码。 但即使某些图表包含一些错误, 所有 图表仍会生成,这对于大型项目来说可能是耗时的。

您可以使用 -failfast 标志来改变这种行为,在错误发生时尽快停止图表生成。在这种情况下,将生成一些图表,而有些图表则不会生成。

同时有 -failfast2 标志做第一次通过检查。 如果出现某些错误,根本不会有图表生成。如果有错误 -failfast2 运行速度比 -failfast 要快, 这可能对大型项目有用。。

Standard report [stdrpt]

Using the -stdrpt (standard report) option, you can change the format of the error output of your PlantUML scripts.

With this option, a different error output of your diagram is possible:
  • -stdrpt
  • -stdrpt:1
  • -stdrpt:2

[Ref. Issue#155 and QA-11805]

Examples, with the bad file file1.pu, where as is written aass:

@startuml
participant "Famous Bob" aass Bob
@enduml

Without any option

java -jar plantuml.jar file1.pu

The error output is:

Error line 2 in file: file1.pu
Some diagram description contains errors

-stdrpt option

java -jar plantuml.jar -stdrpt file1.pu

The error output is:

file1.pu:2:error:Syntax Error?

-stdrpt:1 option

java -jar plantuml.jar -stdrpt:1 file1.pu

The error output is:

protocolVersion=1
status=ERROR
lineNumber=2
label=Syntax Error?
Error line 2 in file: file1.pu
Some diagram description contains errors

-stdrpt:2 option (like -stdrpt)

java -jar plantuml.jar -stdrpt:2 file1.pu

The error output is:

file1.pu:2:error:Syntax Error?

标准输入输出

使用 -pipe 选项,您可以很容易在脚本中使用 PlantUML。

使用此选项,通过标准输入接收图表描述,并生成png文件到标准输出。在本地文件系统上不会写任何文件。

例如:

type somefile.txt | java -jar plantuml.jar -pipe > somefile.png

WARNING
 This translation need to be updated. 
WARNING

帮助

您可以用以下命令来获得帮助:

java -jar plantuml.jar -help

这将输出:

Usage: java -jar plantuml.jar [options] -gui
(to execute the GUI)
    or java -jar plantuml.jar [options] [file/dir] [file/dir] [file/dir]
(to process files or directories)

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:
    -DVAR1=value                   Set a preprocessing variable as if '!define VAR1 value' were used
    -I/path/to/file                Include file as if '!include file' was used
    -I/path/to/*.puml              Include files with pattern
    -Sparam1=value                 Set a skin parameter as if 'skinparam param1 value' were used
    -author[s]                     Print information about PlantUML authors
    -charset xyz                   Use a specific charset (default is windows-1252).
                                   Use "utf-8" for extra international chars
    -checkmetadata                 Skip PNG files that don't need to be regenerated
    -checkonly                     Check the syntax of files without generating images
    -checkversion                  Check if a newer version is available for download
    -computeurl|-encodeurl         Compute the encoded URL of a PlantUML source file
    -config "file"                 Include a file before each diagram (same as -I ??)
    -cypher                        Cypher texts of diagrams so that you can share them
    -decodeurl                     Retrieve the PlantUML source from an encoded URL
    -disablestats                  Disable statistics computation (default)
    -duration                      Print the duration of complete diagrams processing
    -[exclude|x] pattern           Exclude files that match the provided pattern
    -enablestats                   Enable statistics computation
    -encodesprite 4|8|16[z] "file" Encode a sprite at gray level (z for compression) from an image
    -extractstdlib                 Extract PlantUML Standard Library into stdlib folder
    -failfast                      Stop processing as soon as a syntax error in diagram occurs
    -failfast2                     Do a first syntax check before processing files, to fail even faster
    -filename \"example.puml\"     Override %filename% variable
    -graphvizdot "exe"             Specify the graphviz "dot" executable.
                                   If needed, you can setup the environment variable GRAPHVIZ_DOT.
    -gui                           Run the graphical user interface
    -h[elp]                        Display this help message
    -htmlstats                     Output general statistics in file plantuml-stats.html
    -keepfiles                     Do NOT delete temporary files after processing
    -language                      Print the list of PlantUML keywords
    -loopstats                     Continuously print statistics about usage
    -metadata                      Retrieve PlantUML sources from PNG images
    -nbthread N                    Use N threads for processing
    -nbthread auto                 Use 4 threads for processing
    -o[utput] "dir"                Generate images in the specified directory
    -overwrite                     Allow overwriting of read-only files
    -p[ipe]                        Use stdin for PlantUML source and stdout for PNG/SVG/EPS generation
    -pattern                       Print the list of Regular Expression used by PlantUML
    -pipeNoStderr                  When used with -pipe, print errors to stdout (no image is generated in that case).
                                   The first line is "ERROR" and it respects -pipedelimitor
    -pipedelimitor "xyz"           When used with -pipe, append "xyz" after every image
    -pipeimageindex N              Generate only the N-th image when used with -pipe
    -pipemap                       Generate PNG map data of hyperlink rectangles, for use in HTML
    -preproc                       Output the preprocessed text of diagrams
    -printfonts                    Print fonts available on your system
    -progress                      Display a textual progress bar at the console
    -quiet                         Do NOT print error messages to the console
    -r[ecurse]                     Recurse through directories
    -realtimestats                 Generate statistics on the fly rather than at the end
    -splash                        Display a splash screen with some progress bar
    -stdlib                        Print standard library info
    -syntax                        Report any syntax error from standard input without generating images
    -teps                          Generate images using EPS format
    -testdot                       Test the installation of graphviz
    -thtml                         Generate HTML file for class diagram
    -tlatex                        Generate images using LaTeX/Tikz format
    -tlatex:nopreamble             Generate images using LaTeX/Tikz format without preamble
    -tpdf                          Generate images using PDF format
    -tpng                          Generate images using PNG format (default)
    -tscxml                        Generate SCXML file for state diagram
    -tsvg                          Generate images using SVG format
    -ttxt                          Generate images with ASCII art
    -tutxt                         Generate images with ASCII art using Unicode characters
    -tvdx                          Generate images using VDX format
    -txmi                          Generate XMI file for class diagram
    -v[erbose]                     Have log information
    -version                       Display information about PlantUML and Java versions
    -xmlstats                      Output general statistics in file plantuml-stats.xml

WARNING
 This translation need to be updated. 
WARNING