From 0aff452d415b886c27ce919c3e3c95a164d4d492 Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Thu, 11 Oct 2018 08:00:01 +0200 Subject: luci-lib-iptparser: fix packaging The previous commit omitted a subdirectory. Fixes: 94323a61e ("luci-base: move luci.sys.iptparser into separate package") Signed-off-by: Jo-Philipp Wich --- .../luci-lib-iptparser/luasrc/sys/iptparser.luadoc | 69 ++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 libs/luci-lib-iptparser/luasrc/sys/iptparser.luadoc (limited to 'libs/luci-lib-iptparser/luasrc/sys/iptparser.luadoc') diff --git a/libs/luci-lib-iptparser/luasrc/sys/iptparser.luadoc b/libs/luci-lib-iptparser/luasrc/sys/iptparser.luadoc new file mode 100644 index 0000000000..071e7d52e4 --- /dev/null +++ b/libs/luci-lib-iptparser/luasrc/sys/iptparser.luadoc @@ -0,0 +1,69 @@ +---[[ +LuCI iptables parser and query library + +@cstyle instance +]] +module "luci.sys.iptparser" + +---[[ +Create a new iptables parser object. + +@class function +@name IptParser +@param family Number specifying the address family. 4 for IPv4, 6 for IPv6 +@return IptParser instance +]] + +---[[ +Find all firewall rules that match the given criteria. Expects a table with + +search criteria as only argument. If args is nil or an empty table then all +rules will be returned. +]] + +---[[ +Rebuild the internal lookup table, for example when rules have changed + +through external commands. +@class function +@name IptParser.resync +@return nothing +]] + +---[[ +Find the names of all tables. + +@class function +@name IptParser.tables +@return Table of table names. +]] + +---[[ +Find the names of all chains within the given table name. + +@class function +@name IptParser.chains +@param table String containing the table name +@return Table of chain names in the order they occur. +]] + +---[[ +Return the given firewall chain within the given table name. + +@class function +@name IptParser.chain +@param table String containing the table name +@param chain String containing the chain name +@return Table containing the fields "policy", "packets", "bytes" +-- and "rules". The "rules" field is a table of rule tables. +]] + +---[[ +Test whether the given target points to a custom chain. + +@class function +@name IptParser.is_custom_target +@param target String containing the target action +@return Boolean indicating whether target is a custom chain. +]] + -- cgit v1.2.3