From owner-freebsd-doc@FreeBSD.ORG  Thu Aug 19 12:23:38 2004
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id C724016A4CE
	for <freebsd-doc@freebsd.org>; Thu, 19 Aug 2004 12:23:38 +0000 (GMT)
Received: from mail.pushitlive.net (mail.pushitlive.net [24.106.18.115])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 815A243D2F
	for <freebsd-doc@freebsd.org>; Thu, 19 Aug 2004 12:23:38 +0000 (GMT)
	(envelope-from duerra@pushitlive.net)
Received: from [127.0.0.1] (pushitlive.net [24.106.18.114])
	by mail.pushitlive.net (Postfix) with ESMTP id C4313261AB5
	for <freebsd-doc@freebsd.org>; Thu, 19 Aug 2004 07:23:35 -0500 (CDT)
Message-ID: <41249BC4.7000205@pushitlive.net>
Date: Thu, 19 Aug 2004 07:23:32 -0500
From: Anthony Duerr <duerra@pushitlive.net>
User-Agent: Mozilla Thunderbird 0.7.3 (Windows/20040803)
X-Accept-Language: en-us, en
MIME-Version: 1.0
To: freebsd-doc@freebsd.org
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Subject: Man Pages Thoughts
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 19 Aug 2004 12:23:38 -0000

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 =)