diff options
author | Emile Joubert <emile@rabbitmq.com> | 2011-06-03 11:51:50 +0100 |
---|---|---|
committer | Emile Joubert <emile@rabbitmq.com> | 2011-06-03 11:51:50 +0100 |
commit | 5f152e2e3c555ba96531985ca35cdb64cda362f4 (patch) | |
tree | 22545c50cfd2a4a5884fe0749b440d869373847b | |
parent | e3dbbc0f6f93c12f0997baee05b3fa9ab30f0280 (diff) | |
download | rabbitmq-server-5f152e2e3c555ba96531985ca35cdb64cda362f4.tar.gz |
Change rabbitmqctl docs
Move environment and report from Server Status to Application and Cluster Management
Remove list_consumers, environment and report from usage info
-rw-r--r-- | docs/rabbitmqctl.1.xml | 64 |
1 files changed, 32 insertions, 32 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index 5024a45c..a222c742 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -202,6 +202,34 @@ </listitem> </varlistentry> + <varlistentry> + <term><cmdsynopsis><command>environment</command></cmdsynopsis></term> + <listitem> + <para> + Display the name and value of each variable in the application environment. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><cmdsynopsis><command>report</command></cmdsynopsis></term> + <listitem> + <para> + Generate a server status report containing a concatenation of all server status + information for support purposes. The output should be redirected to a + file when accompanying a support request. + </para> + <para role="example-prefix"> + For example: + </para> + <screen role="example">rabbitmqctl report > server_report.txt</screen> + <para role="example"> + This command creates a server report which may be attached to a + support request email. + </para> + </listitem> + </varlistentry> + <varlistentry id="reset"> <term><cmdsynopsis><command>reset</command></cmdsynopsis></term> <listitem> @@ -1290,38 +1318,10 @@ indicating whether acknowledgements are expected for messages delivered to this consumer. </para> - <para role="usage"> - The output format for "list_consumers" is a list of rows containing, - in order, the queue name, channel process id, consumer tag, and a - boolean indicating whether acknowledgements are expected from the - consumer. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><cmdsynopsis><command>environment</command></cmdsynopsis></term> - <listitem> - <para role="usage"> - The "environment" command displays variables in the rabbit application - environment. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><cmdsynopsis><command>report</command></cmdsynopsis></term> - <listitem> - <para role="usage"> - The "report" command produces a server status report which is a concatenation - of all server status information. The output should be redirected to a file - when accompanying a support request. - </para> - <para role="example-prefix"> - For example: - </para> - <screen role="example">rabbitmqctl report > server_report.txt</screen> - <para role="example"> - This command creates a server report which may be attached to a - support request email. + <para> + The output is a list of rows containing, in order, the queue name, + channel process id, consumer tag, and a boolean indicating whether + acknowledgements are expected from the consumer. </para> </listitem> </varlistentry> |