Scroll to navigation

CRYSTAL-FACET-UML(1) crystal_facet_uml Command Line CRYSTAL-FACET-UML(1)

NAME

crystal_facet_uml - creates a set of uml diagrams. crystal_facet_uml ensures consistency of relationships and uml element names between different diagrams. crystal_facet_uml exports diagrams in various vector and pixel-based image formats.

SYNOPSIS

crystal_facet_uml [-u databasefile ]

crystal_facet_uml {-t | -r} databasefile

crystal_facet_uml {-h | -v}

crystal_facet_uml [-e databasefile file_format export_directory ]

DESCRIPTION

crystal_facet_uml provides a graphical user interface to

•create diagrams

(use-case, deployment, component, composite-structure, package, class, activity, state, timing, communication, sequence)

•create uml elements

(actor, system-boundary, use-case, node, component, part, interface, package, class, activity, state, object, artifact, comment, requirement)

•move, modify and delete uml elements

•create, modify and delete relationships

(dependency, association, aggregation, composition, generalization, realization, contains, sync-call, return-call, async-message, communication-path, control-flow, object-flow, deployment, manifest, include, extend)

•create, modify and delete features

(port, field, operation)

•cut, copy, paste uml elements between diagrams

•undo and redo are supported

•multiple windows can show different or same parts of the uml model

Diagrams are layouted part-automatically:

•The user chooses the relative location of uml elements towards others

•crystal_facet_uml selects the exact locations of uml elements

•The user controls the positions of messages/transitions in sequence and timing diagrams

•crystal_facet_uml auto-layouts relationships in other diagrams

crystal_facet_uml manages a meta model:

•Diagrams are organized as a tree, similar to a book's table-of-contents

•Uml(TM)/SysML(TM) elements exist only once even if shown in many diagrams

•Relationships and features are consistent between all diagrams

•Diagram-local messages/transitions are supported in scenario-based diagrams

(sequence, communication, timing)

crystal_facet_uml exports diagrams as

•vector graphics

(pdf, ps, svg)

•pixel graphics

(png)

•textual representation

(utf-8-txt, docbook, xhtml)

•machine-readable model

(xmi(TM))

crystal_facet_uml can also be started from command line to export all diagrams automatically or to check and repair database files.

OPTIONS

Without options, the program starts in graphical mode. See crystal_facet_uml_user_documentation.pdf for graphical mode usage.

-u databasefile

Starts in graphical mode and opens the databasefile immediately.

-t databasefile

Tests the consistency of a databasefile.

-r databasefile

Tests the consistency of a databasefile and repairs found issues.

-h

Show summary of options.

-v

Show version

-e databasefile file_format export_directory

Exports all diagrams of a databasefile in file_format to the export_directory. Valid formats are: pdf, ps, png, svg, txt, xhtml, docbook, xmi.

DIAGNOSTICS

The following diagnostics may be issued on syslog:

EVT : ...

An event occurred.

ANOM: ...

Something unexpected happened that was handled.

WARN: ...

Something unexpected happened that may cause a failure.

ERR : ...

Something unexpected happened that has caused a failure.

journalctl -f allows one to read the syslog.

BUGS

The upstreams BTS can be found at https://github.com/awarnke/crystal_facet_uml/issues.

AUTHOR

Andreas Warnke <cfu@andreaswarnke.de>

wrote this manpage for Unix and Linux systems.

COPYRIGHT

Copyright © 2018-2020 Andreas Warnke

This manual page was written for Unix and Linux systems.

Permission is granted to copy, distribute and/or modify this document under the terms of the Apache-2.0 License.

10/08/2020 crystal_facet_uml