Re: A sketch of an mdoc tutorial

PHO <[email protected]> Sun, 2 Feb 2025 17:07:38 +0900
Newsgroups gmane.os.netbsd.documentation
Message-ID <[email protected]>
On 2/2/25 12:39, Valery Ushakov wrote:
> There seems to be quite a bit of cargo-cult/copy-paste of the mdoc(7)
> markup when it comes to writing manual pages.  Some time ago I tried
> to write a tutorial but kinda hit a writer's block.  Then I tried to
> just do a jumbo^Hled man page(s) to have a single convenient source
> for casual users to steal from, but, again, got sidetracked with other
> things.
> 
> I thought to commit these somewhere to /usr/share (examples,
> probably), but at the current rate I'm not sure when I'll get around
> to it.  Since unfinished/imperfect is still better than nothing, I put
> the sources here:
> 
>      https://hg.sr.ht/~nbuwe/mdoc-tutorial/browse

Wow... I didn't know about the nroff-view command. It's already very 
helpful. Thank you so much!

One of the aspects I find really confusing in mdoc(7) is how to use (or 
what is the best practice for using) -offset/-width on .Bl and .Bd 
macros. On NetBSD we have so many man pages doing

     .Bl -tag -width indent

but I don't think this "indent" means anything special to the property 
-width. Could you also cover this topic?