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