@@ -1,3 +1,7 @@

+Wed Nov 12 11:21:45 CET 2008 (acab)

+-----------------------------------

+ * docs/man/clamav-milter.8.in: avoid hyphen-used-as-minus-sign warnings

+

 Wed Nov 12 00:34:20 CET 2008 (acab)

 -----------------------------------

  * build system: build-all into /libclamav to workaround inconsistent

@@ -1,4 +1,4 @@

-.TH "clamav-milter" "8" "March 23, 2004" "ClamAV @VERSION@" "Clam AntiVirus"

+.TH "clamav\-milter" "8" "March 23, 2004" "ClamAV @VERSION@" "Clam AntiVirus"

 .SH "NAME"

 .LP

 clamav\-milter \- milter compatible mail scanner

@@ -11,7 +11,7 @@ Clamav\-milter is a filter for \fBsendmail(1)\fR mail server.

 It uses a mail scanning engine built into \fBclamd(8)\fR.

 .LP

 Clamav\-milter can use load balancing and fault tolerant techniques to connect

-to more than one clamd(8) server and seamlessly hot-swap to even the load

+to more than one clamd(8) server and seamlessly hot\-swap to even the load

 between different machines and to keep scanning for viruses even when a server

 goes down.

 When it is configured to use clamd on the the localhost, when

@@ -33,8 +33,8 @@ then that user must have the rights to create the file.

 .LP

 .TP

-\fB-a FROM, \-\-from<=EMAIL>\fR

-Source email address of notices. The default is MAILER-DAEMON.

+\fB\-a FROM, \-\-from<=EMAIL>\fR

+Source email address of notices. The default is MAILER\-DAEMON.

 If \fI=EMAIL\fR is not given, thus \-\-from, then the from address is set

 to the originating email address, however since it is likely that address is

 forged it must not be relied upon.

@@ -49,11 +49,11 @@ to check if any of their machines are infected.

 \fB\-V, \-\-version\fR

 Print the version number and exit.

 .TP

-\fB-C DIR, \-\-chroot=DIR\fR

+\fB\-C DIR, \-\-chroot=DIR\fR

 Run in chroot jail DIR.

 .IP

 You will have to do a lot of fiddling if you want notifications to work,

-since clamav-milter calls \fBsendmail(8)\fR to handle the notifications and

+since clamav\-milter calls \fBsendmail(8)\fR to handle the notifications and

 sendmail will run of out the same jail.

 .TP

 \fB\-c FILE, \-\-config\-file=FILE\fR

@@ -64,20 +64,20 @@ Enables debugging.

 .TP

 \fB\-x n, \-\-debug\-level=n\fR

 Set the debug level to n (where n from [0..9]) if \fBclamav\-milter\fR was

-configured and compiled with \-\-clamav-debug enabled.

+configured and compiled with \-\-clamav\-debug enabled.

 Will be replaced by \-\-debug for compatibility with other programs in the

 suite.

 .TP

-\fB-A, \-\-advisory\fR

+\fB\-A, \-\-advisory\fR

 When in advisory mode, clamav\-milter flags emails with viruses but

 still forwards them. The default option is to stop viruses.

-This mode is incompatible with \-\-quarantine and \-\-quarantine-dir.

+This mode is incompatible with \-\-quarantine and \-\-quarantine\-dir.

 .TP

 \fB\-b, \-\-bounce\fR

 Send a failure message to the sender, and to the postmaster.

 [ \fBWarning\fR: most viruses and worms

 fake their source address, so this option is not recommended, and needs

-to be enabled at compile-time ].

+to be enabled at compile\-time ].

 See also \-\-noreject.

 .TP

 \fB\-B, \-\-broadcast[=<iface>]\fR

@@ -89,45 +89,45 @@ first NIC.

 A future network management program (yet to be written) will intercept these

 broadcasts to raise a warning on the operator's desk.

 .TP

-\fB-d, \-\-dont-scan-on-error\fR

+\fB\-d, \-\-dont\-scan\-on\-error\fR

 If a system error occurs pass messages through unscanned,

 usually when a system error occurs the milter raises a temporary failure which

 generally causes the message to remain in the queue.

 .TP

