svn commit: r169847 - /spamassassin/trunk/spamc/spamc.pod

[jm...@apache.org]

Author: jm
Date: Thu May 12 09:58:07 2005
New Revision: 169847

URL: http://svn.apache.org/viewcvs?rev=169847&view=rev
Log:
add a sample config file to the POD doc

Modified:
    spamassassin/trunk/spamc/spamc.pod

Modified: spamassassin/trunk/spamc/spamc.pod
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/spamc/spamc.pod?rev=169847&r1=169846&r2=169847&view=diff
==============================================================================
--- spamassassin/trunk/spamc/spamc.pod (original)
+++ spamassassin/trunk/spamc/spamc.pod Thu May 12 09:58:07 2005
@@ -41,15 +41,9 @@
 
 =head1 OPTIONS
 
-All options detailed below can be passed as command line arguments, or
-be contained in a configuration file. The layout of the configuration
-file is :
-
-B<[option]> B<(value)>
-
-B<(value)> is required for any options that require an argument.
-Whitespace and new lines delimit the options. Blank lines, and lines
-beginning with a '#' are ignored.
+All options detailed below can be passed as command line arguments, or be
+contained in a configuration file, as described in the B<CONFIGURATION FILE>
+section below.
 
 =over
 
@@ -215,6 +209,17 @@
 C</opt>, C</etc/opt/mail/spamassassin/spamc.conf> will be attempted. If those
 don't exist, C</etc/spamc.conf> will be appended to the prefix and tried. If
 none of those exist, no configuration file will be read by default.
+
+Example:
+
+    # spamc global configuration file 
+    
+    # connect to "server.example.com", port 783
+    -d server.example.com
+    -p 783
+
+    # max message size for scanning = 350k
+    -s 350000
 
 =head1 EXIT CODES