aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lease-script.md
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 13:12:58 +0200
commit087e7bc3b7cf46054c17bf91558c69a1802dc043 (patch)
tree0a913213b254ca30a7bcc39d413a0ac8648a806f /doc/lease-script.md
parent2b647bef80b014e0d3d751506fbf6bfc54871293 (diff)
doc/lease-script: reflect actual action of the script
(cherry picked from commit 56c5da8ed4097018300c1cf284ce7308acd7ece4)
Diffstat (limited to 'doc/lease-script.md')
-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
-----------------------------