Web lists-archives.com

Re: Partition information as text file?




On Fri, Feb 01, 2019 at 06:06:18PM +0000, Joe wrote:
> On Fri, 1 Feb 2019 07:59:42 -0600
> Richard Owlett <rowlett@xxxxxxxxxxx> wrote:
> 
> > ... a major deficiency of the man page format --
> >   [/begin_rant   almost total lack of examples /end_rant ;]
> 
> That's what's expected of man pages. If you want examples, poke around
> the Net for tutorials, and be prepared to find a wide range of quality.

I disagree.  Perhaps you've come to expect a lack of examples from the
man pages published by various GNU projects.  GNU developers prefer their
own texinfo format instead, so they often write only stub man pages.

A well-written man page includes an EXAMPLES section, unless the command
being documented is so trivial that none is required (e.g. true(1)).

The lack of examples is not a "deficiency of the format".  It is a
deficiency of that particular page, written by that particular author.