aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mod/ipcalc.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2021-11-16 16:03:10 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-02-21 12:44:28 +0100
commit39871f22210d6b48775bef4f78c73a78626fa7ba (patch)
treed8fff25f4b9e4c778d856fd12f47128a800a21d6 /doc/mod/ipcalc.md
parentd1c4eb2303fc4ea3c2acbafe5b31825ca07b56a9 (diff)
add doc/mod/ipcalc
(cherry picked from commit e9953c361267f10fd15d3280ccd985062c1dde28)
Diffstat (limited to 'doc/mod/ipcalc.md')
-rw-r--r--doc/mod/ipcalc.md53
1 files changed, 53 insertions, 0 deletions
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)