contrib/sendmail/mail.local/mail.local.8

   1 .\" Copyright (c) 1998-2001 Sendmail, Inc. and its suppliers.
   2 .\"      All rights reserved.
   3 .\" Copyright (c) 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" By using this file, you agree to the terms and conditions set
   7 .\" forth in the LICENSE file which can be found at the top level of
   8 .\" the sendmail distribution.
   9 .\"
  10 .\"
  11 .\"     $Id: mail.local.8,v 8.23 2001/04/05 23:27:35 gshapiro Exp $
  12 .\"
  13 .TH MAIL.LOCAL 8 "$Date: 2001/04/05 23:27:35 $"
  14 .SH NAME
  15 mail.local
  16 \- store mail in a mailbox
  17 .SH SYNOPSIS
  18 .B mail.local
  19 .RB [ \-7 "] [" \-B "] [" \-b "] [" \-d "] [" \-D
  20 .IR mbdb ]
  21 .RB [ \-l "] [" \-s "] [" \-f
  22 \fIfrom\fR|\fB\-r\fR
  23 .IR from ]
  24 .RB [ \-h
  25 \fIfilename\fR ]
  26 .I "user ..."
  27 .SH DESCRIPTION
  28 .B Mail.local
  29 reads the standard input up to an end-of-file and appends it to each
  30 .I user's
  31 .B mail
  32 file.  The
  33 .I user
  34 must be a valid user name.
  35 .PP
  36 The options are as follows:
  37 .TP 1i
  38 .B \-7
  39 Do not advertise 8BITMIME support in LMTP mode.
  40 .TP
  41 .B \-B
  42 Turn off the attempts to notify the
  43 .Dq biff
  44 service.
  45 .TP
  46 .B \-b
  47 Return a permanent error instead of a temporary error
  48 if a mailbox exceeds quota.
  49 .TP
  50 .B \-d
  51 Specify this is a delivery (for backward compatibility).
  52 This option has no effect.
  53 .TP
  54 .BI \-D " mbdb"
  55 Specify the name of the mailbox database
  56 which is used to look up local recipient names.
  57 This option defaults to "pw", which means use getpwnam().
  58 .TP
  59 .BI \-f " from"
  60 Specify the sender's name.
  61 .TP
  62 .B \-l
  63 Turn on LMTP mode.
  64 .TP
  65 .B \-s
  66 Turn off the
  67 .Xr fsync 2
  68 call that forces the mailbox to be committed to disk before returning a
  69 .Dq success
  70 status.
  71 .TP
  72 .BI \-r " from"
  73 Specify the sender's name (for backward compatibility).
  74 Same as \-f.
  75 .TP
  76 .BI \-h " filename"
  77 Store incoming mail in \fIfilename\fR in the user's home directory instead
  78 of a system mail spool directory.
  79 .PP
  80 Individual mail messages in the mailbox are delimited by an empty
  81 line followed by a line beginning with the string ``From ''.
  82 A line containing the string ``From '', the sender's name and a time stamp
  83 is prepended to each delivered mail message.
  84 A blank line is appended to each message.
  85 A greater-than character (``>'') is prepended to any line in the message
  86 which could be mistaken for a ``From '' delimiter line
  87 (that is,
  88 a line beginning with the five characters
  89 ``From '' following a blank line).
  90 .PP
  91 The mail files are exclusively locked with
  92 flock(2)
  93 while mail is appended,
  94 and a
  95 .B user.lock
  96 file also is created while the mailbox is locked
  97 for compatibility with older MUAs.
  98 .PP
  99 If the ``biff'' service is returned by
 100 getservbyname(3),
 101 the biff server is notified of delivered mail.
 102 .PP
 103 The
 104 .B mail.local
 105 utility exits 0 on success, and >0 if an error occurs.
 106 .SH ENVIRONMENT
 107 .IP TZ
 108 Used to set the appropriate time zone on the timestamp.
 109 .SH FILES
 110 .PD 0.2v
 111 .TP 2.2i
 112 /tmp/local.XXXXXX
 113 temporary files
 114 .TP
 115 /var/mail/user
 116 user's default mailbox directory
 117 .TP
 118 /var/mail/user.lock
 119 lock file for a user's default mailbox
 120 .PD
 121 .SH SEE ALSO
 122 mail(1),
 123 flock(2),
 124 getservbyname(3),
 125 comsat(8),
 126 sendmail(8)
 127 .SH WARNING
 128 .B mail.local
 129 escapes only "^From " lines that follow an empty line.
 130 If all lines starting with "From " should be escaped,
 131 use the 'E' flag for the local mailer in the
 132 sendmail.cf file.
 133 .SH HISTORY
 134 A superset of
 135 .B mail.local
 136 (handling mailbox reading as well as mail delivery)
 137 appeared in
 138 Version 7 AT&T UNIX
 139 as the program
 140 .BR mail .
 141 .\" $FreeBSD: src/contrib/sendmail/mail.local/mail.local.8,v 1.5.6.5 2002/09/03 01:50:01 gshapiro Exp $
 142 .\" $DragonFly: src/contrib/sendmail/mail.local/Attic/mail.local.8,v 1.2 2003/06/17 04:24:06 dillon Exp $