[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Do have programs have poor documentation? (was ... Re: Why? -- "A Modest Proposal")



Greg Wooledge wrote:
> On Fri, Dec 30, 2016 at 02:24:28PM -0000, Dan Purgert wrote:
>> Anyway, isn't this where the differences between say "man something" and
>> "man 5 something" come into play?  Or rather, the implication that
>> section 1 (or whatever) may only hold a basic overview, and then section
>> 5 (or whatever) will hold the full documentation.
>
> Section 1: user commands.
> Section 5: file formats.
>
> man 1 intro
> man 5 intro
>
> What you want is actually section 7: overviews, conventions, protocols,
> etc.  That's where tutorials should go.
>
> man 7 intro

yeah, I really need to remember to not pretend to be a functioning human
til at least my second cuppa coffee :)


-- 
|_|O|_| Registered Linux user #585947
|_|_|O| Github: https://github.com/dpurgert
|O|O|O| PGP: 05CA 9A50 3F2E 1335 4DC5  4AEE 8E11 DDF3 1279 A281


Reply to: