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

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