Skip to content
Permalink
Browse files

Add manual pages.

  • Loading branch information...
schmonz committed Dec 30, 2018
1 parent b3a18ee commit 70f042173bd512cb064c8656a0c873841e43959f
Showing with 269 additions and 0 deletions.
  1. +16 −0 Makefile
  2. +61 −0 qmail-qfilter-queue.8
  3. +25 −0 qmail-qfilter-viruscan.8
  4. +25 −0 qmail-rcptcheck-badrcptto.8
  5. +28 −0 qmail-rcptcheck-qregex.8
  6. +21 −0 qmail-rcptcheck-realrcptto.8
  7. +93 −0 qmail-rcptcheck.8
@@ -4,6 +4,21 @@ SHELL=/bin/sh

default: it

REJECTUTILS_BIN=qmail-qfilter-queue qmail-qfilter-viruscan \
qmail-rcptcheck qmail-rcptcheck-badrcptto \
qmail-rcptcheck-qregex qmail-rcptcheck-realrcptto
REJECTUTILS_MAN=qmail-qfilter-queue.8 qmail-qfilter-viruscan.8 \
qmail-rcptcheck.8 qmail-rcptcheck-badrcptto.8 \
qmail-rcptcheck-qregex.8 qmail-rcptcheck-realrcptto.8

rejectutils: \
${REJECTUTILS_BIN} ${REJECTUTILS_MAN}

rejectutils-install: \
rejectutils
cp ${REJECTUTILS_BIN} `head -1 conf-qmail`/bin && \
cp ${REJECTUTILS_MAN} `head -1 conf-qmail`/man/man8

addresses.0: \
addresses.5
nroff -man addresses.5 > addresses.0
@@ -312,6 +327,7 @@ exit.h auto_spawn.h
clean: \
TARGETS
rm -f `cat TARGETS`
git checkout -- INSTALL SENDMAIL

