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

Documentation update

parent edc550ebae1f
No related branches found
No related tags found
No related merge requests found
...@@ -11,6 +11,9 @@ ...@@ -11,6 +11,9 @@
- [Running supervisorctl](#running-supervisorctl) - [Running supervisorctl](#running-supervisorctl)
- [supervisorctl Command-Line Options](#supervisorctl-command-line-options) - [supervisorctl Command-Line Options](#supervisorctl-command-line-options)
- [supervisorctl Actions](#supervisorctl-actions) - [supervisorctl Actions](#supervisorctl-actions)
- [Configuration file](#configuration-file)
- [File Format](#file-format)
- [**\[supervisord\]** Section Settings](#supervisord-section-settings)
It was inspired by *[supervisor](http://supervisord.org/)* It was inspired by *[supervisor](http://supervisord.org/)*
...@@ -34,8 +37,10 @@ ...@@ -34,8 +37,10 @@
**supervisorctl.py** **supervisorctl.py**
The command-line client piece of the supervisor is named supervisorctl.<br> The command-line client piece of the supervisor is named supervisorctl.
It provides a shell-like interface to the features provided by supervisord.<br>
It provides a shell-like interface to the features provided by supervisord.
From **supervisorctl**, a user can connect to the **supervisord** process, get status on the processes controlled by, stop and start processes of, and get lists of running processes (programs). From **supervisorctl**, a user can connect to the **supervisord** process, get status on the processes controlled by, stop and start processes of, and get lists of running processes (programs).
The command-line client talks to the server across a mailbox (SUPERVISORD_CMD logical) The command-line client talks to the server across a mailbox (SUPERVISORD_CMD logical)
...@@ -49,7 +54,8 @@ ...@@ -49,7 +54,8 @@
Finally, if all seem correct, shutdown it and restart it on daemon mode. Finally, if all seem correct, shutdown it and restart it on daemon mode.
Running processes doesn't need to be stopped. When restarting **supervisord** find the necessary informations for running processes using the logical name table **SUPERVISORD_TABLE**. Running processes doesn't need to be stopped.<br>
When restarting **supervisord** find the necessary informations for running processes using the logical name table **SUPERVISORD_TABLE**.
### supervisord Command-Line Options ### supervisord Command-Line Options
<dl> <dl>
...@@ -100,5 +106,5 @@ ...@@ -100,5 +106,5 @@
<dt><strong>stop all</strong></dt> <dt><strong>stop all</strong></dt>
<dd>Stop all processes</dd> <dd>Stop all processes</dd>
<dt><strong>shutdown</strong></dt> <dt><strong>shutdown</strong></dt>
<dd>Stop supervisord, don't stop processes</dd> <dd>Stop <strong>supervisord</strong>, don't stop processes</dd>
</dl> </dl>
...@@ -104,1 +110,27 @@ ...@@ -104,1 +110,27 @@
</dl> </dl>
## Configuration file
The Supervisor configuration file is conventionally named supervisord.conf. <br>
It is used by both **supervisord** and **supervisorctl**.
### File Format
**supervisord.conf** is a Windows-INI-style (Python ConfigParser) file.<br>
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
All pathname use a **OpenVMS** syntax.
<dl>
<dt><strong>nodaemon</strong></dt>
<dd>If true, supervisord will start in the foreground instead of daemonizing<br>Default: false</dd>
<dt><strong>user</strong></dt>
<dd>OpenVMS account to run <strong>supervisord</strong> as a detach process (daemon mode).<br> Default: system</dd>
<dt><strong>command</strong></dt>
<dd>Command procedure which run supervisord.<br>Default: None, should be specified, can be build from the template
supervisord.com_template</dd>
<dt><strong>stdout_file</strong></dt>
<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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment