X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-daemon.pod;h=f77fc3a9f732e44c738946edb95ee3b972256713;hb=0ae89efce11e1e3b10a067c61c5b4cde30fa2b3b;hp=abb84dd7ebaba196d4e1e6b671bf6204748f705f;hpb=819eba8e79e703f593a0310ee9cda57cbb9bbd0d;p=public-inbox.git diff --git a/Documentation/public-inbox-daemon.pod b/Documentation/public-inbox-daemon.pod index abb84dd7..f77fc3a9 100644 --- a/Documentation/public-inbox-daemon.pod +++ b/Documentation/public-inbox-daemon.pod @@ -5,15 +5,15 @@ public-inbox-daemon - common usage for public-inbox network daemons =head1 SYNOPSIS public-inbox-httpd + public-inbox-imapd public-inbox-nntpd =head1 DESCRIPTION This manual describes common options and behavior for public-inbox network daemons. Network daemons for public-inbox -provide read-only NNTP and HTTP access to public-inboxes. Write -access to a public-inbox repository will never be required to -run these. +provide read-only NNTP, IMAP and HTTP access to public-inboxes. Write +access to a public-inbox will never be required to run these. These daemons are implemented with a common core using non-blocking sockets and optimized for fairness; even with @@ -25,13 +25,13 @@ breaking existing connections during software upgrades. These daemons may also utilize multiple pre-forked worker processes to take advantage of multiple CPUs. -Native TLS (Transport Layer Security) support is planned. - =head1 OPTIONS =over -=item -l, --listen ADDRESS +=item -l ADDRESS + +=item --listen ADDRESS This takes an absolute path to a Unix socket or HOST:PORT to listen on. For example, to listen to TCP connections on @@ -48,7 +48,9 @@ L or similar Default: server-dependent unless socket activation is used with L or similar (see L). -=item -1, --stdout PATH +=item -1 + +=item --stdout PATH Specify an appendable path to redirect stdout descriptor (1) to. Using this is preferable to setting up the redirect externally @@ -57,11 +59,15 @@ SIGUSR1 to be handled (see L below). Default: /dev/null -=item -2, --stderr PATH +=item -2 PATH + +=item --stderr PATH Like C<--stdout>, but for the stderr descriptor (2). -=item -W, --worker-processes +=item -W + +=item --worker-processes Set the number of worker processes. @@ -98,7 +104,7 @@ See L below. =item SIGHUP Reload config files associated with the process. -(FIXME: not tested for -httpd, yet) +(Note: broken for L only in E= 1.6) =item SIGTTIN @@ -145,8 +151,8 @@ enables the use of L which speeds up subprocess spawning with the Linux kernel. public-inbox will never enable L automatically without -this environment variable set. See L and L -for more details. +this environment variable set or C<~/.cache/public-inbox/inline-c> +created by a user. See L and L for more details. =back @@ -172,15 +178,16 @@ interrupted and lost. Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT -Copyright 2013-2019 all contributors L +Copyright 2013-2021 all contributors L License: AGPL-3.0+ L =head1 SEE ALSO -L, L +L, L, +L