diff options
Diffstat (limited to 'docs/rabbitmqctl.1.pod')
| -rw-r--r-- | docs/rabbitmqctl.1.pod | 103 |
1 files changed, 50 insertions, 53 deletions
diff --git a/docs/rabbitmqctl.1.pod b/docs/rabbitmqctl.1.pod index 421568960e..58fbb100c8 100644 --- a/docs/rabbitmqctl.1.pod +++ b/docs/rabbitmqctl.1.pod @@ -20,16 +20,16 @@ It performs all actions by connecting to one of the broker's nodes. B<-n> I<node> default node is C<rabbit@server>, where server is the local host. - On a host named C<server.example.com>, the node name of the - RabbitMQ Erlang node will usually be rabbit@server (unless - RABBITMQ_NODENAME has been set to some non-default value at broker - startup time). The output of hostname -s is usually the correct - suffix to use after the "@" sign. See rabbitmq-server(1) for - details of configuring the RabbitMQ broker. +On a host named C<server.example.com>, the node name of the RabbitMQ +Erlang node will usually be rabbit@server (unless RABBITMQ_NODENAME +has been set to some non-default value at broker startup time). The +output of hostname -s is usually the correct suffix to use after the +"@" sign. See rabbitmq-server(1) for details of configuring the +RabbitMQ broker. B<-q> - quiet output mode is selected with the B<-q> flag. Informational - messages are suppressed when quiet mode is in effect. + quiet output mode is selected with the B<-q> flag. Informational +messages are suppressed when quiet mode is in effect. =head1 COMMANDS @@ -40,53 +40,51 @@ stop stop_app stop the RabbitMQ application, leaving the Erlang node running. - This command is typically run prior to performing other management - actions that require the RabbitMQ application to be stopped, - e.g. I<reset>. +This command is typically run prior to performing other management +actions that require the RabbitMQ application to be stopped, +e.g. I<reset>. start_app start the RabbitMQ application. This command is typically run prior to performing other management - actions that require the RabbitMQ application to be stopped, - e.g. I<reset>. +actions that require the RabbitMQ application to be stopped, +e.g. I<reset>. status display various information about the RabbitMQ broker, such as - whether the RabbitMQ application on the current node, its version - number, what nodes are part of the broker, which of these are - running. +whether the RabbitMQ application on the current node, its version +number, what nodes are part of the broker, which of these are running. -force +reset return a RabbitMQ node to its virgin state. Removes the node from any cluster it belongs to, removes all data - from the management database, such as configured users, vhosts and - deletes all persistent messages. +from the management database, such as configured users, vhosts and +deletes all persistent messages. force_reset - the same as I<force> command, but resets the node unconditionally, - regardless of the current management database state and cluster - configuration. + the same as I<reset> command, but resets the node unconditionally, +regardless of the current management database state and cluster +configuration. It should only be used as a last resort if the database or cluster - configuration has been corrupted. +configuration has been corrupted. rotate_logs [suffix] instruct the RabbitMQ node to rotate the log files. The RabbitMQ - broker will attempt to append the current contents of the log file - to the file with the name composed of the original name and the - suffix. It will create a new file if such a file does not already - exist. When no I<suffix> is specified, the empty log file is - simply created at the original location; no rotation takes place. - When an error occurs while appending the contents of the old log - file, the operation behaves in the same way as if no I<suffix> was - specified. +broker will attempt to append the current contents of the log file to +the file with the name composed of the original name and the +suffix. It will create a new file if such a file does not already +exist. When no I<suffix> is specified, the empty log file is simply +created at the original location; no rotation takes place. When an +error occurs while appending the contents of the old log file, the +operation behaves in the same way as if no I<suffix> was specified. This command might be helpful when you are e.g. writing your own - logrotate script and you do not want to restart the RabbitMQ node. +logrotate script and you do not want to restart the RabbitMQ node. cluster I<clusternode> ... instruct the node to become member of a cluster with the specified - nodes determined by I<clusternode> option(s). - See http://www.rabbitmq.com/clustering.html for more information - about clustering. +nodes determined by I<clusternode> option(s). See +http://www.rabbitmq.com/clustering.html for more information about +clustering. =head2 USER MANAGEMENT @@ -110,35 +108,35 @@ add_vhost I<vhostpath> delete_vhost I<vhostpath> delete a virtual host I<vhostpath>. That command deletes also all its exchanges, queues and user - mappings. +mappings. list_vhosts list all virtual hosts. set_permissions [-p I<vhostpath>] I<username> I<regexp> I<regexp> I<regexp> set the permissions for the user named I<username> in the virtual - host I<vhostpath>, granting 'configure', 'write' and 'read' access - to resources with names matching the first, second and third - I<regexp>, respectively. +host I<vhostpath>, granting 'configure', 'write' and 'read' access to +resources with names matching the first, second and third I<regexp>, +respectively. clear_permissions [-p I<vhostpath>] I<username> remove the permissions for the user named I<username> in the - virtual host I<vhostpath>. +virtual host I<vhostpath>. list_permissions [-p I<vhostpath>] list all the users and their permissions in the virtual host - I<vhostpath>. +I<vhostpath>. list_user_permissions I<username> list the permissions of the user named I<username> across all - virtual hosts. +virtual hosts. =head2 SERVER STATUS list_queues [-p I<vhostpath>] [I<queueinfoitem> ...] list queue information by virtual host. If no I<queueinfoitem>s - are specified then then name and number of messages is displayed - for each queue. +are specified then then name and number of messages is displayed for +each queue. =head3 Queue information items @@ -163,8 +161,7 @@ messages_ready number of messages ready to be delivered to clients messages_unacknowledged - number of messages delivered to clients but not yet - acknowledged + number of messages delivered to clients but not yet acknowledged messages_uncommitted number of messages published in as yet uncommitted transactions @@ -174,7 +171,7 @@ messages acks_uncommitted number of acknowledgements received in as yet uncommitted - transactions +transactions consumers number of consumers @@ -184,14 +181,14 @@ transactions memory bytes of memory consumed by the Erlang process for the queue, - including stack, heap and internal structures +including stack, heap and internal structures =back list_exchanges [-p I<vhostpath>] [I<exchangeinfoitem> ...] list exchange information by virtual host. If no - I<exchangeinfoitem>s are specified then name and type is displayed - for each exchange. +I<exchangeinfoitem>s are specified then name and type is displayed for +each exchange. =head3 Exchange information items @@ -216,11 +213,11 @@ arguments list_bindings [-p I<vhostpath>] list bindings by virtual host. Each line contains exchange name, - routing key and queue name (all URL encoded) and arguments. +routing key and queue name (all URL encoded) and arguments. list_connections [I<connectioninfoitem> ...] list connection information. If no I<connectioninfoitem>s are - specified then the user, peer address and peer port are displayed. +specified then the user, peer address and peer port are displayed. =head3 Connection information items @@ -243,7 +240,7 @@ peer_port state connection state (B<pre-init>, B<starting>, B<tuning>, B<opening>, - B<running>, B<closing>, B<closed>) +B<running>, B<closing>, B<closed>) channels number of channels using the connection |