forked from Telodendria/Telodendria
Update telodendria(8)
This commit is contained in:
parent
f1f66c6331
commit
cb7ee91908
1 changed files with 28 additions and 12 deletions
|
@ -1,4 +1,4 @@
|
||||||
.Dd $Mdocdate: February 15 2023 $
|
.Dd $Mdocdate: April 30 2023 $
|
||||||
.Dt TELODENDRIA 8
|
.Dt TELODENDRIA 8
|
||||||
.Os Telodendria Project
|
.Os Telodendria Project
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -15,27 +15,42 @@ It is designed to be lightweight and simple, yet functional.
|
||||||
.sp
|
.sp
|
||||||
The options are as follows:
|
The options are as follows:
|
||||||
.Bl -tag -width Ds
|
.Bl -tag -width Ds
|
||||||
.It Fl f Ar file
|
.It Fl d Ar dir
|
||||||
Specify an alternate configuration file. The default is
|
Specify the data directory to use. All persistant storage that
|
||||||
.Pa /etc/telodendria.conf .
|
Telodendria requires is saved and loaded here.
|
||||||
.It Fl n
|
|
||||||
Configtest mode. Only check the configuration file for validity.
|
|
||||||
.It Fl V
|
.It Fl V
|
||||||
Only print the version information header.
|
Only print the version information header and then quit.
|
||||||
.It Fl v
|
.It Fl v
|
||||||
Verbose mode. This overrides the configuration file and sets the
|
Verbose mode. This overrides the configuration file and sets the
|
||||||
log level to
|
log level to
|
||||||
.Em LOG_DEBUG
|
.Em LOG_DEBUG .
|
||||||
|
It also enables extra logging of memory operations, which can
|
||||||
|
be useful for debugging.
|
||||||
.El
|
.El
|
||||||
.Sh ENVIRONMENT
|
.Sh ENVIRONMENT
|
||||||
.Nm
|
.Nm
|
||||||
does not read any environment variables. All configuration should
|
does not read any environment variables. All configuration should
|
||||||
be done via the configuration file.
|
be done via the configuration file.
|
||||||
.Sh FILES
|
.Sh FILES
|
||||||
Just the configuration file and the data directory; see
|
Just the data directory. Telodendria does not read any files outside
|
||||||
.Xr telodendria.conf 5
|
of its data directory, with the exception of TLS files if configured.
|
||||||
for more details.
|
.Sh SIGNALS
|
||||||
|
Telodendria recognizes a number of signals that it handles:
|
||||||
|
.Bl -tag -width Ds
|
||||||
|
.It PIPE
|
||||||
|
This signal is ignored, because all I/O errors should be handled
|
||||||
|
properly.
|
||||||
|
.It USR1
|
||||||
|
Perform a soft restart by shutting down the HTTP servers and resetting
|
||||||
|
all program state. However, the daemon process does not exit.
|
||||||
|
.It TERM
|
||||||
|
Perform a clean shutdown after all existing connections are closed.
|
||||||
|
.It INT
|
||||||
|
Perform a clean shutdown after all existing connections are closed.
|
||||||
.El
|
.El
|
||||||
|
.Pp
|
||||||
|
Any other signals are not explicitly handled, so they have the
|
||||||
|
default behavior defined by the operating system.
|
||||||
.Sh EXIT STATUS
|
.Sh EXIT STATUS
|
||||||
.Nm
|
.Nm
|
||||||
exits with a non-0 exit code if the configuration file is invalid, or
|
exits with a non-0 exit code if the configuration file is invalid, or
|
||||||
|
@ -54,4 +69,5 @@ the bootstrap process completed successfully, and by all accounts,
|
||||||
it ran normally and exitted normally.
|
it ran normally and exitted normally.
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr telodendria 7 ,
|
.Xr telodendria 7 ,
|
||||||
.Xr telodendria.conf 5
|
.Xr telodendria-setup 7 ,
|
||||||
|
.Xr telodendria-admin 7
|
||||||
|
|
Loading…
Reference in a new issue