~ubuntu-branches/ubuntu/saucy/clamav/saucy-backports

« back to all changes in this revision

Viewing changes to docs/man/clamd.conf.5.in

  • Committer: Package Import Robot
  • Author(s): Scott Kitterman
  • Date: 2014-07-15 01:08:10 UTC
  • mfrom: (0.35.47 sid)
  • Revision ID: package-import@ubuntu.com-20140715010810-ru66ek4fun2iseba
Tags: 0.98.4+dfsg-2~ubuntu13.10.1
No-change backport to saucy (LP: #1341962)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "clamd.conf" "5" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
 
1
.TH "clamd.conf" "5" "December 4, 2013" "ClamAV @VERSION@" "Clam AntiVirus"
2
2
.SH "NAME"
3
3
.LP 
4
4
\fBclamd.conf\fR \- Configuration file for Clam AntiVirus Daemon
15
15
String without blank characters.
16
16
.TP 
17
17
\fBSIZE\fR
18
 
Size in bytes. You can use 'M' or 'm' modifiers for megabytes and 'K' or 'k' for kilobytes.
 
18
Size in bytes. You can use 'M' or 'm' modifiers for megabytes and 'K' or 'k' for kilobytes. To specify the size in bytes just don't use modifiers.
19
19
.TP 
20
20
\fBNUMBER\fR
21
21
Unsigned integer.
27
27
If this option is set clamd will not run.
28
28
.TP 
29
29
\fBLogFile STRING\fR
30
 
Enable logging to selected file.
 
30
Save all reports to a log file.
31
31
.br 
32
 
Default: no
 
32
Default: disabled
33
33
.TP 
34
34
\fBLogFileUnlock BOOL\fR
35
 
Disable a system lock that protects against running clamd with the same configuration file multiple times.
 
35
By default the log file is locked for writing and only a single daemon process can write to it. This option disables the lock.
36
36
.br 
37
37
Default: no
38
38
.TP 
39
39
\fBLogFileMaxSize SIZE\fR
40
 
Limit the size of the log file. The logger will be automatically disabled if the file is greater than SIZE. Value of 0 disables the limit.
 
40
Maximum size of the log file.
 
41
.br
 
42
Value of 0 disables the limit.
41
43
.br 
42
 
Default: 1M
 
44
Default: 1048576
43
45
.TP 
44
46
\fBLogTime BOOL\fR
45
47
Log time for each message.
47
49
Default: no
48
50
.TP 
49
51
\fBLogClean BOOL\fR
50
 
Log clean files.
 
52
Log all clean files.
 
53
.br
 
54
Useful in debugging but drastically increases the log size.
51
55
.br 
52
56
Default: no
53
57
.TP 
54
58
\fBLogSyslog BOOL\fR
55
 
Use system logger (can work together with LogFile).
 
59
Use the system logger (can work together with LogFile).
56
60
.br 
57
61
Default: no
58
62
.TP 
59
63
\fBLogFacility STRING\fR
60
 
Specify the type of syslog messages \- please refer to 'man syslog' for facility names.
 
64
Type of syslog messages
 
65
.br
 
66
Please refer to 'man syslog' for facility names.
61
67
.br 
62
68
Default: LOG_LOCAL6
63
69
.TP 
65
71
Enable verbose logging.
66
72
.br 
67
73
Default: no
 
74
.TP
 
75
\fBLogRotate BOOL\fR
 
76
Rotate log file. Requires LogFileMaxSize option set prior to this option.
 
77
.br
 
78
Default: no
68
79
.TP 
69
80
\fBExtendedDetectionInfo BOOL\fR
70
81
Log additional information about the infected file, such as its size and hash, together with the virus name.
74
85
\fBPidFile STRING\fR
75
86
Save the process identifier of a listening daemon (main thread) to a specified file.
76
87
.br 
77
 
Default: no
 
88
Default: disabled
78
89
.TP 
79
90
\fBTemporaryDirectory STRING\fR
80
 
Optional path to the global temporary directory.
 
91
This option allows you to change the default temporary directory.
81
92
.br 
82
93
Default: system specific (usually /tmp or /var/tmp).
83
94
.TP 
84
95
\fBDatabaseDirectory STRING\fR
85
 
Path to a directory containing database files.
 
96
This option allows you to change the default database directory. If you enable it, please make sure it points to the same directory in both clamd and freshclam.
 
97
.br
 
98
Default: defined at configuration (/usr/local/share/clamav)
86
99
.TP 
87
100
\fBOfficialDatabaseOnly BOOL\fR
88
101
Only load the official signatures published by the ClamAV project.
92
105
\fBLocalSocket STRING\fR
93
106
Path to a local (Unix) socket the daemon will listen on.
94
107
.br 
95
 
Default: no
 
108
Default: disabled
96
109
.TP
97
110
\fBLocalSocketGroup STRING\fR
98
111
Sets the group ownership on the unix socket.
112
125
\fBTCPSocket NUMBER\fR
113
126
TCP port number the daemon will listen on.
114
127
.br 
115
 
Default: no
 
128
Default: disabled
116
129
.TP 
117
130
\fBTCPAddr STRING\fR
118
 
TCP socket address to bind to. By default clamd binds to INADDR_ANY.
 
131
By default clamd binds to INADDR_ANY.
 
132
.br
 
133
This option allows you to restrict the TCP address and provide some degree of protection from the outside world. This option can be specified multiple times in order to listen on multiple IPs. IPv6 is now supported.
119
134
.br 
120
 
Default: no
 
135
Default: disabled
121
136
.TP 
122
137
\fBMaxConnectionQueueLength NUMBER\fR
123
138
Maximum length the queue of pending connections may grow to.
124
139
.br 
125
140
Default: 200
 
141
.TP
 
142
\fBStreamMaxLength SIZE\fR
 
143
Close the STREAM session when the data size limit is exceeded.
 
144
.br
 
145
The value should match your MTA's limit for the maximum attachment size.
 
146
.br
 
147
Default: 25M
 
148
.TP
 
149
\fBStreamMinPort NUMBER\fR
 
150
The STREAM command uses an FTP-like protocol.
 
151
.br
 
152
This option sets the lower boundary for the port range.
 
153
.br
 
154
Default: 1024
 
155
.TP
 
156
\fBStreamMaxPort NUMBER\fR
 
157
This option sets the upper boundary for the port range.
 
158
.br
 
159
Default: 2048
126
160
.TP 
127
161
\fBMaxThreads NUMBER\fR
128
162
Maximum number of threads running at the same time.
130
164
Default: 10
131
165
.TP 
132
166
\fBReadTimeout NUMBER\fR
133
 
Waiting for data from a client socket will timeout after this time (seconds).
 
167
This option specifies the time (in seconds) after which clamd should
 
168
timeout if a client doesn't provide any data.
134
169
.br 
135
170
Default: 120
136
171
.TP
161
196
Default: 100
162
197
.TP 
163
198
\fBIdleTimeout NUMBER\fR
164
 
Waiting for a new job will timeout after this time (seconds).
 
199
This option specifies how long (in seconds) the process should wait
 
200
for a new job.
165
201
.br 
166
202
Default: 30
167
203
.TP
168
204
\fBExcludePath REGEX\fR
169
205
Don't scan files and directories matching REGEX. This directive can be used multiple times.
170
206
.br
171
 
Default: scan all
 
207
Default: disabled
172
208
.TP 
173
209
\fBMaxDirectoryRecursion NUMBER\fR
174
210
Maximum depth directories are scanned at.
191
227
Default: no
192
228
.TP 
193
229
\fBSelfCheck NUMBER\fR
194
 
Perform a database check.
 
230
This option specifies the time intervals (in seconds) in which clamd
 
231
should perform a database check.
195
232
.br 
196
 
Default: 1800
 
233
Default: 600
197
234
.TP 
198
235
\fBVirusEvent COMMAND\fR
199
 
Execute COMMAND when a virus is found. In the command string %v will be replaced with the virus name.
 
236
Execute a command when a virus is found. In the command string %v will be
 
237
replaced with the virus name. Additionally, two environment variables will
 
238
be defined: $CLAM_VIRUSEVENT_FILENAME and $CLAM_VIRUSEVENT_VIRUSNAME.
200
239
\fR
201
240
.br 
202
 
Default: no
 
241
Default: disabled
203
242
.TP 
204
243
\fBExitOnOOM BOOL\fR
205
244
Stop daemon when libclamav reports out of memory condition.
206
245
.br 
207
246
Default: no
208
247
.TP 
209
 
\fBUser STRING\fR
210
 
Run as another user (clamd must be started by root to make this option working).
211
 
.br 
212
 
Default: no
213
 
.TP 
214
 
\fBAllowSupplementaryGroups BOOL\fR
215
 
Initialize supplementary group access (clamd must be started by root).
216
 
.br 
217
 
Default: no
 
248
\fBAllowAllMatchScan BOOL\fR
 
249
Permit use of the ALLMATCHSCAN command.
 
250
.br
 
251
Default: yes
218
252
.TP 
219
253
\fBForeground BOOL\fR
220
254
Don't fork into background.
223
257
.TP 
224
258
\fBDebug BOOL\fR
225
259
Enable debug messages from libclamav.
 
260
.br
 
261
Default: no
226
262
.TP 
227
263
\fBLeaveTemporaryFiles BOOL\fR
228
 
Do not remove temporary files (for debug purpose).
229
 
.br 
230
 
Default: no
231
 
.TP 
232
 
\fBStreamMaxLength SIZE\fR
233
 
Clamd uses FTP\-like protocol to receive data from remote clients. If you are using clamav\-milter to balance load between remote clamd daemons on firewall servers you may need to tune the Stream* options. This option allows you to specify the upper limit for data size that will be transfered to remote daemon when scanning a single file. It should match your MTA's limit for a maximum attachment size.
234
 
.br 
235
 
Default: 10M
236
 
.TP 
237
 
\fBStreamMinPort NUMBER\fR
238
 
Limit data port range.
239
 
.br 
240
 
Default: 1024
241
 
.TP 
242
 
\fBStreamMaxPort NUMBER\fR
243
 
Limit data port range.
244
 
.br 
245
 
Default: 2048
246
 
.TP 
 
264
Do not remove temporary files (for debugging purpose).
 
265
.br 
 
266
Default: no
 
267
.TP
 
268
\fBUser STRING\fR
 
269
Run the daemon as a specified user (the process must be started by root).
 
270
.br
 
271
Default: disabled
 
272
.TP
 
273
\fBAllowSupplementaryGroups BOOL\fR
 
274
Initialize a supplementary group access (the process must be started by root).
 
275
.br
 
276
Default: no
 
277
.TP
247
278
\fBBytecode BOOL\fR
248
279
With this option enabled ClamAV will load bytecode from the database. It is highly recommended you keep this option turned on, otherwise you may miss detections for many new viruses.
249
280
.br
250
281
Default: yes
251
282
.TP 
252
283
\fBBytecodeSecurity STRING\fR
253
 
Set bytecode security level. Possible values: \fBTrustSigned\fR: trust bytecode loaded from signed .c[lv]d files and insert runtime safety checks for bytecode loaded from other sources, \fBParanoid\fR: don't trust any bytecode, insert runtime checks for all. The recommended setting is \fBTrustSigned\fR, because bytecode in .cvd files already has safety checks inserted into it.
 
284
Set bytecode security level. 
 
285
.RS
 
286
.PD 0
 
287
.HP 4
 
288
Possible values:
 
289
.br
 
290
\fBTrustSigned\fR \- trust bytecode loaded from signed .c[lv]d files and insert runtime safety checks for bytecode loaded from other sources, 
 
291
.br
 
292
\fBParanoid\fR \- don't trust any bytecode, insert runtime checks for all. 
 
293
.RE
 
294
.RS
 
295
Recommended: \fBTrustSigned\fR, because bytecode in .cvd files already has these checks.
254
296
.br 
255
297
Default: TrustSigned
256
 
.TP 
257
 
\fBBytecodeUnsigned BOOL\fR
258
 
Allow loading bytecode from outside digitally signed .c[lv]d files.
259
 
.br
260
 
Default: no
 
298
.PD 1
 
299
.RE
261
300
.TP 
262
301
\fBBytecodeTimeout NUMBER\fR
263
302
Set bytecode timeout in milliseconds.
264
303
.br
265
304
Default: 5000
266
305
.TP 
 
306
\fBBytecodeUnsigned BOOL\fR
 
307
Allow loading bytecode from outside digitally signed .c[lv]d files.
 
308
.br
 
309
Default: no
 
310
.TP
 
311
\fBBytecodeMode STRING\fR
 
312
Set bytecode execution mode.
 
313
.RS
 
314
.PD 0
 
315
.HP 4
 
316
Possible values:
 
317
.br
 
318
\fBAuto\fR \- automatically choose JIT if possible, fallback to interpreter
 
319
.br
 
320
\fBForceJIT\fR \- always choose JIT, fail if not possible
 
321
.br
 
322
\fBForceIntepreter\fR \- always choose interpreter
 
323
.br
 
324
\fBTest\fR \- run with both JIT and interpreter and compare results. Make all failures fatal.
 
325
.RE
 
326
.RS
 
327
Default: Auto
 
328
.PD 1
 
329
.RE
 
330
.TP 
267
331
\fBDetectPUA BOOL\fR
268
332
Detect Possibly Unwanted Applications.
269
333
.br 
272
336
\fBExcludePUA CATEGORY\fR
273
337
Exclude a specific PUA category. This directive can be used multiple times. See http://www.clamav.net/support/pua for the complete list of PUA categories.
274
338
.br
275
 
Default: Load all categories (if DetectPUA is activated)
 
339
Default: disabled
276
340
.TP
277
341
\fBIncludePUA CATEGORY\fR
278
342
Only include a specific PUA category. This directive can be used multiple times. See http://www.clamav.net/support/pua for the complete list of PUA categories.
279
343
.br
280
 
Default: Load all categories (if DetectPUA is activated)
 
344
Default: disabled
281
345
.TP 
282
346
\fBAlgorithmicDetection BOOL\fR
283
347
In some cases (eg. complex malware, exploits in graphic files, and others), ClamAV uses special algorithms to provide accurate detection. This option controls the algorithmic detection.
285
349
Default: yes
286
350
.TP 
287
351
\fBScanPE BOOL\fR
288
 
PE stands for Portable Executable \- it's an executable file format used in all 32 and 64\-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.
 
352
PE stands for Portable Executable \- it's an executable file format used in all 32 and 64\-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.  
 
353
.br
 
354
If you turn off this option, the original files will still be scanned, but without additional processing.
289
355
.br 
290
356
Default: yes
291
357
.TP 
292
358
\fBScanELF BOOL\fR
293
 
Executable and Linking Format is a standard format for UN*X executables. This option allows you to control the scanning of ELF files.
 
359
Executable and Linking Format is a standard format for UN*X executables. This option allows you to control the scanning of ELF files. 
 
360
.br
 
361
If you turn off this option, the original files will still be scanned, but without additional processing.
294
362
.br 
295
363
Default: yes
296
364
.TP 
299
367
.br 
300
368
Default: no
301
369
.TP 
302
 
\fBScanOLE2 BOOL\fR
303
 
This option enables scanning of OLE2 files, such as Microsoft Office documents and .msi files.
304
 
.br 
305
 
Default: yes
306
 
.TP 
307
 
\fBOLE2BlockMacros BOOL\fR
308
 
With this option enabled OLE2 files with VBA macros, which were not detected by signatures will be marked as "Heuristics.OLE2.ContainsMacros".
309
 
.br 
310
 
Default: no
311
 
.TP 
312
 
\fBScanPDF BOOL\fR
313
 
This option enables scanning within PDF files.
314
 
.br 
315
 
Default: yes
316
 
.TP 
317
 
\fBScanHTML BOOL\fR
318
 
Enables HTML detection and normalisation.
319
 
.br 
320
 
Default: yes
321
 
.TP 
322
370
\fBScanMail BOOL\fR
323
 
Enable scanning of mail files.
 
371
Enable scanning of mail files. 
 
372
.br
 
373
If you turn off this option, the original files will still be scanned, but without parsing individual messages/attachments.
324
374
.br 
325
375
Default: yes
326
376
.TP
329
379
.br
330
380
Default: no
331
381
.TP
332
 
\fBMailMaxRecursion NUMBER (OBSOLETE)\fR
 
382
\fBMailMaxRecursion (OBSOLETE)\fR
333
383
\fBWARNING:\fR This option is no longer accepted. See \fBMaxRecursion\fR.
334
384
.TP 
335
385
\fBPhishingSignatures BOOL\fR
342
392
.br
343
393
Default: yes
344
394
.TP
 
395
\fBPhishingAlwaysBlockCloak BOOL\fR
 
396
Always block cloaked URLs, even if URL isn't in database. This can lead to false positives.
 
397
.br
 
398
Default: no
 
399
.TP
345
400
\fBPhishingAlwaysBlockSSLMismatch BOOL\fR
346
401
Always block SSL mismatches in URLs, even if the URL isn't in the database. This can lead to false positives.
347
402
.br
348
403
Default: no
349
404
.TP
350
 
\fBPhishingAlwaysBlockCloak BOOL\fR
351
 
Always block cloaked URLs, even if URL isn't in database. This can lead to false positives.
 
405
\fBPartitionIntersection BOOL\fR
 
406
Detect partition intersections in raw disk images using heuristics.
352
407
.br
353
408
Default: no
354
409
.TP
382
437
.br 
383
438
Default: No
384
439
.TP
 
440
\fBScanHTML BOOL\fR
 
441
Perform HTML/JavaScript/ScriptEncoder normalisation and decryption.
 
442
.br
 
443
If you turn off this option, the original files will still be scanned, but without additional processing.
 
444
.br
 
445
Default: yes
 
446
.TP
 
447
\fBScanOLE2 BOOL\fR
 
448
This option enables scanning of OLE2 files, such as Microsoft Office documents and .msi files. 
 
449
.br
 
450
If you turn off this option, the original files will still be scanned, but without additional processing.
 
451
.br 
 
452
Default: yes
 
453
.TP 
 
454
\fBOLE2BlockMacros BOOL\fR
 
455
With this option enabled OLE2 files with VBA macros, which were not detected by signatures will be marked as "Heuristics.OLE2.ContainsMacros".
 
456
.br 
 
457
Default: no
 
458
.TP 
 
459
\fBScanPDF BOOL\fR
 
460
This option enables scanning within PDF files.
 
461
.br
 
462
If you turn off this option, the original files will still be scanned, but without additional processing.
 
463
.br 
 
464
Default: yes
 
465
.TP 
 
466
\fBScanSWF BOOL\fR
 
467
This option enables scanning within SWF files.
 
468
.br
 
469
If you turn off this option, the original files will still be scanned, but without decoding and additional processing.
 
470
.br 
 
471
Default: yes
 
472
.TP
385
473
\fBScanArchive BOOL\fR
386
 
Enable archive scanning.
 
474
Scan within archives and compressed files.
 
475
.br
 
476
If you turn off this option, the original files will still be scanned, but without unpacking and additional processing.
387
477
.br 
388
478
Default: yes
 
479
.TP
 
480
\fBArchiveBlockEncrypted BOOL\fR
 
481
Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR).
 
