path: root/usr.bin/msgs/msgs.1

.\"	$OpenBSD: msgs.1,v 1.16 2007/03/15 22:39:52 jmc Exp $
.\"	$NetBSD: msgs.1,v 1.5 1995/09/28 06:57:39 tls Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)msgs.1	8.2 (Berkeley) 4/28/95
.\"
.Dd April 28, 1995
.Dt MSGS 1
.Os
.Sh NAME
.Nm msgs
.Nd system messages and junk mail program
.Sh SYNOPSIS
.Nm msgs
.Op Fl fhlopqr
.Op Oo Fl Oc Ar number
.Nm msgs
.Op Fl s
.Nm msgs
.Op Fl c Op Fl Ns Ar days
.Sh DESCRIPTION
.Nm msgs
is used to read system messages.
These messages are
sent by mailing to the login
.Dq msgs
and should be short
pieces of information which are suitable to be read once by most users
of the system.
.Pp
The options are as follows:
.Bl -tag -width "-number"
.It Fl c Op Fl Ns Ar days
The
.Fl c
option is used for performing cleanup on
.Pa /var/msgs .
An entry with the
.Fl c
option should be placed in the system
.Xr crontab 5
to run every night.
This will remove all messages over 21 days old.
The optional
.Fl Ns Ar days
argument may be specified on the command line to override the default.
.It Fl f
Do not say
.Dq \&No new messages.
This is useful in a
.Pa .login
file since this is often the case here.
.It Fl h
Print the first part of messages only.
.It Fl l
Causes only locally originated messages to be reported.
.It Fl o
By default,
.Nm
exits when there are no more messages to read.
If the
.Fl o
flag is specified,
the user will be given the chance to save or read messages again.
.It Fl p
Pipe long messages through the program specified by the
.Ev PAGER
environment variable.
If
.Ev PAGER
is null or not defined,
.Xr more 1
is used.
.It Fl q
Queries whether there are messages, printing
.Dq There are new messages.
if there are.
The command
.Ic msgs -q
is often used in login scripts.
.It Fl r
Disables the ability to save messages or enter the mailer.
It is assumed that the
.Ev PAGER
environment is set to something secure.
.It Fl s
The
.Fl s
option is used for setting up the posting of messages.
The line
.Pp
.Dl msgs: \&"| /usr/bin/msgs -s\&"
.Pp
should be included in
.Pa /etc/mail/aliases
(see
.Xr newaliases 8 )
to enable posting of messages.
.It Ar number
A message number can be given
on the command line, causing
.Nm msgs
to start at the specified message rather than at the next message
indicated by your
.Pa .msgsrc
file.
Thus
.Pp
.Dl msgs -h 1
.Pp
prints the first part of all messages.
.It Fl Ns Ar number
Start
.Ar number
messages back from the one indicated in the
.Pa .msgsrc
file; useful for reviews of recent messages.
.El
.Pp
.Nm msgs
is normally invoked each time you login, by placing it in the file
.Pa .login
(or
.Pa .profile
if you use
.Xr sh 1 ) .
It will then prompt you with the source and subject of each new message.
If there is no subject line, the first few non-blank lines of the
message will be displayed.
If there is more to the message, you will be told how
long it is and asked whether you wish to see the rest of the message.
The possible responses are:
.Bl -tag -width Fl
.It Ic y
Type the rest of the message.
.It Ic RETURN
Synonym for
.Ic y .
.It Ic n
Skip this message
and go on to the next message.
.It Ic -
Redisplay the last message.
.It Ic q
Drop out of
.Nm msgs ;
the next time
.Nm msgs
will pick up where it last left off.
.It Ic s
Append the current message to the file
.Pa Messages
in the current directory;
.Sq s-
will save the previously displayed message.
An
.Sq s
or
.Sq s-
may be followed by a space and a file name to receive the message replacing
the default
.Dq Messages .
.It Ic m
A copy of the specified message is placed in a temporary
mailbox and
.Xr mail 1
is invoked on that mailbox.
.It Ic p
The specified message is piped through the program specified by the
.Ev PAGER
environment variable.
If
.Ev PAGER
is not defined,
.Xr more 1
is used.
.El
.Pp
The commands
.Ic m ,
.Ic p ,
and
.Ic s
all accept a numeric argument in place of the
.Sq - .
.Pp
.Nm msgs
keeps track of the next message you will see by a number in the file
.Pa .msgsrc
in your home directory.
In the directory
.Pa /var/msgs
it keeps a set of files whose names are the (sequential) numbers
of the messages they represent.
The file
.Pa /var/msgs/bounds
shows the low and high number of the messages in the directory
so that
.Nm msgs
can quickly determine if there are no messages for you.
.\" If the contents of
.\" .Pa bounds
.\" is incorrect it can be fixed by removing it;
.\" .Nm msgs
.\" will make a new
.\" .Pa bounds
.\" file the next time it is run.
.Pp
Within
.Nm msgs
you can also go to any specific message by typing its number when
.Nm msgs
requests input as to what to do.
.Sh ENVIRONMENT
.Nm msgs
uses the
.Ev HOME
and
.Ev TERM
environment variables for the default home directory and
terminal type.
If defined and non-null, the
.Ev PAGER
variable is invoked as the pagination program.
.Sh FILES
.Bl -tag -width /var/msgs/* -compact
.It Pa /var/msgs/*
database
.It ~/.msgsrc
number of next message to be presented
.El
.Sh SEE ALSO
.Xr mail 1 ,
.Xr more 1 ,
.Xr aliases 5 ,
.Xr crontab 5 ,
.Xr newaliases 8
.Sh HISTORY
The
.Nm msgs
command appeared in
.Bx 3.0 .