From e9953c361267f10fd15d3280ccd985062c1dde28 Mon Sep 17 00:00:00 2001
From: Christian Hesse <mail@eworm.de>
Date: Tue, 16 Nov 2021 16:03:10 +0100
Subject: add doc/mod/ipcalc

---
 doc/mod/ipcalc.d/ipcalc.avif       | Bin 0 -> 1791 bytes
 doc/mod/ipcalc.d/ipcalcreturn.avif | Bin 0 -> 1283 bytes
 doc/mod/ipcalc.md                  |  53 +++++++++++++++++++++++++++++++++++++
 3 files changed, 53 insertions(+)
 create mode 100644 doc/mod/ipcalc.d/ipcalc.avif
 create mode 100644 doc/mod/ipcalc.d/ipcalcreturn.avif
 create mode 100644 doc/mod/ipcalc.md

(limited to 'doc')

diff --git a/doc/mod/ipcalc.d/ipcalc.avif b/doc/mod/ipcalc.d/ipcalc.avif
new file mode 100644
index 0000000..022f325
Binary files /dev/null and b/doc/mod/ipcalc.d/ipcalc.avif differ
diff --git a/doc/mod/ipcalc.d/ipcalcreturn.avif b/doc/mod/ipcalc.d/ipcalcreturn.avif
new file mode 100644
index 0000000..d858bb1
Binary files /dev/null and b/doc/mod/ipcalc.d/ipcalcreturn.avif differ
diff --git a/doc/mod/ipcalc.md b/doc/mod/ipcalc.md
new file mode 100644
index 0000000..a3e7fc8
--- /dev/null
+++ b/doc/mod/ipcalc.md
@@ -0,0 +1,53 @@
+IP address calculation
+======================
+
+[◀ Go back to main README](../../README.md)
+
+> ℹ️️ **Info**: This module can not be used on its own but requires the base
+> installation. See [main README](../../README.md) for details.
+
+Description
+-----------
+
+This module adds functions for IP address calculation.
+
+Requirements and installation
+-----------------------------
+
+Just install the module:
+
+    $ScriptInstallUpdate mod/ipcalc;
+
+Usage and invocation
+--------------------
+
+### IPCalc
+
+The function `$IPCalc` prints information to terminal, including:
+
+* address
+* netmask
+* network in CIDR notation
+* minimum host address
+* maximum host address
+* broadcast address
+
+It expects an IP address in CIDR notation as argument.
+
+    $IPCalc 192.168.88.1/24;
+
+![IPCalc](ipcalc.d/ipcalc.avif)
+
+### IPCalcReturn
+
+The function `$IPCalcReturn` expects an IP address in CIDR notation as
+argument as well. But it does not print to terminal, instead it returns
+the information in a named array.
+
+    :put ([ $IPCalcReturn  192.168.88.1/24 ]->"broadcast");
+
+![IPCalcReturn](ipcalc.d/ipcalcreturn.avif)
+
+---
+[◀ Go back to main README](../../README.md)  
+[▲ Go back to top](#top)
-- 
cgit v1.2.3-70-g09d2