X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-daemon.pod;h=f77fc3a9f732e44c738946edb95ee3b972256713;hb=0ae89efce11e1e3b10a067c61c5b4cde30fa2b3b;hp=a3c97d8b21c52dbf2d2c73ceddeeb25d37e92412;hpb=3d41aa23f35501ca92aab8aa42980fa73f7fa74f;p=public-inbox.git

diff --git a/Documentation/public-inbox-daemon.pod b/Documentation/public-inbox-daemon.pod
index a3c97d8b..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,27 +25,32 @@ 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
 port 119, use: C<-l 0.0.0.0:119>.  This may also point to
 a Unix socket (C<-l /path/to/http.sock>) for a reverse proxy
-like L<nginx(1)> to use.
+like L<nginx(8)> to use.
 
 May be specified multiple times to allow listening on multiple
 sockets.
 
+This does not need to be specified at all if relying on
+L<systemd.socket(5)> or similar
+
 Default: server-dependent unless socket activation is used with
 L<systemd(1)> or similar (see L<systemd.socket(5)>).
 
-=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
@@ -54,11 +59,15 @@ SIGUSR1 to be handled (see L<SIGNALS/SIGNALS> 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.
 
@@ -77,7 +86,7 @@ Default: 1
 
 =head1 SIGNALS
 
-Most of our signal handling behavior is copied from L<nginx(1)>
+Most of our signal handling behavior is copied from L<nginx(8)>
 and/or L<starman(1)>; so it is possible to reuse common scripts
 for managing them.
 
@@ -95,7 +104,7 @@ See L</UPGRADING> below.
 =item SIGHUP
 
 Reload config files associated with the process.
-(FIXME: not tested for -httpd, yet)
+(Note: broken for L<public-inbox-httpd(1)> only in E<lt>= 1.6)
 
 =item SIGTTIN
 
@@ -142,8 +151,8 @@ enables the use of L<vfork(2)> which speeds up subprocess
 spawning with the Linux kernel.
 
 public-inbox will never enable L<Inline::C> automatically without
-this environment variable set.  See L<Inline> and L<Inline::C>
-for more details.
+this environment variable set or C<~/.cache/public-inbox/inline-c>
+created by a user. See L<Inline> and L<Inline::C> for more details.
 
 =back
 
@@ -169,15 +178,16 @@ interrupted and lost.
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 
-The mail archives are hosted at L<https://public-inbox.org/meta/>
-and L<http://hjrcffqmbrq6wope.onion/meta/>
+The mail archives are hosted at L<https://public-inbox.org/meta/> and
+L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2013-2018 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2013-2021 all contributors L<mailto:meta@public-inbox.org>
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
 =head1 SEE ALSO
 
-L<public-inbox-httpd(1)>, L<public-inbox-nntpd(1)>
+L<public-inbox-httpd(1)>, L<public-inbox-imapd(1)>,
+L<public-inbox-nntpd(1)>