aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2021-11-16 16:02:55 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-02-21 12:44:28 +0100
commitd1c4eb2303fc4ea3c2acbafe5b31825ca07b56a9 (patch)
tree9bcda66b7e7b59679b721add38196431f26b38c2
parent10bb0a9f52a9dbd4a92c72f444ed5b831c91e4df (diff)
add doc/mod/inspectvar
(cherry picked from commit 002315035c25b8569d2b6f232a6f8dfba37cf07b)
-rw-r--r--README.md1
-rw-r--r--doc/mod/inspectvar.d/inspectvar.avifbin0 -> 2891 bytes
-rw-r--r--doc/mod/inspectvar.md33
3 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
index 732afd9..80e4693 100644
--- a/README.md
+++ b/README.md
@@ -239,6 +239,7 @@ Available modules
* [Manage ports in bridge](doc/mod/bridge-port-to.md)
* [Manage VLANs on bridge ports](doc/mod/bridge-port-vlan.md)
+* [Inspect variables](doc/mod/inspectvar.md)
* [Send notifications via Matrix](doc/mod/notification-matrix.md)
* [Send notifications via Telegram](doc/mod/notification-telegram.md)
diff --git a/doc/mod/inspectvar.d/inspectvar.avif b/doc/mod/inspectvar.d/inspectvar.avif
new file mode 100644
index 0000000..d4a745f
--- /dev/null
+++ b/doc/mod/inspectvar.d/inspectvar.avif
Binary files differ
diff --git a/doc/mod/inspectvar.md b/doc/mod/inspectvar.md
new file mode 100644
index 0000000..d3fb3b2
--- /dev/null
+++ b/doc/mod/inspectvar.md
@@ -0,0 +1,33 @@
+Inspect variables
+=================
+
+[◀ 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
+-----------
+
+RouterOS handles not just scalar variables, but also arrays - even nested.
+This module adds a function to inspect variables.
+
+Requirements and installation
+-----------------------------
+
+Just install the module:
+
+ $ScriptInstallUpdate mod/inspectvar;
+
+Usage and invocation
+--------------------
+
+Call the function `$InspectVar` with a variable as parameter:
+
+ $InspectVar $ModeButton
+
+![InspectVar](inspectvar.d/inspectvar.avif)
+
+---
+[◀ Go back to main README](../../README.md)
+[▲ Go back to top](#top)