openSUSE Build Service

Overview Repositories Revisions Requests Users Attributes Meta

File plantuml.xml of Package plantuml (Revision 4dbfea610b74d4798b27cb3bc9dc745d)

Currently displaying revision 4dbfea610b74d4798b27cb3bc9dc745d , Show latest

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC
  "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[
  <!ENTITY product "plantuml">
  <!ENTITY cmd     "plantuml">
]>

<refentry lang="en" id="plantuml.man">
  <refentryinfo>
      <productname>&product;</productname>
      <authorgroup>
         <author>
            <contrib>Developer</contrib>
            <firstname>Arnaud</firstname>
            <surname>Roques</surname>
         </author>
      </authorgroup>
   </refentryinfo>
   <refmeta>
      <refentrytitle>&product;</refentrytitle>
      <manvolnum>1</manvolnum>
      <refmiscinfo class="version">@VERSION@</refmiscinfo>
      <refmiscinfo class="source">http://plantuml.sourceforge.net/download.html</refmiscinfo>
      <refmiscinfo class="manual">http://plantuml.sourceforge.net</refmiscinfo>
   </refmeta>
    <refnamediv>
      <refname>&product;</refname>
      <refpurpose>plantuml - a tool that allows to quickly write UML diagrams</refpurpose>
   </refnamediv>
  
  <refsynopsisdiv id="plantuml.synopsis">
      <title>Synopsis</title>
      <screen> </screen>
      <cmdsynopsis><command>&cmd;</command>
        <arg choice="opt">options</arg>
        <arg>-gui</arg>
      </cmdsynopsis>
      <para>or:</para>
      <cmdsynopsis><command>&cmd;</command>
        <arg choice="opt">options</arg>
        <arg choice="opt">file1/dir1</arg>
        <arg choice="opt">file2/dir2</arg>
        <arg choice="opt">file3/dir3</arg>
      </cmdsynopsis>
  </refsynopsisdiv>
  
 <refsect1>
   <title>Description</title> 
   <para>Plantuml generates UML and other diagrams from text.</para>
   <para>You can use the following wildcards in files/dirs:</para>
   <variablelist>
     <varlistentry>
       <term><literal>*</literal></term>
       <listitem>
         <para>means any characters but '/'
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>?</literal></term>
       <listitem>
         <para>one and only one character but '/'
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>**</literal></term>
       <listitem>
         <para>means any characters (used to recurse through directories)
         </para>
       </listitem>
     </varlistentry>

</variablelist>

<para>where options include:</para>
   <variablelist>
     <varlistentry>
       <term><literal>-gui</literal></term>
       <listitem>
         <para>To run the graphical user interface
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-tpng</literal></term>
       <listitem>
         <para>To generate images using PNG format (default)
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-tsvg</literal></term>
       <listitem>
         <para>To generate images using SVG format
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-teps</literal></term>
       <listitem>
         <para>To generate images using EPS format
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-tpdf</literal></term>
       <listitem>
         <para>To generate images using PDF format
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-tvdx</literal></term>
       <listitem>
         <para>To generate images using VDX format
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-txmi</literal></term>
       <listitem>
         <para>To generate XMI file for class diagram
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-thtml</literal></term>
       <listitem>
         <para>To generate HTML files for class diagram
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-ttxt</literal></term>
       <listitem>
         <para>To generate images with ASCII art
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-tutxt</literal></term>
       <listitem>
         <para>To generate images with ASCII art using Unicode characters
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-o[utput] "dir"</literal></term>
       <listitem>
         <para>To generate images in the specified directory
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-DVAR1=value</literal></term>
       <listitem>
         <para>To set a preprocessing variable as if '!define VAR1 value' were used
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-Sparam1=value</literal></term>
       <listitem>
         <para>To set a skin parameter as if 'skinparam param1 value' were used
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-r[ecurse]</literal></term>
       <listitem>
         <para>recurse through directories
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-config "file"</literal></term>
       <listitem>
         <para>To read the provided config file before each diagram
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-charset xxx</literal></term>
       <listitem>
         <para>To use a specific charset (default is UTF-8)
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-e[x]clude pattern</literal></term>
       <listitem>
         <para>To exclude files that match the provided pattern
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-metadata</literal></term>
       <listitem>
         <para>To retrieve PlantUML sources from PNG images
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-version</literal></term>
       <listitem>
         <para>To display information about PlantUML and Java versions
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-checkversion</literal></term>
       <listitem>
         <para>To check if a newer version is available for download
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-v[erbose]</literal></term>
       <listitem>
         <para>To have log information
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-quiet</literal></term>
       <listitem>
         <para>To NOT print error message into the console
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-keepfiles</literal></term>
       <listitem>
         <para>To NOT delete temporary files after process
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-h[elp]</literal></term>
       <listitem>
         <para>To display this help message
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-testdot</literal></term>
       <listitem>
         <para>To test the installation of graphviz
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-graphvizdot "exe"</literal></term>
       <listitem>
         <para>To specify dot executable
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-p[ipe]</literal></term>
       <listitem>
         <para>To use stdin for PlantUML source and stdout for PNG/SVG/EPS generation
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-encodesprite 4|8|16[z] "file"</literal></term>
       <listitem>
         <para>To encode a sprite at gray level (z for compression) from an image
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-computeurl|-encodeurl</literal></term>
       <listitem>
         <para>To compute the encoded URL of a PlantUML source file
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-decodeurl</literal></term>
       <listitem>
         <para>To retrieve the PlantUML source from an encoded URL
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-syntax</literal></term>
       <listitem>
         <para>To report any syntax error from standard input without generating images
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-language</literal></term>
       <listitem>
         <para>To print the list of PlantUML keywords
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-nosuggestengine</literal></term>
       <listitem>
         <para>To disable the suggest engine when errors in diagrams
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-checkonly</literal></term>
       <listitem>
         <para>To check the syntax of files without generating images
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-failfast</literal></term>
       <listitem>
         <para>To stop processing as soon as a syntax error in diagram occurs
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-failfast2</literal></term>
       <listitem>
         <para>To do a first syntax check before processing files, to fail even faster
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-pattern</literal></term>
       <listitem>
         <para>To print the list of Regular Expression used by PlantUML
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-duration</literal></term>
       <listitem>
         <para>To print the duration of complete diagrams processing
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-nbthread N</literal></term>
       <listitem>
         <para>To use (N) threads for processing
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-nbthread auto</literal></term>
       <listitem>
         <para>To use 4 threads for processing
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-author[s]</literal></term>
       <listitem>
         <para>To print information about PlantUML authors
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-overwrite</literal></term>
       <listitem>
         <para>To allow to overwrite read only files
         </para>
       </listitem>
     </varlistentry>

<varlistentry>
       <term><literal>-printfonts</literal></term>
       <listitem>
         <para>To print fonts available on your system  
       </para>
    
       </listitem>
     </varlistentry>
          
   </variablelist>
   <para>If needed, you can setup the environment variable GRAPHVIZ_DOT.  </para>
 </refsect1>

<refsect1>
   <title>Documentation</title>
   <para>See PDF file <ulink
     url="file:///usr/share/doc/packages/plantuml/PlantUML_Language_Reference_Guide.pdf"/>
     for more information.</para>
 </refsect1>
  
 
 
 
 
</refentry>

Places

File plantuml.xml of Package plantuml (Revision 4dbfea610b74d4798b27cb3bc9dc745d)

Places