Should we keep the man pages?

Justin Finkelstein justin at redwiredesign.com
Mon Feb 9 14:26:04 CET 2009


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 <498FEDE4.7060108 at redpill-linpro.com>, 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.
> 


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://www.varnish-cache.org/lists/pipermail/varnish-misc/attachments/20090209/c4c3874c/attachment-0001.html>


More information about the varnish-misc mailing list