umlspeed(1) - Linux man page

Name

umlspeed - Compile UML code to SVG diagrams, XMI and source

Synopsis

umlspeed sourcefile
umlspeed [--output-code lang] [--output-svg] [--output-xmi] sourcefile

Description

UMLSpeed is a compiler for a simple, abstract UML description language. You declare UML entities with a C-style syntax, along with diagrams.

The UMLSpeed compiler will take this code and generate SVG renderings of the diagrams. If no options are given, this is the default behaviour.

Optionally, UMLSpeed can also generate an XMI document of the entities and generate source code in the language of your choice.

Whilst the compiler only accepts one source file, you can have an unlimited number of import statements and nest to unlimited depth.

Options

--output-svg, -s

Output all diagrams in the code as SVG files to the current directory. If no output options are given, this is the default. In addition to the SVG files, a umlspeed.html file is also output with links to all the generated diagrams.

--html-template-file <file>, -t <file>

Specify an HTML template file for use when outputting an HTML document to wrap up the SVG diagrams. See the UMLSpeed samples folder for more information.

--project-name <name>

Specify a name for the project. This will be output by the $PROJECTNAME token when generating HTML doucmentation.

--project-version <version>

Specify a version for the project. This will be output by the $PROJECTVERSION token when generating HTML doucmentation.

--output-png, -p

Automatically assumes --output-svg and uses the ImageMagick convert binary to create PNG versions of all rendered diagrams. Note that "convert" must be on the PATH.

--output-xmi, -x

Output all UML entities as an XMI document.

--output-code <language>, -c <language>

Generate source code in the language specified. Language can be one of java, python, perl, php, ruby, c++, c#

-v[vv]

Verbose mode. Causes UMLSpeed to print debugging messages. Extra vs increase the verbosity. The maximum is 3.

Author

Written by Robin Rawson-Tetley.

Reporting Bugs

Report bugs to Robin Rawson-Tetley <robin@rawsontetley.org>

Copyright

Copyright 2007 R. Rawson-Tetley
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public Licence for more details.