summaryrefslogtreecommitdiff
path: root/tools/doc/amqp-delete-queue.xml
diff options
context:
space:
mode:
Diffstat (limited to 'tools/doc/amqp-delete-queue.xml')
-rw-r--r--tools/doc/amqp-delete-queue.xml94
1 files changed, 94 insertions, 0 deletions
diff --git a/tools/doc/amqp-delete-queue.xml b/tools/doc/amqp-delete-queue.xml
new file mode 100644
index 0000000..040a384
--- /dev/null
+++ b/tools/doc/amqp-delete-queue.xml
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"
+[
+<!ENTITY date SYSTEM "man-date.ent" >
+]
+>
+<refentry lang="en">
+ <refentryinfo>
+ <productname>RabbitMQ C Client</productname>
+ <authorgroup>
+ <corpauthor>The RabbitMQ Team &lt;<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>&gt;</corpauthor>
+ </authorgroup>
+ <date>&date;</date>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>amqp-delete-queue</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>amqp-delete-queue</refname>
+ <refpurpose>Delete a queue from an AMQP server</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>amqp-delete-queue</command>
+ <arg choice="opt" rep="repeat">
+ <replaceable>OPTION</replaceable>
+ </arg>
+ <arg choice="req">-q <replaceable>queue name</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>amqp-delete-queue</command> deletes a queue from
+ an AMQP server, and exits after printing to standard
+ output the number of messages that were in the queue at
+ the time of its deletion.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>-q</option></term>
+ <term><option>--queue</option>=<replaceable class="parameter">queue name</replaceable></term>
+ <listitem>
+ <para>
+ The name of the queue to delete.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Exit Status</title>
+ <para>
+ If the queue was successfully deleted, the exit status is
+ 0. If an error occurs, the exit status is 1.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Examples</title>
+ <variablelist>
+ <varlistentry>
+ <term>Delete the
+ queue <quote><systemitem class="resource">myqueue</systemitem></quote>
+ at a moment when it has 123 messages waiting on
+ it:</term>
+ <listitem>
+ <screen><prompt>$ </prompt><userinput>amqp-delete-queue -q myqueue</userinput>
+123</screen>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <citerefentry><refentrytitle>librabbitmq-tools</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+ describes connection-related options common to all the
+ RabbitMQ C Client tools.
+ </para>
+ </refsect1>
+</refentry>