From owner-freebsd-doc@FreeBSD.ORG Thu Aug 19 20:28:04 2004 Return-Path: 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 635EA16A4CE for ; Thu, 19 Aug 2004 20:28:04 +0000 (GMT) Received: from aiolos.otenet.gr (aiolos.otenet.gr [195.170.0.23]) by mx1.FreeBSD.org (Postfix) with ESMTP id 1A73543D3F for ; Thu, 19 Aug 2004 20:27:31 +0000 (GMT) (envelope-from keramida@ceid.upatras.gr) Received: from gothmog.gr (patr530-a070.otenet.gr [212.205.215.70]) i7JKRLp3012977; Thu, 19 Aug 2004 23:27:25 +0300 Received: from gothmog.gr (gothmog [127.0.0.1]) by gothmog.gr (8.13.1/8.13.1) with ESMTP id i7JKQ3sM001637; Thu, 19 Aug 2004 23:26:03 +0300 (EEST) (envelope-from keramida@ceid.upatras.gr) Received: (from giorgos@localhost) by gothmog.gr (8.13.1/8.13.1/Submit) id i7JKQ3ne001636; Thu, 19 Aug 2004 23:26:03 +0300 (EEST) (envelope-from keramida@ceid.upatras.gr) Date: Thu, 19 Aug 2004 23:26:03 +0300 From: Giorgos Keramidas To: Anthony Duerr Message-ID: <20040819202603.GD1275@gothmog.gr> References: <41249BC4.7000205@pushitlive.net> <20040819085015.73799dca.wmoran@potentialtech.com> <20040819112808.52f7bdc5@localhost.pittgoth.com> <20040819150125.4fbae6e2.wmoran@potentialtech.com> <412502EE.8070507@pushitlive.net> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <412502EE.8070507@pushitlive.net> cc: freebsd-doc@freebsd.org Subject: Re: Man Pages Thoughts X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 19 Aug 2004 20:28:04 -0000 On 2004-08-19 14:43, Anthony Duerr wrote: > > [[[ snip long discussion about EXAMPLES in manpages ]]] > > Examples: > scp -r username@remotehost.com: /path/to/local/dir/ > /path/to/remote/dir /* This recursively copies a local directory to a > remote directory using the current user */ > scp username@remotehost.com: /a/file.txt /remote/directory/file.txt /* > This copies local file "file.txt" to /remote/directory/file.txt */ > > Now, the example above isn't exactly flawless, but you get the idea. This is a good idea. One way that anyone could help add EXAMPLES to more manpages is to keep a note of the manpages they want to see examples in and then mail freebsd-doc or send a PR. If you also have the kindness to include a sample of the examples you'd like to see in the manpages I'll be happy to review the text and commit as many of these as I can to the tree. Submissions don't really have to be in -mdoc format if this scares you off. I can handle the conversion.