diff --git a/README.md b/README.md index 61688a7b270f7060af6acb255b2f65cdb11b56dc_UkVBRE1FLm1k..a71a0dc1e0437f92ceea99fcc64888bfd90f467b_UkVBRE1FLm1k 100644 --- a/README.md +++ b/README.md @@ -148,6 +148,6 @@ #### **[program:x]** Section Values <dl> <dt><strong>image</strong></dt> -<dd>Name of the image to be activated in the newly created process<br> -Default: <strong>SYS$SYSTEM:LOGINOUT.EXE</strong></dd> +<dd>Name of the image to be activated in the newly created process.<br> +Default: SYS$SYSTEM:LOGINOUT.EXE</dd> <dt><strong>command</strong></dt> @@ -153,5 +153,5 @@ <dt><strong>command</strong></dt> -<dd>Equivalence name to be associated with the logical name SYS$INPUT in the logical name table of the created process<br> +<dd>Equivalence name to be associated with the logical name SYS$INPUT in the logical name table of the created process.<br> Default: NLA0:</dd> <dt><strong>process_name</strong></dt> <dd>Process name to be assigned to the created process.<br> @@ -160,5 +160,6 @@ <dd>Instruct supervisord to use this OpenVMS user account as the account which runs the program.<br> Default: None, mandatory</dd> <dt><strong>autostart</strong></dt> -<dd></dd> +<dd>If true, this program will start automatically when supervisord is started.<br> +Default: true</dd> <dt><strong>stdout_file</strong></dt> @@ -164,3 +165,4 @@ <dt><strong>stdout_file</strong></dt> -<dd></dd> +<dd>Equivalence name to be associated with the logical name SYS$OUTPUT in the logical name table of the created process.<br> +Default: NLA0:</dd> <dt><strong>stderr_file</strong></dt> @@ -166,3 +168,4 @@ <dt><strong>stderr_file</strong></dt> -<dd></dd> +<dd>Equivalence name to be associated with the logical name SYS$ERROR in the logical name table of the created process.<br> +Default NLA0:</dd> <dt><strong>startsecs</strong></dt> @@ -168,3 +171,5 @@ <dt><strong>startsecs</strong></dt> -<dd></dd> +<dd>The total number of seconds which the program needs to stay running after a startup to consider the start successful (moving the process from the <strong>STARTING</strong> state to the <strong>RUNNING</strong> state).<br> +Set to 0 to indicate that the program needn’t stay running for any particular amount of time.<br> +Default: 10</dd> <dt><strong>startretries</strong></dt> @@ -170,3 +175,4 @@ <dt><strong>startretries</strong></dt> -<dd></dd> +<dd>The number of serial failure attempts that supervisord will allow when attempting to start the program before giving up and putting the process into an <strong>FATAL</strong> state<.<br> +Default: 3</dd> <dt><strong>stopwaitsecs</strong></dt> @@ -172,3 +178,4 @@ <dt><strong>stopwaitsecs</strong></dt> -<dd></dd> +<dd>The number of seconds to wait for the program after a $FORCEX has been sent. If this number of seconds elapses before supervisord will attempt to kill it with a $DELPRC.<br> +Default: 10</dd> <dt><strong>kt_limit</strong></dt> @@ -174,3 +181,4 @@ <dt><strong>kt_limit</strong></dt> -<dd></dd> +<dd>Sets the limit of the number of kernel threads that can be created in the process.<br> +Default: 0</dd> <dt><strong>baspri</strong></dt> @@ -176,3 +184,4 @@ <dt><strong>baspri</strong></dt> -<dd></dd> +<dd>Base priority to be assigned to the created process.<br> +Default: 4</dd> <dt><strong>nouaf</strong></dt> @@ -178,3 +187,4 @@ <dt><strong>nouaf</strong></dt> -<dd></dd> +<dd>Create the detach process with flag PRC$M_NOUAF set. Read OpenVMS documentation for more information.<br> +Default: false</dd> <dt><strong>quotas</strong></dt> @@ -180,3 +190,3 @@ <dt><strong>quotas</strong></dt> -<dd></dd> +<dd>Process quotas to be established for the created process. View the template configuration for format and example.</dd> <dt><strong>privileges</strong></dt> @@ -182,3 +192,3 @@ <dt><strong>privileges</strong></dt> -<dd></dd> +<dd>Process privileges to be established for the created process. View the template configuration for format and example.</dd> <dt><strong>autorestart</strong></dt> @@ -184,3 +194,7 @@ <dt><strong>autorestart</strong></dt> -<dd></dd> +<dd>Specifies if supervisord should automatically restart a process if it exits when it is in the <strong>RUNNING</strong> state. May be one of false, unexpected, or true.<br> +If false, the process will not be autorestarted.<br> +If unexpected, the process will be restarted when the program exits with an exit code that is not one of the exit codes associated with this process’ configuration (see exitcodes).<br> +If true, the process will be unconditionally restarted when it exits, without regard to its exit code.<br> +Default: unexpected</dd> <dt><strong>exitcodes</strong></dt> @@ -186,3 +200,4 @@ <dt><strong>exitcodes</strong></dt> -<dd></dd> +<dd>The list of “expected” exit codes for this program used with autorestart. If the autorestart parameter is set to unexpected, and the process exits in any other way than as a result of a supervisor stop request, supervisord will restart the process if it exits with an exit code that is not defined in this list.<br> +Default: 1</dd> </dl>