xref: /netbsd-src/usr.bin/biff/biff.1 (revision 1ccf3ec022026273dd1c53d82576e472e1852266)
1*1ccf3ec0Sabhinav.\"	$NetBSD: biff.1,v 1.11 2016/12/20 08:21:32 abhinav Exp $
2b7327c7cSglass.\"
3b7327c7cSglass.\" Copyright (c) 1980, 1990, 1993
4b7327c7cSglass.\"	The Regents of the University of California.  All rights reserved.
561f28255Scgd.\"
661f28255Scgd.\" Redistribution and use in source and binary forms, with or without
761f28255Scgd.\" modification, are permitted provided that the following conditions
861f28255Scgd.\" are met:
961f28255Scgd.\" 1. Redistributions of source code must retain the above copyright
1061f28255Scgd.\"    notice, this list of conditions and the following disclaimer.
1161f28255Scgd.\" 2. Redistributions in binary form must reproduce the above copyright
1261f28255Scgd.\"    notice, this list of conditions and the following disclaimer in the
1361f28255Scgd.\"    documentation and/or other materials provided with the distribution.
1489aaa1bbSagc.\" 3. Neither the name of the University nor the names of its contributors
1561f28255Scgd.\"    may be used to endorse or promote products derived from this software
1661f28255Scgd.\"    without specific prior written permission.
1761f28255Scgd.\"
1861f28255Scgd.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1961f28255Scgd.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2061f28255Scgd.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2161f28255Scgd.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2261f28255Scgd.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2361f28255Scgd.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2461f28255Scgd.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2561f28255Scgd.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2661f28255Scgd.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2761f28255Scgd.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2861f28255Scgd.\" SUCH DAMAGE.
2961f28255Scgd.\"
30b7327c7cSglass.\"     @(#)biff.1	8.1 (Berkeley) 6/6/93
3161f28255Scgd.\"
32*1ccf3ec0Sabhinav.Dd December 20, 2016
3361f28255Scgd.Dt BIFF 1
349e44e9b5Sgarbled.Os
3561f28255Scgd.Sh NAME
3661f28255Scgd.Nm biff
37066e9230Swiz.Nd be notified if mail arrives and who it is from
3861f28255Scgd.Sh SYNOPSIS
3980baf83fSlukem.Nm
40*1ccf3ec0Sabhinav.Op Cm n | y
4161f28255Scgd.Sh DESCRIPTION
4280baf83fSlukem.Nm
4361f28255Scgdinforms the system whether you want to be notified when mail arrives
4461f28255Scgdduring the current terminal session.
4561f28255Scgd.Pp
4661f28255ScgdOptions supported by
47990562bfSwiz.Nm :
4861f28255Scgd.Bl -tag -width 4n
4961f28255Scgd.It Cm n
5061f28255ScgdDisables notification.
5161f28255Scgd.It Cm y
5261f28255ScgdEnables notification.
5361f28255Scgd.El
5461f28255Scgd.Pp
5561f28255ScgdWhen mail notification is enabled, the header and first few lines of
5661f28255Scgdthe message will be printed on your screen whenever mail arrives.
5761f28255ScgdA
5861f28255Scgd.Dq Li biff y
5961f28255Scgdcommand is often included in the file
6061f28255Scgd.Pa \&.login
6161f28255Scgdor
6261f28255Scgd.Pa \&.profile
6361f28255Scgdto be executed at each login.
6461f28255Scgd.Pp
65*1ccf3ec0SabhinavWhen no arguments are present,
66*1ccf3ec0Sabhinav.Nm
67*1ccf3ec0Sabhinavdisplays the current notification status to the standard output.
68*1ccf3ec0Sabhinav.Pp
6980baf83fSlukem.Nm
7061f28255Scgdoperates asynchronously.
7161f28255ScgdFor synchronous notification use the
7261f28255Scgd.Ar MAIL
7361f28255Scgdvariable of
7461f28255Scgd.Xr sh 1
7561f28255Scgdor the
7661f28255Scgd.Ar mail
7761f28255Scgdvariable of
7861f28255Scgd.Xr csh 1 .
79066e9230Swiz.Sh EXIT STATUS
80066e9230SwizThe
81066e9230Swiz.Nm
82066e9230Swizutility exits with one of the following values:
83066e9230Swiz.Bl -tag -width indent
84066e9230Swiz.It 0
85066e9230SwizNotification was enabled at the time of invocation.
86066e9230Swiz.It 1
87066e9230SwizNotification was disabled at the time of invocation.
88066e9230Swiz.It >1
89066e9230SwizAn error occurred.
90066e9230Swiz.El
9161f28255Scgd.Sh SEE ALSO
9261f28255Scgd.Xr csh 1 ,
93*1ccf3ec0Sabhinav.Xr from 1 ,
9461f28255Scgd.Xr mail 1 ,
9561f28255Scgd.Xr sh 1 ,
9661f28255Scgd.Xr comsat 8
9761f28255Scgd.Sh HISTORY
9861f28255ScgdThe
9961f28255Scgd.Nm
10061f28255Scgdcommand appeared in
10161f28255Scgd.Bx 4.0 .
102