AAAREADME
1Purpose of this document
2========================
3
4This document provides a road map of the Postfix mail system source
5code distribution. I suggest that you
6
7- take a few minutes to read this file,
8
9- review the RELEASE_NOTES file for incompatible changes,
10
11- and then proceed with the INSTALL instructions.
12
13Introduction
14============
15
16This is the public release of the Postfix mail system. Thank you
17for your interest in this project. Send me a postcard if you like
18it. My postal address is below.
19
20You must read the LICENSE file, if you didn't do so already. A copy
21of the LICENSE must be distributed with every original, modified,
22complete, source, or binary copy of this software or parts thereof.
23I suggest that you keep a copy of the file in /etc/postfix/LICENSE.
24
25Purpose of the Postfix mail system
26==================================
27
28Postfix aims to be an alternative to the widely-used sendmail
29program.
30
31Although IBM supported the Postfix development, it abstains from
32control over its evolution. The goal is to have Postfix installed
33on as many systems as possible. To this end, the software is given
34away with no strings attached to it, so that it can evolve with
35input from and under control by its users.
36
37In other words, IBM releases Postfix only once. I will be around
38to guide its development for a limited time.
39
40On-line resources devoted to the Postfix mail system
41====================================================
42
43Web sites:
44
45 http://www.postfix.org/ current release information
46
47Mail addresses (PLEASE send questions to the mailing list)
48
49 postfix-users@postfix.org Postfix users mailing list
50
51In order to subscribe to the mailing list, see http://www.postfix.org/.
52
53Acknowledgments
54===============
55
56This release could not have happened without the input from a team
57of competent alpha testers. Their names appear in numerous places
58in the HISTORY file. I appreciate the input from my colleagues at
59the IBM Global Security Analysis Laboratory: Paul Karger, Dave
60Safford, Douglas Schales, and Leendert van Doorn. I also appreciate
61the support by Charles Palmer under whose leadership I began this
62project, and who had the privilege to name the software, twice.
63
64If you wish to express your appreciation for the Postfix software,
65you are welcome to send a postcard to:
66
67 Wietse Venema
68 IBM T.J Watson Research Center
69 P.O. Box 704,
70 Yorktown Heights, NY 10598
71 USA
72
73Roadmap of the Postfix source distribution
74==========================================
75
76The RELEASE_NOTES file describes new features, and lists incompatible
77changes with respect to previous Postfix versions.
78
79The INSTALL file provides a step-by-step guide for building and
80installing Postfix on many popular UNIX platforms.
81
82The COMPATIBILITY file lists features that Postfix does or does
83not yet implement, and how well it works with other software.
84
85The HISTORY file gives a detailed log of changes to the software.
86
87Point your browser at html/index.html for Postfix documentation
88and for hyperlinked versions of Postfix manual pages. Expect
89to see updated versions on-line at http://www.postfix.org/
90
91Point your MANPATH environment variable at the `man' directory (use
92an absolute path) for UNIX-style on-line manual pages. These pages
93are also available through the HTML interface, which allows you to
94navigate faster.
95
96The PORTING file discusses how to go about porting Postfix to other
97UNIX platforms.
98
99Documentation:
100
101 README_FILES/ Instructions for specific Postfix features
102 html/ HTML format
103 man/ UNIX on-line manual page format
104
105Example files:
106
107 conf/ configuration files, run-time scripts
108 examples/ chroot environments, virtual domains
109
110Library routines:
111
112 src/dns/ DNS client library
113 src/global/ Postfix-specific support routines
114 src/milter/ Postfix Milter (mail filter) client
115 src/tls/ TLS client and server support
116 src/util/ General-purpose support routines
117 src/xsasl/ SASL plug-in API
118
119Command-line utilities:
120
121 src/postalias/ Alias database management
122 src/postcat/ List Postfix queue file
123 src/postconf/ Configuration utility
124 src/postdrop/ Postfix mail submission program
125 src/postfix/ Postfix administrative interface
126 src/postkick/ Postfix IPC for shell scripts
127 src/postlock/ Postfix locking for shell scripts
128 src/postlog/ Postfix logging for shell scripts
129 src/postmap/ Postfix lookup table management
130 src/postmulti/ Postfix multi-instance manager
131 src/postqueue/ Postfix queue control program
132 src/postsuper/ Postfix house keeping program
133 src/sendmail/ Sendmail compatibility interface
134
135Postfix daemons:
136
137 src/anvil/ Connection count/rate limiter
138 src/bounce/ Bounce or defer mail
139 src/cleanup/ Canonicalize and enqueue mail
140 src/discard/ Trivial discard mailer
141 src/dnsblog/ DNS agent for postscreen
142 src/error/ Trivial error mailer
143 src/flush/ Support for ETRN, sendmail -qI, sendmail -qR
144 src/local/ Local delivery
145 src/master/ Postfix resident superserver
146 src/oqmgr/ Old queue manager
147 src/pickup/ Local pickup
148 src/pipe/ Pipe delivery
149 src/postscreen/ Zombie blocker
150 src/proxymap/ Table lookup proxy agent
151 src/qmgr/ Queue manager
152 src/qmqpd/ QMQPD server
153 src/scache/ Postfix SMTP session cache
154 src/showq/ List Postfix queue status
155 src/smtp/ SMTP and LMTP client
156 src/smtpd/ SMTP server
157 src/spawn/ Run non-Postfix server
158 src/tlsmgr/ TLS session keys and random pool
159 src/tlsproxy/ TLS proxy for postscreen
160 src/trivial-rewrite/ Address rewriting and resolving
161 src/verify/ address verification service
162 src/virtual/ virtual mailbox-only delivery agent
163
164Test programs:
165
166 src/fsstone/ Measure file system overhead
167 src/posttls-finger/ Postfix SMTP/LMTP TLS probe utility
168 src/smtpstone/ SMTP and QMQP server torture test
169
170Miscellaneous:
171
172 auxiliary/ Auxiliary software etc.
173 bin/ Postfix command executables
174 conf/ Configuration files, run-time scripts
175 include/ Include files
176 implementation-notes/ Background information
177 lib/ Object libraries
178 libexec/ Postfix daemon executables
179 mantools/ Documentation utilities
180 proto/ Documentation source
181