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, modify and delete diagrams,

       •   create, modify and delete UML/SysML elements,

       •   create, modify and delete relationships,

       •   cut, copy, paste elements between diagrams,

       •   undo and redo are supported,

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

       •   search for elements.

       Diagrams are layouted part-automatically:

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

       •   crystal-facet-uml selects the exact locations of shown 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 interaction
           diagrams: sequence, communication, timing, interaction overview.

       Diagrams can be exported as

       •   images: pdf, ps, svg, png,

       •   text: utf-8, DocBook, xhtml,

       •   machine-readable model: json, 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_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: docbook, json, pdf, png, ps, svg, txt, xhtml, 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-2021 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.