aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mod/scriptrunonce.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2021-11-16 16:03:56 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-02-21 12:56:02 +0100
commit9419e3407731eea0594c8fbdff27d9688e656397 (patch)
tree6509f1d5523091a4e6592da1d71617ea57ba63c1 /doc/mod/scriptrunonce.md
parent39871f22210d6b48775bef4f78c73a78626fa7ba (diff)
add doc/mod/scriptrunonce
Diffstat (limited to 'doc/mod/scriptrunonce.md')
-rw-r--r--doc/mod/scriptrunonce.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/mod/scriptrunonce.md b/doc/mod/scriptrunonce.md
new file mode 100644
index 0000000..190ed03
--- /dev/null
+++ b/doc/mod/scriptrunonce.md
@@ -0,0 +1,35 @@
+Download script and run it once
+===============================
+
+[◀ 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 a function that downloads a script, checks for syntax
+validity and runs it once.
+
+Requirements and installation
+-----------------------------
+
+Just install the module:
+
+ $ScriptInstallUpdate mod/scriptrunonce;
+
+Usage and invocation
+--------------------
+
+The function `$ScriptRunOnce` expects an url pointing to a script as parameter.
+
+ $ScriptRunOnce https://git.eworm.de/cgit/routeros-scripts/plain/doc/mod/scriptrunonce.d/hello-world.rsc
+
+![ScriptRunOnce](scriptrunonce.d/scriptrunonce.avif)
+
+Giving multiple scripts is possible, separated by comma.
+
+---
+[◀ Go back to main README](../../README.md)
+[▲ Go back to top](#top)