diplodocus.org Git - nmh/blob - man/rcvtty.man

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