From: dsp <>
Date: Thu, 14 Oct 2004 20:13:01 +0000 (+0000)
Subject: Initial draft of mdeliver(1) man page.
X-Git-Url: https://diplodocus.org/git/mdeliver/commitdiff_plain/aa8dbd08e1c7e36219a4c5fd0ea4057adab35e0b?hp=1a0a636309cdd75eb9c89b052edbabbe4406f045

Initial draft of mdeliver(1) man page.
---

diff --git a/mdeliver.1.pod b/mdeliver.1.pod
new file mode 100644
index 0000000..d3971c2
--- /dev/null
+++ b/mdeliver.1.pod
@@ -0,0 +1,76 @@
+# $Id$
+
+=head1 NAME
+
+B<mdeliver> -- robust Maildir mail delivery agent
+
+=head1 SYNOPSIS
+
+B<mdeliver> [B<-v>]
+
+=head1 DESCRIPTION
+
+The B<mdeliver> utility is a simple and robust mail delivery agent.  It
+takes a single message via standard input and stores it in $HOME/Maildir
+using the usual Maildir semantics.  Please be aware that the Maildir must
+already exist, or message delivery will fail.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-v>
+
+Output version information and exit.  With this option, message delivery
+will not be attempted.
+
+=back
+
+=head1 EXAMPLES
+
+As an individual user if you want to use B<mdeliver> you could put the
+following in your .forward:
+
+    | /usr/local/bin/mdeliver
+
+If you want to use B<mdeliver> on a system wide basis, Postfix users could
+put the following in their main.cf:
+
+    mailbox_command = /usr/local/bin/mdeliver
+
+=head1 ENVIRONMENT
+
+The following environment variable affects the execution of B<mdeliver>:
+
+=over 4
+
+=item HOME
+
+The HOME environment variable defines in which directory the Maildir will
+be found.  If HOME is set to ``/home/charlie'', ``/home/charlie/Maildir''
+will be where delivery is attempted to.  If this variable is not set,
+delivery will fail.
+
+=back
+
+=head1 EXIT STATUS
+
+The following exit codes are possible:
+
+=over 4
+
+=item Z<>0
+
+Delivery was successful.
+
+=item EX_TEMPFAIL
+
+Message delivery failed.  The EX_TEMPFAIL code will let the MTA know that
+the failure was temporary.  Well written MTAs will take this hint and try
+to deliver the message again later.
+
+=back
+
+=head1 SEE ALSO
+
+maildir(5), maildirmake(1), forward(5), maildrop(1)