diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index 0465db02fd..ef313ab012 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -135,6 +135,29 @@ </listitem> </varlistentry> + <varlistentry> + <term><cmdsynopsis><command>shutdown</command></cmdsynopsis></term> + <listitem> + <para> + Shuts down the Erlang process on which RabbitMQ is running. The + command is blocking and will return after the Erlang process + exits. If RabbitMQ fails to stop, it will return a non-zero exit + code. + </para> + <para> + Unlike the stop command, the shutdown command: + * does not require a pid_file to wait for the Erlang process to exit + * if RabbitMQ node is not running, it will return a non-zero exit code + * it will refuse to stop a remote RabbitMQ node and return a non-zero exit code + </para> + <para role="example-prefix">For example:</para> + <screen role="example">rabbitmqctl shutdown</screen> + <para role="example"> + This command shuts down the Erlang process on which RabbitMQ is running. + </para> + </listitem> + </varlistentry> + <varlistentry id="stop_app"> <term><cmdsynopsis><command>stop_app</command></cmdsynopsis></term> <listitem> |