]> git.ipfire.org Git - thirdparty/iproute2.git/commitdiff
rtmon: Align usage with ip help
authorYedaya Katsman <yedaya.ka@gmail.com>
Mon, 13 May 2024 18:52:17 +0000 (21:52 +0300)
committerStephen Hemminger <stephen@networkplumber.org>
Tue, 14 May 2024 05:23:55 +0000 (22:23 -0700)
Also update the man page accordingly, and add ip-monitor to see also

Signed-off-by: Yedaya Katsman <yedaya.ka@gmail.com>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
ip/rtmon.c
man/man8/rtmon.8

index 08105d686c080fb2632df750ba1e7257f2dcf7ba..470f4ba641dc67dfa0af3a16c5fcfc7488905f1b 100644 (file)
@@ -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);
 }
 
index 38a2b77470e6229ed82c2582acccf13a57c854ac..f3b9f774413fba87441de952976a3968937847b6 100644 (file)
@@ -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@ms2.inr.ac.ru>.