forked from trinitrix/core
65 lines
1.8 KiB
Markdown
65 lines
1.8 KiB
Markdown
% 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>.
|
|
|
|
# COPYRIGHT
|
|
|
|
Copyright (C) 2024 The Trinitrix Project
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
this software and associated documentation files (the “Software”), to deal in
|
|
the Software without restriction, including without limitation the rights to use,
|
|
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
|
Software, and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
OTHER DEALINGS IN THE SOFTWARE.
|