Initial import from FreeBSD RELENG_4:
[games.git] / libexec / comsat / comsat.8
1 .\" Copyright (c) 1983, 1991, 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 .\"     @(#)comsat.8    8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/libexec/comsat/comsat.8,v 1.6.2.4 2002/08/18 17:30:53 johan Exp $
34 .\"
35 .Dd August 9, 2002
36 .Dt COMSAT 8
37 .Os
38 .Sh NAME
39 .Nm comsat
40 .Nd biff server
41 .Sh SYNOPSIS
42 .Nm
43 .Sh DESCRIPTION
44 .Nm Comsat
45 is the server process which receives reports of incoming mail
46 and notifies users if they have requested this service.
47 .Nm Comsat
48 receives messages on a datagram port associated with the
49 .Dq biff
50 service
51 specification (see
52 .Xr services 5
53 and
54 .Xr inetd 8 ) .
55 The one line messages are of the form:
56 .Pp
57 .Dl user@mailbox-offset[:mailbox-name]
58 .Pp
59 If the
60 .Em user
61 specified is logged in to the system and the associated terminal has
62 the owner execute bit turned on (by a
63 .Dq Li biff y ) ,
64 the
65 .Em offset
66 is used as a seek offset into the appropriate mailbox file and
67 the first 7 lines or 560 characters of the message are printed
68 on the user's terminal.  Lines which appear to be part of
69 the message header other than the
70 .Dq From ,
71 .Dq \&To ,
72 .Dq Date ,
73 or
74 .Dq Subject
75 lines are not included in the displayed message.
76 .Pp
77 If the
78 .Em user
79 specified is logged in to the system and the associated terminal has
80 the group execute bit turned on (by a
81 .Dq Li biff b ) ,
82 two bell characters (ASCII \\007) are printed on the user's terminal.
83 .Pp
84 If mailbox-name omitted, standard mailbox assumed.
85 .Sh FILES
86 .Bl -tag -width /var/mail/user -compact
87 .It Pa /var/run/utmp
88 to find out who's logged on and on what terminals
89 .It Pa /var/mail/user
90 standard mailbox
91 .El
92 .Sh SEE ALSO
93 .Xr biff 1 ,
94 .Xr inetd 8
95 .Sh BUGS
96 The message header filtering is prone to error.
97 The density of the information presented is near the theoretical minimum.
98 .Pp
99 Users should be notified of mail which arrives on other
100 machines than the one to which they are currently logged in.
101 .Pp
102 The notification should appear in a separate window so it
103 does not mess up the screen.
104 .Sh HISTORY
105 The
106 .Nm
107 command appeared in
108 .Bx 4.2 .