provide a fresh new from-scratch written manual page

smtpfeed/smtpfeed.8

@@ -1,153 +1,183 @@
-.TH NAME SECTION 
+.\"
-.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
+.\"  smtpfeed.8 -- SMTPfeed Unix Manual Page
-.\" other parms are allowed: see man(7), man(1)
+.\"
+.TH SMTPFEED 8 "December 2001" Unix "User Manuals"
 .SH NAME
-smtpfeed \- SMTP feed, SMTP Fast Exploding External Deliverer for Sendmail
+.PP
+smtpfeed \- SMTP Fast Exploding External Deliverer
 .SH SYNOPSIS
-.B smtpfeed
+.PP
-.I "[options]"
+\fBsmtpfeed\fP
-.br
+[\fB-1\fP]
-.SH "DESCRIPTION"
+[\fB-5\fP]
-This manual page documents briefly the
+[\fB-A\fP]
-.BR smtpfeed
+[\fB-a\fP \fIalias\fP]
-command.
+[\fB-b\fP \fIbufsize\fP]
-.B smtpfeed
+[\fB-c\fP \fIname\fP]
-is a program that used as external mailer for sendmail.
+[\fB-d\fP \fIdebugopt\fP]
+[\fB-E\fP]
+[\fB-F\fP]
+[\fB-F -F\fP]
+[\fB-g\fP \fIpgateway\fP]
+[\fB-h\fP]
+[\fB-i\fP \fIqueue-id\fP]
+[\fB-I\fP \fIqueue-id\fP]
+[\fB-l\fP \fIfacility\fP]
+[\fB-M\fP \fImapfile\fP]
+[\fB-m\fP \fIfallback-mx\fP]
+[\fB-N\fP \fIdomain\fP]
+[\fB-n\fP \fInum\fP]
+[\fB-o\fP \fIsource-addr\fP]
+[\fB-p\fP \fIsource-port\fP]
+[\fB-r\fP \fInum\fP]
+[\fB-R\fP \fInum\fP]
+[\fB-S\fP \fIpattern\fP]
+[\fB-s\fP \fIsize\fP]
+[\fB-t\fP \fIcategory=value\fP]
+[\fB-u\fP]
+[\fB-V\fP]
+[\fB-x\fP]
+[\fB-y\fP]
+[\fB-z\fP]
+.SH DESCRIPTION
+.PP
+This manual page documents the \fBsmtpfeed\fP command, an
+LMTP-speaking mail delivery agent (MDA) dedicated to mass mail delivery, i.e.,
+the delivery of mails via SMTP, addressed to large number of recipients.  So
+\fBsmtpfeed\fP is effective for delivery of large mailing lists.
+\fBsmtpfeed\fP is spawned by a mail transfer agent (MTA) like Sendmail or
+Postfix, receives the mail and recipients via LMTP on stdin/stdout and
+performs SMTP delivery by first processing DNS queries in parallel, followed
+by parallel processing of SMTP deliveries.  \fBsmtpfeed\fP can not deliver
+huge messages because it stores all information (includes message data) in
+memory.
 .SH OPTIONS
-A summary of options are included below.
+.PP
-.TP
+A description of the available command options are included below.
-.B \-1
+.IP "\fB-1\fP"
-.br
+Disable SMTP piggybacking (equivalent to \fB-R1\fP).
-Disable SMTP piggybacking (equivalent to -R1)
+.IP "\fB-5\fP"
-.TP
+If \fBsmtpfeed\fP works only with IPv4 (IPv6) protocol
-.B \-a
+(see option \fB-N\fP), and if peer host has
-.I alias
+only AAAA (A) RRs in DNS, message will not be
-.br
+bounced back with "Host not found" error, and fallback MX
-Specify my host alias name, which is used to check MX list.
+(option \fB-m\fP) will be used.
-.TP
+.IP "\fB-A\fP"
-.B \-A
+Try T_ANY DNS query first to get MX list.
-.br
+.IP "\fB-a\fP \fIalias\fP"
-try T_ANY query first to get MX.
+Specify this host's alias name, which is used to check MX list.
-.TP
+.IP "\fB-b\fP \fIbufsize\fP"
-.B \-b
-.I bufsize
-.br
 Specify TCP send buffer size.
