Supervisor: Add supervisorctl commands to documentation

[grillermo]

There is a nice intro on how to run it on the docs, and configs and everything, but nowhere it says what it does, what it is, and why do you want it.
Or maybe i skipped some part of the docs.

[hd-deman]

it's just an interface for supervisord.

There is a nice intro on how to run it on the docs, and configs and
everything, but nowhere it says what it does, what it is, and why do you
want it.
Or maybe i skipped some part of the docs.

Reply to this email directly or view it on GitHubhttps://github.com/Supervisor/supervisor/issues/250
.

With best regards, Dmitry

[mnaberez]

See also #470 ("docs don't list the supervisorctl commands").

[nicbus]

One particular issue I faced is I couldn't tell what the _reread_ and _update_ actually do.

After searching, reading and testing I understood I needed the _update_ command to read the new config files and have them come into effect.

I don't understand what the _reread_ command is for, it just tells if config files have changed and do nothing else.

Just to give some more context, I use this in a Debian package's postinst to apply the new configuration, followed by a restart of all the tasks managed by the package. This allows me to avoid issuing a _reload_ which would affect all tasks, including the ones provided by other packages.

[manuel-colmenero]

It's a shame that the otherwise great online documentation has such a gap, for a command which is more or less fundamental! I've been googling for a few minutes and was confused that I couldn't find a list of commands.

+1 I'm all for this issue getting resolved. Do you guys accept pull requests?

[msabramo]

Yep I've had several PRs merged so I think your work would get merged if it's good.

[oryband]

:+1: it is terrible that the docs are missing any supervisorctl documentation
please add

[mnaberez]

@oryband Pull request welcome.

[VynceMontgomery]

@mnaberez of course, the reason people find this issue is that they don't know what it does. Bit of a chicken-and-egg problem, y'see. ("Pull requests welcome" makes a lot less sense as a response to requests for documentation.)

[mnaberez]

@VynceMontgomery At a supervisorctl prompt, help lists all commands and help <command> shows specific help for a command. All of the commands are implemented in one file, supervisorctl.py. We'd certainly appreciate a pull request if someone is up to spending a little time on it, hopefully this provides a starting point.

[Somebi]

Is this fixed? Bump if not. Very frustrating.

[mnaberez]

Fixed in #866.