imap+nntp: share COMPRESS implementation

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

diff --git a/Documentation/public-inbox-mda.pod b/Documentation/public-inbox-mda.pod
index 64ec690cc568a3ccc71f085b81c4bef94221b427..93cb0e9cc077ea49ded6572fbdcee3cfbb293a5d 100644 (file)
--- a/Documentation/public-inbox-mda.pod
+++ b/Documentation/public-inbox-mda.pod
@@ -4,7 +4,7 @@ public-inbox-mda - mail delivery agent for public-inbox
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-B<public-inbox-mda> E<lt>MESSAGE
+  public-inbox-mda </path/to/RFC2822_message

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 


@@ -16,6 +16,31 @@ By default, it relies on L<spamc(1)> for filtering mail,
 but may be disabled via
 L<public-inbox-config(5)/publicinboxmda.spamcheck>
 
 but may be disabled via
 L<public-inbox-config(5)/publicinboxmda.spamcheck>
 

+=head1 OPTIONS
+
+=over 8
+
+=item --no-precheck
+
+By default, public-inbox-mda does some simple checks before
+invoking L<spamc(1)> since it is intended to receive mail before
+it goes to a mailing list.
+
+However, some users prefer to use public-inbox-mda to mirror
+mailing lists.  This option exists to support those users.
+
+Using this option, the following prechecks are disabled:
+
+  * multiple Message-IDs
+  * non-existent Message-IDs
+  * Message-IDs longer than 244 characters long
+  * From: header shorter than 3 characters
+  * Subject: header shorter than 2 characters
+  * unusable Date: headers
+  * inbox address specified in To: or Cc: header
+
+=back
+

 =head1 ENVIRONMENT
 
 =over 8
 =head1 ENVIRONMENT
 
 =over 8


@@ -25,6 +50,9 @@ L<public-inbox-config(5)/publicinboxmda.spamcheck>
 The original recipient email address, set by the MTA.  Postfix
 sets it by default, untested on other MTAs.
 
 The original recipient email address, set by the MTA.  Postfix
 sets it by default, untested on other MTAs.
 

+This does not have to be set if relying on C<publicinbox.$NAME.listid>
+directives configured in L<public-inbox-config(5)>.
+

 =item PI_CONFIG
 
 Per-user config file parseable by L<git-config(1)>.
 =item PI_CONFIG
 
 Per-user config file parseable by L<git-config(1)>.


@@ -45,12 +73,12 @@ Default: ~/.public-inbox/emergency/
 
 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>
 
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>