diff options
author | Emile Joubert <emile@lshift.net> | 2009-06-10 16:02:11 +0100 |
---|---|---|
committer | Emile Joubert <emile@lshift.net> | 2009-06-10 16:02:11 +0100 |
commit | 4ea6373d2c898324f156a3d33bc42bd7a01ea843 (patch) | |
tree | f6b185cdc1e5f52e3e3e4d79bc80959e6e3df020 | |
parent | 6a7d99ad7a86fbdd80090dc43916586f93d1ec32 (diff) | |
parent | 1b4c7db9ff29a27d1ce3296d7f45e81040178a3d (diff) | |
download | rabbitmq-server-bug19984.tar.gz |
merge default into bug19984bug19984
-rw-r--r-- | docs/rabbitmq-server.1.pod | 68 | ||||
-rw-r--r-- | docs/rabbitmqctl.1.pod | 181 |
2 files changed, 149 insertions, 100 deletions
diff --git a/docs/rabbitmq-server.1.pod b/docs/rabbitmq-server.1.pod index 99a7cecc..23b9ae85 100644 --- a/docs/rabbitmq-server.1.pod +++ b/docs/rabbitmq-server.1.pod @@ -20,35 +20,45 @@ process or use rabbitmqctl(1). =head1 ENVIRONMENT -B<RABBITMQ_MNESIA_BASE> - Defaults to /var/lib/rabbitmq/mnesia. Set this to the directory - where Mnesia database files should be placed. - -B<RABBITMQ_LOG_BASE> - Defaults to /var/log/rabbitmq. Log files generated by the server - will be placed in this directory. - -B<RABBITMQ_NODENAME> - Defaults to rabbit. This can be useful if you want to run more - than one node per machine - B<RABBITMQ_NODENAME> should be unique - per erlang-node-and-machine combination. See clustering on a - single machine guide at - http://www.rabbitmq.com/clustering.html#single-machine for - details. - -B<RABBITMQ_NODE_IP_ADDRESS> - Defaults to 0.0.0.0. This can be changed if you only want to bind - to one network interface. - -B<RABBITMQ_NODE_PORT> - Defaults to 5672. - -B<RABBITMQ_CLUSTER_CONFIG_FILE> - Defaults to /etc/rabbitmq/rabbitmq_cluster.config. If this file is - present it is used by the server to auto-configure a RabbitMQ - cluster. - See the clustering guide at http://www.rabbitmq.com/clustering.html - for details. +=for xhtml <a id="server-environment-variables"/> + +=over + +=item B<RABBITMQ_MNESIA_BASE> + +Defaults to /var/lib/rabbitmq/mnesia. Set this to the directory +where Mnesia database files should be placed. + +=item B<RABBITMQ_LOG_BASE> + +Defaults to /var/log/rabbitmq. Log files generated by the server +will be placed in this directory. + +=item B<RABBITMQ_NODENAME> + +Defaults to rabbit. This can be useful if you want to run more +than one node per machine - B<RABBITMQ_NODENAME> should be unique +per erlang-node-and-machine combination. See the +L<clustering on a single machine guide|http://www.rabbitmq.com/clustering.html#single-machine> +for details. + +=item B<RABBITMQ_NODE_IP_ADDRESS> + +Defaults to 0.0.0.0. This can be changed if you only want to bind +to one network interface. + +=item B<RABBITMQ_NODE_PORT> + +Defaults to 5672. + +=item B<RABBITMQ_CLUSTER_CONFIG_FILE> + +Defaults to /etc/rabbitmq/rabbitmq_cluster.config. If this file is +present it is used by the server to auto-configure a RabbitMQ +cluster. See the L<clustering guide|http://www.rabbitmq.com/clustering.html> +for details. + +=back =head1 OPTIONS diff --git a/docs/rabbitmqctl.1.pod b/docs/rabbitmqctl.1.pod index 42156896..013062b4 100644 --- a/docs/rabbitmqctl.1.pod +++ b/docs/rabbitmqctl.1.pod @@ -142,49 +142,63 @@ list_queues [-p I<vhostpath>] [I<queueinfoitem> ...] =head3 Queue information items +=for xhtml <a id="queue-information-items"/> + =over 4 -name - URL-encoded name of the queue +=item name + +URL-encoded name of the queue + +=item durable + +whether the queue survives server restarts + +=item auto_delete -durable - whether the queue survives server restarts +whether the queue will be deleted when no longer used -auto_delete - whether the queue will be deleted when no longer used +=item arguments -arguments - queue arguments +queue arguments -node - node on which the process associated with the queue resides +=item node -messages_ready - number of messages ready to be delivered to clients +node on which the process associated with the queue resides -messages_unacknowledged - number of messages delivered to clients but not yet - acknowledged +=item messages_ready -messages_uncommitted - number of messages published in as yet uncommitted transactions +number of messages ready to be delivered to clients -messages - sum of ready, unacknowledged and uncommitted messages +=item messages_unacknowledged -acks_uncommitted - number of acknowledgements received in as yet uncommitted - transactions +number of messages delivered to clients but not yet acknowledged -consumers - number of consumers +=item messages_uncommitted +number of messages published in as yet uncommitted transactions + +=item messages + +sum of ready, unacknowledged and uncommitted messages + +=item acks_uncommitted + +number of acknowledgements received in as yet uncommitted transactions - number of transactions -memory - bytes of memory consumed by the Erlang process for the queue, - including stack, heap and internal structures +=item consumers + +number of consumers + +=item transactions + +number of transactions + +=item memory + +bytes of memory consumed by the Erlang process for the queue, +including stack, heap and internal structures =back @@ -195,22 +209,29 @@ list_exchanges [-p I<vhostpath>] [I<exchangeinfoitem> ...] =head3 Exchange information items +=for xhtml <a id="exchange-information-items"/> + =over 4 -name - URL-encoded name of the exchange +=item name + +URL-encoded name of the exchange + +=item type + +exchange type (B<direct>, B<topic>, B<fanout>, or B<headers>) + +=item durable -type - exchange type (B<direct>, B<topic>, B<fanout>, or B<headers>) +whether the exchange survives server restarts -durable - whether the exchange survives server restarts +=item auto_delete -auto_delete - whether the exchange is deleted when no longer used +whether the exchange is deleted when no longer used -arguments - exchange arguments +=item arguments + +exchange arguments =back @@ -224,56 +245,74 @@ list_connections [I<connectioninfoitem> ...] =head3 Connection information items +=for xhtml <a id="connection-information-items"/> + =over 4 -node - node on which the process associated with the connection resides +=item node + +node on which the process associated with the connection resides + +=item address + +server IP number + +=item port + +server port + +=item peer_address + +peer address + +=item peer_port + +peer port + +=item state + +connection state (B<pre-init>, B<starting>, B<tuning>, B<opening>, +B<running>, B<closing>, B<closed>) + +=item channels + +number of channels using the connection + +=item user + +username associated with the connection + +=item vhost -address - server IP number +URL-encoded virtual host -port - server port +=item timeout -peer_address - peer address +connection timeout -peer_port - peer port +=item frame_max -state - connection state (B<pre-init>, B<starting>, B<tuning>, B<opening>, - B<running>, B<closing>, B<closed>) +maximum frame size (bytes) -channels - number of channels using the connection +=item recv_oct -user - username associated with the connection +octets received -vhost - URL-encoded virtual host +=item recv_cnt -timeout - connection timeout +packets received -frame_max - maximum frame size (bytes) +=item send_oct -recv_oct - octets received +octets sent -recv_cnt - packets received +=item send_cnt -send_oct - octets sent +packets sent -send_cnt - packets sent +=item send_pend -send_pend - send queue size +send queue size =back |