Blame view

3rdparty/rabbitmq-c-0.11.0/tools/doc/amqp-delete-queue.xml 3.04 KB
09c2d08c   Hu Chunming   arm交付版
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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>