forked from trinitrix/core
63 lines
1.6 KiB
Markdown
63 lines
1.6 KiB
Markdown
<!--
|
|
Copyright (C) 2024 - 2024:
|
|
The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
|
|
SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
This file is part of Trinitrix.
|
|
|
|
Trinitrix is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published
|
|
by the Free Software Foundation, either version 3 of the License,
|
|
or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
-->
|
|
|
|
% TRINITRIX(1) trinitrix 0.1.0
|
|
% The Trinitrix Project
|
|
% May 2024
|
|
|
|
# NAME
|
|
|
|
trinitrix - A multi protocol chat client
|
|
|
|
# SYNOPSIS
|
|
|
|
**trinitrix** \[*--help*|*--version*\]
|
|
|
|
# DESCRIPTION
|
|
|
|
Trinitrix is a multi protocol client. That is implemented via cbs and plugins.
|
|
|
|
# OPTIONS
|
|
|
|
**--help**, **-h**
|
|
: Displays a help message and exit.
|
|
|
|
**--version**, **-v**
|
|
: Displays the software version and exit.
|
|
|
|
**--plugin-path \<SHARED_OBJECT>**, **-p \<SHARED_OBJECT>**
|
|
: The SHARED_OBJECT to load as a dynamic library. The `plugin_main` function will be
|
|
executed.
|
|
|
|
# EXAMPLES
|
|
|
|
**trinitrix repl**
|
|
: Start a repl with evaluation of trinitry commands.
|
|
|
|
# FILES
|
|
|
|
*plugin.so*
|
|
: Shared object file of a plugin, to be loaded with **--plugin-path**
|
|
|
|
# BUGS
|
|
|
|
Report bugs to <https://git.nerdcult.net/trinitrix/core/issues>.
|