On Fri, 2005-11-11 at 23:04 +0100, Thomas Anders wrote:
> Dave Shield wrote:
> >    What do people think about splitting this into a number
> > of separate man pages? 


> I'm not convinced splitting (a lot) is too helpful.

Having to look through a multitude of itty-bitty man
pages is obviously not a good thing.  But neither is
having to plough through an overly-long man page.
It's a matter of finding the right balance.

>                                      I often search 
> through the man page looking for the token/topic I'm
> interested in which is much easier with a single
> snmpd.conf(5) document.

OK - I'll leave things as a single man page for now,
and we'll see how it looks when I've finished massaging
it.  We can always split it later if that seems sensible.


>                                 That said, I can see an
> argument for documenting the *persistent* configuration in a 
> separate man page as has been previously proposed/discussed.

Yup.
I'm also inclined to split off the examples into a separate
cookbook-style man page (probably following the same structure
as the main snmpd.conf(5)).
   That would allow us to beef up some of the examples,
without overload things for a simple lookup.

But I'll get the main man page documentation finished first.

Dave


-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server. Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP.  Click here to play: http://sourceforge.net/geronimo.php
_______________________________________________
Net-snmp-coders mailing list
Net-snmp-coders@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/net-snmp-coders

Reply via email to