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

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