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

Fix some documentation stuffs.

Browse source
This commit is contained in:
Jordan Bancino 2022-09-30 13:09:22 -04:00
parent 271cdd8ff0
commit 7a939b91d1
2 changed files with 40 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/telodendria.7
View file

@ -1,4 +1,4 @@
.Dd $Mdocdate: September 29 2022 $ .Dd $Mdocdate: September 30 2022 $
.Dt TELODENDRIA 7 .Dt TELODENDRIA 7
.Os Telodendria Project .Os Telodendria Project
.Sh NAME .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 All features defined by the specification should eventually be present in
.Nm . .Nm .
.It .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, 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. such as embedded devices, cheap VPSs, or a peer-to-peer device.
.Nm .Nm
@ -172,8 +180,10 @@ of crossing the item off the list yourself.
.Xr telodendria.conf 5 , .Xr telodendria.conf 5 ,
.Xr td 8 .Xr td 8
.Sh STANDARDS .Sh STANDARDS
The installed version of
.Nm .Nm
conforms to the Matrix Specification v1.3. conforms to the latest Matrix specification available at the time
of its release.
.Sh HISTORY .Sh HISTORY
At this time, At this time,
.Nm .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. is mature enough to have a change log, it will go in this section.
.Sh AUTHORS .Sh AUTHORS
.Nm .Nm
was started by was started by Jordan Bancino <@jordan:bancino.net>.
.An Jordan Bancino Aq Mt @jordan:bancino.net .
Contributions to the code, website, documentation, or other Contributions to the code, website, documentation, or other
components of components of
.Nm .Nm
were made by the following people: were made by the following people:
.sp .Bl -bullet
.An Jonah Evans Aq Mt @jonah:bancino.net .It
Jonah Evans <@jonah:bancino.net>
.El
.Sh LICENSE .Sh LICENSE
All of the code and documentation for All of the code and documentation for
.Nm .Nm

39
docs/telodendria.8
View file

@ -1,4 +1,4 @@
.Dd $Mdocdate: September 24 2022 $ .Dd $Mdocdate: September 30 2022 $
.Dt TELODENDRIA 8 .Dt TELODENDRIA 8
.Os Telodendria Project .Os Telodendria Project
.Sh NAME .Sh NAME
@ -28,23 +28,30 @@ log level to
.Em LOG_DEBUG .Em LOG_DEBUG
.El .El
.Sh ENVIRONMENT .Sh ENVIRONMENT
.Nm
does not read any environment variables. All configuration should
be done via the configuration file.
.Sh FILES .Sh FILES
.Sh EXIT STATUS Just the configuration file and the data directory; see
.Sh SEE ALSO
.Xr telodendria.conf 5 .Xr telodendria.conf 5
.Sh STANDARDS for more details.
.El
.Sh EXIT STATUS
.Nm .Nm
conforms to the Matrix Specification v1.3. exits with a non-0 exit code if the configuration file is invalid, or
.Sh HISTORY one or more required paths is inaccessible.
.Sh AUTHORS
.Nm .Nm
was started by will print an error to the log and then terminate abnormally.
.An Jordan Bancino Aq Mt @jordan:bancino.net . .Pp
Contributions to the code, website, documentation, or other
components of
.Nm .Nm
were made by the following people: exits with a code of 0 if the configuration file is valid, all
.sp paths and files required are accessible, and the HTTP listener starts
.An Jonah Evans Aq Mt @jonah:bancino.net as intended. If
.Sh CAVEATS .Nm
.Sh BUGS 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