I agree; man pages are normally used (in my experience) to describe how to access program control instructions, such as parameters, description and exit codes.
I think the best approach would be this split, with a static html (or other format) of the wiki documentation included in the distributable archive. On Mon, 2009-02-09 at 08:50 +0000, Poul-Henning Kamp wrote: > In message <[email protected]>, Per Andreas Buer writes: > >Hi, > > > >There is a lot of confusion regarding the documentation. Some of it is > >in the wiki and some of it is in the manual. Some of it is missing - but > >as always, we're working on that. :-) > > > >Should we drop the man pages? Should we drop all of them or just "man > >vcl"? Dropping a man page would men we would incorporate the content > >into the wiki - maybe adding a few extra ACL's on the pages to restrict > >editing. > > I think there should be a manpage for the executables, varnishd, varnishlog, > varnishstat etc. > > But for documenting the overall workings and VCL in particular, manpages > suffer badly from the inability to include sensible illustrations. >
_______________________________________________ varnish-misc mailing list [email protected] http://projects.linpro.no/mailman/listinfo/varnish-misc
