1 |
File: libspf-1.0.0-RC5/docs/README |
2 |
Date: 09/15/04 |
3 |
Desc: README for libSPF 1.0 documentation |
4 |
|
5 |
libSPF documentation is broken down into the following components. |
6 |
Firstly there is API documentation which consists of a Doxygen |
7 |
doc tree, as well as pieces submitted by the authors of this |
8 |
library. |
9 |
|
10 |
|
11 |
history - History (deprecated documentation but still useful) |
12 |
|
13 |
- You'll find all the old CHANGELOG's within this dir |
14 |
|
15 |
API - Application Programming Interface |
16 |
|
17 |
- DOXYGEN |
18 |
|
19 |
- A DOXYGEN tree which encompasses the entire library |
20 |
breaking apart every function, type, define etc.. |
21 |
and creating hyperlinks all throughout the pages |
22 |
allowing you to easily discover where a particular |
23 |
piece of information originates whilst reviewing the |
24 |
literal code or broken down explanations and |
25 |
definitions of each. |
26 |
|
27 |
- debugging_libspf_1.0.pdf |
28 |
|
29 |
- A comprehensive document on how to interact with |
30 |
the libSPF debugging factility |
31 |
|
32 |
- api_cache.html |
33 |
|
34 |
- A short, but informative article which talk sbaout the |
35 |
DNS caching available within libSPF and why the cache |
36 |
is implemented the way it is (AVL-Tree instead of the |
37 |
commonly used hash table). |
38 |
|
39 |
RFC - Requests for Comments |
40 |
|
41 |
- This is the technical document used as a roadmap for |
42 |
libSPF. It describes the ways SPF may be implemented |
43 |
from the optional to the mandatory. |
44 |
|
45 |
qmail - qmail (best damn mta on earth) |
46 |
|
47 |
- netqmail-1.05-libspf-1.0.0-RC5-HOWTO.html |
48 |
- A step by step (with literal output) process of how |
49 |
to patch netqmail-1.05 with libSPF. |
50 |
|
51 |
- tcpserver_vars.html |
52 |
- A comprehensive explanation of the tcpserver variables |
53 |
which libSPF adds which are available for use within |
54 |
qmail and facilitate controlling the behaviour of |
55 |
libSPF without ever touching a control file. |
56 |
|
57 |
- control_files.html |
58 |
- A document that is similar to the tcpserver_vars |
59 |
document except that its focus is on explaining all of |
60 |
the available qmail control files that one can create |
61 |
to facilitate controlling the behaviour of libSPF. |
62 |
|
63 |
Sendmail - Sendmail |
64 |
|
65 |
- sendmail-8.13.1+libspf-1.0-HOWTO.pdf |
66 |
- A step by step (with literal output) process of how to |
67 |
patch Sendmail v8.13.1 with libSPF. |
68 |
|
69 |
- sendmail-8.12.x-libspf-0.2x-HOWTO |
70 |
- A HOWTO for patching Sendmail v8.12.x with libSPF |
71 |
|
72 |
- sendmail.cf.example |
73 |
- An example sendmail.cf file from a Sendmail server after |
74 |
having been patched with libSPF |
75 |
|
76 |
spfmilter - Sendmail 'spfmilter' |
77 |
|
78 |
- spfmilter-HOWTO |
79 |
- A Quick guide to installing the Sendmail spfmilter |
80 |
|
81 |
- spf-redhat.init |
82 |
- A Red Hat specific init script |
83 |
|
84 |
- spfmilter.sysconfig |
85 |
- A spfmilter config file example |
86 |
|
87 |
Courier-MTA - The Courier MTA |
88 |
- Documentation relative to patching Courier with libSPF. |
89 |
|
90 |
spfqtool - The libSPF Query Tool |
91 |
- The source code is available featuring syntax highlighted |
92 |
HTML. The goal of spfqtool is threefold: |
93 |
|
94 |
1) Provide an easy method to test libSPF for RFC compliance. |
95 |
2) Provide would-be developers with an implementation |
96 |
example of the libSPF API |
97 |
3) Provide end-users with a tool to easy and powerfully test |
98 |
their SPF published records for accuracy. |
99 |
|
100 |
|
101 |
EOF |