5 .\" include the -mh macro file
8 .TH RCVTTY %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
10 rcvtty \- report new mail
17 \%[\-form\ formatfile]
21 \%[\-bell] \%[\-nobell]
30 The \fIrcvtty\fR can be used to report new mail. It is used primarily
31 in conjunction with mail filtering agents such as \fIslocal\fP or
34 The \fIrcvtty\fR program executes the named command with the message as
35 its standard input, and writes the resulting output on your terminal.
37 Alternately, if no command is specified (or is bogus), then \fIrcvtty\fR
38 will instead write a one\-line scan listing. The default output format
39 of this scan listing may be overridden by using either the
40 `\-form\ formatfile' or `\-format\ string' option, similar to the
41 equivalent options for \fIscan\fP and \fIinc\fP.
42 See \fImh\-format\fP(5) for details.
44 A newline is output before the message output, and the terminal bell is
45 rung after the output. The `\-nonewline' and `\-nobell' options will
46 inhibit these functions.
48 The switch `\-width\ columns' may be given to specify the width of
49 the scan line. The default is to use the width of the terminal.
51 In addition to the standard format escapes described in
52 \fImh\-format\fR(5), \fIrcvtty\fR also recognizes the following additional
53 \fIcomponent\fR escapes:
57 .ta \w'Dtimenow 'u +\w'Returns 'u
58 \fIEscape\fR \fIReturns\fR \fIDescription\fR
59 body string the (compressed) first part of the body
60 dtimenow date the current date
61 folder string the name of the current folder
65 By default, \fIrcvtty\fP will send its output to every terminal on the
66 local machine that is owned by current user, and that has given write
67 permission as granted by the command \fImesg\fP\0(1). If the option
68 `\-biff' is given, then \fIrcvtty\fP will obey the notification status
69 set by the command \fIbiff\fP\0(1) instead.
71 ^%etcdir%/mts.conf~^nmh mts configuration file
72 ^$HOME/\&.maildelivery~^The file controlling local delivery
73 ^%etcdir%/maildelivery~^Rather than the standard file
75 `\-width' defaults to the width of the terminal
81 rcvdist(1), rcvpack(1), rcvstore(1), mh\-format(5), slocal(1)
83 Only two return codes are meaningful, others should be.