Modules should be self documenting.

I've considered DTDs and RelaxNG for this, but as the config is inherited, there is no good what to use with for validation -- which eliminates much of their purpose. I think some simple documentation like:

• keyname
• allowed values
• description
• required/optional/dependent/etc.

<module>
  <name>Terse Name</name>
  <description>Longer purpose statement</description>
  <loader>C/lua</loader>
  <image>module.so</image>
  <object>lua.module.name</object>
  <moduleconfig>
    <parameter name="regex" required="true" allowed="regex">Description</parameter>
    <parameter ... />
  </moduleconfig>
  <checkconfig>
    <parameter name="regex" required="true" allowed="regex">Description</parameter>
    <parameter ... />
  </checkconfig>
  <examples>
    <example>....</example>
    <example>....</example>
  </examples>
</module>

forgot to ref this ticket from [399]

(In [416]) pull help and docs into the console, refs #21

I think the premise is done here. The rest should be a new exercise.

(In [417]) ignore and some varnish docs, refs #21

(In [419]) more docs, fixups.. Better smtp options and docs. refs #21

(In [420]) autobuild docs form lua stuff... the things you can do in lua are as evil as perl, refs #21

(In [422]) oops, extract_xml.lua produces just the meta XML, need to docbook it, refs #21

(In [425]) integrate command line docs as usage, refs #21

(In [427]) integrate command line docs as usage, refs #21