updated ali-flist, with batch edit of others
[mmh] / man / rcvdist.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .\" include the -mh macro file
6 .so %etcdir%/tmac.h
7 .\"
8 .TH RCVDIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
9 .SH NAME
10 rcvdist \- asynchronously redistribute new mail
11 .SH SYNOPSIS
12 .in +.5i
13 .ti -.5i
14 %libdir%/rcvdist
15 \%[\-form\ formfile]
16 .br
17 \%[switches\ for\ \fIpostproc\fR]
18 address1\ ...
19 .br
20 \%[\-version]
21 \%[\-help]
22 .in -.5i
23 .SH DESCRIPTION
24 The \fIrcvdist\fR program will accept a message on its standard input
25 and resend a copy of this message to all of the addresses listed on its
26 command line.
27
28 When a message is redistributed with the \fIrcvdist\fR command, the
29 format of the Resent-xxx header fields is controlled by the forms files
30 "rcvdistcomps".  If a file named "rcvdistcomps" exists in the user's nmh
31 directory, it will be used instead of the default one.  You may specify
32 an alternate forms file with the switch `\-form\ formfile'.
33
34 The "rcvdistcomps" file uses the format string facility described in
35 \fImh\-format\fR(5).  In addition to the standard format escapes,
36 \fIrcvdist\fP also recognizes the following additional \fIcomponent\fR
37 escape:
38 .sp 1
39 .ne 5
40 .nf
41 .ta \w'Dtimenow  'u +\w'Returns  'u
42 \fIEscape\fR     \fIReturns\fR   \fIDescription\fR
43 addresses  string    the addresses to distribute to
44 .re
45 .fi
46
47 By default, \fIrcvdist\fR uses the program \fIpost\fR(8) to do the actual
48 delivery of the message, although this can be changed by defining the
49 \fIpostproc\fR profile component.
50 .Fi
51 ^%etcdir%/rcvdistcomps~^Default message skeleton
52 ^or <mh\-dir>/rcvdistcomps~^Rather than standard message skeleton
53 ^%etcdir%/mts.conf~^nmh mts configuration file
54 ^$HOME/\&.maildelivery~^The file controlling local delivery
55 ^%etcdir%/maildelivery~^Rather than the standard file
56 .Sa
57 rcvpack(1), rcvstore(1), rcvtty(1), mh\-format(5), slocal(1)
58 .Bu
59 Only two return codes are meaningful, others should be.
60 .En