netdev - [PATCH] rtmon: Align usage with ip help

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date: Mon, 13 May 2024 21:52:17 +0300
From: Yedaya Katsman <yedaya.ka@...il.com>
To: netdev@...r.kernel.org
Cc: Stephen Hemminger <stephen@...workplumber.org>,
	Yedaya Katsman <yedaya.ka@...il.com>
Subject: [PATCH] rtmon: Align usage with ip help

Also update the man page accordingly, and add ip-monitor to see also

Signed-off-by: Yedaya Katsman <yedaya.ka@...il.com>
---
 ip/rtmon.c       |  4 ++--
 man/man8/rtmon.8 | 31 +++++++++++++++++++++++++------
 2 files changed, 27 insertions(+), 8 deletions(-)

diff --git a/ip/rtmon.c b/ip/rtmon.c
index 08105d686c08..470f4ba641dc 100644
--- a/ip/rtmon.c
+++ b/ip/rtmon.c
@@ -58,10 +58,10 @@ static int dump_msg2(struct nlmsghdr *n, void *arg)
 static void usage(void)
 {
 	fprintf(stderr,
-		"Usage: rtmon [ OPTIONS ] file FILE [ all | LISTofOBJECTS ]\n"
+		"Usage: rtmon [ OPTIONS ] file FILE [ all | OBJECTS ]\n"
 		"OPTIONS := { -f[amily] { inet | inet6 | link | help } |\n"
 		"             -4 | -6 | -0 | -V[ersion] }\n"
-		"LISTofOBJECTS := [ link ] [ address ] [ route ]\n");
+		"OBJECTS := [ link ] [ address ] [ route ]\n");
 	exit(-1);
 }
 
diff --git a/man/man8/rtmon.8 b/man/man8/rtmon.8
index 38a2b77470e6..f3b9f774413f 100644
--- a/man/man8/rtmon.8
+++ b/man/man8/rtmon.8
@@ -1,9 +1,27 @@
 .TH RTMON 8
-.SH NAME
+.SH "NAME"
 rtmon \- listens to and monitors RTnetlink
-.SH SYNOPSIS
-.B rtmon
-.RI "[ options ] file FILE [ all | LISTofOBJECTS ]"
+.SH "SYNOPSIS"
+.sp
+.ad l
+.in +8
+.ti -8
+.B "rtmon"
+.RI "[ " OPTIONS " ] "
+.BI "file " FILE
+.BR "[ " all
+.RI "| " OBJECTS
+.RB "]"
+
+.ti -8
+.IR OPTIONS
+.RI ":= { f[amily] { inet | inet6 | link | help } |"
+.RI "-4 | -6 | -0 | -V[ersion] }"
+
+.ti -8
+.I OBJECTS
+.B ":= [" link "]" "[" address "]" "[" route "]"
+
 .SH DESCRIPTION
 This manual page documents briefly the
 .B rtmon
@@ -32,8 +50,8 @@ Print version and exit.
 .B help
 Show summary of options.
 .TP
-.B file FILE [ all | LISTofOBJECTS ]
-Log output to FILE. LISTofOBJECTS is the list of object types that we
+.B file FILE [ all | OBJECTS ]
+Log output to FILE. OBJECTS is the list of object types that we
 want to monitor. It may contain 'link', 'address', 'route'
 and 'all'. 'link' specifies the network device, 'address' the protocol
 (IP or IPv6) address on a device, 'route' the routing table entry
@@ -60,6 +78,7 @@ Log to file /var/log/rtmon.log, then run:
 to display logged output from file.
 .SH SEE ALSO
 .BR ip (8)
+.BR ip-monitor (8)
 .SH AUTHOR
 .B rtmon
 was written by Alexey Kuznetsov <kuznet@....inr.ac.ru>.
-- 
2.34.1