482
.br
 
483
Default: no
 
484
.TP
 
485
\fBForceToDisk\fR
 
486
This option causes memory or nested map scans to dump the content to disk.
 
487
.br
 
488
If you turn on this option, more data is written to disk and is available when the leave-temps option is enabled at the cost of more disk writes.
 
489
.br
 
490
Default: no
389
491
.TP 
390
492
\fBArchiveMaxFileSize (OBSOLETE)\fR
391
493
\fBWARNING:\fR This option is no longer accepted. See \fBMaxFileSize\fR and \fBMaxScanSize\fR.
407
509
.br 
408
510
Default: no
409
511
.TP 
410
 
\fBArchiveBlockEncrypted BOOL\fR
411
 
Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR).
412
 
.br 
413
 
Default: no
414
 
.TP 
415
512
\fBMaxScanSize SIZE\fR
416
 
Sets the maximum amount of data to be scanned for each input file. Archives and other containers are recursively extracted and scanned up to this value. \fBWarning: disabling this limit or setting it too high may result in severe damage to the system.\fR
 
513
Sets the maximum amount of data to be scanned for each input file. Archives and other containers are recursively extracted and scanned up to this value. The size of an archive plus the sum of the sizes of all files within archive count toward the scan size. For example, a 1M uncompressed archive containing a single 1M inner file counts as 2M toward the max scan size. \fBWarning: disabling this limit or setting it too high may result in severe damage to the system.\fR
417
514
.br 
418
515
Default: 100M
419
516
.TP 
431
528
Number of files to be scanned within an archive, a document, or any other kind of container. \fBWarning: disabling this limit or setting it too high may result in severe damage to the system.\fR
432
529
.br 
433
530
Default: 10000
434
 
