]> Kevux Git Server - fll/commitdiff
Update: Man page for controller specification changes regarding "helper" mode.
authorKevin Day <kevin@kevux.org>
Thu, 16 Mar 2023 00:00:52 +0000 (19:00 -0500)
committerKevin Day <kevin@kevux.org>
Thu, 16 Mar 2023 00:00:52 +0000 (19:00 -0500)
level_3/controller/data/documentation/man/man5/controller-entry.5

index 33d4dba0e915c32d12fec9217865df62d30f5b9a..fd9619d8d0c1078acf71e38ee6110b63f92e6967 100644 (file)
@@ -55,10 +55,19 @@ Execution of all Items is top\-down.
 
   \- The \fBmode\fR setting:
     Represents the mode in which the Entry is operating in.
-    The following modes are supported: \fBprogram\fR and \fBservice\fR.
+    The following modes are supported: \fBhelper\fR, \fBprogram\fR, and \fBservice\fR.
+
+    - The \fBhelper\fR mode:
+      Designates that the Entry operates as a helper for starting programs or performing actions and exits when complete.
+      On exit, any background (asynchronous) processes are not cancelled.
+      If terminated, the foreground (synchronous) process is cancelled.
+      Will call the \fBexit\fR with the same name as this Entry, but with the extension \fBexit\fR, such as \fBdefault.exit\fR.
+      Supports the Item Action \fBexecute\fR to execute a program (switching the \fBcontroller\fR program entirely with the executed process).
 
     \- The \fBprogram\fR mode:
       Designates that the Entry operates as a program and exits when complete.
+      On exit, any background (asynchronous) processes are also cancelled.
+      If terminated, the foreground (synchronous) process is cancelled.
       Will call the \fBexit\fR with the same name as this Entry, but with the extension \fBexit\fR, such as \fBdefault.exit\fR.
       Supports the Item Action \fBexecute\fR to execute a program (switching the \fBcontroller\fR program entirely with the executed process).