plate/telodendria
1
0
Fork 0
forked from lda/telodendria
Code Pull requests Activity Actions
telodendria/docs/telodendria.8

58 lines
1.6 KiB
Groff
Raw Normal View History

Fix some documentation stuffs.
2022-09-30 17:09:22 +00:00
.Dd $Mdocdate: September 30 2022 $
Begin work on converting most of the site to man pages. I want to do this so that even the documentation can be viewed on a base install, without having to install a browser or converter.
2022-09-22 00:12:21 +00:00
.Dt TELODENDRIA 8
.Os Telodendria Project
.Sh NAME
.Nm telodendria
.Nd Matrix homeserver daemon
.Sh SYNOPSIS
.Nm
Cleaned up argument parsing to match what was in the docs
2022-09-24 23:41:39 +00:00
.Op Fl nVv
Begin work on converting most of the site to man pages. I want to do this so that even the documentation can be viewed on a base install, without having to install a browser or converter.
2022-09-22 00:12:21 +00:00
.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
Fix some documentation stuffs.
2022-09-30 17:09:22 +00:00
.Nm
does not read any environment variables. All configuration should
be done via the configuration file.
Begin work on converting most of the site to man pages. I want to do this so that even the documentation can be viewed on a base install, without having to install a browser or converter.
2022-09-22 00:12:21 +00:00
.Sh FILES
Fix some documentation stuffs.
2022-09-30 17:09:22 +00:00
Just the configuration file and the data directory; see
Begin work on converting most of the site to man pages. I want to do this so that even the documentation can be viewed on a base install, without having to install a browser or converter.
2022-09-22 00:12:21 +00:00
.Xr telodendria.conf 5
Fix some documentation stuffs.
2022-09-30 17:09:22 +00:00
for more details.
.El
.Sh EXIT STATUS
Begin work on converting most of the site to man pages. I want to do this so that even the documentation can be viewed on a base install, without having to install a browser or converter.
2022-09-22 00:12:21 +00:00
.Nm
Fix some documentation stuffs.
2022-09-30 17:09:22 +00:00
exits with a non-0 exit code if the configuration file is invalid, or
one or more required paths is inaccessible.
Begin work on converting most of the site to man pages. I want to do this so that even the documentation can be viewed on a base install, without having to install a browser or converter.
2022-09-22 00:12:21 +00:00
.Nm
Fix some documentation stuffs.
2022-09-30 17:09:22 +00:00
will print an error to the log and then terminate abnormally.
.Pp
Begin work on converting most of the site to man pages. I want to do this so that even the documentation can be viewed on a base install, without having to install a browser or converter.
2022-09-22 00:12:21 +00:00
.Nm
Fix some documentation stuffs.
2022-09-30 17:09:22 +00:00
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
Copy permalink