.TP 
435
 
\fBClamukoScanOnAccess BOOL\fR
436
 
Enable Clamuko. Dazuko (/dev/dazuko) must be configured and running.
437
 
.br 
438
 
Default: no
439
 
.TP 
440
 
\fBClamukoScannerCount NUMBER\fR
441
 
The number of scanner threads that will be started (DazukoFS only). Having multiple scanner threads allows Clamuko to serve multiple processes simultaneously. This is particularly beneficial on SMP machines.
442
 
.br 
443
 
Default: 3
444
 
.TP 
445
 
\fBClamukoScanOnOpen BOOL\fR
446
 
Scan files on open.
447
 
.br 
448
 
Default: no
449
 
.TP 
450
 
\fBClamukoScanOnClose BOOL\fR
451
 
Scan files on close.
452
 
.br 
453
 
Default: no.
454
 
.TP 
455
 
\fBClamukoScanOnExec BOOL\fR
456
 
Scan files on execute.
457
 
.br 
458
 
Default: no
459
 
.TP 
460
 
\fBClamukoIncludePath STRING\fR
461
 
Set the include paths (all files and directories inside them will be scanned). You can have multiple ClamukoIncludePath directives but each directory must be added in a separate line).
462
 
.br 
463
 
Default: no
464
 
.TP 
465
 
