make timeout dependent on RING_WAIT (time when client will try re-inviting the callee)
[unix-history] / usr / src / libexec / mail.local / mail.local.8
index 097fa90..5705715 100644 (file)
-.\"    @(#)mail.local.8        6.2 (Berkeley) %G%
+.\" Copyright (c) 1990 The Regents of the University of California.
+.\" All rights reserved.
 .\"
 .\"
-.TH DELIVERMAIL 1 ""
-.AT 3
-.SH NAME
-delivermail \- send or receive mail among users
-.SH SYNOPSIS
-.B delivermail
-[
-.B +
-] [
-.B \-i
-] [ person ] ...
-.br
-.B delivermail
-.B "[ + ]"
-[
-.B \-i
-]
-.B \-f
-file
-.LP
-.SH DESCRIPTION
-Note: This is the old version 7 UNIX system mail program.  The default
-.I mail
-command is described in
-.IR Mail (1).
-.PP
-.I mail
-with no argument prints a user's mail, message-by-message,
-in last-in, first-out order; the optional argument
-.B +
-displays the mail messages in first-in, first-out order.
-For each message, it reads a line from the standard input
-to direct disposition of the message.
-.TP
-newline
-Go on to next message.
-.TP
-d
-Delete message and go on to the next.
-.TP
-p
-Print message again.
-.TP
-\-
-Go back to previous message.
-.TP
-.RI "s [" " file " "] ..."
-Save the message in the named
-.I files
-(`mbox' default).
-.TP
-.RI "w [" " file " "] ..."
-Save the message, without a header, in the named
-.I files
-(`mbox' default).
-.TP
-.RI "m [" " person " "] ..."
-Mail the message to the named
-.I persons
-(yourself is default).
-.TP
-EOT (control-D)
-Put unexamined mail back in the mailbox and stop.
-.TP
-q
-Same as EOT.
-.TP
-.RI ! command
-Escape to the Shell to do
-.IR command .
-.TP
-*
-Print a command summary.
-.PP
-An interrupt normally terminates the 
-.I mail
-command; the mail file is unchanged.  The optional argument
-.B \(mii
-tells
-.I mail
-to continue after interrupts.
-.PP
-When
-.I persons
-are named,
-.I mail
-takes the standard input up to an end-of-file (or a line with just `.')
-and adds it to each
-.I person's
-`mail' file.  The message is preceded by the sender's name and a postmark.
-Lines that look like postmarks are prepended with `>'.  A
-.I person
-is usually a user name recognized by
-.IR  login (1).
-To denote a recipient on a remote system, prefix 
-.I person
-by the system name and exclamation mark (see
-.IR uucp (1)).
-.PP
+.\" %sccs.include.redist.roff%
+.\"
+.\"    @(#)mail.local.8        6.8 (Berkeley) %G%
+.\"
+.Dd 
+.Dt MAIL.LOCAL 8
+.Os
+.Sh NAME
+.Nm mail.local
+.Nd store mail in a mailbox
+.Sh SYNOPSIS
+.Nm mail.local
+.Op Fl f Ar from
+.Ar user ...
+.Sh DESCRIPTION
+.Nm Mail.local
+reads the standard input up to an end-of-file and appends it to each
+.Ar user 's
+.Pa mail
+file.
+The
+.Ar user
+must be a valid user name.
+.Pp
+The options are as follows:
+.Bl -tag -width xxxfrom
+.It Fl f Ar from
+Specify the sender's name.
+.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.
+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.
+.Pp
+The mail files are exclusively locked with 
+.Xr flock 2
+while mail is appended.
+.Pp
+If the ``biff'' service is returned by
+.Xr getservbyname 3 ,
+the biff server is notified of delivered mail.
+.Pp
 The
 The
-.B \-f
-option causes the named file, for example, `mbox',
-to be printed as if it were the mail file.
-.PP
-When a user logs in he is informed of the presence of mail.
-.SH FILES
-.ta \w'/usr/spool/mail/*.lock 'u
-/etc/passwd    to identify sender and locate persons
-.br
-.li
-/usr/spool/mail/*      incoming mail for user *
-.br
-mbox           saved mail
-.br
-/tmp/ma*       temp file
-.br
-/usr/spool/mail/*.lock lock for mail directory
-.br
-dead.letter    unmailable text
-.br
-.SH "SEE ALSO"
-Mail(1), write(1), uucp(1), uux(1), xsend(1), sendmail(8)
-.SH BUGS
-Race conditions sometimes result in a failure to remove a lock file.
-.PP
-Normally anybody can read your mail, unless it is sent by
-.IR xsend (1).
-An installation can overcome this by making
-.I mail
-a set-user-id command that owns the mail directory.
+.Nm mail.local
+utility exits 0 on success, and >0 if an error occurs.
+.Sh ENVIRONMENT
+.Bl -tag -width indent
+.It Ev TZ
+Used to set the appropriate time zone on the timestamp.
+.El
+.Sh FILES
+.Bl -tag -width /tmp/local.XXXXXX -compact
+.It Pa /tmp/local.XXXXXX
+temporary files
+.It Pa /var/mail/user
+user's mailbox directory
+.El
+.Sh SEE ALSO
+.Xr mail 1 ,
+.Xr xsend 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
+.At v7 .
+as the program
+.Nm mail .