git: eaf3ac81cf12 - main - wlanstats: add man page
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Tue, 04 Mar 2025 23:31:15 UTC
The branch main has been updated by bz:
URL: https://cgit.FreeBSD.org/src/commit/?id=eaf3ac81cf12bbaecb1d6bce3a8bcdef5b9c0ffc
commit eaf3ac81cf12bbaecb1d6bce3a8bcdef5b9c0ffc
Author: Bjoern A. Zeeb <bz@FreeBSD.org>
AuthorDate: 2025-02-28 23:45:44 +0000
Commit: Bjoern A. Zeeb <bz@FreeBSD.org>
CommitDate: 2025-03-04 23:30:12 +0000
wlanstats: add man page
After two decades in tools add a basic man page to wlanstats now that
it is in usr.sbin. Most users will likely ever only run it without
arguments.
Sponsored by: The FreeBSD Foundation
MFC after: 3 days
X-MFC with: 61ce422531805
Reviewed by: adrian, ziaee
Differential Revision: https://reviews.freebsd.org/D49186
---
usr.sbin/wlanstats/Makefile | 2 +-
usr.sbin/wlanstats/wlanstats.8 | 67 ++++++++++++++++++++++++++++++++++++++++++
2 files changed, 68 insertions(+), 1 deletion(-)
diff --git a/usr.sbin/wlanstats/Makefile b/usr.sbin/wlanstats/Makefile
index 60c56d24700b..574a9c27137f 100644
--- a/usr.sbin/wlanstats/Makefile
+++ b/usr.sbin/wlanstats/Makefile
@@ -1,7 +1,7 @@
.include <bsd.compiler.mk>
PROG= wlanstats
-MAN=
+MAN= wlanstats.8
CFLAGS= -I${SRCTOP}/lib/libbsdstat
LIBADD= bsdstat
diff --git a/usr.sbin/wlanstats/wlanstats.8 b/usr.sbin/wlanstats/wlanstats.8
new file mode 100644
index 000000000000..e032835bac43
--- /dev/null
+++ b/usr.sbin/wlanstats/wlanstats.8
@@ -0,0 +1,67 @@
+.\"
+.\" Copyright (c) 2025 The FreeBSD Foundation
+.\"
+.\" This documentation was written by Björn Zeeb under sponsorship from
+.\" the FreeBSD Foundation.
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
+.Dd February 20, 2025
+.Dt WLANSTATS 8
+.Os
+.Sh NAME
+.Nm wlanstats
+.Nd query 802.11 wireless network statistics
+.Sh SYNOPSIS
+.Nm
+.\" .Op Fl a
+.Op Fl h
+.Op Fl i Ar ifnet
+.Op Fl l
+.Op Fl m Ar station MAC address
+.Op Fl o Ar fmt
+.Op interval
+.Sh DESCRIPTION
+The
+.Nm
+command is a tool to query 802.11 statistics for
+.Xr wlan 4
+interface.
+Running
+.Nm
+without any options will display the current statistics
+for the
+.Em wlan0
+network interface.
+.Pp
+The following options are available:
+.Bl -tag -width indent
+.It Fl h
+Print usage and exit.
+.It Fl i Ar ifnet
+Report information for the specified
+.Ar ifnet
+instead of the default
+.Em wlan0 .
+.It Fl l
+List all fields names and their descriptions.
+.It Fl m Ar station MAC address
+Request information for the station specified by the given
+.Ar MAC address.
+.It Fl o Ar fmt
+Set format of fields to query.
+This can be either on of the pre-defined tags:
+.Em default ,
+.Em ampdu , or
+.Em amsdu
+or a comma separated list of field names without space.
+.El
+.Pp
+.Sh SEE ALSO
+.Xr ifconfig 8 ,
+.Xr wlandebug 8
+.Pp
+The
+.Pa /usr/src/tools/tools/net80211
+directory contains more utilities that might be relevant to debug wireless
+issues.