1 '\" t

     2 .\"     Title: rabbitmq-plugins

     3 .\"    Author: The RabbitMQ Team <[email protected]>

     4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>

     5 .\"      Date: 05/10/2013

     6 .\"    Manual: RabbitMQ Service

     7 .\"    Source: RabbitMQ Server

     8 .\"  Language: English

     9 .\"

    10 .TH "RABBITMQ\-PLUGINS" "1" "05/10/2013" "RabbitMQ Server" "RabbitMQ Service"

    11 .\" -----------------------------------------------------------------

    12 .\" * set default formatting

    13 .\" -----------------------------------------------------------------

    14 .\" disable hyphenation

    15 .nh

    16 .\" disable justification (adjust text to left margin only)

    17 .ad l

    18 .\" -----------------------------------------------------------------

    19 .\" * MAIN CONTENT STARTS HERE *

    20 .\" -----------------------------------------------------------------

    21 .SH "NAME"

    22 rabbitmq-plugins \- command line tool for managing RabbitMQ broker plugins

    23 .SH "SYNOPSIS"

    24 .HP \w'\fBrabbitmq\-plugins\fR\ 'u

    25 \fBrabbitmq\-plugins\fR {\fIcommand\fR} [\fIcommand\ options\fR...]

    26 .SH "DESCRIPTION"

    27 .PP

    28 

    29 \fBrabbitmq\-plugins\fR

    30 is a command line tool for managing RabbitMQ broker plugins\&. It allows one to enable, disable and browse plugins\&. It must be run by a user with write permissions to the RabbitMQ configuration directory\&.

    31 .PP

    32 Some plugins depend on others to work correctly\&.

    33 \fBrabbitmq\-plugins\fR

    34 traverses these dependencies and enables all required plugins\&. Plugins listed on the

    35 \fBrabbitmq\-plugins\fR

    36 command line are marked as explicitly enabled; dependent plugins are marked as implicitly enabled\&. Implicitly enabled plugins are automatically disabled again when they are no longer required\&.

    37 .SH "COMMANDS"

    38 .PP

    39 \fBlist\fR [\-v] [\-m] [\-E] [\-e] [\fIpattern\fR]

    40 .RS 4

    41 .PP

    42 \-v

    43 .RS 4

    44 Show all plugin details (verbose)\&.

    45 .RE

    46 .PP

    47 \-m

    48 .RS 4

    49 Show only plugin names (minimal)\&.

    50 .RE

    51 .PP

    52 \-E

    53 .RS 4

    54 Show only explicitly enabled plugins\&.

    55 .RE

    56 .PP

    57 \-e

    58 .RS 4

    59 Show only explicitly or implicitly enabled plugins\&.

    60 .RE

    61 .PP

    62 pattern

    63 .RS 4

    64 Pattern to filter the plugin names by\&.

    65 .RE

    66 .sp

    67 Lists all plugins, their versions, dependencies and descriptions\&. Each plugin is prefixed with a status indicator \- [ ] to indicate that the plugin is not enabled, [E] to indicate that it is explicitly enabled, [e] to indicate that it is implicitly enabled, and [!] to indicate that it is enabled but missing and thus not operational\&.

    68 .sp

    69 If the optional pattern is given, only plugins whose name matches

    70 \fBpattern\fR

    71 are shown\&.

    72 .RE

    73 .PP

    74 \fBenable\fR {\fIplugin\fR \&.\&.\&.}

    75 .RS 4

    76 .PP

    77 plugin

    78 .RS 4

    79 One or more plugins to enable\&.

    80 .RE

    81 .sp

    82 Enables the specified plugins and all their dependencies\&.

    83 .RE

    84 .PP

    85 \fBdisable\fR {\fIplugin\fR \&.\&.\&.}

    86 .RS 4

    87 .PP

    88 plugin

    89 .RS 4

    90 One or more plugins to disable\&.

    91 .RE

    92 .sp

    93 Disables the specified plugins and all plugins that depend on them\&.

    94 .RE

    95 .SH "EXAMPLES"

    96 .PP

    97 \fBrabbitmq\-plugins list\fR

    98 .RS 4

    99 This command lists all plugins, on one line each\&.

   100 .RE

   101 .PP

   102 \fBrabbitmq\-plugins list \-v \fR

   103 .RS 4

   104 This command lists all plugins\&.

   105 .RE

   106 .PP

   107 \fBrabbitmq\-plugins list \-v management\fR

   108 .RS 4

   109 This command lists all plugins whose name contains "management"\&.

   110 .RE

   111 .PP

   112 \fBrabbitmq\-plugins list \-e rabbit\fR

   113 .RS 4

   114 This command lists all implicitly or explicitly enabled RabbitMQ plugins\&.

   115 .RE

   116 .PP

   117 \fBrabbitmq\-plugins enable rabbitmq_shovel rabbitmq_management\fR

   118 .RS 4

   119 This command enables the

   120 \fBshovel\fR

   121 and

   122 \fBmanagement\fR

   123 plugins and all their dependencies\&.

   124 .RE

   125 .PP

   126 \fBrabbitmq\-plugins disable amqp_client\fR

   127 .RS 4

   128 This command disables

   129 \fBamqp_client\fR

   130 and all plugins that depend on it\&.

   131 .RE

   132 .SH "AUTHOR"

   133 .PP

   134 \fBThe RabbitMQ Team <\fR\fB\fBinfo@rabbitmq\&.com\fR\fR\fB>\fR