libexec/mail.local/mail.local.8

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)mail.local.8        8.2 (Berkeley) 12/11/93
  33 .\"     $Id: mail.local.8,v 1.7 1997/10/11 22:05:42 wosch Exp $
  34 .\"
  35 .Dd December 11, 1993
  36 .Dt MAIL.LOCAL 8
  37 .Os
  38 .Sh NAME
  39 .Nm mail.local
  40 .Nd store mail in a mailbox
  41 .Sh SYNOPSIS
  42 .Nm mail.local
  43 .Op Fl f Ar from
  44 .Op Fl b
  45 .Ar user ...
  46 .Sh DESCRIPTION
  47 .Nm Mail.local
  48 reads the standard input up to an end-of-file and appends it to each
  49 .Ar user Ns 's
  50 .Pa mail
  51 file.
  52 The
  53 .Ar user
  54 must be a valid user name.
  55 .Pp
  56 The options are as follows:
  57 .Bl -tag -width xxxfrom
  58 .It Fl f Ar from
  59 Specify the sender's name.
  60 .It Fl b
  61 Turn off the attempts to notify the
  62 .Dq biff
  63 service.
  64 .El
  65 .Pp
  66 Individual mail messages in the mailbox are delimited by an empty
  67 line followed by a line beginning with the string ``From ''.
  68 A line containing the string ``From '', the sender's name and a time stamp
  69 is prepended to each delivered mail message.
  70 A blank line is appended to each message.
  71 A greater-than character (``>'') is prepended to any line in the message
  72 which could be mistaken for a ``From '' delimiter line.
  73 .Pp
  74 The mail files are exclusively locked with
  75 .Xr flock 2
  76 while mail is appended.
  77 .Pp
  78 If the ``biff'' service is returned by
  79 .Xr getservbyname 3 ,
  80 the biff server is notified of delivered mail.
  81 .Pp
  82 The
  83 .Nm mail.local
  84 utility exits 0 on success, and >0 if an error occurs.
  85 .Sh ENVIRONMENT
  86 .Bl -tag -width indent
  87 .It Ev TZ
  88 Used to set the appropriate time zone on the timestamp.
  89 .El
  90 .Sh FILES
  91 .Bl -tag -width /var/tmp/local.XXXXXX -compact
  92 .It Pa /var/tmp/local.XXXXXX
  93 temporary files
  94 .It Pa /var/mail/user
  95 user's mailbox directory
  96 .El
  97 .Sh SEE ALSO
  98 .Xr mail 1 ,
  99 .Xr flock 2 ,
 100 .Xr getservbyname 3 ,
 101 .Xr comsat 8 ,
 102 .Xr sendmail 8
 103 .Sh HISTORY
 104 A superset of
 105 .Nm mail.local
 106 (handling mailbox reading as well as mail delivery)
 107 appeared in
 108 .At v7
 109 as the program
 110 .Nm mail .