
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 TRANSITIONAL//EN">

<HTML>

<HEAD>

  <META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=UTF-8">

  <META NAME="GENERATOR" CONTENT="GtkHTML/3.16.3">

</HEAD>

<BODY>

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.<BR>

<BR>

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.<BR>

<BR>

On Mon, 2009-02-09 at 08:50 +0000, Poul-Henning Kamp wrote:

<BLOCKQUOTE TYPE=CITE>

<PRE>

<FONT COLOR="#000000">In message <<A HREF="mailto:498FEDE4.7060108@redpill-linpro.com">498FEDE4.7060108@redpill-linpro.com</A>>, Per Andreas Buer writes:</FONT>

<FONT COLOR="#000000">>Hi,</FONT>

<FONT COLOR="#000000">></FONT>

<FONT COLOR="#000000">>There is a lot of confusion regarding the documentation. Some of it is</FONT>

<FONT COLOR="#000000">>in the wiki and some of it is in the manual. Some of it is missing - but</FONT>

<FONT COLOR="#000000">>as always, we're working on that. :-)</FONT>

<FONT COLOR="#000000">></FONT>

<FONT COLOR="#000000">>Should we drop the man pages? Should we drop all of them or just "man</FONT>

<FONT COLOR="#000000">>vcl"? Dropping a man page would men we would incorporate the content</FONT>

<FONT COLOR="#000000">>into the wiki - maybe adding a few extra ACL's on the pages to restrict</FONT>

<FONT COLOR="#000000">>editing.</FONT>


<FONT COLOR="#000000">I think there should be a manpage for the executables, varnishd, varnishlog,</FONT>

<FONT COLOR="#000000">varnishstat etc.</FONT>


<FONT COLOR="#000000">But for documenting the overall workings and VCL in particular, manpages</FONT>

<FONT COLOR="#000000">suffer badly from the inability to include sensible illustrations.</FONT>


</PRE>

</BLOCKQUOTE>

<BR>

</BODY>

</HTML>