Browse code

Document the new stats feature in manpages and help text

Shawn Webb authored on 2014/03/08 03:59:17
Showing 6 changed files
... ...
@@ -279,6 +279,10 @@ void help(void)
279 279
     mprintf("    --max-ziptypercg=#n                  Maximum size zip to type reanalyze\n");
280 280
     mprintf("    --max-partitions=#n                  Maximum number of partitions in disk image to be scanned\n");
281 281
     mprintf("    --max-iconspe=#n                     Maximum number of icons in PE file to be scanned\n");
282
+    mprintf("    --enable-stats                       Enable statistical reporting of malware\n");
283
+    mprintf("    --disable-pe-stats                   Disable submission of individual PE sections in stats submissions\n");
284
+    mprintf("    --stats-timeout=#n                   Number of seconds to wait for waiting a response back from the stats server\n");
285
+    mprintf("    --stats-host-id=UUID                 Set the Host ID used when submitting statistical info.\n");
282 286
     mprintf("\n");
283 287
     mprintf("(*) Default scan settings\n");
284 288
     mprintf("(**) Certain files (e.g. documents, archives, etc.) may in turn contain other\n");
... ...
@@ -656,6 +656,26 @@ Default: 5M
656 656
 Disable authenticode certificate chain verification in PE files.
657 657
 .br
658 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
659 679
 .SH "NOTES"
660 680
 .LP 
661 681
 All options expressing a size are limited to max 4GB. Values in excess will be resetted to the maximum.
... ...
@@ -213,6 +213,18 @@ This option sets the maximum number of partitions of a raw disk image to be scan
213 213
 .TP
214 214
 \fB\-\-max\-iconspe=#n\fR
215 215
 This option sets the maximum number of icons within a PE to be scanned. This must be a positive integer (default: 100).
216
+.TP
217
+\fB\-\-enable\-stats\fR
218
+This option enables submission of statistical data. (Default: stats submissions disabled)
219
+.TP
220
+\fB\-\-stats\-host\-id\fR
221
+This option sets the HostID, in the form of an UUID, to use when submitting statistical information.
222
+.TP
223
+\fB\-\-disable\-pe\-stats\fR
224
+This option disables the submission of PE section data. (Default: submitting of PE section data enabled if stats submissions as a whole is enabled).
225
+.TP
226
+\fB\-\-stats\-timeout=#n\fR
227
+This option sets the timeout in seconds to wait for communication back from the stats server. (Default: 10).
216 228
 .SH "EXAMPLES"
217 229
 .LP 
218 230
 .TP 
... ...
@@ -80,6 +80,12 @@ Upload detection statistics to the ClamAV Project (see freshclam.conf(5):SubmitD
80 80
 .TP
81 81
 \fB\-\-update\-db=DBNAME\fR
82 82
 With this option you can limit updates to a subset of database files. The DBNAME should be "main", "daily", "bytecode", "safebrowsing" or one of the 3rd party database names. This option can be used multiple times and only works with the official and 3rd party databases distrubuted through the ClamAV mirrors, your custom databases (specified with DatabaseCustomURL in freshclam.conf) will not be ignored.
83
+.TP
84
+\fB\-\-enable\-stats\fR
85
+Enable submission of statistical data.
86
+.TP
87
+\fB\-\-stats\-host\-id=UUID\fR
88
+HostID in the form of an UUID to use when submitting statistical information.
83 89
 .SH "EXAMPLES"
84 90
 .LP 
85 91
 .TP 
... ...
@@ -582,3 +582,23 @@ Example
582 582
 # 
583 583
 # Default: 5000
584 584
 # BytecodeTimeout 1000
585
+
586
+##
587
+## Statistics gathering and submitting
588
+##
589
+
590
+# Enable statistical reporting.
591
+# Default: no
592
+#StatsEnabled yes
593
+
594
+# Disable submission of individual PE sections for files flagged as malware.
595
+# Default: no
596
+#StatsPEDisabled yes
597
+
598
+# HostID in the form of an UUID to use when submitting statistical information.
599
+# Default: auto
600
+#StatsHostID auto
601
+
602
+# Time in seconds to wait for the stats server to come back with a response
603
+# Default: 10
604
+#StatsTimeout 10
... ...
@@ -198,7 +198,9 @@ help (void)
198 198
     mprintf
199 199
         ("    --list-mirrors                       print mirrors from mirrors.dat\n");
200 200
     mprintf
201
-        ("    --submit-stats[=/path/clamd.conf]    only submit detection statistics\n");
201
+        ("    --enable-stats                       enable statistical information reporting\n");
202
+    mprintf
203
+        ("    --stats-host-id=UUID                 HostID in the form of an UUID to use when submitting statistical information\n");
202 204
     mprintf
203 205
         ("    --update-db=DBNAME                   only update database DBNAME\n");
204 206