[PATCH v2] Re: MANUAL.rst: Improve with Perf tips and SSL notes

[Nicolas Sebrecht]

On Sun, Jul 10, 2011 at 10:03:38PM +0200, Sebastian Spaeth wrote:

> I agree, we need to think about how to arrange our documentation. Right
> now the manual is just a description of hte command line options and a
> very verbose description of the various UIs.

Right. We could split it in two manuals like

  offlineimap(1)
  offlineimap_tips(7)

> If it's called MANUAL, I think, it can take some more explanations,
> tipps and tricks, and example configurations, to make it a real
> manual. The most interesting part right now is in the FAQ (as a user) or
> the API docs (as a developer).

For the configuration file I'd rather another manual page

  offlineimap_conf(5)

IMHO, the API docs should stay as text file in the repository and the
FAQ should be cleaned by setting part of the documentation in the above
manuals.

-- 
Nicolas Sebrecht