Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 19 Aug 2004 07:23:32 -0500
From:      Anthony Duerr <duerra@pushitlive.net>
To:        freebsd-doc@freebsd.org
Subject:   Man Pages Thoughts
Message-ID:  <41249BC4.7000205@pushitlive.net>

next in thread | raw e-mail | index | archive | help
Greetings,
My thoughts are concerning the man pages.  I don't know if this is the 
perfect group to mail this to, but it seems to be as close as I could get.

Anyway, a thought occured to me this morning when reading through some 
documentation.  It would be great to see an "Examples" section in the 
man pages.  Often times the prototypes are difficult to read or 
understand because of their length, option depth, etc.  An "Examples" 
area in the man pages would allow the man creator to put in a couple of 
the more commonly used prototypes examples in to get a user started on 
the right track.

Granted, this would mostly be beneficial to newer users like me, but it 
would save quite a bit of frustration when trying to process the vast 
array of different commands in my mind.

I'm interested in your thoughts!

Thanks =)



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?41249BC4.7000205>