git.marmaro.de Git - mmh/blob - man/rcvtty.man1

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH RCVTTY %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 rcvtty  \- report new mail
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B %libdir%/rcvtty
  11 .RI [ command ]
  12 .RB [ \-form
  13 .IR formatfile ]
  14 .RB [ \-width
  15 .IR columns ]
  16 .RB [ \-bell " | " \-nobell ]
  17 .RB [ \-newline " | " \-nonewline ]
  18 .RB [ \-biff ]
  19 .RB [ \-version ]
  20 .RB [ \-help ]
  21 .ad
  22 .SH DESCRIPTION
  23 The
  24 .B rcvtty
  25 can be used to report new mail.  It is used primarily
  26 in conjunction with mail filtering agents such as
  27 .B slocal
  28 or
  29 .BR procmail .
  30 .PP
  31 The
  32 .B rcvtty
  33 program executes the named command with the message as
  34 its standard input, and writes the resulting output on your terminal.
  35 .PP
  36 Alternately, if no command is specified (or is bogus), then
  37 .B rcvtty
  38 will instead write a one\-line scan listing.  The default output format
  39 of this scan listing may be overridden by using the
  40 .B \-form
  41 .I formatfile
  42 option, similar to the
  43 equivalent options for
  44 .B scan
  45 and
  46 .BR inc .
  47 See
  48 .BR mh\-format (5)
  49 for details.
  50 .PP
  51 A newline is output before the message output, and the terminal bell is
  52 rung after the output.  The
  53 .B \-nonewline
  54 and
  55 .B \-nobell
  56 options will
  57 inhibit these functions.
  58 .PP
  59 The switch
  60 .B \-width
  61 .I columns
  62 may be given to specify the width of
  63 the scan line.  The default is to use the width of the terminal.
  64 .PP
  65 In addition to the standard format escapes described in
  66 .BR mh\-format (5),
  67 .B rcvtty
  68 also recognizes the following additional
  69 .I component
  70 escapes:
  71 .PP
  72 .RS 5
  73 .nf
  74 .ta \w'Dtimenow  'u +\w'Returns  'u
  75 Escape  Returns Description
  76 body    string  the (compressed) first part of the body
  77 dtimenow        date    the current date
  78 folder  string  the name of the current folder
  79 .fi
  80 .RE
  81 .PP
  82 By default,
  83 .B rcvtty
  84 will send its output to every terminal on the
  85 local machine that is owned by current user, and that has given write
  86 permission as granted by the command
  87 .BR mesg (1).
  88 If the option
  89 .B \-biff
  90 is given, then
  91 .B rcvtty
  92 will obey the notification status
  93 set by the command
  94 .BR biff (1)
  95 instead.
  96
  97 .SH FILES
  98 .fc ^ ~
  99 .nf
 100 .ta \w'%etcdir%/ExtraBigFileName  'u
 101 ^$HOME/\&.maildelivery~^The file controlling local delivery
 102 ^%etcdir%/maildelivery~^Rather than the standard file
 103 .fi
 104
 105 .SH CONTEXT
 106 None
 107
 108 .SH DEFAULTS
 109 .nf
 110 .RB ` \-width "' defaults to the width of the terminal"
 111 .RB ` \-newline '
 112 .RB ` \-bell '
 113 .fi
 114
 115 .SH "SEE ALSO"
 116 rcvdist(1), rcvpack(1), rcvstore(1), mh\-format(5), slocal(1)
 117
 118 .SH BUGS
 119 Only two return codes are meaningful, others should be.