... | ... |
@@ -1,4 +1,4 @@ |
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,7 +15,7 @@ Boolean value (yes/no or true/false or 1/0). |
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,19 +27,21 @@ When some option is not used (commented out or not included in the configuration |
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,17 +49,21 @@ Log time for each message. |
47 | 47 |
Default: no |
48 | 48 |
.TP |
49 | 49 |
\fBLogClean BOOL\fR |
50 |
-Log clean files. |
|
50 |
+Log all clean files. |
|
51 |
+.br |
|
52 |
+Useful in debugging but drastically increases the log size. |
|
51 | 53 |
.br |
52 | 54 |
Default: no |
53 | 55 |
.TP |
54 | 56 |
\fBLogSyslog BOOL\fR |
55 |
-Use system logger (can work together with LogFile). |
|
57 |
+Use the system logger (can work together with LogFile). |
|
56 | 58 |
.br |
57 | 59 |
Default: no |
58 | 60 |
.TP |
59 | 61 |
\fBLogFacility STRING\fR |
60 |
-Specify the type of syslog messages \- please refer to 'man syslog' for facility names. |
|
62 |
+Type of syslog messages |
|
63 |
+.br |
|
64 |
+Please refer to 'man syslog' for facility names. |
|
61 | 65 |
.br |
62 | 66 |
Default: LOG_LOCAL6 |
63 | 67 |
.TP |
... | ... |
@@ -65,6 +71,11 @@ Default: LOG_LOCAL6 |
65 | 65 |
Enable verbose logging. |
66 | 66 |
.br |
67 | 67 |
Default: no |
68 |
+.TP |
|
69 |
+\fBLogRotate BOOL\fR |
|
70 |
+Rotate log file. Requires LogFileMaxSize option set prior to this option. |
|
71 |
+.br |
|
72 |
+Default: no |
|
68 | 73 |
.TP |
69 | 74 |
\fBExtendedDetectionInfo BOOL\fR |
70 | 75 |
Log additional information about the infected file, such as its size and hash, together with the virus name. |
... | ... |
@@ -74,15 +85,17 @@ Default: no |
74 | 74 |
\fBPidFile STRING\fR |
75 | 75 |
Save the process identifier of a listening daemon (main thread) to a specified file. |
76 | 76 |
.br |
77 |
-Default: no |
|
77 |
+Default: disabled |
|
78 | 78 |
.TP |
79 | 79 |
\fBTemporaryDirectory STRING\fR |
80 |
-Optional path to the global temporary directory. |
|
80 |
+This option allows you to change the default temporary directory. |
|
81 | 81 |
.br |
82 | 82 |
Default: system specific (usually /tmp or /var/tmp). |
83 | 83 |
.TP |
84 | 84 |
\fBDatabaseDirectory STRING\fR |
85 |
-Path to a directory containing database files. |
|
85 |
+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. |
|
86 |
+.br |
|
87 |
+Default: defined at configuration (/usr/local/share/clamav) |
|
86 | 88 |
.TP |
87 | 89 |
\fBOfficialDatabaseOnly BOOL\fR |
88 | 90 |
Only load the official signatures published by the ClamAV project. |
... | ... |
@@ -92,7 +105,7 @@ Default: no |
92 | 92 |
\fBLocalSocket STRING\fR |
93 | 93 |
Path to a local (Unix) socket the daemon will listen on. |
94 | 94 |
.br |
95 |
-Default: no |
|
95 |
+Default: disabled |
|
96 | 96 |
.TP |
97 | 97 |
\fBLocalSocketGroup STRING\fR |
98 | 98 |
Sets the group ownership on the unix socket. |
... | ... |
@@ -112,17 +125,39 @@ Default: yes |
112 | 112 |
\fBTCPSocket NUMBER\fR |
113 | 113 |
TCP port number the daemon will listen on. |
114 | 114 |
.br |
115 |
-Default: no |
|
115 |
+Default: disabled |
|
116 | 116 |
.TP |
117 | 117 |
\fBTCPAddr STRING\fR |
118 |
-TCP socket address to bind to. By default clamd binds to INADDR_ANY. |
|
118 |
+By default clamd binds to INADDR_ANY. |
|
119 |
+.br |
|
120 |
+This option allows you to restrict the TCP address and provide some degree of protection from the outside world. |
|
119 | 121 |
.br |
120 |
-Default: no |
|
122 |
+Default: disabled |
|
121 | 123 |
.TP |
122 | 124 |
\fBMaxConnectionQueueLength NUMBER\fR |
123 | 125 |
Maximum length the queue of pending connections may grow to. |
124 | 126 |
.br |
125 | 127 |
Default: 200 |
128 |
+ |
|
129 |
+.TP |
|
130 |
+\fBStreamMaxLength SIZE\fR |
|
131 |
+Close the STREAM session when the data size limit is exceeded. |
|
132 |
+\br |
|
133 |
+The value should match your MTA's limit for the maximum attachment size. |
|
134 |
+\br |
|
135 |
+Default: 26214400 |
|
136 |
+.TP |
|
137 |
+\fBStreamMinPort NUMBER\fR |
|
138 |
+The STREAM command uses an FTP-like protocol. |
|
139 |
+\br |
|
140 |
+This option sets the lower boundary for the port range. |
|
141 |
+\br |
|
142 |
+Default: 1024 |
|
143 |
+.TP |
|
144 |
+\fBStreamMaxPort NUMBER\fR |
|
145 |
+This option sets the upper boundary for the port range. |
|
146 |
+\br |
|
147 |
+Default: 2048 |
|
126 | 148 |
.TP |
127 | 149 |
\fBMaxThreads NUMBER\fR |
128 | 150 |
Maximum number of threads running at the same time. |
... | ... |
@@ -130,7 +165,8 @@ Maximum number of threads running at the same time. |
130 | 130 |
Default: 10 |
131 | 131 |
.TP |
132 | 132 |
\fBReadTimeout NUMBER\fR |
133 |
-Waiting for data from a client socket will timeout after this time (seconds). |
|
133 |
+This option specifies the time (in seconds) after which clamd should |
|
134 |
+timeout if a client doesn't provide any data. |
|
134 | 135 |
.br |
135 | 136 |
Default: 120 |
136 | 137 |
.TP |
... | ... |
@@ -161,14 +197,15 @@ by \fBulimit \-n\fR. |
161 | 161 |
Default: 100 |
162 | 162 |
.TP |
163 | 163 |
\fBIdleTimeout NUMBER\fR |
164 |
-Waiting for a new job will timeout after this time (seconds). |
|
164 |
+This option specifies how long (in seconds) the process should wait |
|
165 |
+for a new job. |
|
165 | 166 |
.br |
166 | 167 |
Default: 30 |
167 | 168 |
.TP |
168 | 169 |
\fBExcludePath REGEX\fR |
169 | 170 |
Don't scan files and directories matching REGEX. This directive can be used multiple times. |
170 | 171 |
.br |
171 |
-Default: scan all |
|
172 |
+Default: disabled |
|
172 | 173 |
.TP |
173 | 174 |
\fBMaxDirectoryRecursion NUMBER\fR |
174 | 175 |
Maximum depth directories are scanned at. |
... | ... |
@@ -191,30 +228,28 @@ Follow regular file symlinks. |
191 | 191 |
Default: no |
192 | 192 |
.TP |
193 | 193 |
\fBSelfCheck NUMBER\fR |
194 |
-Perform a database check. |
|
194 |
+This option specifies the time intervals (in seconds) in which clamd |
|
195 |
+should perform a database check. |
|
195 | 196 |
.br |
196 |
-Default: 1800 |
|
197 |
+Default: 600 |
|
197 | 198 |
.TP |
198 | 199 |
\fBVirusEvent COMMAND\fR |
199 |
-Execute COMMAND when a virus is found. In the command string %v will be replaced with the virus name. |
|
200 |
+Execute a command when a virus is found. In the command string %v will be |
|
201 |
+replaced with the virus name. Additionally, two environment variables will |
|
202 |
+be defined: $CLAM_VIRUSEVENT_FILENAME and $CLAM_VIRUSEVENT_VIRUSNAME. |
|
200 | 203 |
\fR |
201 | 204 |
.br |
202 |
-Default: no |
|
205 |
+Default: disabled |
|
203 | 206 |
.TP |
204 | 207 |
\fBExitOnOOM BOOL\fR |
205 | 208 |
Stop daemon when libclamav reports out of memory condition. |
206 | 209 |
.br |
207 | 210 |
Default: no |
208 | 211 |
.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 |
|
212 |
+\fBAllowAllMatchScan BOOL\fR |
|
213 |
+Permit use of the ALLMATCHSCAN command. |
|
214 |
+.br |
|
215 |
+Default: yes |
|
218 | 216 |
.TP |
219 | 217 |
\fBForeground BOOL\fR |
220 | 218 |
Don't fork into background. |
... | ... |
@@ -223,46 +258,76 @@ Default: no |
223 | 223 |
.TP |
224 | 224 |
\fBDebug BOOL\fR |
225 | 225 |
Enable debug messages from libclamav. |
226 |
+.br |
|
227 |
+Default: no |
|
226 | 228 |
.TP |
227 | 229 |
\fBLeaveTemporaryFiles BOOL\fR |
228 |
-Do not remove temporary files (for debug purpose). |
|
230 |
+Do not remove temporary files (for debugging purpose). |
|
229 | 231 |
.br |
230 | 232 |
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 |
|
233 |
+.TP |
|
234 |
+\fBUser STRING\fR |
|
235 |
+Run the daemon as a specified user (the process must be started by root). |
|
236 |
+.br |
|
237 |
+Default: disabled |
|
238 |
+.TP |
|
239 |
+\fBAllowSupplementaryGroups BOOL\fR |
|
240 |
+Initialize a supplementary group access (the process must be started by root). |
|
241 |
+.br |
|
242 |
+Default: no |
|
243 |
+.TP |
|
247 | 244 |
\fBBytecode BOOL\fR |
248 | 245 |
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 | 246 |
.br |
250 | 247 |
Default: yes |
251 | 248 |
.TP |
252 | 249 |
\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. |
|
250 |
+Set bytecode security level. |
|
251 |
+.RS |
|
252 |
+.PD 0 |
|
253 |
+.HP 4 |
|
254 |
+Possible values: |
|
255 |
+.br |
|
256 |
+\fBTrustSigned\fR \- trust bytecode loaded from signed .c[lv]d files and insert runtime safety checks for bytecode loaded from other sources, |
|
257 |
+.br |
|
258 |
+\fBParanoid\fR \- don't trust any bytecode, insert runtime checks for all. |
|
259 |
+.RE |
|
260 |
+.RS |
|
261 |
+Recommended: \fBTrustSigned\fR, because bytecode in .cvd files already has these checks. |
|
254 | 262 |
.br |
255 | 263 |
Default: TrustSigned |
264 |
+.PD 1 |
|
265 |
+.RE |
|
266 |
+.TP |
|
267 |
+\fBBytecodeTimeout NUMBER\fR |
|
268 |
+Set bytecode timeout in milliseconds. |
|
269 |
+.br |
|
270 |
+Default: 5000 |
|
256 | 271 |
.TP |
257 | 272 |
\fBBytecodeUnsigned BOOL\fR |
258 | 273 |
Allow loading bytecode from outside digitally signed .c[lv]d files. |
259 | 274 |
.br |
260 | 275 |
Default: no |
261 |
-.TP |
|
262 |
-\fBBytecodeTimeout NUMBER\fR |
|
263 |
-Set bytecode timeout in milliseconds. |
|
276 |
+.TP |
|
277 |
+\fBBytecodeMode STRING\fR |
|
278 |
+Set bytecode execution mode. |
|
279 |
+.RS |
|
280 |
+.PD 0 |
|
281 |
+.HP 4 |
|
282 |
+Possible values: |
|
264 | 283 |
.br |
265 |
-Default: 5000 |
|
284 |
+\fBAuto\fR \- automatically choose JIT if possible, fallback to interpreter |
|
285 |
+.br |
|
286 |
+\fBForceJIT\fR \- always choose JIT, fail if not possible |
|
287 |
+.br |
|
288 |
+\fBForceIntepreter\fR \- always choose interpreter |
|
289 |
+.br |
|
290 |
+\fBTest\fR \- run with both JIT and interpreter and compare results. Make all failures fatal. |
|
291 |
+.RE |
|
292 |
+.RS |
|
293 |
+Default: Auto |
|
294 |
+.PD 1 |
|
295 |
+.RE |
|
266 | 296 |
.TP |
267 | 297 |
\fBDetectPUA BOOL\fR |
268 | 298 |
Detect Possibly Unwanted Applications. |
... | ... |
@@ -272,12 +337,12 @@ Default: No |
272 | 272 |
\fBExcludePUA CATEGORY\fR |
273 | 273 |
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 | 274 |
.br |
275 |
-Default: Load all categories (if DetectPUA is activated) |
|
275 |
+Default: disabled |
|
276 | 276 |
.TP |
277 | 277 |
\fBIncludePUA CATEGORY\fR |
278 | 278 |
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 | 279 |
.br |
280 |
-Default: Load all categories (if DetectPUA is activated) |
|
280 |
+Default: disabled |
|
281 | 281 |
.TP |
282 | 282 |
\fBAlgorithmicDetection BOOL\fR |
283 | 283 |
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,12 +350,16 @@ In some cases (eg. complex malware, exploits in graphic files, and others), Clam |
285 | 285 |
Default: yes |
286 | 286 |
.TP |
287 | 287 |
\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. |
|
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. |
|
289 |
+.br |
|
290 |
+If you turn off this option, the original files will still be scanned, but without additional processing. |
|
289 | 291 |
.br |
290 | 292 |
Default: yes |
291 | 293 |
.TP |
292 | 294 |
\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. |
|
295 |
+Executable and Linking Format is a standard format for UN*X executables. This option allows you to control the scanning of ELF files. |
|
296 |
+.br |
|
297 |
+If you turn off this option, the original files will still be scanned, but without additional processing. |
|
294 | 298 |
.br |
295 | 299 |
Default: yes |
296 | 300 |
.TP |
... | ... |
@@ -299,28 +368,10 @@ With this option clamd will try to detect broken executables (both PE and ELF) a |
299 | 299 |
.br |
300 | 300 |
Default: no |
301 | 301 |
.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 | 302 |
\fBScanMail BOOL\fR |
323 |
-Enable scanning of mail files. |
|
303 |
+Enable scanning of mail files. |
|
304 |
+.br |
|
305 |
+If you turn off this option, the original files will still be scanned, but without parsing individual messages/attachments. |
|
324 | 306 |
.br |
325 | 307 |
Default: yes |
326 | 308 |
.TP |
... | ... |
@@ -329,7 +380,7 @@ Scan RFC1341 messages split over many emails. You will need to periodically clea |
329 | 329 |
.br |
330 | 330 |
Default: no |
331 | 331 |
.TP |
332 |
-\fBMailMaxRecursion NUMBER (OBSOLETE)\fR |
|
332 |
+\fBMailMaxRecursion (OBSOLETE)\fR |
|
333 | 333 |
\fBWARNING:\fR This option is no longer accepted. See \fBMaxRecursion\fR. |
334 | 334 |
.TP |
335 | 335 |
\fBPhishingSignatures BOOL\fR |
... | ... |
@@ -342,13 +393,13 @@ Scan URLs found in mails for phishing attempts using heuristics. This will class |
342 | 342 |
.br |
343 | 343 |
Default: yes |
344 | 344 |
.TP |
345 |
-\fBPhishingAlwaysBlockSSLMismatch BOOL\fR |
|
346 |
-Always block SSL mismatches in URLs, even if the URL isn't in the database. This can lead to false positives. |
|
345 |
+\fBPhishingAlwaysBlockCloak BOOL\fR |
|
346 |
+Always block cloaked URLs, even if URL isn't in database. This can lead to false positives. |
|
347 | 347 |
.br |
348 | 348 |
Default: no |
349 | 349 |
.TP |
350 |
-\fBPhishingAlwaysBlockCloak BOOL\fR |
|
351 |
-Always block cloaked URLs, even if URL isn't in database. This can lead to false positives. |
|
350 |
+\fBPhishingAlwaysBlockSSLMismatch BOOL\fR |
|
351 |
+Always block SSL mismatches in URLs, even if the URL isn't in the database. This can lead to false positives. |
|
352 | 352 |
.br |
353 | 353 |
Default: no |
354 | 354 |
.TP |
... | ... |
@@ -382,10 +433,57 @@ With this option enabled the DLP module will search for valid SSNs formatted as |
382 | 382 |
.br |
383 | 383 |
Default: No |
384 | 384 |
.TP |
385 |
+\fBScanHTML BOOL\fR |
|
386 |
+Perform HTML/JavaScript/ScriptEncoder normalisation and decryption. |
|
387 |
+.br |
|
388 |
+If you turn off this option, the original files will still be scanned, but without additional processing. |
|
389 |
+.br |
|
390 |
+Default: yes |
|
391 |
+.TP |
|
392 |
+\fBScanOLE2 BOOL\fR |
|
393 |
+This option enables scanning of OLE2 files, such as Microsoft Office documents and .msi files. |
|
394 |
+.br |
|
395 |
+If you turn off this option, the original files will still be scanned, but without additional processing. |
|
396 |
+.br |
|
397 |
+Default: yes |
|
398 |
+.TP |
|
399 |
+\fBOLE2BlockMacros BOOL\fR |
|
400 |
+With this option enabled OLE2 files with VBA macros, which were not detected by signatures will be marked as "Heuristics.OLE2.ContainsMacros". |
|
401 |
+.br |
|
402 |
+Default: no |
|
403 |
+.TP |
|
404 |
+\fBScanPDF BOOL\fR |
|
405 |
+This option enables scanning within PDF files. |
|
406 |
+.br |
|
407 |
+If you turn off this option, the original files will still be scanned, but without additional processing. |
|
408 |
+.br |
|
409 |
+Default: yes |
|
410 |
+.TP |
|
411 |
+\fBScanSWF BOOL\fR |
|
412 |
+This option enables scanning within SWF files. |
|
413 |
+.br |
|
414 |
+If you turn off this option, the original files will still be scanned, but without decoding and additional processing. |
|
415 |
+.br |
|
416 |
+Default: yes |
|
417 |
+.TP |
|
385 | 418 |
\fBScanArchive BOOL\fR |
386 |
-Enable archive scanning. |
|
419 |
+Scan within archives and compressed files. |
|
420 |
+.br |
|
421 |
+If you turn off this option, the original files will still be scanned, but without unpacking and additional processing. |
|
387 | 422 |
.br |
388 | 423 |
Default: yes |
424 |
+.TP |
|
425 |
+\fBArchiveBlockEncrypted BOOL\fR |
|
426 |
+Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR). |
|
427 |
+.br |
|
428 |
+Default: no |
|
429 |
+.TP |
|
430 |
+\fBForceToDisk\fR |
|
431 |
+This option causes memory or nested map scans to dump the content to disk. |
|
432 |
+.br |
|
433 |
+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. |
|
434 |
+.br |
|
435 |
+Default: no |
|
389 | 436 |
.TP |
390 | 437 |
\fBArchiveMaxFileSize (OBSOLETE)\fR |
391 | 438 |
\fBWARNING:\fR This option is no longer accepted. See \fBMaxFileSize\fR and \fBMaxScanSize\fR. |
... | ... |
@@ -407,11 +505,6 @@ Default: yes |
407 | 407 |
.br |
408 | 408 |
Default: no |
409 | 409 |
.TP |
410 |
-\fBArchiveBlockEncrypted BOOL\fR |
|
411 |
-Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR). |
|
412 |
-.br |
|
413 |
-Default: no |
|
414 |
-.TP |
|
415 | 410 |
\fBMaxScanSize SIZE\fR |
416 | 411 |
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 |
417 | 412 |
.br |
... | ... |
@@ -431,59 +524,121 @@ Default: 16 |
431 | 431 |
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 | 432 |
.br |
433 | 433 |
Default: 10000 |
434 |
+.TP |
|
435 |
+\fBMaxEmbeddedPE SIZE\fR |
|
436 |
+This option sets the maximum size of a file to check for embedded PE. |
|
437 |
+.br |
|
438 |
+Files larger than this value will skip the additional analysis step. |
|
439 |
+.br |
|
440 |
+Negative values are not allowed. |
|
441 |
+.br |
|
442 |
+Default: 10M |
|
443 |
+.TP |
|
444 |
+\fBMaxHTMLNormalize SIZE\fR |
|
445 |
+This option sets the maximum size of a HTML file to normalize. |
|
446 |
+.br |
|
447 |
+HTML files larger than this value will not be normalized or scanned. |
|
448 |
+.br |
|
449 |
+Negative values are not allowed. |
|
450 |
+.br |
|
451 |
+Default: 10M |
|
452 |
+.TP |
|
453 |
+\fBMaxHTMLNoTags SIZE\fR |
|
454 |
+This option sets the maximum size of a normalized HTML file to scan. |
|
455 |
+.br |
|
456 |
+HTML files larger than this value after normalization will not be scanned. |
|
457 |
+.br |
|
458 |
+Negative values are not allowed. |
|
459 |
+.br |
|
460 |
+Default: 2M |
|
461 |
+.TP |
|
462 |
+\fBMaxScriptNormalize SIZE\fR |
|
463 |
+This option sets the maximum size of a script file to normalize. |
|
464 |
+.br |
|
465 |
+Script content larger than this value will not be normalized or scanned. |
|
466 |
+.br |
|
467 |
+Negative values are not allowed. |
|
468 |
+.br |
|
469 |
+Default: 5M |
|
470 |
+.TP |
|
471 |
+\fBMaxZipTypeRcg SIZE\fR |
|
472 |
+This option sets the maximum size of a ZIP file to reanalyze type recognition. |
|
473 |
+.br |
|
474 |
+ZIP files larger than this value will skip the step to potentially reanalyze as PE. |
|
475 |
+.br |
|
476 |
+Negative values are not allowed. |
|
477 |
+.br |
|
478 |
+WARNING: setting this limit too high may result in severe damage or impact performance. |
|
479 |
+.br |
|
480 |
+Default: 1M |
|
434 | 481 |
.TP |
435 |
-\fBClamukoScanOnAccess BOOL\fR |
|
436 |
-Enable Clamuko. Dazuko (/dev/dazuko) must be configured and running. |
|
437 |
-.br |
|
438 |
-Default: no |
|
482 |
+\fBClamukoScanOnAccess (OBSOLETE)\fR |
|
483 |
+\fBWARNING:\fR This option is no longer accepted. See \fBScanOnAccess\fR. |
|
439 | 484 |
.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 |
|
485 |
+\fBClamukoScannerCount (OBSOLETE)\fR |
|
486 |
+\fBWARNING:\fR This option is no longer accepted. |
|
444 | 487 |
.TP |
445 |
-\fBClamukoScanOnOpen BOOL\fR |
|
446 |
-Scan files on open. |
|
447 |
-.br |
|
448 |
-Default: no |
|
488 |
+\fBClamukoScanOnOpen (OBSOLETE)\fR |
|
489 |
+\fBWARNING:\fR This option is no longer accepted. |
|
449 | 490 |
.TP |
450 |
-\fBClamukoScanOnClose BOOL\fR |
|
451 |
-Scan files on close. |
|
452 |
-.br |
|
453 |
-Default: no. |
|
491 |
+\fBClamukoScanOnClose (OBSOLETE)\fR |
|
492 |
+\fBWARNING:\fR This option is no longer accepted. |
|
454 | 493 |
.TP |
455 |
-\fBClamukoScanOnExec BOOL\fR |
|
456 |
-Scan files on execute. |
|
457 |
-.br |
|
458 |
-Default: no |
|
494 |
+\fBClamukoScanOnExec (OBSOLETE)\fR |
|
495 |
+\fBWARNING:\fR This option is no longer accepted. |
|
459 | 496 |
.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 |
|
497 |
+\fBClamukoIncludePath (OBSOLETE)\fR |
|
498 |
+\fBWARNING:\fR This option is no longer accepted. See \fBOnAccessIncludePath\fR. |
|
464 | 499 |
.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 |
|
500 |
+\fBClamukoExcludePath (OBSOLETE)\fR |
|
501 |
+\fBWARNING:\fR This option is no longer accepted. See \fBOnAccessExcludePath\fR. |
|
502 |
+.TP |
|
503 |
+\fBClamukoExcludeUID (OBSOLETE)\fR |
|
504 |
+\fBWARNING:\fR This option is no longer accepted. See \fBOnAccessExcludeUID\fR. |
|
473 | 505 |
.TP |
474 |
-\fBClamukoMaxFileSize SIZE\fR |
|
475 |
-Ignore files larger than SIZE. |
|
476 |
-.br |
|
506 |
+\fBClamukoMaxFileSize (OBSOLETE)\fR |
|
507 |
+\fBWARNING:\fR This option is no longer accepted. See \fBOnAccessMaxFileSize\fR. |
|
508 |
+.TP |
|
509 |
+\fBScanOnAccess BOOL\fR |
|
510 |
+This option enables on-access scanning (Linux only) |
|
511 |
+.br |
|
512 |
+Default: disabled |
|
513 |
+.TP |
|
514 |
+\fBOnAccessIncludePath STRING\fR |
|
515 |
+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. |
|
516 |
+.br |
|
517 |
+Default: disabled |
|
518 |
+.TP |
|
519 |
+\fBOnAccessExcludePath STRING\fR |
|
520 |
+This option allows excluding directories from on-access scanning. It can be used multiple times. |
|
521 |
+.br |
|
522 |
+Default: disabled |
|
523 |
+.TP |
|
524 |
+\fBOnAccessExcludeUID NUMBER\fR |
|
525 |
+With this option you can whitelist specific UIDs. Processes with these UIDs will be able to access all files. |
|
526 |
+.br |
|
527 |
+This option can be used multiple times (one per line). |
|
528 |
+.br |
|
529 |
+Default: disabled |
|
530 |
+.TP |
|
531 |
+\fBOnAccessMaxFileSize SIZE\fR |
|
532 |
+Files larger than this value will not be scanned in on access. |
|
533 |
+.br |
|
477 | 534 |
Default: 5M |
535 |
+.TP |
|
536 |
+\fBDisableCertCheck BOOL\fR |
|
537 |
+Disable authenticode certificate chain verification in PE files. |
|
538 |
+.br |
|
539 |
+Default: no |
|
478 | 540 |
.SH "NOTES" |
479 | 541 |
.LP |
480 | 542 |
All options expressing a size are limited to max 4GB. Values in excess will be resetted to the maximum. |
481 | 543 |
.SH "FILES" |
482 | 544 |
.LP |
483 | 545 |
@CFGDIR@/clamd.conf |
484 |
-.SH "AUTHOR" |
|
546 |
+.SH "AUTHORS" |
|
485 | 547 |
.LP |
486 |
-Tomasz Kojm <tkojm@clamav.net> |
|
548 |
+Tomasz Kojm <tkojm@clamav.net>, Kevin Lin <klin@sourcefire.com> |
|
487 | 549 |
.SH "SEE ALSO" |
488 | 550 |
.LP |
489 | 551 |
clamd(8), clamdscan(1), clamav-milter(8), freshclam(1), freshclam.conf(5) |
... | ... |
@@ -1,4 +1,4 @@ |
1 |
-.TH "clamscan" "1" "December 30, 2008" "ClamAV @VERSION@" "Clam AntiVirus" |
|
1 |
+.TH "clamscan" "1" "December 4, 2013" "ClamAV @VERSION@" "Clam AntiVirus" |
|
2 | 2 |
.SH "NAME" |
3 | 3 |
.LP |
4 | 4 |
clamscan \- scan files and directories for viruses |
... | ... |
@@ -20,6 +20,9 @@ Print version number and exit. |
20 | 20 |
.TP |
21 | 21 |
\fB\-v, \-\-verbose\fR |
22 | 22 |
Be verbose. |
23 |
+.TP |
|
24 |
+\fB\-a, \-\-archive\-verbose\fR |
|
25 |
+Show filenames inside scanned archives |
|
23 | 26 |
.TP |
24 | 27 |
\fB\-\-debug\fR |
25 | 28 |
Display debug messages from libclamav. |
... | ... |
@@ -29,6 +32,24 @@ Be quiet (only print error messages). |
29 | 29 |
.TP |
30 | 30 |
\fB\-\-stdout\fR |
31 | 31 |
Write all messages (except for libclamav output) to the standard output (stdout). |
32 |
+.TP |
|
33 |
+\fB\-\-no\-summary\fR |
|
34 |
+Do not display summary at the end of scanning. |
|
35 |
+.TP |
|
36 |
+\fB\-i, \-\-infected\fR |
|
37 |
+Only print infected files. |
|
38 |
+.TP |
|
39 |
+\fB\-o, \-\-suppress\-ok\-results\fR |
|
40 |
+Skip printing OK files |
|
41 |
+.TP |
|
42 |
+\fB\-\-bell\fR |
|
43 |
+Sound bell on virus detection. |
|
44 |
+.TP |
|
45 |
+\fB\-\-tempdir=DIRECTORY\fR |
|
46 |
+Create temporary files in DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan. |
|
47 |
+.TP |
|
48 |
+\fB\-\-leave\-temps\fR |
|
49 |
+Do not remove temporary files. |
|
32 | 50 |
.TP |
33 | 51 |
\fB\-d FILE/DIR, \-\-database=FILE/DIR\fR |
34 | 52 |
Load virus database from FILE or load all virus database files from DIR. |
... | ... |
@@ -39,15 +60,6 @@ Only load the official signatures published by the ClamAV project. |
39 | 39 |
\fB\-l FILE, \-\-log=FILE\fR |
40 | 40 |
Save scan report to FILE. |
41 | 41 |
.TP |
42 |
-\fB\-\-tempdir=DIRECTORY\fR |
|
43 |
-Create temporary files in DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan. |
|
44 |
-.TP |
|
45 |
-\fB\-\-leave\-temps\fR |
|
46 |
-Do not remove temporary files. |
|
47 |
-.TP |
|
48 |
-\fB\-f FILE, \-\-file\-list=FILE\fR |
|
49 |
-Scan files listed line by line in FILE. |
|
50 |
-.TP |
|
51 | 42 |
\fB\-r, \-\-recursive\fR |
52 | 43 |
Scan directories recursively. All the subdirectories in the given directory will be scanned. |
53 | 44 |
.TP |
... | ... |
@@ -63,23 +75,11 @@ Follow directory symlinks. There are 3 options: 0 - never follow directory symli |
63 | 63 |
\fB\-\-follow\-file\-symlinks=[0/1(*)/2]\fR |
64 | 64 |
Follow file symlinks. There are 3 options: 0 - never follow file symlinks, 1 (default) - only follow file symlinks, which are passed as direct arguments to clamscan. 2 - always follow file symlinks. |
65 | 65 |
.TP |
66 |
-\fB\-\-bell\fR |
|
67 |
-Sound bell on virus detection. |
|
68 |
-.TP |
|
69 |
-\fB\-\-no\-summary\fR |
|
70 |
-Do not display summary at the end of scanning. |
|
71 |
-.TP |
|
72 |
-\fB\-\-exclude=REGEX, \-\-exclude\-dir=REGEX\fR |
|
73 |
-Don't scan file/directory names matching regular expression. These options can be used multiple times. |
|
74 |
-.TP |
|
75 |
-\fB\-\-include=REGEX, \-\-include\-dir=REGEX\fR |
|
76 |
-Only scan file/directory matching regular expression. These options can be used multiple times. |
|
77 |
-.TP |
|
78 |
-\fB\-i, \-\-infected\fR |
|
79 |
-Only print infected files. |
|
66 |
+\fB\-f FILE, \-\-file\-list=FILE\fR |
|
67 |
+Scan files listed line by line in FILE. |
|
80 | 68 |
.TP |
81 | 69 |
\fB\-\-remove[=yes/no(*)]\fR |
82 |
-Remove infected files. \fBBe careful.\fR |
|
70 |
+Remove infected files. \fBBe careful!\fR |
|
83 | 71 |
.TP |
84 | 72 |
\fB\-\-move=DIRECTORY\fR |
85 | 73 |
Move infected files into DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan. |
... | ... |
@@ -87,6 +87,12 @@ Move infected files into DIRECTORY. Directory must be writable for the '@CLAMAVU |
87 | 87 |
\fB\-\-copy=DIRECTORY\fR |
88 | 88 |
Copy infected files into DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan. |
89 | 89 |
.TP |
90 |
+\fB\-\-exclude=REGEX, \-\-exclude\-dir=REGEX\fR |
|
91 |
+Don't scan file/directory names matching regular expression. These options can be used multiple times. |
|
92 |
+.TP |
|
93 |
+\fB\-\-include=REGEX, \-\-include\-dir=REGEX\fR |
|
94 |
+Only scan file/directory matching regular expression. These options can be used multiple times. |
|
95 |
+.TP |
|
90 | 96 |
\fB\-\-bytecode[=yes(*)/no]\fR |
91 | 97 |
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. |
92 | 98 |
.TP |
... | ... |
@@ -152,6 +158,9 @@ Scan Microsoft Office documents and .msi files. If you turn off this option, the |
152 | 152 |
.TP |
153 | 153 |
\fB\-\-scan\-pdf[=yes(*)/no]\fR |
154 | 154 |
Scan within PDF files. If you turn off this option, the original files will still be scanned, but without decoding and additional processing. |
155 |
+.TP |
|
156 |
+\fB\-\-scan\-swf[=yes(*)/no]\fR |
|
157 |
+Scan SWF files. If you turn off this option, the original files will still be scanned but without additional processing. |
|
155 | 158 |
.TP |
156 | 159 |
\fB\-\-scan\-html[=yes(*)/no]\fR |
157 | 160 |
Detect, normalize/decrypt and scan HTML files and embedded scripts. If you turn off this option, the original files will still be scanned, but without additional processing. |
... | ... |
@@ -165,20 +174,36 @@ Mark broken executables as viruses (Broken.Executable). |
165 | 165 |
\fB\-\-block\-encrypted[=yes/no(*)]\fR |
166 | 166 |
Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR). |
167 | 167 |
.TP |
168 |
-\fB\-\-max\-files=#n\fR |
|
169 |
-Extract at most #n files from each scanned file (when this is an archive, a document or another kind of container). This option protects your system against DoS attacks (default: 10000) |
|
170 |
-.TP |
|
171 | 168 |
\fB\-\-max\-filesize=#n\fR |
172 |
-Extract and scan at most #n kilobytes from each archive. You may pass the value in megabytes in format xM or xm, where x is a number. This option protects your system against DoS attacks (default: 25 MB, max: <4 GB) |
|
169 |
+Extract and scan at most #n bytes from each archive. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number. This option protects your system against DoS attacks (default: 25 MB, max: <4 GB) |
|
173 | 170 |
.TP |
174 | 171 |
\fB\-\-max\-scansize=#n\fR |
175 |
-Extract and scan at most #n kilobytes from each scanned file. You may pass the value in megabytes in format xM or xm, where x is a number. This option protects your system against DoS attacks (default: 100 MB, max: <4 GB) |
|
172 |
+Extract and scan at most #n bytes from each archive. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number. This option protects your system against DoS attacks (default: 100 MB, max: <4 GB) |
|
173 |
+.TP |
|
174 |
+\fB\-\-max\-files=#n\fR |
|
175 |
+Extract at most #n files from each scanned file (when this is an archive, a document or another kind of container). This option protects your system against DoS attacks (default: 10000) |
|
176 | 176 |
.TP |
177 | 177 |
\fB\-\-max\-recursion=#n\fR |
178 | 178 |
Set archive recursion level limit. This option protects your system against DoS attacks (default: 16). |
179 | 179 |
.TP |
180 | 180 |
\fB\-\-max\-dir\-recursion=#n\fR |
181 | 181 |
Maximum depth directories are scanned at (default: 15). |
182 |
+ |
|
183 |
+.TP |
|
184 |
+\fB\-\-max\-embeddedpe=#n\fR |
|
185 |
+Maximum size file to check for embedded PE. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 10 MB, max: <4 GB). |
|
186 |
+.TP |
|
187 |
+\fB\-\-max\-htmlnormalize=#n\fR |
|
188 |
+Maximum size of HTML file to normalize. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 10 MB, max: <4 GB). |
|
189 |
+.TP |
|
190 |
+\fB\-\-max\-htmlnotags=#n\fR |
|
191 |
+Maximum size of normalized HTML file to scan. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 2 MB, max: <4 GB). |
|
192 |
+.TP |
|
193 |
+\fB\-\-max\-scriptnormalize=#n\fR |
|
194 |
+Maximum size of script file to normalize. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 5 MB, max: <4 GB). |
|
195 |
+.TP |
|
196 |
+\fB\-\-max-ziptypercg=#n\fR |
|
197 |
+Maximum size zip to type reanalyze. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 1 MB, max: <4 GB). |
|
182 | 198 |
.SH "EXAMPLES" |
183 | 199 |
.LP |
184 | 200 |
.TP |
... | ... |
@@ -216,7 +241,7 @@ Maximum depth directories are scanned at (default: 15). |
216 | 216 |
Please check the full documentation for credits. |
217 | 217 |
.SH "AUTHOR" |
218 | 218 |
.LP |
219 |
-Tomasz Kojm <tkojm@clamav.net> |
|
219 |
+Tomasz Kojm <tkojm@clamav.net>, Kevin Lin <klin@sourcefire.com> |
|
220 | 220 |
.SH "SEE ALSO" |
221 | 221 |
.LP |
222 | 222 |
clamdscan(1), freshclam(1), freshclam.conf(5) |
... | ... |
@@ -1,4 +1,4 @@ |
1 |
-.TH "freshclam" "1" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus" |
|
1 |
+.TH "freshclam" "1" "December 4, 2013" "ClamAV @VERSION@" "Clam AntiVirus" |
|
2 | 2 |
.SH "NAME" |
3 | 3 |
.LP |
4 | 4 |
freshclam \- update virus databases |
... | ... |
@@ -21,50 +21,54 @@ Print version number and exit. |
21 | 21 |
\fB\-v, \-\-verbose\fR |
22 | 22 |
Be verbose. This option causes freshclam to print much additional information. |
23 | 23 |
.TP |
24 |
+\fB\-\-debug\fR |
|
25 |
+Enable debug messages from LibClamAV. |
|
26 |
+.TP |
|
24 | 27 |
\fB\-\-quiet\fR |
25 | 28 |
Be quiet \- output only error messages. |
26 | 29 |
.TP |
27 | 30 |
\fB\-\-no\-warnings\fR |
28 | 31 |
Don't print and log warnings. |
29 |
-.TP |
|
30 |
-\fB\-v, \-\-debug\fR |
|
31 |
-Enable debug messages from LibClamAV. |
|
32 |
-.TP |
|
32 |
+.TP |
|
33 | 33 |
\fB\-\-stdout\fR |
34 | 34 |
Write all messages to stdout. |
35 | 35 |
.TP |
36 |
+\fB\-\-config\-file=FILE |
|
37 |
+Read configuration from FILE. |
|
38 |
+.TP |
|
36 | 39 |
\fB\-l FILE, \-\-log=FILE\fR |
37 |
-Write download report to FILE. |
|
38 |
-.TP |
|
39 |
-\fB\-\-datadir=DIRECTORY\fR |
|
40 |
-Install new database in DIRECTORY. The directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running freshclam. |
|
41 |
-.TP |
|
42 |
-\fB\-u USER, \-\-user USER\fR |
|
43 |
-Run as USER. By default (when started by root) freshclam drops privileges and operates as the '@CLAMAVUSER@' user. |
|
44 |
-.TP |
|
40 |
+Log report to FILE. |
|
41 |
+.TP |
|
45 | 42 |
\fB\-d, \-\-daemon\fR |
46 |
-Run in a daemon mode. This option requires \-\-checks. |
|
43 |
+Run in a daemon mode. Defaults to 12 checks per day unless otherwise specified by \-\-checks or freshclam.conf. |
|
44 |
+.TP |
|
47 | 45 |
\fB\-p FILE, \-\-pid=FILE\fR |
48 | 46 |
Write daemon's pid to FILE. |
49 | 47 |
.TP |
48 |
+\fB\-u USER, \-\-user USER\fR |
|
49 |
+Run as USER. By default (when started by root) freshclam drops privileges and operates as the '@CLAMAVUSER@' user. |
|
50 |
+.TP |
|
50 | 51 |
\fB\-\-no\-dns\fR |
51 | 52 |
This option forces old non\-DNS verification method (without a TTL delay). |
52 | 53 |
.TP |
53 | 54 |
\fB\-c #n, \-\-checks=#n\fR |
54 | 55 |
Check #n times per day for a new database. #n must be between 1 and 50. |
56 |
+.TP |
|
57 |
+\fB\-\-datadir=DIRECTORY\fR |
|
58 |
+Install new database in DIRECTORY. The directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running freshclam. |
|
55 | 59 |
.TP |
56 | 60 |
\fB\-\-daemon\-notify=/path/to/clamd.conf\fR |
57 | 61 |
Notify the daemon about the new database. By default it reads a hardcoded config file but you can use a different one. Both local and TCP sockets are supported. |
58 | 62 |
.TP |
59 | 63 |
\fB\-a IP, \-\-local\-address=IP\fR |
60 | 64 |
Use (local) IP for HTTP downloads. Useful for multi\-homed systems. If binding fails for whatever reason, a warning is issued and freshclam behaves like without this flag. |
65 |
+.TP |
|
66 |
+\fB\-\-on\-update\-execute=COMMAND\fR |
|
67 |
+Execute COMMAND after successful update. |
|
61 | 68 |
.TP |
62 | 69 |
\fB\-\-on\-error\-execute=COMMAND\fR |
63 | 70 |
Execute COMMAND if error occurred. Remember, that virus database freshness is the most important thing in anti\-virus system. With this option freshclam can alert you (eg. send SMS) when something is going wrong. |
64 | 71 |
.TP |
65 |
-\fB\-\-on\-update\-execute=COMMAND\fR |
|
66 |
-Execute COMMAND after successful update. |
|
67 |
-.TP |
|
68 | 72 |
\fB\-\-on\-outdated\-execute=COMMAND\fR |
69 | 73 |
Execute COMMAND when freshclam reports outdated version. In the command string %v will be replaced by the new version number. |
70 | 74 |
.TP |
... | ... |
@@ -129,7 +133,7 @@ Some return codes of freshclam can be overwritten with a built-in command EXIT_n |
129 | 129 |
Please check the full documentation for credits. |
130 | 130 |
.SH "AUTHOR" |
131 | 131 |
.LP |
132 |
-Tomasz Kojm <tkojm@clamav.net> |
|
132 |
+Tomasz Kojm <tkojm@clamav.net>, Kevin Lin <klin@sourcefire.com> |
|
133 | 133 |
.SH "SEE ALSO" |
134 | 134 |
.LP |
135 | 135 |
freshclam.conf(5), clamd(8), clamd.conf(5), clamscan(1) |
... | ... |
@@ -1,4 +1,4 @@ |
1 |
-.TH "freshclam.conf" "5" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus" |
|
1 |
+.TH "freshclam.conf" "5" "December 4, 2013" "ClamAV @VERSION@" "Clam AntiVirus" |
|
2 | 2 |
.SH "NAME" |
3 | 3 |
.LP |
4 | 4 |
\fBfreshclam.conf\fR \- Configuration file for Clam AntiVirus database update tool |
... | ... |
@@ -25,37 +25,17 @@ When an option is not used (hashed or doesn't exist in the configuration file) f |
25 | 25 |
.TP |
26 | 26 |
\fBExample\fR |
27 | 27 |
If this option is set freshclam will not run. |
28 |
-.TP |
|
29 |
-\fBDatabaseOwner STRING\fR |
|
30 |
-When started by root, drop privileges to a specified user. |
|
31 |
-.br |
|
32 |
-Default: @CLAMAVUSER@ |
|
33 |
-.TP |
|
34 |
-\fBAllowSupplementaryGroups BOOL\fR |
|
35 |
-Initialize supplementary group access (freshclam must be started by root). |
|
36 |
-.br |
|
37 |
-Default: disabled |
|
38 |
-.TP |
|
39 |
-\fBDatabaseDirectory STRING\fR |
|
40 |
-Path to a directory containing database files. |
|
41 |
-.br |
|
42 |
-Default: @DBDIR@ |
|
43 |
-.TP |
|
44 |
-\fBChecks NUMBER\fR |
|
45 |
-Number of database checks per day. |
|
46 |
-.br |
|
47 |
-Default: 12 |
|
48 |
-.TP |
|
49 |
-\fBUpdateLogFile STRING\fR |
|
50 |
-Enable logging to a specified file. Highly recommended. |
|
51 |
-.br |
|
52 |
-Default: disabled. |
|
53 | 28 |
.TP |
54 | 29 |
\fBLogFileMaxSize SIZE\fR |
55 | 30 |
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. |
56 | 31 |
.br |
57 |
-Default: 1M |
|
58 |
-.TP |
|
32 |
+Default: 1M |
|
33 |
+.TP |
|
34 |
+\fBLogTime BOOL\fR |
|
35 |
+Log time with each message. |
|
36 |
+.br |
|
37 |
+Default: no |
|
38 |
+.TP |
|
59 | 39 |
\fBLogSyslog BOOL\fR |
60 | 40 |
Enable logging to Syslog. May be used in combination with UpdateLogFile. |
61 | 41 |
.br |
... | ... |
@@ -66,26 +46,73 @@ Specify the type of syslog messages \- please refer to 'man syslog' for facility |
66 | 66 |
.br |
67 | 67 |
Default: LOG_LOCAL6 |
68 | 68 |
.TP |
69 |
+\fBLogVerbose BOOL\fR |
|
70 |
+Enable verbose logging. |
|
71 |
+.br |
|
72 |
+Default: disabled |
|
73 |
+.TP |
|
74 |
+\fBLogRotate BOOL\fR |
|
75 |
+Rotate log file. Requires LogFileMaxSize option set prior to this option. |
|
76 |
+.br |
|
77 |
+Default: no |
|
78 |
+.TP |
|
69 | 79 |
\fBPidFile STRING\fR |
70 | 80 |
This option allows you to save the process identifier of the daemon to a file specified in the argument. |
71 | 81 |
.br |
72 | 82 |
Default: disabled |
73 | 83 |
.TP |
74 |
-\fBLogVerbose BOOL\fR |
|
75 |
-Enable verbose logging. |
|
84 |
+\fBDatabaseDirectory STRING\fR |
|
85 |
+Path to a directory containing database files. |
|
86 |
+.br |
|
87 |
+Default: @DBDIR@ |
|
88 |
+.TP |
|
89 |
+\fBForeground BOOL\fR |
|
90 |
+Don't fork into background. |
|
91 |
+.br |
|
92 |
+Default: no |
|
93 |
+.TP |
|
94 |
+\fBDebug BOOL\fR |
|
95 |
+Enable debug messages in libclamav. |
|
96 |
+.br |
|
97 |
+Default: no |
|
98 |
+.TP |
|
99 |
+\fBAllowSupplementaryGroups BOOL\fR |
|
100 |
+Initialize supplementary group access (freshclam must be started by root). |
|
76 | 101 |
.br |
77 | 102 |
Default: disabled |
78 | 103 |
.TP |
104 |
+\fBUpdateLogFile STRING\fR |
|
105 |
+Enable logging to a specified file. Highly recommended. |
|
106 |
+.br |
|
107 |
+Default: disabled. |
|
108 |
+.TP |
|
109 |
+\fBDatabaseOwner STRING\fR |
|
110 |
+When started by root, drop privileges to a specified user. |
|
111 |
+.br |
|
112 |
+Default: @CLAMAVUSER@ |
|
113 |
+.TP |
|
114 |
+\fBChecks NUMBER\fR |
|
115 |
+Number of database checks per day. |
|
116 |
+.br |
|
117 |
+Default: 12 |
|
118 |
+.TP |
|
79 | 119 |
\fBDNSDatabaseInfo STRING\fR |
80 |
-This directive enables database and software version checks through DNS TXT records. |
|
120 |
+Use DNS to verify the virus database version. Freshclam uses DNS TXT records to verify the versions of the database and software itself. With this directive you can change the database verification domain. |
|
121 |
+.br |
|
122 |
+\fBWARNING:\fR Please don't change it unless you're configuring freshclam to use your own database verification domain. |
|
81 | 123 |
.br |
82 | 124 |
Default: enabled, pointing to current.cvd.clamav.net |
83 | 125 |
.TP |
84 | 126 |
\fBDatabaseMirror STRING\fR |
85 |
-Server name where database updates are downloaded from. In order to download the database from the closest mirror you should configure freshclam to use db.xy.clamav.net where xy represents your country code. If this option is given multiple times, freshclam(1) tries them in the order given. It's strongly recommended that you use db.xy.clamav.net as the first mirror and database.clamav.net as the second. |
|
127 |
+DatabaseMirror specifies to which mirror(s) freshclam should connect. You should have at least two entries: db.XY.clamav.net (or db.XY.ipv6.clamav.net for IPv6) and database.clamav.net (in this order). Please replace XY with your country code (see http://www.iana.org/cctld/cctld-whois.htm). database.clamav.net is a round-robin record which points to our most reliable mirrors. It's used as a fall back in case db.XY.clamav.net is not working. |
|
86 | 128 |
.br |
87 | 129 |
Default: database.clamav.net |
88 | 130 |
.TP |
131 |
+\fBPrivateMirror STR\fR |
|
132 |
+This option allows you to easily point freshclam to private mirrors. If PrivateMirror is set, freshclam does not attempt to use DNS to determine whether its databases are out-of-date, instead it will use the If-Modified-Since request or directly check the headers of the remote database files. For each database, freshclam first attempts to download the CLD file. If that fails, it tries to download the CVD file. This option overrides DatabaseMirror, DNSDatabaseInfo and ScriptedUpdates. It can be used multiple times to provide fall-back mirrors. |
|
133 |
+.br |
|
134 |
+Default: disabled |
|
135 |
+.TP |
|
89 | 136 |
\fBMaxAttempts NUMBER\fR |
90 | 137 |
How many attempts (per mirror) to make before giving up. |
91 | 138 |
.br . |
... | ... |
@@ -94,7 +121,7 @@ Default: 3 (per mirror) |
94 | 94 |
\fBScriptedUpdates BOOL\fR |
95 | 95 |
With this option you can control scripted updates. It's highly recommended to keep it enabled. |
96 | 96 |
.br . |
97 |
-Default: enabled |
|
97 |
+Default: yes |
|
98 | 98 |
.TP |
99 | 99 |
\fBTestDatabases BOOL\fR |
100 | 100 |
With this option enabled, freshclam will attempt to load new databases into memory to make sure they are properly handled by libclamav before replacing the old ones. |
... | ... |
@@ -105,15 +132,15 @@ Default: enabled |
105 | 105 |
By default freshclam will keep the local databases (.cld) uncompressed to make their handling faster. With this option you can enable the compression; the change will take effect with the next database update. |
106 | 106 |
.br |
107 | 107 |
Default: no |
108 |
+.TP |
|
109 |
+\fBExtraDatabase STRING\fR |
|
110 |
+Download an additional 3rd party signature database distributed through the ClamAV mirrors. This option can be used multiple times. Here you can find a list of available databases: http://www.clamav.net/download/cvd/3rdparty |
|
111 |
+.br |
|
112 |
+Default: disabled |
|
108 | 113 |
.TP |
109 |
-\fBDatabaseCustomURL STR\fR |
|
114 |
+\fBDatabaseCustomURL STRING\fR |
|
110 | 115 |
With this option you can provide custom sources (http:// or file://) for database files. This option can be used multiple times. |
111 | 116 |
.br |
112 |
-Default: no custom URLs |
|
113 |
-.TP |
|
114 |
-\fBPrivateMirror STR\fR |
|
115 |
-This option allows you to easily point freshclam to private mirrors. If PrivateMirror is set, freshclam does not attempt to use DNS to determine whether its databases are out-of-date, instead it will use the If-Modified-Since request or directly check the headers of the remote database files. For each database, freshclam first attempts to download the CLD file. If that fails, it tries to download the CVD file. This option overrides DatabaseMirror, DNSDatabaseInfo and ScriptedUpdates. It can be used multiple times to provide fall-back mirrors. |
|
116 |
-.br |
|
117 | 117 |
Default: disabled |
118 | 118 |
.TP |
119 | 119 |
\fBHTTPProxyServer STR\fR, \fBHTTPProxyPort NUMBER\fR |
... | ... |
@@ -122,37 +149,37 @@ Use given proxy server and TCP port for database downloads. HTTPProxyPort defaul |
122 | 122 |
\fBHTTPProxyUsername STR\fR,\fBHTTPProxyPassword STRING\fR |
123 | 123 |
Proxy usage is authenticated through given username and password. |
124 | 124 |
.br . |
125 |
-Default: no proxy authentication |
|
125 |
+Default: disabled |
|
126 | 126 |
.TP |
127 | 127 |
\fBHTTPUserAgent STRING\fR |
128 | 128 |
If your servers are behind a firewall/proxy which applies User-Agent filtering, you can use this option to force the use of a different User-Agent header. |
129 | 129 |
.br . |
130 | 130 |
Default: clamav/version_number |
131 | 131 |
.TP |
132 |
-\fBLocalIPAddress IP\fR |
|
133 |
-Use \fBIP\fR as client address for downloading databases. Useful for multi homed systems. |
|
134 |
-.br . |
|
135 |
-Default: Use OS\'es default outgoing IP address. |
|
136 |
-.TP |
|
137 | 132 |
\fBNotifyClamd STRING\fR |
138 | 133 |
Notify a running clamd(8) to reload its database after a download has occurred. The path for clamd.conf file must be provided. |
139 | 134 |
.br . |
140 |
-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. |
|
135 |
+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. |
|
141 | 136 |
.TP |
142 | 137 |
\fBOnUpdateExecute STRING\fR |
143 | 138 |
Execute this command after the database has been successfully updated. |
144 | 139 |
.br |
145 | 140 |
Default: disabled |
146 |
-.TP |
|
147 |
-\fBOnOutdatedExecute STRING\fR |
|
148 |
-Execute this command when freshclam reports outdated version. In the command string %v will be replaced by the new version number. |
|
149 |
-.br |
|
150 |
-Default: disabled |
|
151 | 141 |
.TP |
152 | 142 |
\fBOnErrorExecute STRING\fR |
153 | 143 |
Execute this command after a database update has failed. |
154 | 144 |
.br |
155 | 145 |
Default: disabled |
146 |
+.TP |
|
147 |
+\fBOnOutdatedExecute STRING\fR |
|
148 |
+Execute this command when freshclam reports outdated version. In the command string %v will be replaced by the new version number. |
|
149 |
+.br |
|
150 |
+Default: disabled |
|
151 |
+.TP |
|
152 |
+\fBLocalIPAddress IP\fR |
|
153 |
+Use \fBIP\fR as client address for downloading databases. Useful for multi homed systems. |
|
154 |
+.br . |
|
155 |
+Default: Use OS'es default outgoing IP address. |
|
156 | 156 |
.TP |
157 | 157 |
\fBConnectTimeout NUMBER\fR |
158 | 158 |
Timeout in seconds when connecting to database server. |
... | ... |
@@ -193,7 +220,7 @@ Default: enabled |
193 | 193 |
@CFGDIR@/freshclam.conf |
194 | 194 |
.SH "AUTHOR" |
195 | 195 |
.LP |
196 |
-Thomas Lamy <thomas.lamy@netwake.de>, Tomasz Kojm <tkojm@clamav.net> |
|
196 |
+Thomas Lamy <thomas.lamy@netwake.de>, Tomasz Kojm <tkojm@clamav.net>, Kevin Lin <klin@sourcefire.com> |
|
197 | 197 |
.SH "SEE ALSO" |
198 | 198 |
.LP |
199 | 199 |
freshclam(1), clamd.conf(5), clamd(8), clamscan(1) |