-\fB-f, \-\-force-scan\fR

-Always scan, wherever the message came from (see also --local and --outgoing).

+\fB\-f, \-\-force\-scan\fR

+Always scan, wherever the message came from (see also \-\-local and \-\-outgoing).

 You probably don't want this.

 .TP

-\fB-e, \-\-external\fR

+\fB\-e, \-\-external\fR

 Usually clamav\-milter scans the emails itself without the use of an

 external program.

 The \-\-external option informs clamav\-milter to use an external program such

 as clamd(8) running either on the local server or other server(s) to perform

 the scanning.

 .TP

-\fB\-k, \-\-blacklist-time=time\fR

+\fB\-k, \-\-blacklist\-time=time\fR

 Tells the number of seconds to black list an IP address (IPv4 only). This

 is especially useful with phishing which often send a number of emails one

 after the other.

 .IP

 Blacklisting speeds up scanning significantly, however it does have drawbacks

 since it is possible for a site to be incorrectly blacklisted because of DHCP

-or an unsafe smart-host.

-To avoid this, clamav-milter's blacklist does not last for ever.

+or an unsafe smart\-host.

+To avoid this, clamav\-milter's blacklist does not last for ever.

 The recommended value is 60.

 .IP

 Machines on the LAN, the local host, and machines that are our MX peers are

 never blacklisted.

 .TP

-\fB\f-K, \-\-dont-blacklist=IP[,IP...]\fR

-Instructs clamav-milter to refrain from blacklisting IP the given addresses.

+\fB\f\-K, \-\-dont\-blacklist=IP[,IP...]\fR

+Instructs clamav\-milter to refrain from blacklisting IP the given addresses.

 This is useful for sites that receive email from upstream servers that are

 either untrusted or have no virus.

 Without this option many false positives could occur.

 This scenario often happens when the upstream server belongs to an

 ISP that may not have AV software.

 .TP

-\fB-l, \-\-local\fR

+\fB\-l, \-\-local\fR

 Also scan messages sent from LAN. You probably want this especially if

 your LAN is populated by machines running Windows or DOS.

 .IP

@@ -136,7 +136,7 @@ Machines with IP addresses within the ranges 192.168.0.0/16, 10.0.0.0/8,

 other machines are always scanned.

 Up to 8 extra ranges may be added with the \-\-ignore option.

 .TP

-\fB-M, \-\-freshclam-monitor\fR

+\fB\-M, \-\-freshclam\-monitor\fR

 When not running in external mode, this option tells clamav\-milter how

 often to check that the virus database has been updated, probably by

 freshclam(1).

@@ -145,35 +145,35 @@ The default is 300 seconds.

 The checking cannot be disabled, a value less than or equal to zero will be

 rejected.

 .TP

-\fB-n, \-\-noxheader\fR

+\fB\-n, \-\-noxheader\fR

 Usually clamav\-milter adds headings to messages that are scanned.

-The headers are of the form "X-Virus-Scanned: version",

-and "X-Virus-Status: clean/infected/not-scanned".

+The headers are of the form "X\-Virus\-Scanned: version",

+and "X\-Virus\-Status: clean/infected/not\-scanned".

 This option instructs

 clamav\-milter to refrain from adding this heading.

 .TP

-\fB-N, \-\-noreject\fR

-When clamav\-milter processes an e-mail which contains a virus it rejects

-the e-mail by using the SMTP code 550 or 554 depending on the state machine.

+\fB\-N, \-\-noreject\fR

+When clamav\-milter processes an e\-mail which contains a virus it rejects

+the e\-mail by using the SMTP code 550 or 554 depending on the state machine.

 This option causes clamav\-milter to silently discard such messages.

 It is recommended that system administrators use this option when NOT using

 the \-\-bounce option.

 .TP

-\fB-o, \-\-outgoing\fR

+\fB\-o, \-\-outgoing\fR

 Scan messages generated from this machine. You probably don't need this.

 .TP

-\fB-i, \-\-pidfile=FILE\fR

