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