\fBClamukoExcludePath STRING\fR
466
 
Set the exclude paths. All subdirectories will also be excluded.
467
 
.br 
468
 
Default: no
469
 
\fBClamukoExcludeUID NUMBER\fR
470
 
With this option you can whitelist specific UIDs. Processes with these UIDs will be able to access all files. This option can be used multiple times (one per line).
471
 
.br 
472
 
Default: no
473
 
.TP 
474
 
\fBClamukoMaxFileSize SIZE\fR
475
 
Ignore files larger than SIZE.
476
 
.br 
477
 
Default: 5M
 
531
.TP
 
532
\fBMaxEmbeddedPE SIZE\fR
 
533
This option sets the maximum size of a file to check for embedded PE.
 
534
.br
 
535
Files larger than this value will skip the additional analysis step.
 
536
.br
 
537
Negative values are not allowed.
 
538
.br
 
539
Default: 10M
 
540
.TP
 
541
\fBMaxHTMLNormalize SIZE\fR
 
542
This option sets the maximum size of a HTML file to normalize.
 
543
.br
 
544
HTML files larger than this value will not be normalized or scanned.
 
545
.br
 
546
Negative values are not allowed.
 
547
.br
 
548
Default: 10M
 
549
.TP
 
550
\fBMaxHTMLNoTags SIZE\fR
 
