[Dovecot] Dovecot documentation WAS: Re: Question regarding Postfix and Dovecot
tss at iki.fi
Tue Mar 19 19:25:20 EET 2013
On Mon, 2013-03-18 at 23:15 -0500, Stan Hoeppner wrote:
> Do you have a way to simply dump all the current conf file parameter
> names from 2.x into a single column text file?
With "doveconf -d" you get all the settings and also the defaults. The
docs probably should mention the defaults also.
> I'll sort it and start
> adding the legal parameter values and writing the parameter definitions
> from information currently available in source and wiki pages. When I
> hit the point I can't find reference material for the rest of the
> parameters, we can dump it to a wiki page or similar so others with the
> knowledge can jump in and help finish it. Once it's done, myself, or
> someone else if they already have the experience, can create the man
> page from this to be included in the source. And you can create an
> update mechanism/batch process so that updating the 'master' document
> automatically updates the source man page and other published versions,
> making documentation updates simple when you add/change parameters.
Yes, definitely something that generates all the docs from a single
source. There is of course still going to be some duplication with a)
example config files and b) the more context-specific wiki pages.
I guess once that reference doc is done, the example config could be put
to web with all the settings as links to the reference.
I think the reference should also have pointers to the more generic wiki
pages about the subject, such as ssl_* settings having a pointer to the
"SSL" wiki page. That pointer could be a generic small icon in the
HTML/wiki version, not sure about the man version.
> If this is acceptable to you Timo, let me know. If so send me the
> aforementioned file, any preferences/thoughts you have, and I'll get
> started on the first draft.
More information about the dovecot