104 lines
2.9 KiB
Groff
104 lines
2.9 KiB
Groff
.TH YMS 1 "September 2026" "YMS 0.2" "User Commands"
|
|
.SH NAME
|
|
yms - Yacht Management Software
|
|
.SH SYNOPSIS
|
|
.B yms
|
|
.SH DESCRIPTION
|
|
.B YMS
|
|
(Yacht Management Software) is free and open-source software for
|
|
managing yachts, sailboats and their equipment.
|
|
|
|
YMS is designed for managing yachts and sailboats, including
|
|
equipment, inventory, storage locations, documents, maintenance,
|
|
tasks, projects, provisions and technical data.
|
|
|
|
The application uses MariaDB for structured application data.
|
|
User-managed photos and documents are stored in the local filesystem.
|
|
.SH FEATURES
|
|
YMS provides the following functionality:
|
|
.TP
|
|
.B Equipment and inventory management
|
|
Manage equipment and inventory belonging to the yacht.
|
|
.TP
|
|
.B Storage locations
|
|
Organize equipment and inventory by physical storage location.
|
|
.TP
|
|
.B Documents and manuals
|
|
Manage documents and manuals associated with the yacht and its
|
|
equipment.
|
|
.TP
|
|
.B Maintenance and service history
|
|
Record maintenance activities and service history.
|
|
.TP
|
|
.B Tasks and projects
|
|
Manage tasks and projects related to the yacht.
|
|
.TP
|
|
.B Provisions and consumables
|
|
Manage provisions, supplies and consumable items.
|
|
.TP
|
|
.B Technical data and measurements
|
|
Store technical information, measurements and other data associated
|
|
with the yacht.
|
|
.SH DATABASE
|
|
YMS uses MariaDB to store its structured application data.
|
|
|
|
The MariaDB server must be available to the YMS application when
|
|
the application is running.
|
|
.SH FILES
|
|
.TP
|
|
.I ~/.config/ymsgui.conf
|
|
Per-user configuration file for the YMS graphical user interface.
|
|
|
|
.TP
|
|
.I /var/local/lib/yms/
|
|
Persistent storage for files managed by YMS.
|
|
|
|
The directory contains photos, documents and other media associated
|
|
with the managed yacht. Supported file formats include JPEG, PNG,
|
|
SVG and PDF.
|
|
.SH BACKUP
|
|
YMS stores application data in two separate locations.
|
|
|
|
The directory
|
|
.I /var/local/lib/yms/
|
|
contains user-managed photos and documents and should be included
|
|
in regular backups.
|
|
|
|
The structured application data is stored in MariaDB and must be
|
|
backed up using an appropriate MariaDB backup procedure.
|
|
|
|
.SH REQUIREMENTS
|
|
YMS requires a graphical desktop environment with GTK3 support.
|
|
|
|
The application requires Python and the GTK3 Python bindings.
|
|
A MariaDB server is required for database access.
|
|
|
|
.SH OPEN SOURCE
|
|
YMS is free and open-source software.
|
|
|
|
The source code is available from the YMS Git repository:
|
|
.UR https://git.hoogi.de/thooge/YMS
|
|
.UE
|
|
.SH VERSION
|
|
This manual describes YMS version 0.2.
|
|
.SH PROJECT
|
|
The YMS project homepage is available at:
|
|
.UR https://yms.hoogi.de/
|
|
.UE
|
|
|
|
A live demonstration is available at:
|
|
.UR https://www.hoogi.de/ymsdemo
|
|
.UE
|
|
|
|
German-language documentation is available at:
|
|
.UR https://computerclub.hoogi.de/yms
|
|
.UE
|
|
.SH BUGS
|
|
Please report bugs and contribute improvements through thread in Segeln-Forum or
|
|
by submitting a mail
|
|
.SH AUTHOR
|
|
YMS is developed by Thomas Hooge / thomas@hoogi.de.
|
|
.SH COPYRIGHT
|
|
YMS is free and open-source software. See the project repository for
|
|
license and copyright information.
|