551
This option sets the maximum size of a normalized HTML file to scan.
 
552
.br
 
553
HTML files larger than this value after normalization will not be scanned.
 
554
.br
 
555
Negative values are not allowed.
 
556
.br
 
557
Default: 2M
 
558
.TP
 
559
\fBMaxScriptNormalize SIZE\fR
 
560
This option sets the maximum size of a script file to normalize.
 
561
.br
 
562
Script content larger than this value will not be normalized or scanned.
 
563
.br
 
564
Negative values are not allowed.
 
565
.br
 
566
Default: 5M
 
567
.TP
 
568
\fBMaxZipTypeRcg SIZE\fR
 
569
This option sets the maximum size of a ZIP file to reanalyze type recognition.
 
570
.br
 
571
ZIP files larger than this value will skip the step to potentially reanalyze as PE.
 
572
.br
 
573
Negative values are not allowed.
 
574
.br
 
575
WARNING: setting this limit too high may result in severe damage or impact performance.
 
576
.br
 
577
Default: 1M
 
578
.TP 
 
579
\fBMaxPartitions SIZE\fR
 
580
This option sets the maximum number of partitions of a raw disk image to be scanned.
 
581
.br
 
582
Raw disk images with more partitions than this value will have up to the value partitions scanned.
 
583
.br
 
