summaryrefslogtreecommitdiff
path: root/tools/doc
diff options
context:
space:
mode:
authorSimon MacMullen <simon@rabbitmq.com>2011-05-12 13:08:45 +0100
committerSimon MacMullen <simon@rabbitmq.com>2011-05-12 13:08:45 +0100
commit36a1423f8ad3626303e24ba34abb2ba7429e91bc (patch)
tree9bacec0e0273010e6f44d386ebc4fdfaaafda470 /tools/doc
parent11a5577f7c6ee26ec832bc806567e1909449dfc4 (diff)
downloadrabbitmq-c-github-ask-bug24079.tar.gz
Pre-junk. rabbitmq-c is not in fact a plugin.bug24079
Diffstat (limited to 'tools/doc')
-rw-r--r--tools/doc/Makefile.am42
-rw-r--r--tools/doc/consume.xml177
-rw-r--r--tools/doc/declare_queue.xml122
-rw-r--r--tools/doc/delete_queue.xml94
-rw-r--r--tools/doc/get.xml95
-rw-r--r--tools/doc/librabbitmq-tools.xml90
-rw-r--r--tools/doc/publish.xml160
7 files changed, 0 insertions, 780 deletions
diff --git a/tools/doc/Makefile.am b/tools/doc/Makefile.am
deleted file mode 100644
index f482d94..0000000
--- a/tools/doc/Makefile.am
+++ /dev/null
@@ -1,42 +0,0 @@
-EXTRA_DIST = \
- publish.xml \
- consume.xml \
- get.xml \
- declare_queue.xml \
- delete_queue.xml \
- librabbitmq-tools.xml
-
-if TOOLS_DOC
-man_MANS = \
- amqp-publish.1 \
- amqp-consume.1 \
- amqp-get.1 \
- amqp-declare-queue.1 \
- amqp-delete-queue.1 \
- librabbitmq-tools.7
-MOSTLYCLEANFILES = man-date.ent $(man_MANS)
-
-# automake complains about % pattern rules, and suffix rules don't
-# support multiple dependencies, so we have to expand all these out.
-#
-# Also, xmlto's --searchpath doesn't get passed through to xmllint, so
-# we disable xmllint validation with --skip-validation for the benefit
-# of build/source separation as required by distcheck, debian
-# packaging etc.
-amqp-publish.1: publish.xml man-date.ent
- $(XMLTO) --skip-validation --searchpath $(CURDIR) man $<
-amqp-consume.1: consume.xml man-date.ent
- $(XMLTO) --skip-validation --searchpath $(CURDIR) man $<
-amqp-get.1: get.xml man-date.ent
- $(XMLTO) --skip-validation --searchpath $(CURDIR) man $<
-amqp-declare-queue.1: declare_queue.xml man-date.ent
- $(XMLTO) --skip-validation --searchpath $(CURDIR) man $<
-amqp-delete-queue.1: delete_queue.xml man-date.ent
- $(XMLTO) --skip-validation --searchpath $(CURDIR) man $<
-librabbitmq-tools.7: librabbitmq-tools.xml man-date.ent
- $(XMLTO) --skip-validation --searchpath $(CURDIR) man $<
-
-man-date.ent:
- date +'%Y-%m-%d' >$@
-
-endif
diff --git a/tools/doc/consume.xml b/tools/doc/consume.xml
deleted file mode 100644
index c6dc65c..0000000
--- a/tools/doc/consume.xml
+++ /dev/null
@@ -1,177 +0,0 @@
-<?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-consume</refentrytitle>
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>amqp-consume</refname>
- <refpurpose>Consume messages from a queue on an AMQP server</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>amqp-consume</command>
- <arg choice="opt" rep="repeat">
- <replaceable>OPTION</replaceable>
- </arg>
- <arg choice="req">
- <replaceable>command</replaceable>
- </arg>
- <arg choice="opt" rep="repeat">
- <replaceable>args</replaceable>
- </arg>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
- <para>
- <command>amqp-consume</command> consumes messages from a
- queue on an AMQP server. For each message that arrives, a
- receiving command is run, with the message body supplied
- to it on standard input.
- </para>
- <para>
- <command>amqp-consume</command> can consume from an
- existing queue, or it can create a new queue. It can
- optionally bind the queue to an existing exchange.
- </para>
- <para>
- By default, messages will be consumed with explicit
- acknowledgements. A message will only be acknowledged if
- the receiving command exits successfully (i.e. with an
- exit code of zero). The AMQP <quote>no ack</quote> mode
- (a.k.a. auto-ack mode) can be enable with the
- <option>-A</option> option.
- </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 consume messages
- from.
- </para>
-
- <para>
- If the <option>--queue</option> option is
- omitted, the AMQP server will assign a unique
- name to the queue, and that server-assigned
- name will be dixsplayed on stderr; this case
- implies that an exclusive queue should be
- declared.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-e</option></term>
- <term><option>--exchange</option>=<replaceable class="parameter">exchange name</replaceable></term>
- <listitem>
- <para>
- Specifies that an exclusive queue should
- be declared, and bound to the given exchange.
- The specified exchange should already exist
- unless the <option>--exchange-type</option>
- option is used to request the creation of an
- exchange.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-r</option></term>
- <term><option>--routing-key</option>=<replaceable class="parameter">routing key</replaceable></term>
- <listitem>
- <para>
- The routing key for binding. If omitted, an
- empty routing key is assumed.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-d</option></term>
- <term><option>--declare</option></term>
- <listitem>
- <para>
- Forces an exclusive queue to be declared,
- even when it otherwise would not be. That is,
- when a queue name is specified with the
- <option>--queue</option> option, but no
- binding to an exchange is requested with the
- <option>--exchange</option> option.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-A</option></term>
- <term><option>--no-ack</option>=<replaceable class="parameter">routing key</replaceable></term>
- <listitem>
- <para>
- Enable <quote>no ack</quote> mode: The AMQP
- server will unconditionally acknowledge each
- message that is delivered, regardless of
- whether the target command exits successfully
- or not.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1>
- <title>Examples</title>
- <variablelist>
- <varlistentry>
- <term>Consume messages from an existing queue
- <quote><systemitem
- class="resource">myqueue</systemitem></quote>, and
- output the message bodies on standard output via
- <command>cat</command>:</term>
- <listitem>
- <screen><prompt>$ </prompt><userinput>amqp-publish -q myqueue cat</userinput></screen>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Bind a new exclusive queue to an
- exchange <quote><systemitem
- class="resource">myexch</systemitem></quote>, and send
- each message body to the script
- <filename>myscript</filename>, automatically
- acknowledging them on the server:</term>
- <listitem>
- <screen><prompt>$ </prompt><userinput>amqp-consume -A -e myexch ./myscript</userinput></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>
diff --git a/tools/doc/declare_queue.xml b/tools/doc/declare_queue.xml
deleted file mode 100644
index 7e9da32..0000000
--- a/tools/doc/declare_queue.xml
+++ /dev/null
@@ -1,122 +0,0 @@
-<?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-declare-queue</refentrytitle>
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>amqp-declare-queue</refname>
- <refpurpose>Declare (create or assert the existence of) a queue on an AMQP server</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>amqp-declare-queue</command>
- <arg choice="opt" rep="repeat">
- <replaceable>OPTION</replaceable>
- </arg>
- <arg choice="opt">-d</arg>
- <arg choice="req">-q <replaceable>queue name</replaceable></arg>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
- <para>
- <command>amqp-declare-queue</command> attempts to create a
- queue on an AMQP server, and exits. If the empty-string is
- supplied as the queue name, a fresh queue name is
- generated by the server and returned. In all cases, if a
- queue was successfully declared, the (raw binary) name of
- the queue is printed to standard output, followed by a
- newline.
- </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 declare. If the
- empty string is supplied, a fresh queue name
- is generated by the server.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-d</option></term>
- <term><option>--durable</option></term>
- <listitem>
- <para>
- Causes the queue to be declared with the
- "durable" flag set. Durable queues survive
- server restarts. By default, queues are declared
- in "transient" mode.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1>
- <title>Exit Status</title>
- <para>
- If the queue was successfully declared, the exit status is
- 0. If an error occurs, the exit status is 1.
- </para>
- </refsect1>
-
- <refsect1>
- <title>Examples</title>
- <variablelist>
- <varlistentry>
- <term>Declare the durable queue <quote><systemitem
- class="resource">myqueue</systemitem></quote>, and
- display the name of the queue on standard output:</term>
- <listitem>
- <screen><prompt>$ </prompt><userinput>amqp-declare-queue -d -q myqueue</userinput>
-myqueue</screen>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Declare a fresh, server-named transient queue,
- and display the name of the queue on standard output
- (use <citerefentry><refentrytitle>amqp-delete-queue</refentrytitle>
- <manvolnum>1</manvolnum></citerefentry> to delete
- it from the server once you're done):</term>
- <listitem>
- <screen><prompt>$ </prompt><userinput>amqp-declare-queue -q ""</userinput>
-amq.gen-BW/wvociA8g6LFpb1PlqOA==</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>
diff --git a/tools/doc/delete_queue.xml b/tools/doc/delete_queue.xml
deleted file mode 100644
index 69d03d8..0000000
--- a/tools/doc/delete_queue.xml
+++ /dev/null
@@ -1,94 +0,0 @@
-<?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>
diff --git a/tools/doc/get.xml b/tools/doc/get.xml
deleted file mode 100644
index 9770a8b..0000000
--- a/tools/doc/get.xml
+++ /dev/null
@@ -1,95 +0,0 @@
-<?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-get</refentrytitle>
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>amqp-get</refname>
- <refpurpose>Get a message from a queue on an AMQP server</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>amqp-get</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-get</command> attempts to consume a single
- message from a queue on an AMQP server, and exits. Unless
- the queue was empty, the body of the resulting message is
- sent to standard output.
- </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 consume messages
- from.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1>
- <title>Exit Status</title>
- <para>
- If the queue is not empty, and a message is successfully
- retrieved, the exit status is 0. If an error occurs, the
- exit status is 1. If the queue is found to be empty, the
- exit status is 2.
- </para>
- </refsect1>
-
- <refsect1>
- <title>Examples</title>
- <variablelist>
- <varlistentry>
- <term>Get a message from the queue <quote><systemitem
- class="resource">myqueue</systemitem></quote>, and
- display its body on standard output:</term>
- <listitem>
- <screen><prompt>$ </prompt><userinput>amqp-get -q myqueue</userinput></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>
diff --git a/tools/doc/librabbitmq-tools.xml b/tools/doc/librabbitmq-tools.xml
deleted file mode 100644
index 41f092a..0000000
--- a/tools/doc/librabbitmq-tools.xml
+++ /dev/null
@@ -1,90 +0,0 @@
-<?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>librabbitmq-tools</refentrytitle>
- <manvolnum>7</manvolnum>
- <refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>librabbitmq-tools</refname>
- <refpurpose>Command line AMQP tools</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
- <para>
- A set of command line AMQP tools based on <systemitem
- class="library">librabbitmq</systemitem>. This page
- describes common options and conventions used by all of
- the tools.
- </para>
- </refsect1>
-
- <refsect1>
- <title>Common Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-s</option></term>
- <term><option>--server</option>=<replaceable class="parameter">hostname:port</replaceable></term>
- <listitem>
- <para>
- The host name (or address) to connect to.
- Defaults to localhost. The port number may
- also be specified; if omitted, it defaults to
- the standard AMQP port number (5672).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--vhost</option>=<replaceable class="parameter">vhost</replaceable></term>
- <listitem>
- <para>
- The AMQP vhost to specify when connnecting.
- Defaults to <literal>/</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--username</option>=<replaceable class="parameter">username</replaceable></term>
- <listitem>
- <para>
- The username to authenticate to the AMQP server with. Defaults to <literal>guest</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--password</option>=<replaceable class="parameter">password</replaceable></term>
- <listitem>
- <para>
- The password to authenticate to the AMQP server with. Defaults to <literal>guest</literal>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1>
- <title>See also</title>
- <para>
- <simplelist type='inline'>
- <member><citerefentry><refentrytitle>amqp-publish</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
- <member><citerefentry><refentrytitle>amqp-consume</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
- <member><citerefentry><refentrytitle>amqp-get</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
- </simplelist>
- </para>
- </refsect1>
-</refentry>
diff --git a/tools/doc/publish.xml b/tools/doc/publish.xml
deleted file mode 100644
index d2e8d2e..0000000
--- a/tools/doc/publish.xml
+++ /dev/null
@@ -1,160 +0,0 @@
-<?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-publish</refentrytitle>
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>amqp-publish</refname>
- <refpurpose>Publish a message on an AMQP server</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>amqp-publish</command>
- <arg choice="opt" rep="repeat">
- <replaceable>OPTION</replaceable>
- </arg>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
- <para>
- Publishes a message to an exchange on an AMQP server.
- Options allow the various properties of the message and
- parameters of the AMQP <function>basic.publish</function>
- method to be specified.
- </para>
- <para>
- By default, the message body is read from standard input.
- Alternatively, the <option>-b</option> option allows the message
- body to be provided as part of the command.
- </para>
- </refsect1>
-
- <refsect1>
- <title>Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-e</option></term>
- <term><option>--exchange</option>=<replaceable class="parameter">exchange name</replaceable></term>
- <listitem>
- <para>
- The name of the exchange to publish to. If
- omitted, the default exchange (also known as
- the nameless exchange) is used.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-r</option></term>
- <term><option>--routing-key</option>=<replaceable class="parameter">routing key</replaceable></term>
- <listitem>
- <para>
- The routing key to publish with. If omitted,
- an empty routing key is assumed. A routing
- key must be specified when publishing to the
- default exchange; in that case, accoding to
- the AMQP specification, the routing key
- corresponds to a queue name.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p</option></term>
- <term><option>--persistent</option></term>
- <listitem>
- <para>
- Use the persistent delivery mode. Without
- this option, non-persistent delivery is used.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-C</option></term>
- <term><option>--content-type</option>=<replaceable class="parameter">MIME type</replaceable></term>
- <listitem>
- <para>
- Specifies the content-type property for the
- message. If omitted, the content-type
- property is not set on the message.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E</option></term>
- <term><option>--content-encoding</option>=<replaceable class="parameter">content coding</replaceable></term>
- <listitem>
- <para>
- Specifies the content-encoding property for
- the message. If omitted, the content-encoding
- property is not set on the message.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b</option></term>
- <term><option>--body</option>=<replaceable class="parameter">message body</replaceable></term>
- <listitem>
- <para>
- Specifies the message body. If omitted, the
- message body is read from standard input.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1>
- <title>Examples</title>
- <variablelist>
- <varlistentry>
- <term>Send a short message, consisting of the word
- <quote><literal>Hello</literal></quote> to the queue
- <quote><systemitem
- class="resource">myqueue</systemitem></quote> via the
- default exchange:</term>
- <listitem>
- <screen><prompt>$ </prompt><userinput>amqp-publish -r myqueue -b Hello</userinput></screen>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Send some XML data from a file to the exchange
- <quote><systemitem
- class="resource">events</systemitem></quote>, with
- persistent delivery mode, setting the content-type
- property on the message to make the data format
- explicit:</term>
- <listitem>
- <screen><prompt>$ </prompt><userinput>amqp-publish -e events -p -C text/xml &lt;event.xml</userinput></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>