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