584
Negative values are not allowed.
 
585
.br
 
586
WARNING: setting this limit too high may result in severe damage or impact performance.
 
587
.br
 
588
Default: 50
 
589
.TP 
 
590
\fBMaxIconsPE SIZE\fR
 
591
This option sets the maximum number of icons within a PE to be scanned.
 
592
.br
 
593
PE files with more icons than this value will have up to the value number icons scanned.
 
594
.br
 
595
Negative values are not allowed.
 
596
.br
 
597
WARNING: setting this limit too high may result in severe damage or impact performance.
 
598
.br
 
599
Default: 100
 
600
.TP
 
601
\fBClamukoScanOnAccess (OBSOLETE)\fR
 
602
\fBWARNING:\fR This option is no longer accepted. See \fBScanOnAccess\fR.
 
603
.TP 
 
604
\fBClamukoScannerCount (OBSOLETE)\fR
 
605
\fBWARNING:\fR This option is no longer accepted.
 
606
.TP 
 
607
\fBClamukoScanOnOpen (OBSOLETE)\fR
 
608
\fBWARNING:\fR This option is no longer accepted.
 
609
.TP 
 
610
\fBClamukoScanOnClose (OBSOLETE)\fR
 
611
\fBWARNING:\fR This option is no longer accepted.
 
