aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mod/ipcalc.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2022-02-21 12:54:01 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-02-21 12:54:01 +0100
commit343ee27820c3e5e82e2a0a8ab7899f7059cf370e (patch)
tree5dfacbc9123c44afbe4a5a79d6f9632d4c1ab77b /doc/mod/ipcalc.md
parent886cd67edba86906fea4c0d753b13b7c68c5e78b (diff)
parentd74aac8f6ad3edfdf65d4a3ee6714aae1d3ade0f (diff)
Merge branch 'doc/mod' into next
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)