Follow groff_man_style(7) parameters documentation style. Namely: - Order cyclictest flags in the form -abcCeEgGijklNpRsStUVXzZ - Present the flag and option names in bold to cue the user that they should be input literally. - Use the non-breaking adjustable space escape sequence "\~" to prevent the line output from being broken within the option brackets. - Use the output line continuation escape sequence "\c" to allow all three font styles to be set without breakable space among them. - End the parameters list with .YS, the "End synopsis" macro. It restores indentation, adjustment, and hyphenation to their previous state. Beside just following the standards, this makes the groff rendering of the cyclictest's parameter list way more legible and comprehensible. Signed-off-by: Ahmed S. Darwish <darwi@xxxxxxxxxxxxx> --- src/cyclictest/cyclictest.8 | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8 index 7f1bd39..f093677 100644 --- a/src/cyclictest/cyclictest.8 +++ b/src/cyclictest/cyclictest.8 @@ -7,9 +7,34 @@ cyclictest \- High resolution test program . .SH Synopsis .SY cyclictest -.RI "[ \-fmnqrsvMS ] [\-a " proc " ] [\-A " align " ] [\-b " usec " ] [\-c " clock " ] [\-d " dist " ] \ -[\-h " histogram " ] [\-i " intv " ] [\-\-json " filename " ] [\-l " loop " ] [\-o " red " ] \ -[\-p " prio " ] [\-t " num " ] [\-D " time " ]" +.RB [ \-fmMnqrsMv ] +.RB [ \-a\~\c +.IR proc ] +.RB [ \-A\~\c +.IR align ] +.RB [ \-b\~\c +.IR usec ] +.RB [ \-c\~\c +.IR clock ] +.RB [ \-d\~\c +.IR dist ] +.RB [ \-h\~\c +.IR histogram ] +.RB [ \-i\~\c +.IR intv ] +.RB [ \-\-json\~\c +.IR filename ] +.RB [ \-l\~\c +.IR loop ] +.RB [ \-o\~\c +.IR red ] +.RB [ \-p\~\c +.IR prio ] +.RB [ \-t\~\c +.IR num ] +.RB [ \-D\~\c +.IR time ] +.YS . .SH Options These programs follow the usual GNU command line syntax, with long -- 2.49.0
