Refs. #15. Add documentation about the whitelist service.

SpamExperts · Sep 2, 2014 · 000d999 · 000d999
1 parent d864507
commit 000d999
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/docs/client.rst b/docs/client.rst
@@ -92,12 +92,18 @@ and 0 whitelist, regardless of the message::
 Predigest
 ^^^^^^^^^^^
 
-Prints the message after the predigest phase of the pyzor algorithm.
+Prints the message after the predigest phase of the pyzor algorithm::
+
+	$ pyzor predigest < test.eml
+	Thisisatest.
 
 Digest
 ^^^^^^^^^
 
-Prints the message digest, that will be sent to the server.
+Prints the message digest, that will be sent to the server::
+
+	$ pyzor digest < spam.eml
+	c3a8e8d987f07843792d2ab1823b04cc3cb87482
 
 Genkey
 ^^^^^^^^

diff --git a/docs/index.rst b/docs/index.rst
@@ -27,6 +27,7 @@ Contents:
    installation.rst
    usage.rst
    config.rst
+   whitelist.rst
    changelog.rst
    about.rst   
    pyzor.rst

diff --git a/docs/whitelist.rst b/docs/whitelist.rst
@@ -0,0 +1,11 @@
+Whitelisting
+============
+
+Whitelisting messages is disabled by default on the public server 
+(``public.pyzor.org``). However if you want to request a whitelist you can 
+use the web service at::
+
+http://public.pyzor.org/whitelist/  
+
+You need to upload the raw message and the corresponding pyzor message digest.
+