summaryrefslogtreecommitdiff
path: root/docs/rabbitmq-server.1.pod
diff options
context:
space:
mode:
authorPaul Jones <paulj@lshift.net>2009-08-28 15:40:18 +0100
committerPaul Jones <paulj@lshift.net>2009-08-28 15:40:18 +0100
commite664ae5208de72637485e2547caa761e245f53a3 (patch)
tree502f58faaf5d681fb8287bd659791b0e174f4e45 /docs/rabbitmq-server.1.pod
parentbeaaf30dc12ae60d1a7acf9c9a47f3367b260549 (diff)
parente3a94b0accf234dcaae542ff13054e8f0d8b95bb (diff)
downloadrabbitmq-server-bug17880.tar.gz
Merged default into bug17880bug17880
Diffstat (limited to 'docs/rabbitmq-server.1.pod')
-rw-r--r--docs/rabbitmq-server.1.pod71
1 files changed, 43 insertions, 28 deletions
diff --git a/docs/rabbitmq-server.1.pod b/docs/rabbitmq-server.1.pod
index 99a7cecc..d74ab8d9 100644
--- a/docs/rabbitmq-server.1.pod
+++ b/docs/rabbitmq-server.1.pod
@@ -16,43 +16,57 @@ 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).
+process or use L<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.
+=over
-B<RABBITMQ_LOG_BASE>
- Defaults to /var/log/rabbitmq. Log files generated by the server
- will be placed in this directory.
+=item B<RABBITMQ_MNESIA_BASE>
-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.
+Defaults to F</var/lib/rabbitmq/mnesia>. Set this to the directory where
+Mnesia database files should be placed.
-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_LOG_BASE>
-B<RABBITMQ_NODE_PORT>
- Defaults to 5672.
+Defaults to F</var/log/rabbitmq>. Log files generated by the server will
+be placed in this directory.
-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.
+=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 clustering on a single
+machine guide at
+L<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 F</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 L<http://www.rabbitmq.com/clustering.html>
+for details.
+
+=back
=head1 OPTIONS
-B<-detached> start the server process in the background
+=over
+
+=item B<-detached>
+
+start the server process in the background
+
+=back
=head1 EXAMPLES
@@ -62,7 +76,7 @@ Run RabbitMQ AMQP server in the background:
=head1 SEE ALSO
-rabbitmq.conf(5), rabbitmq-multi(1), rabbitmqctl(1)
+L<rabbitmq.conf(5)>, L<rabbitmq-multi(1)>, L<rabbitmqctl(1)>
=head1 AUTHOR
@@ -70,4 +84,5 @@ The RabbitMQ Team <info@rabbitmq.com>
=head1 REFERENCES
-RabbitMQ Web Site: http://www.rabbitmq.com
+RabbitMQ Web Site: L<http://www.rabbitmq.com>
+