Authd man-page now documents all configuration file variables.

This commit is contained in:
Philippe Pittoli 2024-12-01 00:39:05 +01:00
parent 437a6d5d88
commit b002c5851a

View File

@ -60,6 +60,83 @@ Finally, indexes are recreated, which is related to the
.Xr dodb 7
document database, see the related manual page to learn more.
.Sh Configuration file variables
The following presents the complete list of configuration file variables.
Generic
.Xr libipc 7
related variables:
.
.Bl -tag -width " print functions" -compact
.It Li ipc_timer
Int32, 30_000 (30 seconds)
.
.It Li verbosity
Int32, 4 ([0-4],
.Dq 0
being quiet and
.Dq 4
meaning printing debug values)
.
.It Li print functions
Print functions enable to select messages to print, for example by printing a message each time a message is received while ignoring keepalive messages.
.Bl -tag -width " print_ipc_message_received" -compact
.It Li print_ipc_timer
Bool, false
.It Li print_ipc_connection
Bool, false
.It Li print_ipc_disconnection
Bool, false
.It Li print_ipc_extra_socket
Bool, false
.It Li print_ipc_message_received
Bool, false
.It Li print_ipc_message_sent
Bool, false
.It Li print_ipc_switch
Bool, false
.It Li print_ipc_error
Bool, true
.It Li print_ipc_exception
Bool, true
.It Li print_keepalive
Bool, false
.El
.
.El
Specific
.Xr authd
variables:
.Bl -tag -width " print_password_recovery_parameters" -compact
.It Li service_name
String,
.Dq auth
.It Li recreate_indexes
Bool, false
.It Li storage
String,
.Pa ./storage
.It Li registrations
Bool, false
.It Li require_email
Bool, false
.It Li activation_template
String,
.Dq email-activation
.It Li recovery_template
String,
.Dq email-recovery
.It Li mailer_exe
String,
.Pa /usr/local/bin/mailer
.It Li read_only_profile_keys
Array of String, []
.It Li print_password_recovery_parameters
Bool, false
.El
.Sh Options
.Bl -tag -width "-t activation-template-name,"
.It Li -s , --simulation
@ -140,7 +217,7 @@ An example of such mailer can be found here:
.Sh See also
TODO: expand the documentation
.Bl -bullet
.Bl -bullet -compact
.
.It
.Xr libipc 7