612
.TP 
 
613
\fBClamukoScanOnExec (OBSOLETE)\fR
 
614
\fBWARNING:\fR This option is no longer accepted.
 
615
.TP 
 
616
\fBClamukoIncludePath (OBSOLETE)\fR
 
617
\fBWARNING:\fR This option is no longer accepted. See \fBOnAccessIncludePath\fR.
 
618
.TP 
 
619
\fBClamukoExcludePath (OBSOLETE)\fR
 
620
\fBWARNING:\fR This option is no longer accepted. See \fBOnAccessExcludePath\fR.
 
621
.TP
 
622
\fBClamukoExcludeUID (OBSOLETE)\fR
 
623
\fBWARNING:\fR This option is no longer accepted. See \fBOnAccessExcludeUID\fR.
 
624
.TP 
 
625
\fBClamukoMaxFileSize (OBSOLETE)\fR
 
626
\fBWARNING:\fR This option is no longer accepted. See \fBOnAccessMaxFileSize\fR.
 
627
.TP
 
628
\fBScanOnAccess BOOL\fR
 
629
This option enables on-access scanning (Linux only)
 
630
.br
 
631
Default: disabled
 
632
.TP
 
633
\fBOnAccessIncludePath STRING\fR
 
634
This option specifies a directory (including all files and directories inside it), which should be scanned on access. This option can be used multiple times.
 
635
.br
 
636
Default: disabled
 
637
.TP
 
638
\fBOnAccessExcludePath STRING\fR
 
639
This option allows excluding directories from on-access scanning. It can be used multiple times.
 
640
.br
 
641
Default: disabled
 
642
.TP
 
643
\fBOnAccessExcludeUID NUMBER\fR
 
644
With this option you can whitelist specific UIDs. Processes with these UIDs will be able to access all files.
 
645
.br
 
646
This option can be used multiple times (one per line).
 
647
.br
 
648
Default: disabled
 
649
.TP
 
650
\fBOnAccessMaxFileSize SIZE\fR
 
651
Files larger than this value will not be scanned in on access.
 
652
.br
 
653
Default: 5M
 
654
.TP
 
655
\fBDisableCertCheck BOOL\fR
 
656
Disable authenticode certificate chain verification in PE files.
 
657
.br
 
658
Default: no
 
659
.TP
 
660
\fBStatsEnabled BOOL\fR
 
661
Enable submission of statistical data
 
662
.br
 
663
Default: no
 
664
.TP
 
665
\fBStatsHostID STRING\fR
 
666
HostID in the form of an UUID to use when submitting statistical information.
 
667
.br
 
668
Default: auto
 
669
.TP
 
670
\fBStatsPEDisabled BOOL\fR
 
671
Disable submission of PE section statistical data.
 
672
.br
 
673
Default: no
 
674
.TP
 
675
\fBStatsTimeout NUMBER\fR
 
676
Timeout in seconds to timeout communication with the stats server.
 
677
.br
 
678
Default: 10
478
679
.SH "NOTES"
479
680
.LP 
480
681
All options expressing a size are limited to max 4GB. Values in excess will be resetted to the maximum.
481
682
.SH "FILES"
482
683
.LP 
483
684
@CFGDIR@/clamd.conf
484
 
.SH "AUTHOR"
 
685
.SH "AUTHORS"
485
686
.LP 
486
 
Tomasz Kojm <tkojm@clamav.net>
 
687
Tomasz Kojm <tkojm@clamav.net>, Kevin Lin <klin@sourcefire.com>
487
688
.SH "SEE ALSO"
488
689
.LP 
489
690
clamd(8), clamdscan(1), clamav-milter(8), freshclam(1), freshclam.conf(5)