diff --git a/README.md b/README.md index 742326aeb96e8275c735b452c3d124f05b70ba30_UkVBRE1FLm1k..e6b8d0f8cacefa7313fd97b63a59f6404a7516ca_UkVBRE1FLm1k 100644 --- a/README.md +++ b/README.md @@ -10,4 +10,5 @@ - [supervisord Command-Line Options](#supervisord-command-line-options) - [Running supervisorctl](#running-supervisorctl) - [supervisorctl Command-Line Options](#supervisorctl-command-line-options) + - [supervisorctl Actions](#supervisorctl-actions) @@ -13,7 +14,7 @@ -It was inspired by [[supervisor](http://supervisord.org/)] +It was inspired by *[supervisor](http://supervisord.org/)* Read the supervisor documentation is probably a good idea. Many of configuration parameters are the same. ## Requirements 1. Python 3.10 (VSI version) @@ -15,9 +16,9 @@ Read the supervisor documentation is probably a good idea. Many of configuration parameters are the same. ## Requirements 1. Python 3.10 (VSI version) -2. ovms module +1. ovms module Probably better to use the LD image which contains all the necessary modules. ## Components @@ -26,9 +27,10 @@ **supervisord.py** -The server piece of supervisor is named supervisord. It is responsible for starting processes (programs) at its own invocation, responding to commands from clients, restarting crashed or exited processeses +The server piece of supervisor is named supervisord.<br> +It is responsible for starting processes (programs) at its own invocation, responding to commands from clients, restarting crashed or exited processeses The server process uses a configuration file. **supervisorctl.py** @@ -30,9 +32,11 @@ The server process uses a configuration file. **supervisorctl.py** -The command-line client piece of the supervisor is named supervisorctl. 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). +The command-line client piece of the supervisor is named supervisorctl.<br> +It provides a shell-like interface to the features provided by supervisord.<br> +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) @@ -45,6 +49,6 @@ 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. When restarting **supervisord** find the necessary informations for running processes using the logical name table **SUPERVISORD_TABLE**. ### supervisord Command-Line Options @@ -49,6 +53,6 @@ ### supervisord Command-Line Options -**-c FILE, --configuration=FILE** +- **-c FILE, --configuration=FILE** The path to a **supervisord** configuration file. Unix syntax should be used @@ -52,7 +56,7 @@ The path to a **supervisord** configuration file. Unix syntax should be used -**-n, --nodaemon** +- **-n, --nodaemon** Run supervisord in the foreground. @@ -56,7 +60,7 @@ Run supervisord in the foreground. -**-p pwd, --password=pwd** +- **-p pwd, --password=pwd** Optional password, used by **supervisorctl**. @@ -60,10 +64,10 @@ Optional password, used by **supervisorctl**. -**-h, --help** +- **-h, --help** Show supervisord command help. ## Running supervisorctl Required privilege: **PRMMBX, SYSNAM** ### supervisorctl Command-Line Options @@ -64,10 +68,10 @@ Show supervisord command help. ## Running supervisorctl Required privilege: **PRMMBX, SYSNAM** ### supervisorctl Command-Line Options -**-c FILE, --configuration=FILE** +- **-c FILE, --configuration=FILE** The path to a **supervisord** configuration file. Unix syntax should be used @@ -71,7 +75,7 @@ The path to a **supervisord** configuration file. Unix syntax should be used -**-p pwd, --password=pwd** +- **-p pwd, --password=pwd** Optional password, used by **supervisorctl**. @@ -75,7 +79,7 @@ Optional password, used by **supervisorctl**. -**-h, --help** +- **-h, --help** Show supervisord command help. @@ -79,3 +83,48 @@ Show supervisord command help. +### supervisorctl Actions +- **help** + + Print a list of available actions + +- **help \<action\>** + + Print help for \<action\> + +- **start \<name\>** + + Start a process + +- **start \<name\> \<name\>** + + Start multiple processes + +- **start all** + + Start all processes + +- **status** + + Get all process status info. + +- **status \<name\>** + + Get status on a single process by name. + +- **status \<name\> \<name\>** + + Get status on multiple named processes. + +- **stop \<name\>** + + Stop a process + +- **stop \<name\> \<name\>** + + Stop multiple processes + +- **stop all** + + Stop all processes +