forked from Telodendria/Telodendria
58 lines
1.6 KiB
Groff
58 lines
1.6 KiB
Groff
|
.Dd $Mdocdate: September 30 2022 $
|
||
|
|
.Dt TELODENDRIA 8
|
||
|
|
.Os Telodendria Project
|
||
|
|
.Sh NAME
|
||
|
|
.Nm telodendria
|
||
|
|
.Nd Matrix homeserver daemon
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.Nm
|
||
|
|
.Op Fl nVv
|
||
|
|
.Op Fl f Ar file
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
.Nm
|
||
|
|
is a Matrix homeserver written entirely from scratch in ANSI C.
|
||
|
|
It is designed to be lightweight and simple, yet functional.
|
||
|
|
.sp
|
||
|
|
The options are as follows:
|
||
|
|
.Bl -tag -width Ds
|
||
|
|
.It Fl f Ar file
|
||
|
|
Specify an alternate configuration file. The default is
|
||
|
|
.Pa /etc/telodendria.conf .
|
||
|
|
.It Fl n
|
||
|
|
Configtest mode. Only check the configuration file for validity.
|
||
|
|
.It Fl V
|
||
|
|
Only print the version information header.
|
||
|
|
.It Fl v
|
||
|
|
Verbose mode. This overrides the configuration file and sets the
|
||
|
|
log level to
|
||
|
|
.Em LOG_DEBUG
|
||
|
|
.El
|
||
|
|
.Sh ENVIRONMENT
|
||
|
|
.Nm
|
||
|
|
does not read any environment variables. All configuration should
|
||
|
|
be done via the configuration file.
|
||
|
|
.Sh FILES
|
||
|
|
Just the configuration file and the data directory; see
|
||
|
|
.Xr telodendria.conf 5
|
||
|
|
for more details.
|
||
|
|
.El
|
||
|
|
.Sh EXIT STATUS
|
||
|
|
.Nm
|
||
|
|
exits with a non-0 exit code if the configuration file is invalid, or
|
||
|
|
one or more required paths is inaccessible.
|
||
|
|
.Nm
|
||
|
|
will print an error to the log and then terminate abnormally.
|
||
|
|
.Pp
|
||
|
|
.Nm
|
||
|
|
exits with a code of 0 if the configuration file is valid, all
|
||
|
|
paths and files required are accessible, and the HTTP listener starts
|
||
|
|
as intended. If
|
||
|
|
.Nm
|
||
|
|
is sent a signal that it catches after it begins servicing requests, it
|
||
|
|
will still exit with a code of 0 after it safely shuts down, because
|
||
|
|
the bootstrap process completed successfully, and by all accounts,
|
||
|
|
it ran normally and exitted normally.
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr telodendria 7 ,
|
||
|
|
.Xr telodendria.conf 5
|