| 1 | .\" $Id: dspam_stats.1,v 1.14 2011/06/28 00:13:48 sbajic Exp $ |
|---|
| 2 | .\" -*- nroff -*- |
|---|
| 3 | .\" |
|---|
| 4 | .\" dspam_stats3.9 |
|---|
| 5 | .\" |
|---|
| 6 | .\" Authors: Jonathan A. Zdziarski <jonathan@nuclearelephant.com> |
|---|
| 7 | .\" Stevan Bajic <stevan@bajic.ch> |
|---|
| 8 | .\" |
|---|
| 9 | .\" Copyright (C) 2002-2012 DSPAM Project |
|---|
| 10 | .\" All rights reserved |
|---|
| 11 | .\" |
|---|
| 12 | .TH dspam_stats 1 "Apr 17, 2010" "DSPAM" "DSPAM" |
|---|
| 13 | |
|---|
| 14 | .SH NAME |
|---|
| 15 | dspam_stats \- display spam statistics |
|---|
| 16 | |
|---|
| 17 | .SH SYNOPSIS |
|---|
| 18 | .na |
|---|
| 19 | .B dspam_stats |
|---|
| 20 | [\c |
|---|
| 21 | .B \--profile\c |
|---|
| 22 | =PROFILE]\c |
|---|
| 23 | [\c |
|---|
| 24 | .BI \-HhrSst\fR\c |
|---|
| 25 | ] |
|---|
| 26 | [\c |
|---|
| 27 | .I username\fR\c |
|---|
| 28 | ] |
|---|
| 29 | |
|---|
| 30 | .ad |
|---|
| 31 | .SH DESCRIPTION |
|---|
| 32 | .LP |
|---|
| 33 | .B dspam_stats |
|---|
| 34 | displays the spam filtering statistics for one or all users on the system. |
|---|
| 35 | Displays TP (True Positives (Spam)), TN (True Negatives (Innocent)), FP |
|---|
| 36 | (False Positives), FN (False Negatives), SC (Spam Corpusfed) and NC |
|---|
| 37 | (Nonspam Corpusfed). |
|---|
| 38 | |
|---|
| 39 | .SH OPTIONS |
|---|
| 40 | .LP |
|---|
| 41 | |
|---|
| 42 | .ne 3 |
|---|
| 43 | .TP |
|---|
| 44 | .BI \ \--profile= \PROFILE\c |
|---|
| 45 | Specify a storage profile from dspam.conf. The storage profile selected will be used |
|---|
| 46 | for all database connectivity. See dspam.conf for more information. |
|---|
| 47 | |
|---|
| 48 | .ne 3 |
|---|
| 49 | .TP |
|---|
| 50 | .BI \-H\fR\c |
|---|
| 51 | Uses multi\-line, human\-readable output displaying the fully\-qualified names for |
|---|
| 52 | each class of totals, instead of their abbreviated terms. |
|---|
| 53 | |
|---|
| 54 | .ne 3 |
|---|
| 55 | .TP |
|---|
| 56 | .BI \-h\fR\c |
|---|
| 57 | Displays help syntax |
|---|
| 58 | |
|---|
| 59 | .ne 3 |
|---|
| 60 | .TP |
|---|
| 61 | .BI \-r\fR\c |
|---|
| 62 | Resets the current snapshot |
|---|
| 63 | |
|---|
| 64 | .ne 3 |
|---|
| 65 | .TP |
|---|
| 66 | .BI \-s\fR\c |
|---|
| 67 | Displays stats since last snapshot (instead of since epoch) |
|---|
| 68 | |
|---|
| 69 | .ne 3 |
|---|
| 70 | .TP |
|---|
| 71 | .BI \-S\fR\c |
|---|
| 72 | Displays accuracy percentages in addition to stats |
|---|
| 73 | |
|---|
| 74 | .ne 3 |
|---|
| 75 | .TP |
|---|
| 76 | .BI \-t\fR\c |
|---|
| 77 | Displays a total of all statistics displayed |
|---|
| 78 | |
|---|
| 79 | .ne 3 |
|---|
| 80 | .TP |
|---|
| 81 | .BI [username]\c |
|---|
| 82 | Specifies the username to query. If no username is provided, all users will be |
|---|
| 83 | queried. |
|---|
| 84 | |
|---|
| 85 | .SH EXIT VALUE |
|---|
| 86 | .LP |
|---|
| 87 | .ne 3 |
|---|
| 88 | .PD 0 |
|---|
| 89 | .TP |
|---|
| 90 | .B 0 |
|---|
| 91 | Operation was successful. |
|---|
| 92 | .ne 3 |
|---|
| 93 | .TP |
|---|
| 94 | .B other |
|---|
| 95 | Operation resulted in an error. |
|---|
| 96 | .PD |
|---|
| 97 | |
|---|
| 98 | .SH COPYRIGHT |
|---|
| 99 | Copyright \(co 2002\-2012 DSPAM Project |
|---|
| 100 | .br |
|---|
| 101 | All rights reserved. |
|---|
| 102 | .br |
|---|
| 103 | |
|---|
| 104 | For more information, see http://dspam.sourceforge.net. |
|---|
| 105 | |
|---|
| 106 | .SH SEE ALSO |
|---|
| 107 | .BR dspam (1), |
|---|
| 108 | .BR dspam_admin (1), |
|---|
| 109 | .BR dspam_clean (1), |
|---|
| 110 | .BR dspam_crc (1), |
|---|
| 111 | .BR dspam_dump (1), |
|---|
| 112 | .BR dspam_logrotate (1), |
|---|
| 113 | .BR dspam_merge (1), |
|---|
| 114 | .BR dspam_train (1) |
|---|
