Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / from / from.1
1 .\" Copyright (c) 1980, 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 .\"     @(#)from.1      8.2 (Berkeley) 12/30/93
33 .\" $FreeBSD: src/usr.bin/from/from.1,v 1.7.2.6 2002/07/15 06:17:55 keramida Exp $
34 .\"
35 .Dd December 30, 1993
36 .Dt FROM 1
37 .Os
38 .Sh NAME
39 .Nm from
40 .Nd print names of those who have sent mail
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl c
44 .Op Fl s Ar sender
45 .Op Fl f Ar file
46 .Op Ar user
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility prints
51 out the mail header lines from the invoker's mailbox.
52 .Pp
53 The following options are available:
54 .Bl -tag -width indent
55 .It Fl c
56 Just print a count of messages and exit.
57 .It Fl f Ar file
58 The supplied file
59 is examined instead of the invoker's mailbox.
60 If the
61 .Fl f
62 option is used, the
63 .Ar user
64 argument should not be used.
65 Read from standard input if file name
66 .Ar -
67 is given.
68 .It Fl s Ar sender
69 Only mail from addresses containing
70 the
71 supplied string are printed.
72 .El
73 .Pp
74 If
75 .Ar user
76 is given, the
77 .Ar user Ns 's
78 mailbox is examined instead of the invoker's own mailbox.
79 (Privileges are required.)
80 .Sh ENVIRONMENT
81 .Bl -tag -width Fl
82 .It Ev MAIL
83 If set, the location of the invoker's mailbox.
84 Otherwise, the default in
85 .Pa /var/mail
86 is used.
87 .El
88 .Sh FILES
89 .Bl -tag -width /var/mail/* -compact
90 .It Pa /var/mail/*
91 .El
92 .Sh SEE ALSO
93 .Xr biff 1 ,
94 .Xr mail 1
95 .Sh HISTORY
96 The
97 .Nm
98 command appeared in
99 .Bx 3.0 .