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

[Thorsten Glaser]

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

FWIW, AT&T nroff renders it as:

$ nrcon -mdoc /tmp/x | less
timerdday(3)               BSD Programmer's Manual               
timerdday(3)

NAME
     timerdday - compute time of launch operation within window

SYNOPSIS
     void
     timerdday(struct-timespec *earliest, struct-timespec *latest, struct-
             timespec *resolution);

DESCRIPTION
     Compute the optimal start time for a desired event to occur between
times
     earliest and latest to within a granularity of resolution.

MirBSD #10-current               June 6, 1944                               
1


For this, I did have to change the source though, to…

$ cat /tmp/x
.Dd June 6, 1944
.Dt timerdday 3
.Os
.Sh NAME
.Nm timerdday
.Nd compute time of launch operation within window
.Sh SYNOPSIS
.Ft void
.Fn timerdday "\%struct-timespec *earliest" \
"\%struct-timespec *latest" "\%struct-timespec *resolution"
.Sh DESCRIPTION
Compute the optimal start time for a desired event to occur between
times
.Va earliest No and Va latest
to within a granularity of
.Va resolution .

… to make it compile correctly (3bsd → 3, .Sh arguments uppercase as the
comparision is case-sensitive).

The use of \% there is odd, I’d rather use \- there (which is needed to
avoid getting ‐ anyway), but that leaves us with…

SYNOPSIS
     void
     timerdday(struct-timespec *earliest, struct-timespec *latest, -
             struct-timespec *resolution);

… which is also not right. To get good output, drop the \% as well:

SYNOPSIS
     void
     timerdday(struct-timespec *earliest, struct-timespec *latest,
             struct-timespec *resolution);

From:

.Fn timerdday "struct\-timespec *earliest" \
"struct\-timespec *latest" "struct\-timespec *resolution"



    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?63958>

_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/