[PATCH v1 13/28] cyclictest.8: Synopsis: Distinguish --help mode

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

 



Per groff_man_style(7), different command operation modes should be
distinguished through unique Synopsis (.SY/.YS) blocks.

Distinguish "cyclictest --help" with its own section, as other parameters
won't be recognized when --help is passed.

Signed-off-by: Ahmed S. Darwish <darwi@xxxxxxxxxxxxx>
---
 src/cyclictest/cyclictest.8 | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8
index 0271f5c..1fd550f 100644
--- a/src/cyclictest/cyclictest.8
+++ b/src/cyclictest/cyclictest.8
@@ -6,6 +6,7 @@
 cyclictest \- High resolution test program
 .
 .SH Synopsis
+.
 .SY cyclictest
 .RB [ \-mMNqrRsSuvx ]
 .RB [ \-a\~\c
@@ -61,11 +62,14 @@ cyclictest \- High resolution test program
 .RB [ \-\-tracemark ]
 .YS
 .
+.SY cyclictest
+.B \-\-help
+.YS
+.
 .SH Options
-These programs follow the usual GNU command line syntax, with long
-options starting with two dashes ('\-\-').
-.br
-A summary of options is included below.
+.
+.B \-\-help
+display a usage message and exit.
 .
 .TP
 .B \-a, \-\-affinity[=PROC-SET]
-- 
2.49.0





[Index of Archives]     [RT Stable]     [Kernel Newbies]     [IDE]     [Security]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux ATA RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]

  Powered by Linux