summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael Klishin <mklishin@pivotal.io>2017-04-02 21:52:52 +0300
committerMichael Klishin <mklishin@pivotal.io>2017-04-02 21:52:52 +0300
commita706a2ba08c16ba518a49844114e15bb41119846 (patch)
tree0de1b89a1cecf2dfab2c4ed9414198f34325978e /docs
parentd969c12b09770fb1f473b40af7c07258aa188588 (diff)
parent7741b37b1efa97ac9b17685cc626bd35ee52ca16 (diff)
downloadrabbitmq-server-git-a706a2ba08c16ba518a49844114e15bb41119846.tar.gz
Merge branch 'stable'
Conflicts: src/rabbit_control_main.erl src/rabbit_error_logger_file_h.erl src/rabbit_registry.erl src/rabbit_sasl_report_file_h.erl
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmqctl.1.xml22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml
index ec3bbde75c..b92e1f0229 100644
--- a/docs/rabbitmqctl.1.xml
+++ b/docs/rabbitmqctl.1.xml
@@ -135,6 +135,28 @@
</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
+ </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>