CN place can be everywhere

[sgmon.git] / README

diff --git a/README b/README
index 8454efe691d3b0f32fe5950f4d310f2c549679ee..d59c6a90a6f3ae0829b0df18dbe290dc89125e86 100644 (file)
--- a/README
+++ b/README
@@ -9,34 +9,28 @@ Create some directory hierarchy for convenience:
 
 Make probes from them:
 
-    $ cat > probes/example.com/ping4/run <<EOF
-    #!/bin/sh -e
-    "$SGMONDIR"/helper/http http://example.com/ Some.Expected.Title
-    EOF
+    $ echo '"$SGMONDIR"/helper/http http://example.com/ Some.Expected.Title'
+        > probes/example.com/ping4/run <<EOF
     # only 3 failures will generated notification email
     $ echo 3 > probes/example.com/http/max-attempts
 
-    $ cat > probes/example.com/ping4/run <<EOF
-    #!/bin/sh -e
-    "$SGMONDIR"/helper/ping 4 example.com
-    EOF
+    $ echo '"$SGMONDIR"/helper/ping 4 example.com' > probes/example.com/ping4/run
 
-    $ cat > probes/example.com/ping6/run <<EOF
-    #!/bin/sh -e
-    "$SGMONDIR"/helper/ping 6 example.com
-    EOF
+    $ echo '"$SGMONDIR"/helper/ping 6 example.com' > probes/example.com/ping6/run
     $ echo 5 > probes/example.com/ping4/period # every 5 seconds
 
     $ cat > probes/jails/foobar/run <<EOF
     #!/bin/sh -e
     jls -j foobar-jail-name
     EOF
+    $ chmod +x probes/jails/foobar/run
 
 Set default configuration values:
 
     $ cat > rc <<EOF
     NOTIFY_EMAIL=user+sgmon@example.com
     PERIOD_DEFAULT=60
+    ATTEMPTS_DEFAULT=1
     EOF
 
 You can run probe individually for testing:
@@ -55,11 +49,11 @@ It is advisable to run it under daemontools'es supervise utility for
 convenience.
 
 run.sh creates temporary directory for each probe and links it to
-$probe/state. Also $probe/pid file is created there. run-script expects
-that it is run from the $probe directory, there is state/, where it can
-store its temporary files. $SGMONDIR are also always set $SGMONSRV.
+$probe/state. run-script expects that it is run from the $probe
+directory, there is state/, where it can store its temporary files.
+$SGMONDIR and $SGMONDIR are also always set too.
 
-You can remove all pid-files and state/-directories with clear.sh.
+You can remove all state directories with clear.sh.
 
 Generate HTML page with information about state of all services and
 their output: