Browse Source

Improve documentation of scripts

Baptiste Jonglez 10 years ago
parent
commit
acd4f8bd6e
2 changed files with 11 additions and 3 deletions
  1. 6 2
      templates/cron.sh
  2. 5 1
      templates/run.sh

+ 6 - 2
templates/cron.sh

@@ -3,9 +3,13 @@
 # Measurement script for the dn42 peer finder, see http://peerfinder.polynome.dn42
 # Dependencies: curl, sed, ping
 #
-# Run without argument for IPv4-only, and with an argument for IPv6-only, e.g.
+# This script is designed to be run in cron every minute, like this:
 #
-#   ./script.sh ipv6
+#   * * * * * /home/foo/cron.sh
+#
+# If you also want to provide IPv6 measurements, run it a second time with:
+#
+#   * * * * * /home/foo/cron.sh ipv6
 
 # Put your UUID here, and keep it secret!
 UUID="{{ uuid|default('00000000-0000-0000-0000-000000000000') }}"

+ 5 - 1
templates/run.sh

@@ -5,7 +5,11 @@
 #
 # Run without argument for IPv4-only, and with an argument for IPv6-only, e.g.
 #
-#   ./script.sh ipv6
+#   ./script.sh &
+#   ./script.sh ipv6 &
+#
+# The script will run in a loop forever, periodically fetching targets and
+# reporting results back to the peerfinder.
 
 # Put your UUID here, and keep it secret!
 UUID="{{ uuid|default('00000000-0000-0000-0000-000000000000') }}"