libexec/mail.local/mail.local.8

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