Re: man(7) <-> mdoc(7) (approximate) correspondence table?

[Alejandro Colomar]

Hi Alexis,

On Sat, Apr 27, 2024 at 04:17:28PM +1000, Alexis wrote:
> [ Not subscribed to the linux-man list, so please cc me if replying there. ]
> 
> Hi all,
> 
> As someone who's much more familiar with mdoc(7) than man(7), is there an
> approximate 'correspondence table' somewhere that gives at least a rough
> sense of which man(7) macros to use when, in an mdoc(7) context, one would
> use a given mdoc(7) macro? Such a table might look something like (to use
> some obvious probable correspondences):
> 
> | mdoc(7) | man(7) | Notes
> +---------+--------+-------
> | Lk      | UR     |
> | Op      | OP     |
> | Sh      | SH     |
> | Ss      | SS     |
> | ⋮       | ⋮      |
> 
> i recognise that there's no bijection in general, and that specific mappings
> might differ between projects (e.g. the Linux man-pages project might use a
> certain man(7) macro where a different project uses another), but even a
> project-specific table would be helpful to me.

I have similar problems when writing mdoc(7).  What I tend to do is look
at good (e.g., OpenBSD) mdoc(7) pages' output, and then look at their
source to see what they use.

I can only recommend you look at pages in the Linux man-pages project,
and follow what you see (you can ask me if a page is a good reference).
I try to have them all with perfect source, but there are too many of
them.

> i thought there might be such a table in either groff_man(7) or
> groff_man_style(7), but nothing leapt out ....

It would be interesting if there would exist such a thing.

> Alexis.

Have a lovely weekend!
Alex

-- 
<https://www.alejandro-colomar.es/>

signature.asc
Description: PGP signature