Skip to content
Snippets Groups Projects
Commit a079f6ad1b9b authored by jfp's avatar jfp
Browse files

Documentation update

parent 1a8a6841ebc1
No related branches found
No related tags found
No related merge requests found
......@@ -14,6 +14,9 @@
- [Configuration file](#configuration-file)
- [File Format](#file-format)
- [**\[supervisord\]** Section Settings](#supervisord-section-settings)
- [**\[supervisord\]** Section Values](#supervisord-section-values)
- [**\[program:x\]** Section Settings](#programx-section-settings)
- [**\[program:x\]** Section Values](#programx-section-values)
It was inspired by *[supervisor](http://supervisord.org/)*
......@@ -119,5 +122,5 @@
It has sections (each denoted by a **[header]**) and key / value pairs within the sections.<br>
The sections and their allowable values are described below.
#### **[supervisord]** Section Settings
### **[supervisord]** Section Settings
All pathname use a **OpenVMS** syntax.
......@@ -123,4 +126,5 @@
All pathname use a **OpenVMS** syntax.
#### **[supervisord]** Section Values
<dl>
<dt><strong>nodaemon</strong></dt>
<dd>If true, supervisord will start in the foreground instead of daemonizing<br>Default: false</dd>
......@@ -133,4 +137,52 @@
<dd>stdout of supervisord process.<br>Default: NLA0:</dd>
<dt><strong>logfile</strong></dt>
<dd>The path to the activity log of the supervisord process<br>Default: supervisord.log</dd>
</dl>
\ No newline at end of file
</dl>
### **[program:x]** Section Settings
The configuration file must contain one or more program sections in order for supervisord to know which programs it should start and control.<br>
The header value is composite value.
<br>It is the word “program”, followed directly by a colon, then the program name.<br>
Read the *[$creprc](https://docs.vmssoftware.com/vsi-openvms-system-services-reference-manual-a-getuai/#JUN_147)* documentation may be useful.
#### **[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>
<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>
Default: NLA0:</dd>
<dt><strong>process_name</strong></dt>
<dd>Process name to be assigned to the created process.<br>
Default: %(program_name)s</dd>
<dt><strong>user</strong></dt>
<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>
<dt><strong>stdout_file</strong></dt>
<dd></dd>
<dt><strong>stderr_file</strong></dt>
<dd></dd>
<dt><strong>startsecs</strong></dt>
<dd></dd>
<dt><strong>startretries</strong></dt>
<dd></dd>
<dt><strong>stopwaitsecs</strong></dt>
<dd></dd>
<dt><strong>kt_limit</strong></dt>
<dd></dd>
<dt><strong>baspri</strong></dt>
<dd></dd>
<dt><strong>nouaf</strong></dt>
<dd></dd>
<dt><strong>quotas</strong></dt>
<dd></dd>
<dt><strong>privileges</strong></dt>
<dd></dd>
<dt><strong>autorestart</strong></dt>
<dd></dd>
<dt><strong>exitcodes</strong></dt>
<dd></dd>
</dl>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment