about summary refs log tree commit homepage
path: root/Documentation/public-inbox-mda.pod
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/public-inbox-mda.pod')
-rw-r--r--Documentation/public-inbox-mda.pod36
1 files changed, 36 insertions, 0 deletions
diff --git a/Documentation/public-inbox-mda.pod b/Documentation/public-inbox-mda.pod
new file mode 100644
index 00000000..80bb3496
--- /dev/null
+++ b/Documentation/public-inbox-mda.pod
@@ -0,0 +1,36 @@
+% public-inbox-mda(1) public-inbox user manual
+
+=head1 NAME
+
+public-inbox-mda - mail delivery for public-inbox
+
+=head1 SYNOPSIS
+
+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
+
+=head1 ENVIRONMENT
+
+=over 8
+
+=item ORIGINAL_RECIPIENT
+
+the original recipient email address, from Postfix
+
+=item PI_CONFIG
+
+config file. default: ~/.public-inbox/config
+
+=item PI_EMERGENCY
+
+emergency destination.  default: ~/.public-inbox/emergency/
+
+=back
+
+=head1 PI_CONFIG FILE
+
+This is a config file parseable by L<git-config(1)>.