usr.bin/msgs/msgs.1

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