+\fB\-i, \-\-pidfile=FILE\fR

 Notifies clamav\-milter to store its process ID in FILE.

 The file must be creatable by clamav\-milter,

 if the User option is set in

 \fBclamd.conf(5)\fR,

 then that user must have the rights to create the file.

 .TP

-\fB-p, \-\-postmaster=EMAILADDRESS\fR

-Sets the e-mail address that receives notifications of viruses caught,

+\fB\-p, \-\-postmaster=EMAILADDRESS\fR

+Sets the e\-mail address that receives notifications of viruses caught,

 when the \-\-quiet option is not given.

 .TP

-\fB-P, \-\-postmaster-only\fR

+\fB\-P, \-\-postmaster\-only\fR

 When the \-\-quiet option is not given, send a notification to the postmaster.

 Setting this flag will include the ID of the message in the email's body

 which can ease searching through system logs if the administrator believes it

@@ -181,27 +181,27 @@ is a locally sourced virus.

 Without this option, the intended recipient of the email will also receive a

 copy of the notification of the interception.

 .TP

-\fB-q, \-\-quiet\fR

+\fB\-q, \-\-quiet\fR

 Don't send any notification messages when a virus or worm is detected.

-This option overrides the \-\-bounce and \-\-postmaster-only options, and is

+This option overrides the \-\-bounce and \-\-postmaster\-only options, and is

 the way to turn off notification to the postmaster.

 .TP

-\fB-Q, \-\-quarantine=EMAILADDRESS\fR

-If this e-mail address is given, messages containing a virus or worm are

+\fB\-Q, \-\-quarantine=EMAILADDRESS\fR

+If this e\-mail address is given, messages containing a virus or worm are

 redirected to it.

 .TP

-\fB-r, \-\-report-phish=EMAILADDRESS\fR

-Report caught phishing to an anti-phish organisation's email address such

+\fB\-r, \-\-report\-phish=EMAILADDRESS\fR

+Report caught phishing to an anti\-phish organisation's email address such

 as pirt_clamav@castlecops.com and reportphishing@antiphishing.org.

 .TP

-\fB-R, \-\-report-phish-false-positives=EMAILADDRESS\fR

+\fB\-R, \-\-report\-phish\-false\-positives=EMAILADDRESS\fR

 Report phish false positves to an email address, such as bugs@clamav.net.

 .TP

-\fB-U, \-\-quarantine-dir=DIR\fR

+\fB\-U, \-\-quarantine\-dir=DIR\fR

 If this option is given, infected files are left in this directory.

 The directory must not be publicly readable or writable, if it is,

 clamav\-milter will issue an error and fail to start.

-\fBNote\fR - this option only works when using LocalSocket.

