X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-mda.pod;h=01bb84764bb1d379df14a9a82bbb9e7f2599e8e5;hb=37724c7e792ca0e1df9f64cfc17cebf7359ca9f0;hp=cb17471413e7715f8f694270a6c8ff22ef946007;hpb=d3ded72481e6435fc67f2d1cb9ae9cf7ffe8d753;p=public-inbox.git

diff --git a/Documentation/public-inbox-mda.pod b/Documentation/public-inbox-mda.pod
index cb174714..01bb8476 100644
--- a/Documentation/public-inbox-mda.pod
+++ b/Documentation/public-inbox-mda.pod
@@ -1,17 +1,45 @@
-% public-inbox-mda(1) public-inbox user manual
-
 =head1 NAME
 
-public-inbox-mda - mail delivery for public-inbox
+public-inbox-mda - mail delivery agent for public-inbox
 
 =head1 SYNOPSIS
 
-B<public-inbox-mda> E<lt> message
+B<public-inbox-mda> E<lt>MESSAGE
 
 =head1 DESCRIPTION
 
 Mail Delivery Agent (MDA) for public-inbox installations.
-Each system user may have their own public-inbox instances
+Each system user may have their own public-inbox instances.
+This may be invoked via L<procmail(1)> or similar tools.
+
+By default, it relies on L<spamc(1)> for filtering mail,
+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
 
@@ -19,34 +47,41 @@ Each system user may have their own public-inbox instances
 
 =item ORIGINAL_RECIPIENT
 
-the original recipient email address, from Postfix
+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
 
-config file. default: ~/.public-inbox/config
+Per-user config file parseable by L<git-config(1)>.
+See L<public-inbox-config(5)>.
+
+Default: ~/.public-inbox/config
 
 =item PI_EMERGENCY
 
-emergency destination.  default: ~/.public-inbox/emergency/
+emergency Maildir destination.
 
-=back
+Default: ~/.public-inbox/emergency/
 
-=head1 PI_CONFIG FILE
+=back
 
-This is a config file parseable by L<git-config(1)>.
 
 =head1 CONTACT
 
-All 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<http://public-inbox.org/meta/>
+The mail archives are hosted at L<https://public-inbox.org/meta/>
+and L<http://hjrcffqmbrq6wope.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2013-2016 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2013-2019 all contributors L<mailto:meta@public-inbox.org>
 
-License: AGPL-3.0+ L<http://www.gnu.org/licenses/agpl-3.0.txt>
+License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
 =head1 SEE ALSO
 
-L<git(1)>, L<git-config(1)>, L<ssoma_repository(5)>
+L<git(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>