Skip to content

Commit cff0f16

Browse files
committed
doc: moved supervisorctl Command-Line Options
options were with running supervisor, so as a user, I was not easy to find options for supervisorctl it will make more sense with the next commit where we explain all different actions for supervisorctl
1 parent bad867b commit cff0f16

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

docs/running.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,27 @@ value in the configuration file.
166166
the supervisord process before it will start successfully.
167167

168168

169+
Running :program:`supervisorctl`
170+
--------------------------------
171+
172+
To start :program:`supervisorctl`, run ``$BINDIR/supervisorctl``. A
173+
shell will be presented that will allow you to control the processes
174+
that are currently managed by :program:`supervisord`. Type "help" at
175+
the prompt to get information about the supported commands.
176+
177+
The :command:`supervisorctl` executable may be invoked with "one time"
178+
commands when invoked with arguments from a command line. An example:
179+
``supervisorctl stop all``. If arguments are present on the
180+
command-line, it will prevent the interactive shell from being
181+
invoked. Instead, the command will be executed and ``supervisorctl``
182+
will exit with a code of 0 for success or running and non-zero for
183+
error. An example: ``supervisorctl status all`` would return non-zero
184+
if any single process was not running.
185+
186+
If :command:`supervisorctl` is invoked in interactive mode against a
187+
:program:`supervisord` that requires authentication, you will be asked
188+
for authentication credentials.
189+
169190
:command:`supervisorctl` Command-Line Options
170191
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171192

@@ -205,27 +226,6 @@ interactively is started. Use the action "help" to find out about available
205226
actions.
206227

207228

208-
Running :program:`supervisorctl`
209-
--------------------------------
210-
211-
To start :program:`supervisorctl`, run ``$BINDIR/supervisorctl``. A
212-
shell will be presented that will allow you to control the processes
213-
that are currently managed by :program:`supervisord`. Type "help" at
214-
the prompt to get information about the supported commands.
215-
216-
The :command:`supervisorctl` executable may be invoked with "one time"
217-
commands when invoked with arguments from a command line. An example:
218-
``supervisorctl stop all``. If arguments are present on the
219-
command-line, it will prevent the interactive shell from being
220-
invoked. Instead, the command will be executed and ``supervisorctl``
221-
will exit with a code of 0 for success or running and non-zero for
222-
error. An example: ``supervisorctl status all`` would return non-zero
223-
if any single process was not running.
224-
225-
If :command:`supervisorctl` is invoked in interactive mode against a
226-
:program:`supervisord` that requires authentication, you will be asked
227-
for authentication credentials.
228-
229229
Signals
230230
-------
231231

0 commit comments

Comments
 (0)