Browse code

docs: added documentation on max-partitions option

Kevin Lin authored on 2014/03/06 07:20:41
Showing 5 changed files
... ...
@@ -276,6 +276,7 @@ void help(void)
276 276
     mprintf("    --max-htmlnotags=#n                  Maximum size of normalized HTML file to scan\n");
277 277
     mprintf("    --max-scriptnormalize=#n             Maximum size of script file to normalize\n");
278 278
     mprintf("    --max-ziptypercg=#n                  Maximum size zip to type reanalyze\n");
279
+    mprintf("    --max-partitions=#n                  Maximum number of partitions in disk image to be scanned\n");
279 280
     mprintf("\n");
280 281
     mprintf("(*) Default scan settings\n");
281 282
     mprintf("(**) Certain files (e.g. documents, archives, etc.) may in turn contain other\n");
... ...
@@ -571,6 +571,17 @@ WARNING: setting this limit too high may result in severe damage or impact perfo
571 571
 .br
572 572
 Default: 1M
573 573
 .TP 
574
+\fBMaxPartitions SIZE\fR
575
+This option sets the maximum number of partitions of a raw disk image to be scanned.
576
+.br
577
+Raw disk images with more partitions than this value will have up to the value partitions scanned.
578
+.br
579
+Negative values are not allowed.
580
+.br
581
+WARNING: setting this limit too high may result in severe damage or impact performance.
582
+.br
583
+Default: 50
584
+.TP
574 585
 \fBClamukoScanOnAccess (OBSOLETE)\fR
575 586
 \fBWARNING:\fR This option is no longer accepted. See \fBScanOnAccess\fR.
576 587
 .TP 
... ...
@@ -204,6 +204,9 @@ Maximum size of script file to normalize. You may pass the value in kilobytes in
204 204
 .TP
205 205
 \fB\-\-max-ziptypercg=#n\fR
206 206
 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).
207
+.TP
208
+\fB\-\-max-partitions=#n\fR
209
+This option sets the maximum number of partitions of a raw disk image to be scanned. This must be a positive integer (default: 50).
207 210
 .SH "EXAMPLES"
208 211
 .LP 
209 212
 .TP 
... ...
@@ -503,6 +503,12 @@ Example
503 503
 # Default: 1M
504 504
 #MaxZipTypeRcg 1M
505 505
 
506
+# This option sets the maximum number of partitions of a raw disk image to be scanned.
507
+# Raw disk images with more partitions than this value will have up to the value number
508
+# partitions scanned. Negative values are not allowed.
509
+# Note: setting this limit too high may result in severe damage or impact performance.
510
+# Default: 50
511
+#MaxPartitions 128
506 512
 
507 513
 ##
508 514
 ## On-access Scan Settings
... ...
@@ -375,7 +375,7 @@ const struct clam_option __clam_options[] = {
375 375
 
376 376
     { "MaxZipTypeRcg", "max-ziptypercg", 0, TYPE_SIZE, MATCH_SIZE, CLI_DEFAULT_MAXZIPTYPERCG, NULL, 0, OPT_CLAMD | OPT_CLAMSCAN, "This option sets the maximum size of a ZIP file to reanalyze type recognition.\nZIP files larger than this value will skip the step to potentially reanalyze as PE.\nNegative values are not allowed.\nWARNING: setting this limit too high may result in severe damage or impact performance.", "1M" },
377 377
 
378
-    { "MaxPartitions", "max-partitions", 0, TYPE_NUMBER, MATCH_NUMBER, 50, NULL, 0, OPT_CLAMD | OPT_CLAMSCAN, "This option sets the maximum number of partitions of a raw DMG to be scanned.\nRaw DMGs with more partitions than this value will have up to the value number partitions scanned.\nNegative values are not allowed.\nWARNING: setting this limit too high may result in severe damage or impact performance.", "128" },
378
+    { "MaxPartitions", "max-partitions", 0, TYPE_NUMBER, MATCH_NUMBER, 50, NULL, 0, OPT_CLAMD | OPT_CLAMSCAN, "This option sets the maximum number of partitions of a raw disk image to be scanned.\nRaw disk images with more partitions than this value will have up to the value number partitions scanned.\nNegative values are not allowed.\nWARNING: setting this limit too high may result in severe damage or impact performance.", "128" },
379 379
 
380 380
     /* OnAccess settings */
381 381
     { "ScanOnAccess", NULL, 0, TYPE_BOOL, MATCH_BOOL, -1, NULL, 0, OPT_CLAMD, "This option enables on-access scanning (Linux only)", "no" },