env/rabbitmq-c/tools/doc/librabbitmq-tools.xml

<?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 connecting.
                        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>