aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar PackElend <stefan.mueller.83@gmail.com>2022-04-30 00:20:19 +0200
committerGravatar Christian Hesse <mail@eworm.de>2022-05-02 11:50:44 +0200
commit56c5da8ed4097018300c1cf284ce7308acd7ece4 (patch)
tree2c4e22b202d08d1c7c81556197700b3ce3abd7e7
parentf417bcbcd4ab7458f1d0b4265ccda2854ba96b4f (diff)
doc/lease-script: reflect actual action of the script
-rw-r--r--doc/lease-script.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/lease-script.md b/doc/lease-script.md
index 0ad67fb..16fc73e 100644
--- a/doc/lease-script.md
+++ b/doc/lease-script.md
@@ -9,13 +9,19 @@ Run other scripts on DHCP lease
Description
-----------
-This script is supposed to run from dhcp server as lease script. Currently
-it does:
+This script is supposed to run from dhcp server as lease script. On a dhcp
+lease it runs each script containing the following line, where `##` is a
+decimal number for ordering:
-* run [collect-wireless-mac](collect-wireless-mac.md)
-* run [dhcp-lease-comment](dhcp-lease-comment.md)
-* run [dhcp-to-dns](dhcp-to-dns.md)
-* run [hotspot-to-wpa](hotspot-to-wpa.md)
+ # provides: lease-script, order=##
+
+Currently it runs if available, in order:
+
+* [dhcp-to-dns](dhcp-to-dns.md)
+* [collect-wireless-mac](collect-wireless-mac.md)
+* [dhcp-lease-comment](dhcp-lease-comment.md)
+* `hotspot-to-wpa-cleanup`, which is an optional cleanup script
+ of [hotspot-to-wpa](hotspot-to-wpa.md)
Requirements and installation
-----------------------------