Add info about testing/debugging the configuration file snf4sa.cf.

git-svn-id: https://svn.microneil.com/svn/PKG-SNF-CS-NIX/trunk@5 233e721a-07f6-49eb-a7da-05e0e16828fc

SNF_CS_Developer_Package.3.0.2_p4/SNF4SA/INSTALL

@@ -63,21 +63,23 @@ SpamAssassin documentation for other options.
 To specify the relationship between the SNFServer results and the
 SpamAssassin score, enter zero or more lines with the format:
 
-  snf_result: NN sa_score: S short_circuit: YES_OR_NO
+  snf_result NN sa_score S short_circuit_[yes|no]
 
 where NN specifies the SNFServer result, and S is the SpamAssassin
-score for that SNFServer result.  YES_OR_NO is "yes" if further
+score for that SNFServer result.  [yes|no] is "yes" if further
 scanning should be skipped if SNFServer returns the result specified
 by NN, or "no" if further scanning should not be skipped.  NN can be a
 combination of a series of one or more integers, and a range of
 integers specified by N-M, where N and M are integers.  The
-"short_circuit: YES_OR_NO" is optional, and the default value for
-YES_OR_NO is "no" (which specifies that SpamAssasin continue
-scanning).
+"short_circuit_[yes|no]" is optional, and the default value for
+[yes|no] is "no" (which specifies that SpamAssasin continue scanning).
+
+NOTE: There must not be any space when specifying a range of integers.
+For example, specify "34-43" rather than the incorrect "34 - 43".
 
 For example:
 
-  snf_result: 63 sa_score: 2.5 short_circuit: no
+  snf_result 63 sa_score 2.5 short_circuit_no
 
 causes the plugin to add 2.5 to the SpamAssassin score if SNFServer
 returns 63 (which in the default SNFServer configuration corresponds
@@ -85,14 +87,14 @@ to "caution").
 
 Another example:
 
-  snf_result: 45 47-62 sa_score: 5.0 short_circuit: yes
+  snf_result 45 47-62 sa_score 5.0 short_circuit_yes
 
 causes the plugin to add 5.0 to the SpamAssassin score and stop
 further processing if SNFServer returns 45 or 47 thru 62.
 
 Final example:
 
-  snf_result: 1 sa_score: -5.0
+  snf_result 1 sa_score -5.0
 
 causes the plugin to subtract 5.0 from the SpamAssassin score.
 SpamAssassin continues to process the email.
@@ -102,10 +104,30 @@ adds zero to the SpamAssassin score.
 
 The following line specifies the MaxWeight parameter:
 
-  GBUdb_max_weight: MaxWeight
+  GBUdb_max_weight MaxWeight
 
 where MaxWeight is the value to specify.  For example,
 
-  GBUdb_max_weight: 3.0
+  GBUdb_max_weight 3.0
 
 specifies a MaxWeight value of 3.0.
+
+Debugging the configuration
+---------------------------
+
+The configuration can be tested by running
+
+    spamassassin --lint
+
+This outputs a message if any line in in the configuration file cannot
+be parsed, along with the offending line.
+
+In order to obtain more detailed information, run
+
+   spamassassin -D --lint
+
+This command outputs information about why a line could not be parsed.
+The output includes a great deal of other debugging information; you
+can filter the information relevant to this plugin like this:
+
+   spamassassin -D --lint 2>&1 | grep snf4sa