Date: Thu, 19 Aug 2004 23:26:03 +0300 From: Giorgos Keramidas <keramida@ceid.upatras.gr> To: Anthony Duerr <duerra@pushitlive.net> Cc: freebsd-doc@freebsd.org Subject: Re: Man Pages Thoughts Message-ID: <20040819202603.GD1275@gothmog.gr> In-Reply-To: <412502EE.8070507@pushitlive.net> References: <41249BC4.7000205@pushitlive.net> <20040819085015.73799dca.wmoran@potentialtech.com> <20040819112808.52f7bdc5@localhost.pittgoth.com> <20040819150125.4fbae6e2.wmoran@potentialtech.com> <412502EE.8070507@pushitlive.net>
next in thread | previous in thread | raw e-mail | index | archive | help
On 2004-08-19 14:43, Anthony Duerr <duerra@pushitlive.net> 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.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20040819202603.GD1275>