]> Sergey Matveev's repositories - public-inbox.git/commitdiff
public-inbox-mda: preliminary manpage documentation
authorEric Wong <normalperson@yhbt.net>
Sat, 5 Apr 2014 01:33:46 +0000 (01:33 +0000)
committerEric Wong <normalperson@yhbt.net>
Sat, 5 Apr 2014 06:55:35 +0000 (06:55 +0000)
This still needs to be fleshed out.

Documentation/public-inbox-mda.txt [new file with mode: 0644]

diff --git a/Documentation/public-inbox-mda.txt b/Documentation/public-inbox-mda.txt
new file mode 100644 (file)
index 0000000..e29b119
--- /dev/null
@@ -0,0 +1,20 @@
+% public-inbox-mda(1) public-inbox user manual
+
+# NAME
+
+public-inbox-mda - mail delivery for public-inbox
+
+# SYNOPSIS
+
+Mail Delivery Agent (MDA) for public-inbox installations.
+Each system user may have their own public-inbox instances
+
+# ENVIRONMENT
+
+* RECIPIENT - the recipient email address, from Postfix
+* PI_CONFIG - config file. default: ~/.public-inbox/config
+* PI_FAILBOX - emergency destination.  default: ~/public-inbox-fail.mbox
+
+# PI_CONFIG FILE
+
+This is a config file parseable by git-config(1).