-.TP
+.IP "\fB-c\fP \fIname\fP"
-.B \-c
+Specify official full-qualified domain name (FQDN) of this host, which 
-.I name
-.br
-Specify officianl full-qualified domain name FQDN of this host, which 
 is used in SMTP HELO command.
-.TP
+.IP "\fB-d\fP \fIdebugopt\fP"
-.B \-d
-.I debugopt
-.br
 Specify debug options.
-.I debugopt 
+Possible values for \fIdebugopt\fP are one or more of the following: 
-are:  A: all, a: address, c: connection, e: event, h: hash, l: LMTP, 
+A: all, a: address, c: connection, e: event, h: hash, l: LMTP, 
-m: map, n: DNS, s: SMTP, t: transaction, u: res. usage, D: no delivery,
+m: map, n: DNS, s: SMTP, t: transaction, u: resource usage, D: no delivery,
-Q: DNS query only
+Q: DNS query only.
-.TP
+.IP "\fB-E\fP"
-.B \-E
-.br
 Get queue-id information from Received: header.
-.TP
+.IP "\fB-F\fP"
-.B \-F
+Insert recipient information on Received: header line if number of recipients
-Insert recipient information on Received: header line
+for an SMTP transaction is only one (see also option \fB-1\fP).
-when number of recipients for a SMTP transaction is only one.
+.IP "\fB-F -F\fP"
-.TP
+Modify envelope sender address like
-.B \-h
+"SenderUser+RcptUser=RcptDomain@SenderDomain" when \fB-1\fP option is specified.
-Show help message
+If you want to use this feature, configure your mail server to receive such
-.TP
+addresses. Note: this modification will not be done when envelope sender is
-.B \-I
+"<>". See also option \fB-S\fP.
-.br
+.IP "\fB-g\fP \fIpgateway\fP"
-.equevalent to -i option, but no purge on RSET.
+Protocol gateway host (Default: not defined). Option \fB-5\fP must be
-.TP
+specified at the same time. Option \fB-N4\fP or \fB-N6\fP must also be
-.B \-i
+specified at the same time if compiled with -DINET6. If \fB-N4\fP is specified
-.I queue-id
+(or compiled without -DINET6), if an MX has IPv6 addresses, \fIpgateway\fP
-.br
+will be used as first MX. This feature will be useful when delivery via
-.I queue-id 
+\fIpgateway\fP with fat IPv6 network is faster than direct delivery with
-generated by sendmail just for logging information 
+narrow IPv4 network. If \fB-N6\fP is specified, \fIpgateway\fP will be used if
-(macro name for queue-id in sendmail.cf is $i.)
+an MX has IPv4 addresses, conversely.
-.TP
+.IP "\fB-h\fP"
-.B \-l 
+Show help message.
-.I facility
+.IP "\fB-i\fP \fIqueue-id\fB"
-.br
+The \fIqueue-id\fP
-Specify loggin facility (default = local5).
+as generated by the MTA - just for logging purposes. 
-.TP
+(macro name for \fIqueue-id\fP in sendmail.cf is $i.)
-.B \-M
+.IP "\fB-I\fP \fIqueue-id\fB"
-.I mapfile
+Equivalent to option \fB-i\fP, but no purge on SMTP RSET command.
-.br
+.IP "\fB-l\fP \fIfacility\fB"
-path of host map file (Default: not defined)
+Specify syslog(3) logging facility (default is "local5").
-.TP
+.IP "\fB-M\fP \fImapfile\fB"
-.B \-m
+Path of host map file (Default: not defined).
-.I fallbackmx
+Syntax of map file is: "DOMAIN DEST1:DEST2:... # comments"
-.br
+where DOMAIN can be "domain" (exact matching) or ".domain" (substring
+matching) and DEST can be 
+"hostname" (MX for hostname), 
+"[hostname]" (A for hostname), 
+"[IPaddress]" (IP address),
+"MX" (MX for domain part of a mail address),
+"MX?" (same as MX (skip to following dest. even under DNS lookup failure),
+"A" (A for domain part of a mail address),
+"=alias" (MX for an aliased mail address).
+.IP "\fB-m\fP \fIfallback-mx\fB"
 Fallback MX host.
-.TP
+.IP "\fB-N\fP \fIdomain\fB"
-.B \-N
+Specify network domain.
-.I domain
+Possible .I domain
-.br
+specifiers are: 
-specify network domain.
+4: use IPv4 only, 6: use IPv6 only, B: use both of IPv4/IPv6
-.I domain
+at random, B4: IPv4 then IPv6, B6: IPv6 then IPv4.
-are: 4:IPv4 only, 6:IPv6 only, B:Both
+.IP "\fB-n\fP \fInum\fB"
-.TP
+Specify maximum number of available sockets for use.
-.B \-n
+(Default: FD_SETSIZE-1).
-.I num
+.IP "\fB-o\fP \fIsource-addr\fB"
-.br
+Source TCP/IP address for outgoing SMTP connections.
-Specify maximum number of available sockets.
+(Default: an appropriate address will be dynamically assigned.)
-.TP
+.IP "\fB-p\fP \fIsource-port\fB"
-.B \-o
+Source TCP/IP port for outgoing SMTP connections.
-.I source-addr
+(Default: a free port will be dynamically assigned.)
-.br
+.IP "\fB-R\fP \fInum\fB"
-source address for SMTP connection
+Specify maximum number of recipients in a single SMTP transaction.
-.TP
+(Default: 100)
-.B \-p
+.IP "\fB-r\fP \fInum\fB"
-.I port
+Specify minimum number of recipients required for an SMTP transaction.
-.br
+(Default: 1)
-Specify TCP source port to connect by SMTP.
+.IP "\fB-S\fP \fIpattern\fB"
-.TP
+Format to be used at envelope sender address conversion when
-.B \-R
+\fB-F -F\fP option specified. (Default: <%s+%s=%s@%s>)
-.I num
+.IP "\fB-s\fP \fIsize\fB"
-.br
-Specify maximum number of recipients in a transaction.
-.TP
-.B \-r
-.I num
-.br
-Specify minimum number of recipients required for a transaction.
-.TP
-.B \-s
-.I size
-.br
 Specify maximum message size.
-.TP
+(Default: unlimited)
-.B \-t
+.IP "\fB-t\fP \fIcategory=value\fB"
-.I cate
+Set communication timeouts.
-=
+Numbers followed by 's' means 'in seconds', by 'm' means
-.I val
+ 'in minutes' and by 'h' means 'in hours'. default is 'm'.
-.br
+Values for \fIcategory\fP are: 
-set timeouts (val: NUM[hms]; default is s(econds)).
+"total" (total processing limit (55m), it will be take "total + quit"),
-.I cate
+"connect" (till TCP connection establishment (5m)), 
-(gory) are: total, connect, greet, helo, mail,
+"greet" (till get SMTP greeting message (5m)), 
-rcpt, data, body, term, cache, rset, quit
+"helo" (till get response for HELO (5m)),
-.TP
+"mail" (till get response for MAIL (10m)), 
-.B \-u
+"rcpt" (till get response for RCPT (60m)),
-.br
+"data" (till get response for DATA (5m)), 
-reuse SMTP connection for other MX.
+"body" (till send next datablock (20m)), 
-.TP
+"term" (till get response for DATA termination (60m)), 
-.B \-V
+"cache" (for idle SMTP connection (5m)), 
-.br
+"rset" (till get response for RSET (5m)), 
+"quit" (till get response for QUIT (2m)).
+.IP "\fB-u\fP"
+Reuse SMTP connection for other MX.
+(default: off)
+.IP "\fB-V\fP"
 Force to insert version number in Received: line.
-.TP
+.IP "\fB-x\fP"
-.B \-y
+No error even if MX RRs point to absent A/AAAA RRs.
-.br
+.IP "\fB-y\fP"
-refer A RR if this host is the first MX
+Refer to DNS A RR if this host is the first MX.
-.TP
+.IP "\fB-z\fP"
-.B -z
+Disable SMTP pipelining.
-.br
-Suppress SMTP pipelining.
 .SH AUTHOR
-This manual page was written by Fumitoshi UKAI <ukai@debian.or.jp>,
+.PP
-for the Debian GNU/Linux system.
+This manual page was written by Ralf S. Engelschall
+<rse@engelschall.com> for the OpenPKG \fBsmtpfeed\fP
+package.

smtpfeed/smtpfeed.spec

@@ -33,7 +33,7 @@ Distribution: OpenPKG [REL]
 Group:        Mail
 License:      GPL
 Version:      1.16
-Release:      20011210
+Release:      20011221
 
 #   list of sources
 Source0:      ftp://ftp.kyoto.wide.ad.jp/pub/mail/smtpfeed/smtpfeed-%{version}.tar.gz