1This directory contains source for manual pages that aren't generated
2from C source code comments, and for README files.
3
4Tools for these conversions are found in the ../mantools subdirectory.
5The most important tool is postlink, which adds all the hyperlinks
6between manual pages, configuration parameters and README files.
7
8Manual pages are in the form of "shell" style comments.  They are
9converted into nroff(1) input with the srctoman utility, converted
10to HTML with man2html, and hyperlinked with postlink.
11
12The README files are in the form of HTML. The are converted into
13hyperlinked HTML with postlink, and are converted into ASCII files
14with html2readme.
15
16The format of the README source files is a little tricky, because
17of the way postlink works.
18
19- postlink hyperlinks all the references to Postfix manual pages,
20configuration parameters, README file names, RFC documents, Postfix
21address class names, and URLs.  Therefore you should not hyperlink
22those elements yourself.
23
24- URLs (such as "http://www.example.com") cannot contain quote, comma,
25or space characters. 
26
27- An URL that appears at the end of a line must be followed by one
28other character.
29
30- Text must go between <p> and </p>, especially within lists, for
31consistency of vertical space.
32
33- Code fragments must go between <pre> and </pre>, again for
34consistency of vertical space.
35