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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
<?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">
<!--
There is some extra magic in this document besides the usual DocBook semantics
to allow us to derive manpages, HTML and usage messages from the same source
document.
Examples need to be moved to the end for man pages. To this end, <para>s and
<screen>s with role="example" will be moved, and with role="example-prefix"
will be removed.
The usage messages are more involved. We have some magic in usage.xsl to pull
out the command synopsis, global option and subcommand synopses. We also pull
out <para>s with role="usage".
Finally we construct lists of possible values for subcommand options, if the
subcommand's <varlistentry> has role="usage-has-option-list". The option which
takes the values should be marked with role="usage-option-list".
-->
<refentry lang="en">
<refentryinfo>
<productname>RabbitMQ Server</productname>
<authorgroup>
<corpauthor>The RabbitMQ Team <<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>></corpauthor>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>rabbitmq-plugin</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">RabbitMQ Service</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rabbitmq-plugin</refname>
<refpurpose>command line tool for managing a RabbitMQ broker plugins</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>rabbitmq-plugin</command>
<arg choice="req"><replaceable>command</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>command options</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>rabbitmq-plugin</command> is a command line tool for
managing a RabbitMQ broker plugins. It allows you to easily
enable, disable and browse plugins. Note that it must be run by
a user with write permissions to the RabbitMQ installation
directory.
</para>
</refsect1>
<refsect1>
<title>Commands</title>
<refsect2>
<title>Local Plugin Management</title>
<variablelist>
<varlistentry>
<term><cmdsynopsis><command>list</command> <arg choice="opt">-c</arg> <arg choice="opt"><replaceable>pattern</replaceable></arg></cmdsynopsis></term>
<listitem>
<variablelist>
<varlistentry>
<term>-c</term>
<listitem><para>List plugins compactly.</para></listitem>
</varlistentry>
<varlistentry>
<term>pattern</term>
<listitem><para>Pattern to filter the plugin names by.</para></listitem>
</varlistentry>
</variablelist>
<para>
Lists available plugins, their versions, dependencies
and descriptions.
</para>
<para>
If the optional pattern is given, only plugins whose
name mathes pattern are shown.
</para>
<para role="example-prefix">For example:</para>
<screen role="example">rabbitmq-plugin list</screen>
<para role="example">
This command lists all the plugins available..
</para>
<screen role="example">rabbitmq-plugin list -c</screen>
<para role="example">
This command lists all the plugins available, on one line each.
</para>
<screen role="example">rabbitmq-plugin list -c management</screen>
<para role="example">
This command lists all the plugins available, on one
line each, but does not display plugins whose name does
not contain "management".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><cmdsynopsis><command>enable</command> <arg choice="req"><replaceable>plugin</replaceable> ...</arg></cmdsynopsis></term>
<listitem>
<variablelist>
<varlistentry>
<term>plugin</term>
<listitem><para>One or more plugins to enable.</para></listitem>
</varlistentry>
</variablelist>
<para>
Enables the specified plugins and all their
dependencies.
</para>
<para role="example-prefix">For example:</para>
<screen role="example">rabbitmq-plugin enable rabbitmq_shovel rabbitmq_management</screen>
<para role="example">
This command enables the <command>shovel</command> and
<command>management</command> plugins and all their
dependencies.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><cmdsynopsis><command>disable</command> <arg choice="req"><replaceable>plugin</replaceable> ...</arg></cmdsynopsis></term>
<listitem>
<variablelist>
<varlistentry>
<term>plugin</term>
<listitem><para>One or more plugins to disable.</para></listitem>
</varlistentry>
</variablelist>
<para>
Disables the specified plugins and all plugins that
depend on them.
</para>
<para role="example-prefix">For example:</para>
<screen role="example">rabbitmq-plugin disable amqp_client</screen>
<para role="example">
This command disables the <command>amqp_client</command>
and all other plugins that depend on it.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</refentry>
|