+\fBNote\fR \- this option only works when using LocalSocket.

 .TP

 \fB\-\-server=HOSTNAME/ADDRESS, \-s HOSTNAME/ADDRESS\fR

 IP address or hostname of server(s) running clamd (when using TCPsocket and

@@ -219,7 +219,7 @@ Add a hard\-coded signature to each scanned file. It is likely that this

 signature will only display on the end user's terminal if the message is

 plain/text or not encoded.

 .TP

-\fB\-\-signature-file, \-F\fR

+\fB\-\-signature\-file, \-F\fR

 Location of file to be appended to each scanned message. Overrides \-S.

 .TP

 \fB\-\-max\-children=n, \-m n\fR

@@ -237,9 +237,9 @@ unless your system is under great load.

 Note, however, that the default build is for SESSION to be disabled.

 .TP

 \fB\-\-dont\-wait\fR

-Tells clamav\-milter what do to if the max-children number is exceeded.

+Tells clamav\-milter what do to if the max\-children number is exceeded.

 Usually clamav\-milter waits until a child dies or the timeout value has been

-exceeded, which ever comes first, however with dont-wait enabled, clamav\-milter

+exceeded, which ever comes first, however with dont\-wait enabled, clamav\-milter

 will inform the remote SMTP client to retry later.

 .TP

 \fB\-\-dont\-sanitise\fR

@@ -259,8 +259,8 @@ Occurrences of %h are replaced with the message's headers.

 The %v string can be escaped thus, \\%v, to send the string %v.

 The % character can be escaped thus, %%, to send the % character.

 Any occurrence of strings in dollar signs are replaced with the appropriate

-sendmail-variable, e.g. ${if_addr}$.

-If the \-t option is not given, clamav\-milter defaults to a hard-coded message.

+sendmail\-variable, e.g. ${if_addr}$.

+If the \-t option is not given, clamav\-milter defaults to a hard\-coded message.

 Note that to send warning messages, clamav\-milter must be able to execute

 sendmail.

 .TP

@@ -268,7 +268,7 @@ sendmail.

 File points to a file whose contents are added to the headers of the

 warning message given to the \fB\-\-template\-file\fR option.

 For example, to state the character set of the message,

-put "Content-Type: text/plain; charset=koi8-r" into the file.

+put "Content\-Type: text/plain; charset=koi8\-r" into the file.

 .TP

 \fB\-\-timeout=n \-T n\fR

 Used in conjunction with max\-children. If clamav\-milter waits for more than

@@ -276,15 +276,15 @@ Used in conjunction with max\-children. If clamav\-milter waits for more than

 will turn off the timeout and clamav\-milter will wait indefinitely for the

 scanning to quit. In practice the timeout set by sendmail will then take over.

 .TP

-\fB\-\-detect-forged-local-address \-L\fR

+\fB\-\-detect\-forged\-local\-address \-L\fR

 When neither \-\-force, \-\-local nor \-\-outgoing is given,

 this option intercepts incoming mails that incorrectly claim to be from the

 local domain.

 .TP

-\fB\-\-whitelist-file=FILE, \-W file\fR

-This option specifies a file which contains a list of e-mail addresses.

-E-mails sent to or from these addresses will NOT be checked.

-While this is not an Anti-Virus function, it is quite useful for some systems.

+\fB\-\-whitelist\-file=FILE, \-W file\fR

+This option specifies a file which contains a list of e\-mail addresses.

+E\-mails sent to or from these addresses will NOT be checked.

+While this is not an Anti\-Virus function, it is quite useful for some systems.

 The address given to the \-\-quarantine directive is always whitelisted.

 .IP

 The file consists of a list of addresses, each address on a line enclosed

@@ -294,14 +294,14 @@ indicating if it is the sender or recipient that is to be whitelisted. If the

 field is missing, the default is \fITo\fR.

 Lines starting with #, : or ! are ignored.

 .TP

-\fB\-\-sendmail-cf=FILE\fR

+\fB\-\-sendmail\-cf=FILE\fR

 When starting, clamav\-milter runs some sanity checks against the sendmail.cf

 file, usually in /etc/sendmail.cf or /etc/mail/sendmail.cf. This directive

 tells clamav\-milter where to find the sendmail.cf file.

 .TP

-\fB\-\-black-hole-mode\fR

+\fB\-\-black\-hole\-mode\fR

 Since \fIsendmail\fR calls its milters before it looks in its alias and virtuser

-tables, clamav-milter can spend time looking for malware that's going to be

+tables, clamav\-milter can spend time looking for malware that's going to be

 thrown away even if the message is clean.

 .IP

 Enabling this stops these messages from being scanned

@@ -309,14 +309,14 @@ Enabling this stops these messages from being scanned

 these messages so the message doesn't go further down the milter call chain).

 Only enable this if your site has many addresses aliased to /dev/null.

 .IP

-To enable this mode clamav-milter must have certain sendmail rights:

+To enable this mode clamav\-milter must have certain sendmail rights:

 it needs to run as a TrustedUser as defined by \fIsendmail\fR

 (see http://www.sendmail.org/m4/tweaking_config.html)

 by the use of the User directive in clamd.conf,

 the clamav user must be able read the mail queue (often /var/spool/mqueue),

 and AllowSupplementaryGroups must be enabled in clamd.conf.

 Some operating systems set \fI/var/spool/mqueue\fR to be mode 700 forcing you to

-run clamav-milter as root for black-hole-mode.

+run clamav\-milter as root for black\-hole\-mode.

 This is always unadvisable, it is better to have \fI/var/spool/mqueue\fR as

 mode 750.

 .SH "BUGS"