[Top][All Lists]

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

[bug #63958] [mdoc] decide how to set up hanging indent in Synopsis sect

From: Ingo Schwarze
Subject: [bug #63958] [mdoc] decide how to set up hanging indent in Synopsis sections
Date: Sat, 8 Apr 2023 14:13:09 -0400 (EDT)

Follow-up Comment #1, bug #63958 (project groff):

1. mandoc(1) uses 4n, presumably for compatibility with groff.
2. That's only because mandoc(1) does not support mixed-case section names
yet.  Apply s/Synopsis/SYNOPSIS/ and mandoc(1) works as expected.  Yes, this
will be fixed in mandoc(1), hopefully not in the too far future.
3. I doubt that.  Apply s/void/unicorn/ and the indentation remains 4n.
4. Do not use .Bl in the SYNOPSIS, in particular not for such an extremely
simple case.  The mdoc(7) code is OK as is.  I recommend using .Fo if there
are any long arguments or more than two arguments, but that's merely a weak
stylistic recommendation for readability of the source code.  See below for
how i would write this thing.

.Ft void
.Fo timerdday
.Fa "struct timespec *earliest"
.Fa "struct timespec *latest"
-Fa "struct timespec *resolution"

Using \% in a SYNOPSIS seems bogus to me.  The program ought to do the right
thing by default, and i believe mandoc(1) does.  If groff hyphenates type or
argument names, it should be fixed.

Having a hyphen in "struct timespec" seems even more bogus to me; is that even
valid C syntax?

Then again, i don't recall ever seeing a function called timerdday(3) before. 
I neither found it in the OpenBSD nor in the FreeBSD tree.  I would be quite
surprised if it were, as you seem to claim, a BSD thingy.


Reply to this item at:


Message sent via Savannah

reply via email to

[Prev in Thread] Current Thread [Next in Thread]