pop3: reduce memory use while generating the mailbox cache

[public-inbox.git] / Documentation / public-inbox-daemon.pod

diff --git a/Documentation/public-inbox-daemon.pod b/Documentation/public-inbox-daemon.pod
index abb84dd7ebaba196d4e1e6b671bf6204748f705f..f77fc3a9f732e44c738946edb95ee3b972256713 100644 (file)
--- 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
 =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
        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
 
 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.
 
 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
 
 =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
 
 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<systemd.socket(5)> or similar
 Default: server-dependent unless socket activation is used with
 L<systemd(1)> or similar (see L<systemd.socket(5)>).
 
 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
 
 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<SIGNALS/SIGNALS> below).
 
 Default: /dev/null
 
 
 Default: /dev/null
 

-=item -2, --stderr PATH
+=item -2 PATH
+
+=item --stderr PATH

 
 Like C<--stdout>, but for the stderr descriptor (2).
 
 
 Like C<--stdout>, but for the stderr descriptor (2).
 

-=item -W, --worker-processes
+=item -W
+
+=item --worker-processes

 
 Set the number of worker processes.
 
 
 Set the number of worker processes.
 


@@ -98,7 +104,7 @@ See L</UPGRADING> below.
 =item SIGHUP
 
 Reload config files associated with the process.
 =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
 
 
 =item SIGTTIN
 


@@ -145,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
 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
 
 
 =back
 


@@ -172,15 +178,16 @@ interrupted and lost.
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 
 
 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
 
 
 =head1 COPYRIGHT
 

-Copyright 2013-2019 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
 
 
 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)>