\fBclamd.conf\fR\-a configuration file for Clam AntiVirus Daemon
\fBclamd.conf\fR\-Configuration file for Clam AntiVirus Daemon
.SH"DESCRIPTION"
.LP
clamd.conf configures the Clam AntiVirus daemon, clamd(8).
.SH"FILE FORMAT"
The file consists of comments and options with arguments. Each line that starts with a hash (\fB#\fR) symbol is a comment. Options are are case sensitive and of the form \fBOption Argument\fR. The (possibly optional) arguments are are of the following types:
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 are of the following types:
.TP
\fBSTRING\fR
String without blank characters.
.TP
\fBSIZE\fR
Size in bytes. You can use a 'M' or 'm' modifiers for megabytes and a 'K' or 'k' for kilobytes.
Size in bytes. You can use 'M' or 'm' modifiers for megabytes and 'K' or 'k' for kilobytes.
.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.
When an option is not used (hashed or doesn't exist in the configuration file) clamd takes a default action.
.TP
\fBExample\fR
If this option is set clamd will not run.
@ -27,67 +27,72 @@ If this option is set clamd will not run.
\fBLogFile STRING\fR
Enable logging to selected file.
.br
Default: disabled.
Default: disabled
.TP
\fBLogFileUnlock\fR
Disable a system lock that protects against running clamd with a same configuration file multiple times.
.br
Default: disabled.
Default: disabled
.TP
\fBLogFileMaxSize SIZE\fR
Limit a size of a log file. The logger will be automatically disabled if the file is greater than SIZE. Value of 0 disables the limit.
Limit the size of a log file. The logger will be automatically disabled if the file is greater than SIZE. Value of 0 disables the limit.
.br
Default: 1M
.TP
\fBLogTime\fR
Log time with each message.
.br
Default: disabled.
Default: disabled
.TP
\fBLogClean\fR
Log clean files.
.br
Default: disabled.
Default: disabled
.TP
\fBLogSyslog\fR
Use system logger (can work together with LogFile).
.br
Default: disabled.
Default: disabled
.TP
\fBLogFacility\fR
Specify the type of syslog messages \- please refer to 'man syslog' for facility names.
.br
Default: LOG_LOCAL6
.TP
\fBLogVerbose\fR
Enable verbose logging.
.br
Default: disabled.
Default: disabled
.TP
\fBPidFile STRING\fR
Save a process identifier of a listening daemon (main thread) to a specified file.
Save the process identifier of a listening daemon (main thread) to a specified file.
.br
Default: disabled.
Default: disabled
.TP
\fBDatabaseDirectory STRING\fR
Path to a directory containing database files.
.br
Default: hardcoded directory.
Default: @DBDIR@
.TP
\fBLocalSocket STRING\fR
Path to a local (Unix) socket the daemon will listen on.
.br
Default: disabled.
Default: disabled
.TP
\fBFixStaleSocket\fR
Remove stale socket after unclean shutdown.
.br
Default: disabled.
Default: disabled
.TP
\fBTCPSocket NUMBER\fR
TCP port number the daemon will listen on.
.br
Default: disabled.
Default: disabled
.TP
\fBTCPAddr STRING\fR
TCP address to bind to. By default clamd binds to INADDR_ANY.
.br
Default: disabled.
Default: disabled
.TP
\fBMaxConnectionQueueLength NUMBER\fR
Maximum length the queue of pending connections may grow to.
@ -97,106 +102,101 @@ Default: 15
\fBMaxThreads NUMBER\fR
Maximal number of threads running at the same time.
.br
Default: 5.
Default: 10
.TP
\fBThreadTimeout NUMBER\fR
Stop thread\-scanner after specified time (in seconds). Value of 0 disables the timeout.
\fBReadTimeout NUMBER\fR
Waiting for data from a client socket will timeout after this time (seconds).
.br
Default: 180
Default: 120
.TP
\fBMaxDirectoryRecursion NUMBER\fR
Maximal depth a directories are scanned at.
Maximal depth directories are scanned at.
.br
Default: disabled.
Default: 15
.TP
\fBFollowDirectorySymlinks\fR
Follow a directory symlinks. You should have enabled directory recursion limit to avoid a potential problems.
Follow directory symlinks.
.br
Default: disabled.
Default: disabled
.TP
\fBFollowFileSymlinks\fR
Follow regular file symlinks.
.br
Default: disabled.
Default: disabled
.TP
\fBSelfCheck NUMBER\fR
Do internal checks every NUMBER seconds.
Do internal sanity checks every NUMBER seconds.
.br
Default: 3600
Default: 1800
.TP
\fBVirusEvent COMMAND\fR
Execute the COMMAND when virus is found. In the command string %v will be replaced by a virus name.
\fR
.br
Default: disabled.
Default: disabled
.TP
\fBUser STRING\fR
Drop priviledges to a selected user.
Run as selected user.
.br
Default: disabled.
Default: disabled
.TP
\fBAllowSupplementaryGroups\fR
When started by root and the User option is activated, it will initialize all the groups from /etc/group for which user is a member.
Initialize supplementary group access (clamd must be started by root).
.br
Default: disabled.
Default: disabled
.TP
\fBForeground\fR
Don't fork into background. Useful in debugging.
Don't fork into background.
.br
Default: disabled.
Default: disabled
.TP
\fBDebug\fR
Enable debug messages from libclamav. You need to enable the \fBForeground\fR option to see them.
.TP
\fBStreamSaveToDisk\fR
When activated the input stream (see STREAM command) will be saved to disk before scanning \- this allows scanning within archives.
.br
Default: disabled.
Enable debug messages from libclamav.
.TP
\fBStreamMaxLength SIZE\fR
Close the connection when this limit is exceeded.
.br
Default: disabled.
Default: 10M
.TP
\fBDisableDefaultScanOptions\fR
By default clamd uses scan options recommended by libclamav. This option disables recommended options and allows you to enable selected options. DO NOT ENABLE IT unless you know what you are doing.
.br
Default: disabled
.TP
\fBScanPE\fR
PE stands for Portable Executable \- it's an executable file format used in all 32\-bit versions of Windows operating systems. This option allows ClamAV to perform a deeper analysis of executable files and it's also required for decompression of popular executable packers such as UPX.
.br
Default: enabled.
Default: enabled
.TP
\fBDetectBrokenExecutables\fR
With this option clamav will try to detect broken executables and mark them as Broken.Executable.
With this option clamd will try to detect broken executables and mark them as Broken.Executable.
.br
Default: disabled.
Default: disabled
.TP
\fBScanOLE2\fR
Enables scanning of Microsoft Office document macros.
.br
Default: enabled.
Default: enabled
.TP
\fBScanHTML\fR
Enables HTML detection and normalisation.
.br
Default: enabled.
Default: enabled
.TP
\fBScanMail\fR
Enable scanning of mail files.
.br
Default: enabled.
Default: enabled
.TP
\fBMailFollowURLs\fR
If an email contains URLs ClamAV can download and scan them. \fBWARNING: This option may open your system to a DoS attack. Never use it on loaded servers.\fR
.br
Default: disabled.
Default: disabled
.TP
\fBScanArchive\fR
Enable archive scanning.
.br
Default: disabled.
.TP
\fBScanRAR\fR
The built\-in RAR unpacker is disabled by default because the code leaks.
.br
Default: disabled.
Default: enabled
.TP
\fBArchiveMaxFileSize SIZE\fR
Files in archives larger than this limit won't be scanned. Value of 0 disables the limit.
@ -214,9 +214,9 @@ Number of files to be scanned within archive. Value of 0 disables the limit.
Default: 1000
.TP
\fBArchiveMaxCompressionRatio NUMBER\fR
Analyze compression ratio and mark potential archive bombs as viruses (0 disables the limit).
Analyze compression ratio of every file in an archive and mark potential archive bombs as viruses (0 disables the limit).
.br
Default: 200
Default: 250
.TP
\fBArchiveLimitMemoryUsage\fR
Use slower decompression algorithm which uses less memory. This option affects bzip2 decompressor only.
@ -236,32 +236,32 @@ Default: disabled
\fBClamukoScanOnLine\fR
Enable Clamuko \- on\-access scanner for Linux. Dazuko must be already running.
.br
Default: disabled.
Default: disabled
.TP
\fBClamukoScanOnOpen\fR
Scan a file on open.
Scan files on open.
.br
Default: disabled.
Default: disabled
.TP
\fBClamukoScanOnClose\fR
Scan a file on close.
Scan files on close.
.br
Default: disabled.
.TP
\fBClamukoScanOnExec\fR
Scan a file on execute.
Scan files on execute.
.br
Default: disabled.
Default: disabled
.TP
\fBClamukoIncludePath STRING\fR
Set the include paths (all files and directories in them will be scanned). You can have multiple ClamukoIncludePath options but each directory must be added with a seperate option.
Set the include paths (all files and directories in them will be scanned). You can have multiple ClamukoIncludePath directives but each directory must be added in a seperate line).
.br
Default: disabled. Required.
Default: disabled
.TP
\fBClamukoExcludePath\fR
Set the exclude paths. All subdirectories are also excluded.
Set the exclude paths. All subdirectories will also be excluded.
.br
Default: disabled.
Default: disabled
.TP
\fBClamukoMaxFileSize SIZE\fR
Don't scan files larger than SIZE.
@ -271,7 +271,7 @@ Default: 5M
\fBClamukoScanArchive\fR
Enable archive scanning. It uses ArchiveMax* limits.
\fBfreshclam.conf\fR\- Configuration file for Clam AntiVirus Database Updater
@ -7,13 +7,13 @@
.LP
The file freshclam.conf configures the Clam AntiVirus Database Updater, freshclam(1).
.SH"FILE FORMAT"
The file consists of comments and options with arguments. Each line that starts with a hash (\fB#\fR) symbol is a comment. Options are are case sensitive and of the form \fBOption Argument\fR. The (possibly optional) arguments are are of the following types:
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:
.TP
\fBSTRING\fR
String without blank characters.
.TP
\fBSIZE\fR
Size in bytes. You can use a 'M' or 'm' modifiers for megabytes and a 'K' or 'k' for kilobytes.
Size in bytes. You can use 'M' or 'm' modifiers for megabytes and 'K' or 'k' for kilobytes.
.TP
\fBNUMBER\fR
Unsigned integer.
@ -22,18 +22,21 @@ Unsigned integer.
When an option is not used (hashed or doesn't exist in the configuration file) freshclam takes a default action.
.TP
\fBExample\fR
If this option is set clamd will not run.
If this option is set freshclam will not run.
.TP
\fBDatabaseOwner STRING\fR
When started by root, drop privileges to a specified user. Default is \"clamav\".
When started by root, drop privileges to a specified user. .br
Default: @CLAMAVUSER@
.TP
\fBDatabaseDirectory STRING\fR
Path to a directory containing database files.
.br
Default: hardcoded directory
Default: @DBDIR@
.TP
\fBChecks NUM\fR
Number of database checks per day. 12 is the recommended number.
Number of database checks per day.
.br
Default: 12
.TP
\fBUpdateLogFile STRING\fR
Enable logging to a specified file. Highly recommended.
@ -45,20 +48,30 @@ Enable logging to Syslog. May be used in combination with UpdateLogFile
.br
Default: disabled.
.TP
\fBLogFacility\fR
Specify the type of syslog messages \- please refer to 'man syslog' for facility names.
.br
Default: LOG_LOCAL6
.TP
\fBLogVerbose\fR
Enable verbose logging.
.br
Default: disabled
.TP
\fBDNSDatabaseInfo STRING\fR
This directive enables database and software version verification through DNS TXT records. We highly recommend enabling it. Please use the current.cvd.clamav.net record.
.br
Default: disabled
.TP
\fBDatabaseMirror STRING\fR
Server name where database updates are downloaded from. The default is database.clamav.net, which points to all official mirrors.
.br.
If this option is given multiple times, freshclam(1) tries them in the order given if one download fails.
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.
.br
There is no default, which results in an error when running freshclam(1).
Default: There is no default, which results in an error when running freshclam(1).
.TP
\fBMaxAttempts NUM\fR
Freshclam(1) tries every mirror this number of times before switching to the next mirror.
Use given proxy server and TCP port for database downloads.
@ -71,13 +84,17 @@ Default: no proxy authentication
\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.
The default is to not notify clamd. See clamd.conf(5)\'s option SelfCheck for how clamd(8) handles database updates in this case.
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.
.TP
\fBOnUpdateExecute STRING\fR
Execute this command after the database has been successfully updated.
.br
Default: disabled
.TP
\fBOnErrorExecute\fR
Execute this command after a database update has failed.
.br
Default: disabled
.SH"NOTE"
While not reasonable, any configuration option from clamd.conf(5) may be given.