]> git.ipfire.org Git - thirdparty/iproute2.git/commitdiff
ifstat: Add xstat to ifstat man page
authorNogah Frankel <nogahf@mellanox.com>
Thu, 26 Jan 2017 12:44:41 +0000 (14:44 +0200)
committerStephen Hemminger <stephen@networkplumber.org>
Fri, 3 Feb 2017 17:20:15 +0000 (09:20 -0800)
Add documentation about the extended statistics to the ifstat man page.
Add ifstat man age to the man8 Makefile

Signed-off-by: Nogah Frankel <nogahf@mellanox.com>
Reviewed-by: Jiri Pirko <jiri@mellanox.com>
man/man8/Makefile
man/man8/ifstat.8

index 77d347ca98fcc0afb5c8fdf0bf944895db35e435..bc2fc8139c686b4b574f25d48726c92c679ff127 100644 (file)
@@ -18,7 +18,8 @@ MAN8PAGES = $(TARGETS) ip.8 arpd.8 lnstat.8 routel.8 rtacct.8 rtmon.8 rtpr.8 ss.
        tc-connmark.8 tc-csum.8 tc-mirred.8 tc-nat.8 tc-pedit.8 tc-police.8 \
        tc-simple.8 tc-skbedit.8 tc-vlan.8 tc-xt.8  tc-ife.8 \
        tc-tunnel_key.8 \
-       devlink.8 devlink-dev.8 devlink-monitor.8 devlink-port.8 devlink-sb.8
+       devlink.8 devlink-dev.8 devlink-monitor.8 devlink-port.8 devlink-sb.8 \
+       ifstat.8
 
 all: $(TARGETS)
 
index e49d868058f114250be51fcd5fa1f749e23cdb6e..3ba0088d8940a0ddafb0806cb09ae9c2f41acf77 100644 (file)
@@ -14,7 +14,8 @@ ifstat \- handy utility to read network interface statistics
 The utility keeps records of the previous data displayed in history files and
 by default only shows difference between the last and the current call.
 Location of the history files defaults to /tmp/.ifstat.u$UID but may be
-overridden with the IFSTAT_HISTORY environment variable.
+overridden with the IFSTAT_HISTORY environment variable. Similarly, the default
+location for xstat (extended stats) is /tmp/.<xstat name>_ifstat.u$UID.
 .SH OPTIONS
 .TP
 .B \-h, \-\-help
@@ -46,6 +47,15 @@ Report average over the last SECS seconds.
 .TP
 .B \-z, \-\-zeros
 Show entries with zero activity.
+.TP
+.B \-x, \-\-extended=TYPE
+Show extended stats of TYPE. Supported types are:
+
+.in +8
+.B cpu_hits
+- Counts only packets that went via the CPU.
+.in -8
+
 .SH ENVIRONMENT
 .TP
 .B IFSTAT_HISTORY