summaryrefslogtreecommitdiff
path: root/libexec/mail.local
diff options
context:
space:
mode:
authorAaron Campbell <aaron@cvs.openbsd.org>2000-10-30 17:46:31 +0000
committerAaron Campbell <aaron@cvs.openbsd.org>2000-10-30 17:46:31 +0000
commit414ea699038fdddb0d6d5756ea1ed702600abe8f (patch)
treee06ed3e4123eea5a8f37c8ec88db40a70fd59b79 /libexec/mail.local
parent458b80a106b294d4d78828e7d7c6439c802ad85e (diff)
libexec man page fleshing. again, bored on the plane home.
Diffstat (limited to 'libexec/mail.local')
-rw-r--r--libexec/mail.local/mail.local.895
1 files changed, 53 insertions, 42 deletions
diff --git a/libexec/mail.local/mail.local.8 b/libexec/mail.local/mail.local.8
index b2c341a4c02..f7f1a8873bc 100644
--- a/libexec/mail.local/mail.local.8
+++ b/libexec/mail.local/mail.local.8
@@ -30,7 +30,7 @@
.\" SUCH DAMAGE.
.\"
.\" from: @(#)mail.local.8 6.8 (Berkeley) 4/27/91
-.\" $Id: mail.local.8,v 1.19 2000/08/16 17:14:08 brad Exp $
+.\" $Id: mail.local.8,v 1.20 2000/10/30 17:46:07 aaron Exp $
.\"
.Dd April 27, 1991
.Dt MAIL.LOCAL 8
@@ -45,7 +45,7 @@
.Op Fl f Ar from
.Ar user ...
.Sh DESCRIPTION
-.Nm Mail.local
+.Nm
reads the standard input up to an end-of-file and appends it to each
.Ar user Ns 's
.Pa mail
@@ -59,51 +59,60 @@ The options are as follows:
.It Fl f Ar from
Specify the sender's name.
.It Fl l
-For compatibility, request that
-files named
-.Nm username.lock
-be used for locking. (This is the default behavior.)
+For compatibility, request that files named
+.Pa username.lock
+be used for locking.
+(This is the default behavior.)
.It Fl L
Don't create a
-.Nm username.lock
+.Pa username.lock
file while locking the spool.
.El
.Pp
Individual mail messages in the mailbox are delimited by an empty
-line followed by a line beginning with the string ``From ''.
-A line containing the string ``From '', the sender's name and a time stamp
-is prepended to each delivered mail message.
+line followed by a line beginning with the string
+.Dq "From\&\ " .
+A line containing the string
+.Dq "From\&\ " ,
+the sender's name and a timestamp are prepended to each delivered mail message.
A blank line is appended to each message.
-A greater-than character (``>'') is prepended to any line in the message
-which could be mistaken for a ``From '' delimiter line.
+A greater-than character
+.Pq Ql >
+is prepended to any line in the message which could be mistaken for a
+.Dq "From\&\ "
+delimiter line.
.Pp
Significant efforts have been made to ensure that
-.Nm mail.local
+.Nm
acts as securely as possible if the spool directory is mode 1777 or 755.
The default of mode 755 is more secure, but it prevents mail clients from using
-.Nm username.lock
+.Pa username.lock
style locking.
-The use of 1777 is more flexible in an NFS shared-spool
-environment, so many sites use it. However, it does carry some risks, such
-as attackers filling the spool disk. Some of these problems may be alleviated
+The use of 1777 is more flexible in an NFS shared-spool environment,
+so many sites use it.
+However, it does carry some risks, such as attackers filling the spool disk.
+Some of these problems may be alleviated
by making the spool a separate filesystem, and placing quotas on it.
The use of any mode other than 1777 and 755 for the spool directory is
recommended against but may work properly.
.Pp
The mailbox is always locked using
.Xr flock 2
-while mail is appended. Unless the
+while mail is appended.
+Unless the
.Fl L
flag is specified, a
-.Nm username.lock
+.Pa username.lock
file is also used.
.Pp
-If the ``biff'' service is returned by
+If the
+.Xr biff 1
+service is returned by
.Xr getservbyname 3 ,
the biff server is notified of delivered mail.
.Pp
The
-.Nm mail.local
+.Nm
utility exits 0 on success, and >0 if an error occurs.
.Sh ENVIRONMENT
.Bl -tag -width indent
@@ -117,14 +126,20 @@ temporary files
.It Pa /var/mail/user
user's mailbox directory
.El
+.Sh SEE ALSO
+.Xr biff 1 ,
+.Xr mail 1 ,
+.Xr flock 2 ,
+.Xr getservbyname 3 ,
+.Xr comsat 8 ,
+.Xr sendmail 8
.Sh HISTORY
A superset of
-.Nm mail.local
-(handling mailbox reading as well as mail delivery)
-appeared in
+.Nm
+(handling mailbox reading as well as mail delivery) appeared in
.At v7
as the program
-.Nm mail .
+.Xr mail 1 .
.Sh BUGS
Since
.Xr sendmail 8
@@ -133,19 +148,20 @@ on the return value from
.Nm mail.local ,
using quotas in
.Pa /var/mail
-can be problematic. By default,
+can be problematic.
+By default,
.Xr sendmail 8
will ask
-.Nm mail.local
-to deliver a message to multiple recipients if possible. This
-causes problems in a quota environment since a message may be
+.Nm
+to deliver a message to multiple recipients if possible.
+This causes problems in a quota environment since a message may be
delivered to some users but not others due to disk quotas.
Even though the message was delivered to some of the recipients,
-.Nm mail.local
+.Nm
will exit with an exit code > 0, causing
.Xr sendmail 8
-to attempt redelivery later. That means that some users will keep getting
-the same message every time
+to attempt redelivery later.
+That means that some users will keep getting the same message every time
.Xr sendmail 8
runs its queue.
.Pp
@@ -155,7 +171,8 @@ it is imperative that you unset the
.Dq m
mailer flag for the
.Sq local
-mailer. To do this, locate the line beginning with
+mailer.
+To do this, locate the line beginning with
.Dq Mlocal
in
.Pa /etc/mail/sendmail.cf
@@ -163,17 +180,11 @@ and remove the
.Dq m
from the flags section, denoted by
.Dq F= .
-Alternately, you can override the default mailer flags by adding
-the line:
+Alternately, you can override the default mailer flags by adding the line:
+.Pp
.Dl define(`LOCAL_MAILER_FLAGS', `rn9')dnl
+.Pp
to your
.Dq \.mc
file (this is the source file that is used to generate
.Pa /etc/mail/sendmail.cf ) .
-.Sh SEE ALSO
-.Xr biff 1 ,
-.Xr mail 1 ,
-.Xr flock 2 ,
-.Xr getservbyname 3 ,
-.Xr comsat 8 ,
-.Xr sendmail 8