3708f991 |
.\" Manual page created by Magnus Ekdahl and Thomas Lamy |
511eef51 |
.TH "freshclam.conf" "5" "September 27, 2004" "Thomas Lamy" "Clam AntiVirus" |
3708f991 |
.SH "NAME"
.LP
\fBfreshclam.conf\fR \- Configuration file for Clam AntiVirus Database Updater
.SH "DESCRIPTION"
.LP
The file freshclam.conf configures the Clam AntiVirus Database Updater, freshclam(1).
.SH "FILE FORMAT" |
511eef51 |
The file consists of comments and options with arguments. Each line that starts with a hash (\fB#\fR) symbol is a comment. Options and arguments are case sensitive and of the form \fBOption Argument\fR. The (possibly optional) arguments are of the following types: |
3708f991 |
.TP
\fBSTRING\fR
String without blank characters.
.TP
\fBSIZE\fR |
511eef51 |
Size in bytes. You can use 'M' or 'm' modifiers for megabytes and 'K' or 'k' for kilobytes. |
3708f991 |
.TP
\fBNUMBER\fR
Unsigned integer.
.SH "DIRECTIVES"
.LP
When an option is not used (hashed or doesn't exist in the configuration file) freshclam takes a default action.
.TP
\fBExample\fR |
511eef51 |
If this option is set freshclam will not run. |
3708f991 |
.TP
\fBDatabaseOwner STRING\fR |
511eef51 |
When started by root, drop privileges to a specified user. .br
Default: @CLAMAVUSER@ |
3708f991 |
.TP |
a3bc3260 |
\fBAllowSupplementaryGroups\fR
Initialize supplementary group access (freshclam must be started by root).
.br
Default: disabled
.TP |
3708f991 |
\fBDatabaseDirectory STRING\fR
Path to a directory containing database files.
.br |
511eef51 |
Default: @DBDIR@ |
3708f991 |
.TP
\fBChecks NUM\fR |
511eef51 |
Number of database checks per day.
.br
Default: 12 |
3708f991 |
.TP
\fBUpdateLogFile STRING\fR
Enable logging to a specified file. Highly recommended.
.br
Default: disabled.
.TP
\fBLogSyslog\fR
Enable logging to Syslog. May be used in combination with UpdateLogFile
.br
Default: disabled.
.TP |
511eef51 |
\fBLogFacility\fR
Specify the type of syslog messages \- please refer to 'man syslog' for facility names.
.br
Default: LOG_LOCAL6
.TP |
3708f991 |
\fBLogVerbose\fR
Enable verbose logging. |
511eef51 |
.br
Default: disabled
.TP
\fBDNSDatabaseInfo STRING\fR |
e1b40b1b |
This directive enables database and software version verification through DNS TXT records. |
511eef51 |
.br |
e1b40b1b |
Default: enabled, pointing to current.cvd.clamav.net |
3708f991 |
.TP
\fBDatabaseMirror STRING\fR |
511eef51 |
Server name where database updates are downloaded from. database.clamav.net is a round\-robin record which points ClamAV users to most reliable mirrors. If this option is given multiple times, freshclam(1) tries them in the order given if one download fails. |
3708f991 |
.br |
511eef51 |
Default: There is no default, which results in an error when running freshclam(1). |
3708f991 |
.TP
\fBMaxAttempts NUM\fR
Freshclam(1) tries every mirror this number of times before switching to the next mirror.
.br . |
511eef51 |
Default: 3 (per mirror) |
3708f991 |
.TP
\fBHTTPProxyServer STR\fR, \fBHTTPProxyPort NUM\fR
Use given proxy server and TCP port for database downloads.
.TP
\fBHTTPProxyUsername STR\fR,\fBHTTPProxyPassword STR\fR
Proxy usage is authenticated through given username and password.
.br .
Default: no proxy authentication
.TP
\fBNotifyClamd \[STRING\]\fR
Notify a running clamd(8) to reload it\'s database after a download has occured. Optionally a clamd.conf(5) file location may be given to tell freshclam(1) how to communicate with clamd(8).
.br . |
511eef51 |
Default: The default is to not notify clamd. See clamd.conf(5)\'s option SelfCheck for how clamd(8) handles database updates in this case. |
3708f991 |
.TP
\fBOnUpdateExecute STRING\fR
Execute this command after the database has been successfully updated. |
511eef51 |
.br
Default: disabled |
3708f991 |
.TP
\fBOnErrorExecute\fR
Execute this command after a database update has failed. |
511eef51 |
.br
Default: disabled |
3708f991 |
.SH "NOTE"
While not reasonable, any configuration option from clamd.conf(5) may be given.
.SH "FILES"
.LP
@CFGDIR@/freshclam.conf
.SH "AUTHOR"
.LP
Thomas Lamy <thomas.lamy@netwake.de>
.SH "SEE ALSO"
.LP
freshclam(1), clamd.conf(5), clamd(8), clamscan(1)
|