summaryrefslogtreecommitdiff
path: root/src/clamsmtpd.8
diff options
context:
space:
mode:
authorStef Walter <stef@memberwebs.com>2004-07-21 20:14:06 +0000
committerStef Walter <stef@memberwebs.com>2004-07-21 20:14:06 +0000
commitf8f3669040043a6a681fe9711cf83204f6046c2f (patch)
treed0e03c5f857c43b8d8eed9a4e18e58890d91bf48 /src/clamsmtpd.8
parentb0b5f1e0fb508d29e94fdba8e2965905c800b450 (diff)
- Added quarantine feature
- Clarified documentation - New version
Diffstat (limited to 'src/clamsmtpd.8')
-rw-r--r--src/clamsmtpd.821
1 files changed, 15 insertions, 6 deletions
diff --git a/src/clamsmtpd.8 b/src/clamsmtpd.8
index 3ded807..9594624 100644
--- a/src/clamsmtpd.8
+++ b/src/clamsmtpd.8
@@ -42,6 +42,7 @@
.Nd an SMTP server for scanning viruses via clamd
.Sh SYNOPSIS
.Nm
+.Op Fl bq
.Op Fl c Ar clamaddr
.Op Fl d Ar level
.Op Fl D Ar tmpdir
@@ -58,8 +59,8 @@ is an SMTP filter that allows you to check for viruses using the ClamAV
anti-virus software. It accepts SMTP connections and forwards the SMTP commands
and responses to another SMTP server.
.Pp
-The DATA email body is intercepted and scanned before forwarding. Email with
-viruses are rejected and logged without any additional action taken.
+The DATA email body is intercepted and scanned before forwarding. By default email
+with viruses are dropped silently and logged without any additional action taken.
.Pp
.Nm
aims to be lightweight and simple rather than have a myriad of options. Your
@@ -125,6 +126,12 @@ to write a file with the daemon's process id, which can be used to stop the
daemon.
.Ar pidfile
is the location of the file.
+.It Fl q
+Quarantine files that contain viruses by leaving them in the
+.Ar tmpdir
+directory. The file names look like this (where X is a random
+character or number):
+.Pa virus.XXXXXX
.It Fl t
.Ar timeout
is the number of seconds to wait while reading data from network connections.
@@ -145,12 +152,14 @@ option.
In some cases it's advantagous to consolidate the virus scanning and filtering
for several mail servers on one machine.
.Nm
-allows this by providing a loopback feature to connect back to the IP that a
-SMTP connection comes from. If only a port is specified for the
+allows this by providing a loopback feature to connect back to the IP that an
+SMTP connection comes in from.
+.Pp
+To use this feature specify only a port number (no IP address) for the
.Ar serveraddr
-(without IP) then
+in which case
.Nm
-passes the email to the incoming peer's IP address on the said port.
+will pass the email back to the said port on the incoming IP address.
.Pp
Make sure the
.Ar maxconn