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 database_file ]

       crystal-facet-uml {-t | -r} database_file

       crystal-facet-uml {-h | -v}

       crystal-facet-uml [-e database_file export_format export_directory ]

       crystal-facet-uml [-i database_file import_mode json_input_file ]

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 import a previously exported json file 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 database_file
           Starts in graphical mode and opens the database_file immediately. If the file does not
           exist, a new, empty database is created.

       -t database_file
           Tests the consistency of a database_file. In case of an error, a non-zero value is
           returned.

       -r database_file
           Tests the consistency of a database_file and repairs found issues.

       -h
           Show summary of options.

       -v
           Show version

       -e database_file export_format export_directory
           Exports all diagrams of a database_file in export_format to the export_directory.
           Valid formats are: docbook, json, pdf, png, ps, svg, txt, xhtml, xmi. Please be aware
           that the export overwrites possibly existing files in the export_directory without
           notice.

       -i database_file import_mode json_input_file
           Imports elements from json_input_file to the database_file. Valid modes are: check,
           add. Please create a backup of your database_file before importing.

EXAMPLE

       To store a database in a version control system (vcs) like svn or git, you have several
       options:

       •   Store the binary database format to your vcs, lock the file while modifying it.

           Advantage is the simple usage. Disadvantage is the lack of a) diff and merge of files,
           b) identify who changed which line when and with which commit message, c) concurrent
           modifications.

       •   Store the json export to your vcs. To modify it, import it to an empty
           crystal-facet-uml database. When finished, export it back to json.

           Afterwards, one can a) merge and diff files, b) find out who to ask on which change.
           Disadvantage is that this feature requires the new version 1.35.0 or later and
           possibly some additional scripts to simplify the import and export operations.

           Step 1: Export and sync

           crystal-facet-uml -e my_database_file.cfu1 json .

           When all your changes are stored in json format (and only then), sync with your
           version control system.

           Step 2: Import and edit

           crystal-facet-uml -i my_database_file.cfu1 add my_database_file.json

           After import, run the consistency checks on the database (recommended).

           crystal-facet-uml -t my_database_file.cfu1 || echo "ERROR $?"

           When the json format has been imported successfully, continue working on the file
           my_database_file.cfu1 (which is a binary sqlite database format).

           crystal-facet-uml -u my_database_file.cfu1

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-2022 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.