coe.o: \
compile coe.c coe.h
@@ -0,0 +1,61 @@
.TH QMAIL-QFILTER-QUEUE 8 2018-12-30
.SH NAME
qmail-qfilter-queue \- run a sequence of pre-queue filters
.SH SYNOPSIS
.B qmail-qfilter-queue
.SH DESCRIPTION
.B qmail-qfilter-queue
runs an administrator-defined sequence of filters
before calling
.BR qmail-queue .
Filters will be run by
.B qmail-qfilter
and must adhere to that interface.
If any filter rejects, the message is rejected.
.PP
.B qmail-qfilter-queue
is most commonly invoked from
.B qmail-smtpd
and
.BR ofmipd ,
so that incoming and submitted messages are filtered before
entering the queue.
.SH "ENVIRONMENT VARIABLES"
To have
.B qmail-qfilter-queue
invoked in place of
.BR qmail-queue ,
set
.B QMAILQUEUE
to
.I /var/qmail/bin/qmail-qfilter-queue
(typically in your
.BR tcpserver 's
tcprules).
.PP
To run pre-queue filters, set
.B QMAILQUEUEFILTERS
with the path to the control file
containing your sequence of filter programs (one per line).
.SH "CONTROL FILES"
Typical values for
.BR QMAILQUEUEFILTERS :
.TP 5
.I control/smtpfilters
For incoming messages.
.TP 5
.I control/ofmipfilters
For submitted messages.
.SH "EXAMPLES"
See
.IR https://schmonz.com/qmail/rejectutils .
.SH "AUTHOR"
.B Amitai Schleier <schmonz-web-rejectutils@schmonz.com>
.SH "SEE ALSO"
qmail-queue(8),
qmail-qfilter(1),
qmail-smtpd(8),
ofmipd(8),
tcpserver(1),
qmail-qfilter-viruscan(8),
qmail-qfilter-addtlsheader(8).
@@ -0,0 +1,25 @@
.TH QMAIL-QFILTER-VIRUSCAN 8 2018-12-30
.SH NAME
qmail-qfilter-viruscan \- viruscan patch as standalone program
.SH SYNOPSIS
.B qmail-qfilter-viruscan
.SH DESCRIPTION
.B qmail-qfilter-viruscan
is Russ Nelson's viruscan patch repackaged as a
.BR qmail-qfilter -compatible
program.
.SH "CONTROL FILES"
.TP 5
.I signatures
For incoming messages.
.SH "EXAMPLES"
See
.IR https://schmonz.com/qmail/rejectutils .
.SH "AUTHOR"
.B Amitai Schleier <schmonz-web-rejectutils@schmonz.com>
.SH HISTORY
Based on this code from Russ Nelson:
.PP
.I http://www.qmail.org/qmail-smtpd-viruscan-1.3.patch
.SH "SEE ALSO"
qmail-qfilter(1).
@@ -0,0 +1,25 @@
.TH QMAIL-RCPTCHECK-BADRCPTTO 8 2018-12-30
.SH NAME
qmail-rcptcheck-badrcptto \- badrcptto patch as standalone program
.SH SYNOPSIS
.B qmail-rcptcheck-badrcptto
.SH DESCRIPTION
.B qmail-rcptcheck-badrcptto
is Ward Vandewege's badrcptto patch repackaged as a
.BR qmail-qfilter -compatible
program.
.SH "CONTROL FILES"
.TP 5
.I badrcptto
For incoming messages.
.SH "EXAMPLES"
See
.IR https://schmonz.com/qmail/rejectutils .
.SH "AUTHOR"
.B Amitai Schleier <schmonz-web-rejectutils@schmonz.com>
.SH HISTORY
Based on this code from Ward Vandewege:
.PP
.I http://patch.be/qmail/
.SH "SEE ALSO"
qmail-qfilter(1).
@@ -0,0 +1,28 @@
.TH QMAIL-RCPTCHECK-QREGEX 8 2018-12-30
.SH NAME
qmail-rcptcheck-qregex \- qregex patch as standalone program
.SH SYNOPSIS
.B qmail-rcptcheck-qregex
.SH DESCRIPTION
.B qmail-rcptcheck-qregex
is Andrew St. Jean's qregex patch repackaged as a
.BR qmail-qfilter -compatible
program.
.SH "CONTROL FILES"
.TP 5
.I badmailto
For incoming recipients.
.TP 5
.I badmailfrom
For incoming senders.
.SH "EXAMPLES"
See
.IR https://schmonz.com/qmail/rejectutils .
.SH "AUTHOR"
.B Amitai Schleier <schmonz-web-rejectutils@schmonz.com>
.SH HISTORY
Based on this code from Andrew St. Jean:
.PP
.I http://www.arda.homeunix.net/downloads-qmail/
.SH "SEE ALSO"
qmail-qfilter(1).
@@ -0,0 +1,21 @@
.TH QMAIL-RCPTCHECK-REALRCPTTO 8 2018-12-30
.SH NAME
qmail-rcptcheck-realrcptto \- realrcptto patch as standalone program
.SH SYNOPSIS
.B qmail-rcptcheck-realrcptto
.SH DESCRIPTION
.B qmail-rcptcheck-realrcptto
is Paul Jarc's realrcptto patch repackaged as a
.BR qmail-qfilter -compatible
program.
.SH "EXAMPLES"
See
.IR https://schmonz.com/qmail/rejectutils .
.SH "AUTHOR"
.B Amitai Schleier <schmonz-web-rejectutils@schmonz.com>
.SH HISTORY
Based on this code from Paul Jarc:
.PP
.I http://code.dogmap.org/qmail/#realrcptto
.SH "SEE ALSO"
qmail-qfilter(1).
@@ -0,0 +1,93 @@
.TH QMAIL-RCPTCHECK 8 2018-12-30
.SH NAME
qmail-rcptcheck \- run a sequence of sender/recipient checks
.SH SYNOPSIS
.B qmail-rcptcheck
.SH DESCRIPTION
.B qmail-rcptcheck
runs an administrator-defined sequence of filters
on SMTP envelope senders and recipients.
Filters must adhere to the
.B RCPTCHECK
interface.
If any filter rejects, the message is rejected.
.PP
.B qmail-rcptcheck
is most commonly invoked from
.B qmail-smtpd
patched with either
.B qmail-spp
or
.BR RCPTCHECK .
.SH "ENVIRONMENT VARIABLES"
To run under
.BR qmail-spp :
none needed.
.PP
To run under
.BR RCPTCHECK :
set
.B RCPTCHECK
to
.I /var/qmail/bin/qmail-rcptcheck
(typically in your
.BR tcpserver 's
tcprules).
.PP
To write a filter:
.TP 5
.I SENDER
contains the envelope sender.
.TP 5
.I RECIPIENT
contains the envelope recipient.
.SH "CONTROL FILES"
To run under
.BR qmail-spp :
add
.I /var/qmail/bin/qmail-rcptcheck
in the
.I [rcpt]
section of
.IR smtpplugins .
.PP
To run under
.BR RCPTCHECK :
none needed.
.PP
To control
.BR qmail-rcptcheck :
.TP 5
.I rcptchecks
Sequence of filter programs (one per line).
.SH "EXIT CODES"
As defined by the
.B RCPTCHECK
interface,
.I 120
is reserved.
Filters should exit
.I 111
when unable to verify,
.I 100
to reject, or
any other non-reserved code to accept.
.SH COMPATIBILITY
.BR RCPTCHECK -compatible
filter programs can run unmodified under
.B qmail-spp
simply by running them from
.BR qmail-rcptcheck .
.SH "EXAMPLES"
See
.IR https://schmonz.com/qmail/rejectutils .
.SH "AUTHOR"
.B Amitai Schleier <schmonz-web-rejectutils@schmonz.com>
.SH HISTORY
Based on this code from Jay Soffian:
.PP
.I http://www.soffian.org/downloads/qmail/qmail-smtpd-doc.html
.SH "SEE ALSO"
qmail-smtpd(8).
.PP
.I http://qmail-spp.sourceforge.net/doc/

0 comments on commit 70f0421

Please sign in to comment.
You can’t perform that action at this time.