service: fix recently introduced double-start bug.

[oweals/dinit.git] / README

diff --git a/README b/README
index c9213a7056463a94d1001f0b2d939ed2919dc5ba..6c7bd26d7757818b7c3399d64d7f0a4d4669f5b7 100644 (file)
--- a/README
+++ b/README
@@ -164,6 +164,30 @@ smooth-recovery = yes | true | no | false
    the service does not reach the stopped state when the process terminates
    unexpectedly).
 
+restart-delay = XXX.YYYY
+   Specifies the minimum time in seconds between automatic restarts. The
+   default is 0.2 (i.e. 200ms). This prevents Dinit from consuming processor
+   cycles when a process continuously fails immediately after it starts.
+
+restart-limit-interval = XXX.YYYY
+   Specifies the interval, in seconds, over which restarts are limited. If a
+   process automatically restarts more than a certain number of times (default
+   3) in this time interval, it will not restart again. The default value is
+   10 seconds. Use this to prevent broken services from continuously
+   restarting ad infinitum.
+
+restart-limit-count = NNN
+   Specifies the maximum number of times that a service can automatically
+   restart over the interval specified by restart-limit-interval (default of
+   10 seconds). Specify a value of 0 to disable the restart limit.
+
+stop-timeout = XXX.YYYY
+   Specifies the time in seconds allowed for the service to stop. If the
+   service takes longer than this, its process group is sent a SIGKILL signal
+   which should cause it to terminate immediately. The timeout period begins
+   only when all dependent services have already stopped. The default stop
+   timeout is 10 seconds.
+
 pid-file = (path to file)
    For "bgprocess" type services only; specifies the path of the file where
    daemon will write its process ID before detaching.
@@ -257,6 +281,10 @@ options = ( runs-on-console | nosigterm | starts-rwfs | starts-log ) ...
               untrusted processes. You should not use this option unless the
               service is designed to receive a Dinit control socket.
 
+logfile = (log file path)
+   Specifies the log file for the service. Output from the service process
+   will go this file.
+
 
 Controlling services
 =-=-=-=-=-=-=-=-=-=-