doc: inform about dependency on base installation

That should make the documentation clearer if external sites link to the documentation of a specific script.
2024-05-14 08:04:19 +00:00 · 2021-05-03 15:07:50 +02:00 · 2021-05-03 15:07:50 +02:00 · 64ff7fcf65
parent e0e53b8add
commit 64ff7fcf65
31 changed files with 93 additions and 0 deletions
--- a/doc/accesslist-duplicates.md
+++ b/doc/accesslist-duplicates.md
@ -3,6 +3,9 @@ Find and remove access list duplicates

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/bridge-port.md
+++ b/doc/bridge-port.md
@ -3,6 +3,9 @@ Manage ports in bridge

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/capsman-download-packages.md
+++ b/doc/capsman-download-packages.md
@ -3,6 +3,9 @@ Download packages for CAP upgrade from CAPsMAN

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/capsman-rolling-upgrade.md
+++ b/doc/capsman-rolling-upgrade.md
@ -3,6 +3,9 @@ Run rolling CAP upgrades from CAPsMAN

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/certificate-renew-issued.md
+++ b/doc/certificate-renew-issued.md
@ -3,6 +3,9 @@ Renew locally issued certificates

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/check-certificates.md
+++ b/doc/check-certificates.md
@ -3,6 +3,9 @@ Renew certificates and notify on expiration

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/check-health.md
+++ b/doc/check-health.md
@ -3,6 +3,9 @@ Notify about health state

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/check-lte-firmware-upgrade.md
+++ b/doc/check-lte-firmware-upgrade.md
@ -3,6 +3,9 @@ Notify on LTE firmware upgrade

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/check-routeros-update.md
+++ b/doc/check-routeros-update.md
@ -3,6 +3,9 @@ Notify on RouterOS update

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/cloud-backup.md
+++ b/doc/cloud-backup.md
@ -3,6 +3,9 @@ Upload backup to Mikrotik cloud

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/collect-wireless-mac.md
+++ b/doc/collect-wireless-mac.md
@ -3,6 +3,9 @@ Collect MAC addresses in wireless access list

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/daily-psk.md
+++ b/doc/daily-psk.md
@ -3,6 +3,9 @@ Use wireless network with daily psk

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/dhcp-lease-comment.md
+++ b/doc/dhcp-lease-comment.md
@ -3,6 +3,9 @@ Comment DHCP leases with info from access list

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/dhcp-to-dns.md
+++ b/doc/dhcp-to-dns.md
@ -3,6 +3,9 @@ Create DNS records for DHCP leases

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/email-backup.md
+++ b/doc/email-backup.md
@ -3,6 +3,9 @@ Send backup via e-mail

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/gps-track.md
+++ b/doc/gps-track.md
@ -3,6 +3,9 @@ Send GPS position to server

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/hotspot-to-wpa.md
+++ b/doc/hotspot-to-wpa.md
@ -3,6 +3,9 @@ Use WPA2 network with hotspot credentials

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/ipv6-update.md
+++ b/doc/ipv6-update.md
@ -3,6 +3,9 @@ Update configuration on IPv6 prefix change

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/lease-script.md
+++ b/doc/lease-script.md
@ -3,6 +3,9 @@ Run other scripts on DHCP lease

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/log-forward.md
+++ b/doc/log-forward.md
@ -3,6 +3,9 @@ Forward log messages via notification

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/mode-button.md
+++ b/doc/mode-button.md
@ -3,6 +3,9 @@ Mode button with multiple presses

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/netwatch-notify.md
+++ b/doc/netwatch-notify.md
@ -3,6 +3,9 @@ Notify on host up and down

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/ospf-to-leds.md
+++ b/doc/ospf-to-leds.md
@ -3,6 +3,9 @@ Visualize OSPF state via LEDs

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/packages-update.md
+++ b/doc/packages-update.md
@ -3,6 +3,9 @@ Manage system update

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/ppp-on-up.md
+++ b/doc/ppp-on-up.md
@ -3,6 +3,9 @@ Run scripts on ppp connection

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/rotate-ntp.md
+++ b/doc/rotate-ntp.md
@ -3,6 +3,9 @@ Rotate NTP servers

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/sms-action.md
+++ b/doc/sms-action.md
@ -3,6 +3,9 @@ Act on received SMS

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/sms-forward.md
+++ b/doc/sms-forward.md
@ -3,6 +3,9 @@ Forward received SMS

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/update-gre-address.md
+++ b/doc/update-gre-address.md
@ -3,6 +3,9 @@ Update GRE configuration with dynamic addresses

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/update-tunnelbroker.md
+++ b/doc/update-tunnelbroker.md
@ -3,6 +3,9 @@ Update tunnelbroker configuration

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------

--- a/doc/upload-backup.md
+++ b/doc/upload-backup.md
@ -3,6 +3,9 @@ Upload backup to server

 [◀ Go back to main README](../README.md)

+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
 Description
 -----------