190413448070b9d222a3f62c1cf654214bf7929b
[mmh] / man / rcvdist.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .TH RCVDIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 .SH NAME
7 rcvdist \- asynchronously redistribute new mail
8 .SH SYNOPSIS
9 .HP 5
10 .na
11 .B %libdir%/rcvdist
12 .RB [ \-form
13 .IR formfile ]
14 [switches\ for
15 .IR postproc ]
16 .I address1
17 \&...
18 .RB [ \-version ]
19 .RB [ \-help ]
20 .ad
21 .SH DESCRIPTION
22 The
23 .B rcvdist
24 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 .PP
28 When a message is redistributed with the
29 .B rcvdist
30 command, the
31 format of the Resent-xxx header fields is controlled by the forms files
32 .RI \*(lq rcvdistcomps \*(rq.
33 If a file named
34 .RI \*(lq rcvdistcomps \*(rq
35 exists in the user's nmh
36 directory, it will be used instead of the default one.  You may specify
37 an alternate forms file with the switch
38 .B \-form
39 .IR formfile .
40 .PP
41 The
42 .RI \*(lq rcvdistcomps \*(rq
43 file uses the format string facility described in
44 .BR mh\-format (5).
45 In addition to the standard format escapes,
46 .B rcvdist
47 also recognizes the following additional
48 .I component
49 escape:
50 .PP
51 .RS 5
52 .nf
53 .ta \w'Dtimenow  'u +\w'Returns  'u
54 .I Escape       Returns Description
55 addresses       string  the addresses to distribute to
56 .fi
57 .RE
58 .PP
59 By default,
60 .B rcvdist
61 uses the program
62 .B post
63 to do the actual
64 delivery of the message, although this can be changed by defining the
65 .I postproc
66 profile component.
67
68 .SH FILES
69 .fc ^ ~
70 .nf
71 .ta \w'%etcdir%/ExtraBigFileName  'u
72 ^%etcdir%/rcvdistcomps~^Default message skeleton
73 ^or <mh\-dir>/rcvdistcomps~^Rather than standard message skeleton
74 ^%etcdir%/mts.conf~^nmh mts configuration file
75 ^$HOME/\&.maildelivery~^The file controlling local delivery
76 ^%etcdir%/maildelivery~^Rather than the standard file
77 .fi
78
79 .SH "SEE ALSO"
80 rcvpack(1), rcvstore(1), rcvtty(1), mh\-format(5), slocal(1)
81
82 .SH BUGS
83 Only two return codes are meaningful, others should be.