diplodocus.org Git - mdeliver/blob - mdeliver.1.pod

   1 # $Id$
   2
   3 =head1 NAME
   4
   5 B<mdeliver> -- robust Maildir mail delivery agent
   6
   7 =head1 SYNOPSIS
   8
   9 B<mdeliver> [B<-v>]
  10
  11 =head1 DESCRIPTION
  12
  13 The B<mdeliver> utility is a simple and robust mail delivery agent.  It
  14 takes a single message via standard input and stores it in $HOME/Maildir
  15 using the usual Maildir semantics.  Please be aware that the Maildir must
  16 already exist, or message delivery will fail.
  17
  18 =head1 OPTIONS
  19
  20 =over 4
  21
  22 =item B<-v>
  23
  24 Output version information and exit.  With this option, message delivery
  25 will not be attempted.
  26
  27 =back
  28
  29 =head1 EXAMPLES
  30
  31 As an individual user if you want to use B<mdeliver> you could put the
  32 following in your .forward:
  33
  34     | /usr/local/bin/mdeliver
  35
  36 If you want to use B<mdeliver> on a system wide basis, Postfix users could
  37 put the following in their main.cf:
  38
  39     mailbox_command = /usr/local/bin/mdeliver
  40
  41 =head1 ENVIRONMENT
  42
  43 The following environment variable affects the execution of B<mdeliver>:
  44
  45 =over 4
  46
  47 =item HOME
  48
  49 The HOME environment variable defines in which directory the Maildir will
  50 be found.  If HOME is set to ``/home/charlie'', ``/home/charlie/Maildir''
  51 will be where delivery is attempted to.  If this variable is not set,
  52 B<mdeliver> will fall back to using getpwuid(3).
  53
  54 =back
  55
  56 =head1 EXIT STATUS
  57
  58 The following exit codes are possible:
  59
  60 =over 4
  61
  62 =item Z<>0
  63
  64 Delivery was successful.
  65
  66 =item EX_TEMPFAIL
  67
  68 Message delivery failed.  The EX_TEMPFAIL code will let the MTA know that
  69 the failure was temporary.  Well written MTAs will take this hint and try
  70 to deliver the message again later.
  71
  72 =back
  73
  74 =head1 SEE ALSO
  75
  76 maildir(5), maildirmake(1), forward(5), maildrop(1)