about summary refs log tree commit homepage
path: root/Documentation/public-inbox-mda.pod
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2016-01-04 22:18:57 +0000
committerEric Wong <e@80x24.org>2016-01-04 22:24:01 +0000
commit51c8178c0dda34d89f73eae2de2b73abedb6b877 (patch)
tree73ce48eaecff92e710d38b6ca67a1520adc8c8e7 /Documentation/public-inbox-mda.pod
parente9cec9873b585f2552e2bf9bcbcc44de34caa53d (diff)
downloadpublic-inbox-51c8178c0dda34d89f73eae2de2b73abedb6b877.tar.gz
This project is currently implemented in Perl, and pod2man is
probably more common among potential users and developers of
this project.
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)>.