diff options
| author | Emile Joubert <emile@rabbitmq.com> | 2011-08-31 09:51:48 +0100 |
|---|---|---|
| committer | Emile Joubert <emile@rabbitmq.com> | 2011-08-31 09:51:48 +0100 |
| commit | 4f515599a6ee73162665e44438cd7930bc27fd97 (patch) | |
| tree | 290f596c5ac31b0e1c039850299326ecbb6a114d /docs | |
| parent | 2873f3d8c968ba1630e4f601ee7b8a3cfb101527 (diff) | |
| parent | 2e10ce2b7c885dcf65b5014f954fcf7fc3598f04 (diff) | |
| download | rabbitmq-server-4f515599a6ee73162665e44438cd7930bc27fd97.tar.gz | |
Merged default into bug24323
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 95 |
1 files changed, 52 insertions, 43 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index 3291c44d..29d9032b 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -390,44 +390,6 @@ </refsect2> <refsect2> - <title>Closing individual connections</title> - - <variablelist> - <varlistentry> - <term><cmdsynopsis><command>close_connection</command> <arg choice="req"><replaceable>connectionpid</replaceable></arg> <arg choice="req"><replaceable>explanation</replaceable></arg></cmdsynopsis></term> - <listitem> - <variablelist> - <varlistentry> - <term>connectionpid</term> - <listitem><para>Id of the Erlang process associated with the connection to close.</para></listitem> - </varlistentry> - <varlistentry> - <term>explanation</term> - <listitem><para>Explanation string.</para></listitem> - </varlistentry> - </variablelist> - <para> - Instruct the broker to close the connection associated - with the Erlang process id <option>connectionpid</option> (see also the - <link linkend="list_connections"><command>list_connections</command></link> - command), passing the <option>explanation</option> string to the - connected client as part of the AMQP connection shutdown - protocol. - </para> - <para role="example-prefix">For example:</para> - <screen role="example">rabbitmqctl close_connection "<rabbit@tanto.4262.0>" "go away"</screen> - <para role="example"> - This command instructs the RabbitMQ broker to close the - connection associated with the Erlang process - id <command><rabbit@tanto.4262.0></command>, passing the - explanation <command>go away</command> to the connected client. - </para> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - - <refsect2> <title>User management</title> <para> Note that <command>rabbitmqctl</command> manages the RabbitMQ @@ -1306,9 +1268,14 @@ <para> Displays broker status information such as the running applications on the current Erlang node, RabbitMQ and - Erlang versions and OS name. (See - the <command>cluster_status</command> command to find - out which nodes are clustered and running.) + Erlang versions, OS name and memory statistics. + In this context <varname>vm_memory_high_watermark</varname> + indicates the fraction of memory at which flow control is + triggered. <varname>vm_memory_limit</varname> refers to the + absolute memory threshhold at which flow control is triggered. + The unit of this number and those listed in the <varname>memory</varname> + section is bytes. (See the <command>cluster_status</command> + command to find out which nodes are clustered and running.) </para> <para role="example-prefix">For example:</para> <screen role="example">rabbitmqctl status</screen> @@ -1352,9 +1319,40 @@ </refsect2> <refsect2> - <title>Message Tracing</title> + <title>Miscellaneous</title> <variablelist> <varlistentry> + <term><cmdsynopsis><command>close_connection</command> <arg choice="req"><replaceable>connectionpid</replaceable></arg> <arg choice="req"><replaceable>explanation</replaceable></arg></cmdsynopsis></term> + <listitem> + <variablelist> + <varlistentry> + <term>connectionpid</term> + <listitem><para>Id of the Erlang process associated with the connection to close.</para></listitem> + </varlistentry> + <varlistentry> + <term>explanation</term> + <listitem><para>Explanation string.</para></listitem> + </varlistentry> + </variablelist> + <para> + Instruct the broker to close the connection associated + with the Erlang process id <option>connectionpid</option> (see also the + <link linkend="list_connections"><command>list_connections</command></link> + command), passing the <option>explanation</option> string to the + connected client as part of the AMQP connection shutdown + protocol. + </para> + <para role="example-prefix">For example:</para> + <screen role="example">rabbitmqctl close_connection "<rabbit@tanto.4262.0>" "go away"</screen> + <para role="example"> + This command instructs the RabbitMQ broker to close the + connection associated with the Erlang process + id <command><rabbit@tanto.4262.0></command>, passing the + explanation <command>go away</command> to the connected client. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><cmdsynopsis><command>trace_on</command> <arg choice="opt">-p <replaceable>vhost</replaceable></arg></cmdsynopsis></term> <listitem> <variablelist> @@ -1383,7 +1381,18 @@ </para> </listitem> </varlistentry> - + <varlistentry> + <term><cmdsynopsis><command>set_vm_memory_high_watermark</command> <arg choice="req"><replaceable>fraction</replaceable></arg></cmdsynopsis></term> + <listitem> + <variablelist> + <varlistentry> + <term>fraction</term> + <listitem><para>The new memory threshhold fraction at which flow control is triggered, as a + floating point number between 0.0 and 1.0 with a mandatory fractional part.</para></listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> </variablelist> </refsect2> </refsect1> |