From 94888223ffc3552ac0847c3b338cea37e13bfb9d Mon Sep 17 00:00:00 2001 From: Lars Kruse Date: Mon, 5 Oct 2020 04:05:50 +0200 Subject: [PATCH] Plugin ipt_basic_: convert documentation to perlpod format --- plugins/network/ipt_basic_ | 87 +++++++++++++++++++++++++------------- 1 file changed, 57 insertions(+), 30 deletions(-) diff --git a/plugins/network/ipt_basic_ b/plugins/network/ipt_basic_ index 7d3019ab..55aa4ebb 100755 --- a/plugins/network/ipt_basic_ +++ b/plugins/network/ipt_basic_ @@ -1,34 +1,61 @@ #!/bin/sh -#$Id: ipt-basic_ 96 2005-10-12 16:54:19Z grin $ -# -# (C)Copyright Peter grin at grin dot hu Gervai, 2005 -# Released undel GPL v2. -# -# Plugin to monitor traffic through iptables. -# This plugin was designed to monitor FORWARDING interfaces -# on a router with only one-to-one forwarding (traffic goes into -# one interface goes out to the other). -# -# You can initialise the required iptables by running it manually: -# -# ipt-basic_ initialise -# -# You should create two symlinks to this module: -# ln -s ipt-basic_ ipt-basic_bytes -# ln -s ipt-basic_ ipt-basic_pkts -# -# This plugin is based on the ip_ plugin. -# -# Revisions: -# 2006.01.00 - First release. -# 2006.11.26 - Use -j RETURN in rules, and sort interfaces -# -# -# Magic markers (optional - used by munin-config and some installation -# scripts): -# -#%# family=auto -#%# capabilities=autoconf + +: <<=cut + +=head1 NAME + +ipt_basic_ - monitor traffic through iptables + + +=head1 APPLICABLE SYSTEMS + +This plugin was designed to monitor FORWARDING interfaces +on a router with only one-to-one forwarding (traffic goes into +one interface goes out to the other). + + +=head1 CONFIGURATION + +You can initialise the required iptables by running it manually: + + ipt-basic_ initialise + +You should create two symlinks to this module: + ln -s ipt-basic_ ipt-basic_bytes + ln -s ipt-basic_ ipt-basic_pkts + +This plugin is based on the ip_ plugin. + + +=head1 REVISIONS + +=over 4 + +=item 2006.01.00 - First release. + +=item 2006.11.26 - Use -j RETURN in rules, and sort interfaces + +=back + + +=head1 AUTHORS + +Copyright (C) 2005 Peter Gervai + + +=head1 LICENSE + +GNU Library General Public License v2 only + +SPDX-License-Identifier: GPL-2.0-only + + +=head1 MAGIC MARKERS + + #%# family=auto + #%# capabilities=autoconf + +=cut # ipt_bytes, ipt_pkts TYPE=`basename $0 | sed 's/^ipt-basic_//g'`