forked from Telodendria/Telodendria
Fix some documentation stuffs.
This commit is contained in:
parent
271cdd8ff0
commit
7a939b91d1
2 changed files with 40 additions and 22 deletions
|
@ -1,4 +1,4 @@
|
|||
.Dd $Mdocdate: September 29 2022 $
|
||||
.Dd $Mdocdate: September 30 2022 $
|
||||
.Dt TELODENDRIA 7
|
||||
.Os Telodendria Project
|
||||
.Sh NAME
|
||||
|
@ -98,6 +98,14 @@ To implement the latest Matrix specification as fully and completely as possible
|
|||
All features defined by the specification should eventually be present in
|
||||
.Nm .
|
||||
.It
|
||||
To be as privacy-friendly as possible.
|
||||
.Nm
|
||||
should not store any information it does not absolutely need to function as a
|
||||
Matrix homeserver. While
|
||||
.Nm
|
||||
strives to be feature-complete, it should not implement anything not explicitly
|
||||
defined in the Matrix specification.
|
||||
.It
|
||||
To be a production-ready Matrix server capable of working in constrained environments,
|
||||
such as embedded devices, cheap VPSs, or a peer-to-peer device.
|
||||
.Nm
|
||||
|
@ -172,8 +180,10 @@ of crossing the item off the list yourself.
|
|||
.Xr telodendria.conf 5 ,
|
||||
.Xr td 8
|
||||
.Sh STANDARDS
|
||||
The installed version of
|
||||
.Nm
|
||||
conforms to the Matrix Specification v1.3.
|
||||
conforms to the latest Matrix specification available at the time
|
||||
of its release.
|
||||
.Sh HISTORY
|
||||
At this time,
|
||||
.Nm
|
||||
|
@ -185,14 +195,15 @@ to see where things are currently at. When
|
|||
is mature enough to have a change log, it will go in this section.
|
||||
.Sh AUTHORS
|
||||
.Nm
|
||||
was started by
|
||||
.An Jordan Bancino Aq Mt @jordan:bancino.net .
|
||||
was started by Jordan Bancino <@jordan:bancino.net>.
|
||||
Contributions to the code, website, documentation, or other
|
||||
components of
|
||||
.Nm
|
||||
were made by the following people:
|
||||
.sp
|
||||
.An Jonah Evans Aq Mt @jonah:bancino.net
|
||||
.Bl -bullet
|
||||
.It
|
||||
Jonah Evans <@jonah:bancino.net>
|
||||
.El
|
||||
.Sh LICENSE
|
||||
All of the code and documentation for
|
||||
.Nm
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.Dd $Mdocdate: September 24 2022 $
|
||||
.Dd $Mdocdate: September 30 2022 $
|
||||
.Dt TELODENDRIA 8
|
||||
.Os Telodendria Project
|
||||
.Sh NAME
|
||||
|
@ -28,23 +28,30 @@ 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
|
||||
.Sh EXIT STATUS
|
||||
.Sh SEE ALSO
|
||||
Just the configuration file and the data directory; see
|
||||
.Xr telodendria.conf 5
|
||||
.Sh STANDARDS
|
||||
for more details.
|
||||
.El
|
||||
.Sh EXIT STATUS
|
||||
.Nm
|
||||
conforms to the Matrix Specification v1.3.
|
||||
.Sh HISTORY
|
||||
.Sh AUTHORS
|
||||
exits with a non-0 exit code if the configuration file is invalid, or
|
||||
one or more required paths is inaccessible.
|
||||
.Nm
|
||||
was started by
|
||||
.An Jordan Bancino Aq Mt @jordan:bancino.net .
|
||||
Contributions to the code, website, documentation, or other
|
||||
components of
|
||||
will print an error to the log and then terminate abnormally.
|
||||
.Pp
|
||||
.Nm
|
||||
were made by the following people:
|
||||
.sp
|
||||
.An Jonah Evans Aq Mt @jonah:bancino.net
|
||||
.Sh CAVEATS
|
||||
.Sh BUGS
|
||||
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
|
||||
|
|
Loading…
Reference in a new issue