kill: New option --wait.

[dss.git] / dss.suite

diff --git a/dss.suite b/dss.suite
index e69cc28630c8a39359cba3aead33ab3b847011a8..d4926c3117ab214461d44b359beb02e77bfcd9f5 100644 (file)
--- a/dss.suite
+++ b/dss.suite
@@ -475,6 +475,27 @@ caption = Subcommands
 
                        Sending SIGHUP causes the running dss process to reload its config file.
                [/help]
 
                        Sending SIGHUP causes the running dss process to reload its config file.
                [/help]

+       [option wait]
+               short_opt = w
+               summary = wait until the signalled process has terminated
+               [help]
+                       This option is handy for system shutdown scripts which would like
+                       to terminate the dss daemon process.
+
+                       Without --wait the dss process which executes the kill subcommand
+                       exits right after the kill(2) system call returns. At this point the
+                       signalled process might still be alive (even if SIGKILL was sent).
+                       If --wait is given, the process waits until the signalled process
+                       has terminated or the timeout expires.
+
+                       If --wait is not given, the kill subcommand exits successfully if
+                       and only if the signal was sent (i.e., if there exists another dss
+                       process to receive the signal). With --wait it exits successfully
+                       if, additionally, the signalled process has terminated before the
+                       timeout expires.
+
+                       It makes only sense to use the option for signals which terminate dss.
+               [/help]

 
 [section copyright]
        Written by Andre Noll
 
 [section copyright]
        Written by Andre Noll