summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStef Walter <stef@memberwebs.com>2005-03-12 05:23:19 +0000
committerStef Walter <stef@memberwebs.com>2005-03-12 05:23:19 +0000
commitce202a4ed31dcc847a29daa4bdd232978e7939a6 (patch)
tree3938f4c8ad35781509aefd207c36c552dca5c4fe
parentaa8dd5d2add8f620b86ea8e05a6cc01bee5bc32d (diff)
Added documentation for the header patch by Olivier.
-rw-r--r--doc/clamsmtpd.conf2
-rw-r--r--doc/clamsmtpd.conf.532
2 files changed, 29 insertions, 5 deletions
diff --git a/doc/clamsmtpd.conf b/doc/clamsmtpd.conf
index 515bbf0..934289d 100644
--- a/doc/clamsmtpd.conf
+++ b/doc/clamsmtpd.conf
@@ -32,7 +32,7 @@ OutAddress: 10026
#ClamAddress: /var/run/clamav/clamd
# A header to add to all scanned email
-#ScanHeader: X-AV-Checked: ClamAV using ClamSMTP
+#Header: X-Virus-Scanned: ClamAV using ClamSMTP
# Directory for temporary files
#TempDirectory: /tmp
diff --git a/doc/clamsmtpd.conf.5 b/doc/clamsmtpd.conf.5
index 49cd582..191066f 100644
--- a/doc/clamsmtpd.conf.5
+++ b/doc/clamsmtpd.conf.5
@@ -74,24 +74,44 @@ When this flag is set
actively rejects messages with viruses. This may cause the sender to receive
a message back notifying them of the virus. In most cases this is not a good
idea since many viruses spoof sender addresses.
+.Pp
[ Default: off ]
.It Ar ClamAddress
Specifies the address to connect to
.Xr clamd 8
on. See syntax of addresses below.
+.Pp
[ Default:
.Pa /var/run/clamav/clamd
]
+.It Ar Header
+A header to add to scanned messages. Put an empty value to suppress adding
+a header. You can include the following special formatting characters in the
+string to include special values:
+.Bl -inset
+.It Ar %i
+Client Address
+.It Ar %l
+Local Address
+.It Ar %d
+Current Date
+.El
+.Pp
+You can also include the standard \\r or \\n escapes.
+.Pp
+[ Default: 'X-Virus-Scanned: ClamAV using ClamSMTP' ]
.It Ar KeepAlives
On slow connections the server will sometimes timeout before
.Xr clamsmtpd 8
is finished scanning the file. This option sends NOOP's to the server
to keep the connection alive. Specify the number of seconds, or 0
to disable.
+.Pp
[ Default: 0 ]
.It Ar Listen
The address and port to listen for SMTP connections on. See syntax of
addresses below.
+.Pp
[ Default: port 10025 on all local IP addresses ]
.It Ar PidFile
Specifies a location for the a process id file to be written to. This file
@@ -100,6 +120,7 @@ contains the process id of
and can be used to stop the daemon. If the
.Fl p
argument is passed on the command line, then this setting will be ignored.
+.Pp
[ Default: none ]
.It Ar Quarantine
Quarantine files that contain viruses by leaving them in the
@@ -107,19 +128,18 @@ Quarantine files that contain viruses by leaving them in the
directory. The file names look like this (where X is a random
character or number):
.Pa virus.XXXXXX
+.Pp
[ Default: off ]
.It Ar MaxConnections
Specifies the maximum number of connections to accept at once.
.Xr clamd 8
also needs to be setup to accept at least this number of connections.
+.Pp
[ Default: 64 ]
-.It Ar ScanHeader
-A header to add to scanned messages. Put an empty value to suppress adding
-a header.
-[ Default: 'X-Virus-Scanned: ClamAV using ClamSMTP' ]
.It Ar OutAddress
The address of the SMTP server to send email to once it's been scanned. See
syntax of addreses below.
+.Pp
[ Required ]
.It Ar TempDirectory
The directory to write temp files to. This directory needs to be
@@ -127,11 +147,13 @@ accessible to both
.Xr clamd 8
and
.Xr clamsmtpd 8
+.Pp
[ Default:
.Pa /tmp
]
.It Ar TimeOut
The number of seconds to wait while reading data from network connections.
+.Pp
[ Default: 180 seconds ]
.It Ar TransparentProxy
This option enables transparent proxy support, which allows you to route all
@@ -148,10 +170,12 @@ This is a command to run when a virus is found. See the VIRUS ACTION section
in
.Xr clamsmtpd 8
for a discussion of this option.
+.Pp
[ Default: off ]
.It Ar XClient
Send an XCLIENT command to the receiving server. This is useful for forwarding
client addresses and connection info to servers that support this feature.
+.Pp
[ Default: off ]
.El
.Sh ADDRESSES