diff options
Diffstat (limited to 'docs/rabbitmq-server.1.pod')
-rw-r--r-- | docs/rabbitmq-server.1.pod | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/docs/rabbitmq-server.1.pod b/docs/rabbitmq-server.1.pod new file mode 100644 index 0000000000..bb64224d18 --- /dev/null +++ b/docs/rabbitmq-server.1.pod @@ -0,0 +1,80 @@ +=head1 NAME + +rabbitmq-server - start RabbitMQ AMQP server + +=head1 SYNOPSIS + +rabbitmq-server [-detached] + +=head1 DESCRIPTION + +RabbitMQ is an implementation of AMQP, the emerging standard for high +performance enterprise messaging. The RabbitMQ server is a robust and +scalable implementation of an AMQP broker. + +Running rabbitmq-server in the foreground displays a banner message, +and reports on progress in the startup sequence, concluding with the +message "broker running", indicating that the RabbitMQ broker has been +started successfully. To shut down the server, just terminate the +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/default/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. + +=head1 OPTIONS + +B<-detached> start the server process in the background + +=head1 EXAMPLES + +Run RabbitMQ AMQP server in the background: + + rabbitmq-server -detached + +=head1 SEE ALSO + +rabbitmq-multi(1), rabbitmqctl(1) + +=head1 AUTHOR + +Originally written by The RabbitMQ Team <info@lshift.net> + +=head1 COPYRIGHT + +This package, the RabbitMQ server is licensed under the MPL. + +If you have any questions regarding licensing, please contact us at +info@rabbitmq.com. + +=head1 REFERENCES + +RabbitMQ Web Site: http://www.rabbitmq.com |