summaryrefslogtreecommitdiff
path: root/docs/rabbitmq-server.1.pod
diff options
context:
space:
mode:
authorDavid Wragg <dpw@lshift.net>2009-08-24 17:32:19 +0100
committerDavid Wragg <dpw@lshift.net>2009-08-24 17:32:19 +0100
commit7c7801ee159c2f594dca66e0f91516c2f19bb4ee (patch)
tree91e9fb72049a24f0df8c37a3b31acd62de731d1d /docs/rabbitmq-server.1.pod
parent07de2fa67a02377f0a6d46701c6ebb3e9830fafa (diff)
downloadrabbitmq-server-git-7c7801ee159c2f594dca66e0f91516c2f19bb4ee.tar.gz
Reformat man pages, using more features of the pod format
This allows proper indentation, while still allowing the re-flowing of paragraphs according to the terminal width. Also, begin paragraphs consisting of sentences with an upper-case letter.
Diffstat (limited to 'docs/rabbitmq-server.1.pod')
-rw-r--r--docs/rabbitmq-server.1.pod61
1 files changed, 39 insertions, 22 deletions
diff --git a/docs/rabbitmq-server.1.pod b/docs/rabbitmq-server.1.pod
index 04062b1a10..d74ab8d94f 100644
--- a/docs/rabbitmq-server.1.pod
+++ b/docs/rabbitmq-server.1.pod
@@ -16,41 +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
+Defaults to F</var/lib/rabbitmq/mnesia>. Set this to the directory where
+Mnesia database files should be placed.
+
+=item B<RABBITMQ_LOG_BASE>
+
+Defaults to F</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 clustering on a single
machine guide at
-http://www.rabbitmq.com/clustering.html#single-machine for details.
+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.
-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>
-B<RABBITMQ_NODE_PORT>
- Defaults to 5672.
+Defaults to 5672.
-B<RABBITMQ_CLUSTER_CONFIG_FILE>
- Defaults to /etc/rabbitmq/rabbitmq_cluster.config. If this file is
+=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 http://www.rabbitmq.com/clustering.html
+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
@@ -60,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
@@ -68,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>
+