external/ibm-public/postfix/dist/proto/README

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