Reworked the man page system and some man page contents (mmh-intro).
[mmh] / man / rcvdist.man1
diff --git a/man/rcvdist.man1 b/man/rcvdist.man1
new file mode 100644 (file)
index 0000000..3653f47
--- /dev/null
@@ -0,0 +1,82 @@
+.\"
+.\" %nmhwarning%
+.\"
+.TH RCVDIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.SH NAME
+rcvdist \- asynchronously redistribute new mail
+.SH SYNOPSIS
+.HP 5
+.na
+.B %libdir%/rcvdist
+.RB [ \-form
+.IR formfile ]
+[switches\ for
+.IR postproc ]
+.I address1
+\&...
+.RB [ \-version ]
+.RB [ \-help ]
+.ad
+.SH DESCRIPTION
+The
+.B rcvdist
+program will accept a message on its standard input
+and resend a copy of this message to all of the addresses listed on its
+command line.
+.PP
+When a message is redistributed with the
+.B rcvdist
+command, the
+format of the Resent-xxx header fields is controlled by the forms files
+.RI \*(lq rcvdistcomps \*(rq.
+If a file named
+.RI \*(lq rcvdistcomps \*(rq
+exists in the user's mmh
+directory, it will be used instead of the default one.  You may specify
+an alternate forms file with the switch
+.B \-form
+.IR formfile .
+.PP
+The
+.RI \*(lq rcvdistcomps \*(rq
+file uses the format string facility described in
+.BR mh\-format (5).
+In addition to the standard format escapes,
+.B rcvdist
+also recognizes the following additional
+.I component
+escape:
+.PP
+.RS 5
+.nf
+.ta \w'Dtimenow  'u +\w'Returns  'u
+.I Escape      Returns Description
+addresses      string  the addresses to distribute to
+.fi
+.RE
+.PP
+By default,
+.B rcvdist
+uses the program
+.B post
+to do the actual
+delivery of the message, although this can be changed by defining the
+.I postproc
+profile component.
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'%etcdir%/ExtraBigFileName  'u
+^%etcdir%/rcvdistcomps~^Default message skeleton
+^or $HOME/.mmh/rcvdistcomps~^Rather than standard message skeleton
+^%etcdir%/mts.conf~^nmh mts configuration file
+^$HOME/\&.maildelivery~^The file controlling local delivery
+^%etcdir%/maildelivery~^Rather than the standard file
+.fi
+
+.SH "SEE ALSO"
+rcvpack(1), rcvstore(1), rcvtty(1), mh\-format(5), slocal(1)
+
+.SH BUGS
+Only two return codes are meaningful, others should be.