From cd0536387671c6b9916fd48bd6a38500bcd83f17 Mon Sep 17 00:00:00 2001 From: Lars Kruse Date: Sun, 4 Oct 2020 04:52:01 +0200 Subject: [PATCH] Plugin brc_rssi: convert documentation to perldoc header --- plugins/network/brc_rssi | 70 ++++++++++++++++++++++++++++------------ 1 file changed, 49 insertions(+), 21 deletions(-) diff --git a/plugins/network/brc_rssi b/plugins/network/brc_rssi index ae5a886c..d9add6ed 100755 --- a/plugins/network/brc_rssi +++ b/plugins/network/brc_rssi @@ -1,25 +1,53 @@ #!/bin/sh -# -# Munin plugin for WiFi access points with Broadcom chipset such as found -# on hardware supported by OpenWRT. -# -# NOTE: NEEDS NON FREE UTILITY "wl" -# Configuration: -# [brc_rssi] -# env.WIFISIDE eth0 # Set the WiFi side interface. Used to filter arp entries. -# # On a openwrt box defaults to "nvram get lan_ifname" otherwise -# # no default. -# -# Written by Nicolai Langfeldt (janl@linpro.no) 2007/02/18 -# -# Bugs: -# - Should have a persistent list of macs ever seen -# -# License: GPL v.2 -# -#%# family=contrib -#%# capabilities=autoconf -# + +: <<=cut + +=head1 NAME + +brc_rssi - monitor RSSI (Received Signal Strength Indication) of wireless accesspoints + +=head1 APPLICABLE SYSTEMS + +Wireless accesspoints with Broadcom chipset such as found on hardware supported by OpenWRT. +The utility "wl" is required. + + +=head1 CONFIGURATION + + [brc_rssi] + env.WIFISIDE eth0 # Set the WiFi side interface. Used to filter arp entries. + # On a openwrt box defaults to "nvram get lan_ifname" otherwise + # no default. + + +=head1 BUGS + +=over 4 + +=item Should have a persistent list of macs ever seen. + +=back + + +=head1 AUTHORS + +Copyright (C) 2007 Nicolai Langfeldt + + +=head1 LICENSE + +GNU General Public License v2.0 only + +SPDX-License-Identifier: GPL-2.0-only + + +=head1 MAGIC MARKERS + + #%# family=contrib + #%# capabilities=autoconf + +=cut + PATH=/usr/bin:/usr/sbin:/bin:/sbin export PATH