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