aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mod
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2022-05-12 11:04:43 +0200
committerGravatar Christian Hesse <mail@eworm.de>2022-05-12 11:04:43 +0200
commitdf547b87a47e279d3f6b744675821621eea5d7b8 (patch)
treed5b33fb62e10637d70d8d0616437294ceb15ed9f /doc/mod
parent93ec9afe558ef6eba5d513fab359bb5f6618666d (diff)
parent12655bd58afc3a75fe3e2958bbe130b96f8b9be7 (diff)
Merge branch 'ros-v7-path-syntax' into next
Diffstat (limited to 'doc/mod')
-rw-r--r--doc/mod/bridge-port-to.md12
-rw-r--r--doc/mod/bridge-port-vlan.md18
-rw-r--r--doc/mod/inspectvar.d/inspectvar.avifbin2891 -> 2838 bytes
-rw-r--r--doc/mod/inspectvar.md2
-rw-r--r--doc/mod/ipcalc.d/ipcalc.avifbin1791 -> 1729 bytes
-rw-r--r--doc/mod/ipcalc.d/ipcalcreturn.avifbin1283 -> 1247 bytes
-rw-r--r--doc/mod/notification-matrix.d/01-home-server.avifbin2402 -> 2317 bytes
-rw-r--r--doc/mod/notification-matrix.d/02-access-token.avifbin4278 -> 4105 bytes
-rw-r--r--doc/mod/notification-matrix.d/03-join-room.avifbin3143 -> 3166 bytes
-rw-r--r--doc/mod/notification-matrix.md6
-rw-r--r--doc/mod/scriptrunonce.d/hello-world.rsc2
-rw-r--r--doc/mod/scriptrunonce.d/scriptrunonce.avifbin2466 -> 2356 bytes
-rw-r--r--doc/mod/scriptrunonce.md2
13 files changed, 21 insertions, 21 deletions
diff --git a/doc/mod/bridge-port-to.md b/doc/mod/bridge-port-to.md
index 02d1e8d..2b42a9b 100644
--- a/doc/mod/bridge-port-to.md
+++ b/doc/mod/bridge-port-to.md
@@ -22,20 +22,20 @@ Just install the module:
Configuration
-------------
-The configuration goes to ports' comments (`/ interface bridge port`).
+The configuration goes to ports' comments (`/interface/bridge/port`).
- / interface bridge port add bridge=br-guest comment="default=dhcp-client, alt=br-guest" disabled=yes interface=en1;
- / interface bridge port add bridge=br-intern comment="default=br-intern, alt=br-guest" interface=en2;
- / interface bridge port add bridge=br-guest comment="default=br-guest, extra=br-extra" interface=en3;
+ /interface/bridge/port/add bridge=br-guest comment="default=dhcp-client, alt=br-guest" disabled=yes interface=en1;
+ /interface/bridge/port/add bridge=br-intern comment="default=br-intern, alt=br-guest" interface=en2;
+ /interface/bridge/port/add bridge=br-guest comment="default=br-guest, extra=br-extra" interface=en3;
Also dhcp client can be handled:
- / ip dhcp-client add comment="toggle with bridge port" disabled=no interface=en1;
+ /ip/dhcp-client/add comment="toggle with bridge port" disabled=no interface=en1;
Add a scheduler to start with default setup on system startup:
$ScriptInstallUpdate global-wait;
- / system scheduler add name=bridge-port-vlan on-event="/ system script run global-wait; :global BridgePortTo; \$BridgePortTo default;" start-time=startup;
+ /system/scheduler/add name=bridge-port-vlan on-event="/system/script/run global-wait; :global BridgePortTo; \$BridgePortTo default;" start-time=startup;
Usage and invocation
--------------------
diff --git a/doc/mod/bridge-port-vlan.md b/doc/mod/bridge-port-vlan.md
index 290826e..0e6c28f 100644
--- a/doc/mod/bridge-port-vlan.md
+++ b/doc/mod/bridge-port-vlan.md
@@ -23,24 +23,24 @@ Configuration
Using named VLANs you have to add comments in bridge vlan menu:
- / interface bridge vlan add bridge=bridge comment=intern tagged=br-local vlan-ids=10;
- / interface bridge vlan add bridge=bridge comment=geust tagged=br-local vlan-ids=20;
- / interface bridge vlan add bridge=bridge comment=extra tagged=br-local vlan-ids=30;
+ /interface/bridge/vlan/add bridge=bridge comment=intern tagged=br-local vlan-ids=10;
+ /interface/bridge/vlan/add bridge=bridge comment=geust tagged=br-local vlan-ids=20;
+ /interface/bridge/vlan/add bridge=bridge comment=extra tagged=br-local vlan-ids=30;
-The configuration goes to ports' comments (`/ interface bridge port`).
+The configuration goes to ports' comments (`/interface/bridge/port`).
- / interface bridge port add bridge=bridge comment="default=dhcp-client, alt=guest" disabled=yes interface=en1;
- / interface bridge port add bridge=bridge comment="default=intern, alt=guest, extra=30" interface=en2;
- / interface bridge port add bridge=bridge comment="default=guest, extra=extra" interface=en3;
+ /interface/bridge/port/add bridge=bridge comment="default=dhcp-client, alt=guest" disabled=yes interface=en1;
+ /interface/bridge/port/add bridge=bridge comment="default=intern, alt=guest, extra=30" interface=en2;
+ /interface/bridge/port/add bridge=bridge comment="default=guest, extra=extra" interface=en3;
Also dhcp client can be handled:
- / ip dhcp-client add comment="toggle with bridge port" disabled=no interface=en1;
+ /ip/dhcp-client/add comment="toggle with bridge port" disabled=no interface=en1;
Add a scheduler to start with default setup on system startup:
$ScriptInstallUpdate global-wait;
- / system scheduler add name=bridge-port-vlan on-event="/ system script run global-wait; :global BridgePortVlan; \$BridgePortVlan default;" start-time=startup;
+ /system/scheduler/add name=bridge-port-vlan on-event="/system/script/run global-wait; :global BridgePortVlan; \$BridgePortVlan default;" start-time=startup;
Usage and invocation
--------------------
diff --git a/doc/mod/inspectvar.d/inspectvar.avif b/doc/mod/inspectvar.d/inspectvar.avif
index d4a745f..f1da1d4 100644
--- a/doc/mod/inspectvar.d/inspectvar.avif
+++ b/doc/mod/inspectvar.d/inspectvar.avif
Binary files differ
diff --git a/doc/mod/inspectvar.md b/doc/mod/inspectvar.md
index d3fb3b2..7782c8a 100644
--- a/doc/mod/inspectvar.md
+++ b/doc/mod/inspectvar.md
@@ -24,7 +24,7 @@ Usage and invocation
Call the function `$InspectVar` with a variable as parameter:
- $InspectVar $ModeButton
+ $InspectVar $ModeButton;
![InspectVar](inspectvar.d/inspectvar.avif)
diff --git a/doc/mod/ipcalc.d/ipcalc.avif b/doc/mod/ipcalc.d/ipcalc.avif
index 022f325..fe726e8 100644
--- a/doc/mod/ipcalc.d/ipcalc.avif
+++ b/doc/mod/ipcalc.d/ipcalc.avif
Binary files differ
diff --git a/doc/mod/ipcalc.d/ipcalcreturn.avif b/doc/mod/ipcalc.d/ipcalcreturn.avif
index d858bb1..5e4dd57 100644
--- a/doc/mod/ipcalc.d/ipcalcreturn.avif
+++ b/doc/mod/ipcalc.d/ipcalcreturn.avif
Binary files differ
diff --git a/doc/mod/notification-matrix.d/01-home-server.avif b/doc/mod/notification-matrix.d/01-home-server.avif
index 8a79ae6..683c7b5 100644
--- a/doc/mod/notification-matrix.d/01-home-server.avif
+++ b/doc/mod/notification-matrix.d/01-home-server.avif
Binary files differ
diff --git a/doc/mod/notification-matrix.d/02-access-token.avif b/doc/mod/notification-matrix.d/02-access-token.avif
index 8a0b647..54109a6 100644
--- a/doc/mod/notification-matrix.d/02-access-token.avif
+++ b/doc/mod/notification-matrix.d/02-access-token.avif
Binary files differ
diff --git a/doc/mod/notification-matrix.d/03-join-room.avif b/doc/mod/notification-matrix.d/03-join-room.avif
index c7fad4e..45974b8 100644
--- a/doc/mod/notification-matrix.d/03-join-room.avif
+++ b/doc/mod/notification-matrix.d/03-join-room.avif
Binary files differ
diff --git a/doc/mod/notification-matrix.md b/doc/mod/notification-matrix.md
index 91a39e5..3da5659 100644
--- a/doc/mod/notification-matrix.md
+++ b/doc/mod/notification-matrix.md
@@ -42,7 +42,7 @@ Your best bet is to query the server at `domain` with the
[well-known uri](https://spec.matrix.org/latest/client-server-api/#well-known-uri).
For "*matrix.org*" this query is:
- / tool fetch "https://matrix.org/.well-known/matrix/client" output=user;
+ /tool/fetch "https://matrix.org/.well-known/matrix/client" output=user;
![home server](notification-matrix.d/01-home-server.avif)
@@ -59,7 +59,7 @@ account must be sent to the home server via
We use the home server discovered above, "*matrix-client.matrix.org*".
The user is "*example*" and password is "*v3ry-s3cr3t*".
- / tool fetch "https://matrix-client.matrix.org/_matrix/client/r0/login" http-method=post http-data="{\"type\":\"m.login.password\", \"user\":\"example\", \"password\":\"v3ry-s3cr3t\"}" output=user;
+ /tool/fetch "https://matrix-client.matrix.org/_matrix/client/r0/login" http-method=post http-data="{\"type\":\"m.login.password\", \"user\":\"example\", \"password\":\"v3ry-s3cr3t\"}" output=user;
![access token](notification-matrix.d/02-access-token.avif)
@@ -80,7 +80,7 @@ this can be done with
Make sure to replace room id ("*!*" is escaped with "*%21*") and access token
with your data.
- / tool fetch "https://matrix-client.matrix.org/_matrix/client/r0/rooms/%21WUcxpSjKyxSGelouhA:matrix.org/join?access_token=yt_ZXdvcm0tdGVzdA_NNqUyvKHRhBLZmnzVVSK_0xu6yN" http-method=post http-data="" output=user;
+ /tool/fetch "https://matrix-client.matrix.org/_matrix/client/r0/rooms/%21WUcxpSjKyxSGelouhA:matrix.org/join?access_token=yt_ZXdvcm0tdGVzdA_NNqUyvKHRhBLZmnzVVSK_0xu6yN" http-method=post http-data="" output=user;
![join room](notification-matrix.d/03-join-room.avif)
diff --git a/doc/mod/scriptrunonce.d/hello-world.rsc b/doc/mod/scriptrunonce.d/hello-world.rsc
index 17ec575..6404781 100644
--- a/doc/mod/scriptrunonce.d/hello-world.rsc
+++ b/doc/mod/scriptrunonce.d/hello-world.rsc
@@ -1,3 +1,3 @@
#!rsc by RouterOS
-:put ("Hello World from " . [ / system identity get name ] . "!");
+:put ("Hello World from " . [ /system/identity/get name ] . "!");
diff --git a/doc/mod/scriptrunonce.d/scriptrunonce.avif b/doc/mod/scriptrunonce.d/scriptrunonce.avif
index 614c72c..27ccd41 100644
--- a/doc/mod/scriptrunonce.d/scriptrunonce.avif
+++ b/doc/mod/scriptrunonce.d/scriptrunonce.avif
Binary files differ
diff --git a/doc/mod/scriptrunonce.md b/doc/mod/scriptrunonce.md
index aaa64a9..6efa1b7 100644
--- a/doc/mod/scriptrunonce.md
+++ b/doc/mod/scriptrunonce.md
@@ -37,7 +37,7 @@ Usage and invocation
The function `$ScriptRunOnce` expects an URL (or name if
`ScriptRunOnceBaseUrl` is given) pointing to a script as parameter.
- $ScriptRunOnce https://git.eworm.de/cgit/routeros-scripts/plain/doc/mod/scriptrunonce.d/hello-world.rsc
+ $ScriptRunOnce https://git.eworm.de/cgit/routeros-scripts/plain/doc/mod/scriptrunonce.d/hello-world.rsc;
![ScriptRunOnce](scriptrunonce.d/scriptrunonce.avif)