'\" t
.\"     Title: Crystal-facet-uml
.\"    Author: Andreas Warnke <cfu@andreaswarnke.de>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/28/2023
.\"    Manual: crystal-facet-uml Command Line Usage
.\"    Source: crystal-facet-uml
.\"  Language: English
.\"
.TH "CRYSTAL\-FACET\-UML" "1" "01/28/2023" "crystal-facet-uml" "crystal-facet-uml Command Line"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "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\&.
.SH "SYNOPSIS"
.HP \w'\fBcrystal\-facet\-uml\fR\ 'u
\fBcrystal\-facet\-uml\fR [\fB\-u\ \fR\fB\fIdatabase_file\fR\fR\fB\ \fR]
.HP \w'\fBcrystal\-facet\-uml\fR\ 'u
\fBcrystal\-facet\-uml\fR {\fB\-t\fR\ |\ \fB\-r\fR}\ \fIdatabase_file\fR
.HP \w'\fBcrystal\-facet\-uml\fR\ 'u
\fBcrystal\-facet\-uml\fR {\fB\-h\fR\ |\ \fB\-v\fR}
.HP \w'\fBcrystal\-facet\-uml\fR\ 'u
\fBcrystal\-facet\-uml\fR \-e\ \fIdatabase_file\fR\ \fIexport_format\fR\ \fIexport_directory\fR
.HP \w'\fBcrystal\-facet\-uml\fR\ 'u
\fBcrystal\-facet\-uml\fR \-i\ \fIdatabase_file\fR\ \fIimport_mode\fR\ \fIjson_input_file\fR
.SH "DESCRIPTION"
.PP
crystal\-facet\-uml provides a graphical user interface to
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
create, modify and delete diagrams,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
create, modify and delete UML/SysML elements,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
create, modify and delete relationships,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
cut, copy, paste elements between diagrams,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
undo and redo are supported,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
multiple windows can show different or same parts of the uml model,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
search for elements\&.
.RE
.sp
Diagrams are layouted part\-automatically:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The user chooses the relative location of elements towards others,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
crystal\-facet\-uml selects the exact locations of shown elements\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The user controls the positions of messages/transitions in sequence and timing diagrams,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
crystal\-facet\-uml auto\-layouts relationships in other diagrams\&.
.RE
.sp
crystal\-facet\-uml manages a meta model:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Diagrams are organized as a tree, similar to a book\*(Aqs table\-of\-contents;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Uml(TM)/SysML(TM) elements exist only once even if shown in many diagrams;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Relationships and features are consistent between all diagrams;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Diagram\-local messages/transitions are supported in scenario\-based interaction diagrams: sequence, communication, timing, interaction overview\&.
.RE
.sp
Diagrams can be exported as
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
images: pdf, ps, svg, png,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
text: utf\-8, DocBook, xhtml,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
machine\-readable model: json, xmi(TM)\&.
.RE
.sp
crystal\-facet\-uml can also be started from command line
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
to export all diagrams automatically or
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
to import a previously exported json file or
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
to check and repair database files\&.
.RE
.sp
.SH "OPTIONS"
.PP
Without options, the program starts in graphical mode\&. See crystal\-facet\-uml_documentation\&.pdf for graphical mode usage\&.
.PP
\fB\-u \fR\fB\fIdatabase_file\fR\fR
.RS 4
Starts in graphical mode and opens the database_file immediately\&.
.sp
If the file does not exist, a new, empty database is created\&. If database_file ends on \&.cfu1, a binary database file is created\&. Otherwise, a json data file is created\&.
.RE
.PP
\fB\-t \fR\fB\fIdatabase_file\fR\fR
.RS 4
Tests the consistency of a database_file\&. In case of an error, a non\-zero value is returned\&.
.RE
.PP
\fB\-r \fR\fB\fIdatabase_file\fR\fR
.RS 4
Tests the consistency of a database_file and repairs found issues\&.
.RE
.PP
\fB\-h\fR
.RS 4
Show summary of options\&.
.RE
.PP
\fB\-v\fR
.RS 4
Show version
.RE
.PP
\fB\-e \fR\fB\fIdatabase_file\fR\fR\fB \fR\fB\fIexport_format\fR\fR\fB \fR\fB\fIexport_directory\fR\fR
.RS 4
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\&.
.RE
.PP
\fB\-i \fR\fB\fIdatabase_file\fR\fR\fB \fR\fB\fIimport_mode\fR\fR\fB \fR\fB\fIjson_input_file\fR\fR
.RS 4
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\&.
.RE
.SH "EXAMPLE"
.PP
To store a database in a version control system (vcs) like svn or git, store the json file format
\fB*\&.cfuJ\fR
to your vcs\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Note that this feature requires at least version 1\&.35\&.0, better version 1\&.39\&.0 to work smoothly\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Do not synchronize the file with your vcs while you modify it at the same time; save your changes first and re\-open the json file afterwards\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
In case of merge conflicts in
\fB*\&.cfuJ\fR
files, note that uuid strings do uniquely identify all json objects\&. Relations between objects are defined by these uuid strings\&. In contrast to uuids, integer\-id can be changed as long as they are unique among all objects of same type within the file\&.
.RE
.sp
.SH "DIAGNOSTICS"
.PP
The following diagnostics may be issued on
syslog:
.PP
EVT : \&.\&.\&.
.RS 4
An event occurred\&.
.RE
.PP
ANOM: \&.\&.\&.
.RS 4
Something unexpected happened that was handled\&.
.RE
.PP
WARN: \&.\&.\&.
.RS 4
Something unexpected happened that may cause a failure\&.
.RE
.PP
ERR : \&.\&.\&.
.RS 4
Something unexpected happened that has caused a failure\&.
.RE
.PP
\fBjournalctl \-f\fR
allows one to read the syslog\&.
.SH "BUGS"
.PP
The upstreams
BTS
can be found at
\m[blue]\fB\%https://github.com/awarnke/crystal-facet-uml/issues\fR\m[]\&.
.SH "AUTHOR"
.PP
\fBAndreas Warnke\fR <\&cfu@andreaswarnke\&.de\&>
.RS 4
wrote this manpage for Unix and Linux systems\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2018-2023 Andreas Warnke
.br
.PP
This manual page was written for Unix and Linux systems\&.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the Apache\-2\&.0 License\&.
.sp