usr.bin/msgs/msgs.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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)msgs.1      8.2 (Berkeley) 4/28/95
  29 .\" $FreeBSD: src/usr.bin/msgs/msgs.1,v 1.9.2.7 2002/07/15 07:19:24 keramida Exp $
  30 .\"
  31 .Dd April 28, 1995
  32 .Dt MSGS 1
  33 .Os
  34 .Sh NAME
  35 .Nm msgs
  36 .Nd system messages and junk mail program
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl fhlpq
  40 .Op Ar number
  41 .Op Ar \-number
  42 .Nm
  43 .Op Fl s
  44 .Nm
  45 .Op Fl c
  46 .Op \-days
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility is used to read system messages.
  51 These messages are
  52 sent by mailing to the login `msgs' and should be short
  53 pieces of information which are suitable to be read once by most users
  54 of the system.
  55 .Pp
  56 The
  57 .Nm
  58 utility is normally invoked each time you login, by placing it in the file
  59 .Pa .login
  60 (or
  61 .Pa .profile
  62 if you use
  63 .Xr sh 1 ) .
  64 It will then prompt you with the source and subject of each new message.
  65 If there is no subject line, the first few non-blank lines of the
  66 message will be displayed.
  67 If there is more to the message, you will be told how
  68 long it is and asked whether you wish to see the rest of the message.
  69 The possible responses are:
  70 .Bl -tag -width Fl
  71 .It Fl y
  72 Type the rest of the message.
  73 .It Ic RETURN
  74 Synonym for y.
  75 .It Fl n
  76 Skip this message
  77 and go on to the next message.
  78 .It Fl
  79 Redisplay the last message.
  80 .It Fl q
  81 Drop out of
  82 .Nm ;
  83 the next time
  84 .Nm
  85 will pick up where it last left off.
  86 .It Fl s
  87 Append the current message to the file ``Messages'' in the current directory;
  88 `s\-' will save the previously displayed message.
  89 A `s' or `s\-' may
  90 be followed by a space and a file name to receive the message replacing
  91 the default ``Messages''.
  92 .It Fl m
  93 A copy of the specified message is placed in a temporary
  94 mailbox and
  95 .Xr mail 1
  96 is invoked on that mailbox.
  97 Both `m' and `s' accept a numeric argument in place of the `\-'.
  98 .El
  99 .Pp
 100 The
 101 .Nm
 102 utility keeps track of the next message you will see by a number in the file
 103 .Pa \&.msgsrc
 104 in your home directory.
 105 In the directory
 106 .Pa /var/msgs
 107 it keeps a set of files whose names are the (sequential) numbers
 108 of the messages they represent.
 109 The file
 110 .Pa /var/msgs/bounds
 111 shows the low and high number of the messages in the directory
 112 so that
 113 .Nm
 114 can quickly determine if there are no messages for you.
 115 If the contents of
 116 .Pa bounds
 117 is incorrect it can be fixed by removing it;
 118 .Nm
 119 will make a new
 120 .Pa bounds
 121 file the next time it is run with the
 122 .Fl s
 123 option.
 124 If
 125 .Nm
 126 is run with any option other than
 127 .Fl s ,
 128 an error will be displayed if
 129 .Pa /var/msgs/bounds
 130 does not exist.
 131 .Pp
 132 The
 133 .Fl s
 134 option is used for setting up the posting of messages.
 135 The line
 136 .Pp
 137 .Dl msgs: \&"\&| /usr/bin/msgs \-s\&"
 138 .Pp
 139 should be included in
 140 .Pa /etc/mail/aliases
 141 (see
 142 .Xr newaliases 1 )
 143 to enable posting of messages.
 144 .Pp
 145 The
 146 .Fl c
 147 option is used for performing cleanup on
 148 .Pa /var/msgs .
 149 A shell script entry to run
 150 .Nm
 151 with the
 152 .Fl c
 153 option should be placed in
 154 .Pa /etc/periodic/daily
 155 (see
 156 .Xr periodic 8 )
 157 to run every night.
 158 This will remove all messages over 21 days old.
 159 A different expiration may be specified on the command line to override
 160 the default.
 161 You must be the superuser to use this option.
 162 .Pp
 163 Options when reading messages include:
 164 .Bl -tag -width Fl
 165 .It Fl f
 166 Do not say ``No new messages.''.
 167 This is useful in a
 168 .Pa .login
 169 file since this is often the case here.
 170 .It Fl q
 171 Queries whether there are messages, printing
 172 ``There are new messages.'' if there are.
 173 The command ``msgs \-q'' is often used in login scripts.
 174 .It Fl h
 175 Print the first part of messages only.
 176 .It Fl l
 177 Cause only locally originated messages to be reported.
 178 .It Ar num
 179 A message number can be given
 180 on the command line, causing
 181 .Nm
 182 to start at the specified message rather than at the next message
 183 indicated by your
 184 .Pa \&.msgsrc
 185 file.
 186 Thus
 187 .Pp
 188 .Dl msgs \-h 1
 189 .Pp
 190 prints the first part of all messages.
 191 .It Ar \-number
 192 Start
 193 .Ar number
 194 messages back from the one indicated in the
 195 .Pa \&.msgsrc
 196 file, useful for reviews of recent messages.
 197 .It Fl p
 198 Pipe long messages through
 199 .Xr more 1 .
 200 .El
 201 .Pp
 202 Within
 203 .Nm
 204 you can also go to any specific message by typing its number when
 205 .Nm
 206 requests input as to what to do.
 207 .Sh ENVIRONMENT
 208 The
 209 .Nm
 210 utility uses the
 211 .Ev HOME
 212 and
 213 .Ev TERM
 214 environment variables for the default home directory and
 215 terminal type.
 216 .Sh FILES
 217 .Bl -tag -width /var/msgs/* -compact
 218 .It Pa /var/msgs/*
 219 database
 220 .It Pa ~/.msgsrc
 221 number of next message to be presented
 222 .El
 223 .Sh SEE ALSO
 224 .Xr mail 1 ,
 225 .Xr more 1 ,
 226 .Xr aliases 5 ,
 227 .Xr periodic 8
 228 .Sh HISTORY
 229 The
 230 .Nm
 231 command appeared in
 232 .Bx 3.0 .