diff options
Diffstat (limited to 'docs/rabbitmq.conf.5.pod')
| -rw-r--r-- | docs/rabbitmq.conf.5.pod | 37 |
1 files changed, 23 insertions, 14 deletions
diff --git a/docs/rabbitmq.conf.5.pod b/docs/rabbitmq.conf.5.pod index 4d522163bc..a7bf4c0942 100644 --- a/docs/rabbitmq.conf.5.pod +++ b/docs/rabbitmq.conf.5.pod @@ -1,10 +1,11 @@ =head1 NAME -/etc/rabbitmq/rabbitmq.conf - default settings for RabbitMQ AMQP server +F</etc/rabbitmq/rabbitmq.conf> - default settings for RabbitMQ AMQP +server =head1 DESCRIPTION -/etc/rabbitmq/rabbitmq.conf contains variable settings that override the +F</etc/rabbitmq/rabbitmq.conf> contains variable settings that override the defaults built in to the RabbitMQ startup scripts. The file is interpreted by the system shell, and so should consist of @@ -13,27 +14,35 @@ syntax is permitted (since the file is sourced using the shell "." operator), including line comments starting with "#". In order of preference, the startup scripts get their values from the -environment, from /etc/rabbitmq/rabbitmq.conf and finally from the -built-in default values. For example, for the B<RABBITMQ_NODENAME> setting, +environment, from F</etc/rabbitmq/rabbitmq.conf> and finally from the +built-in default values. For example, for the B<RABBITMQ_NODENAME> +setting, -B<RABBITMQ_NODENAME> - from the environment is checked first. If it is absent or equal to -the empty string, then +=over -B<NODENAME> - from /etc/rabbitmq/rabbitmq.conf is checked. If it is also absent +=item B<RABBITMQ_NODENAME> + +from the environment is checked first. If it is absent or equal to the +empty string, then + +=item B<NODENAME> + +from L</etc/rabbitmq/rabbitmq.conf> is checked. If it is also absent or set equal to the empty string then the default value from the startup script is used. The variable names in /etc/rabbitmq/rabbitmq.conf are always equal to the environment variable names, with the B<RABBITMQ_> prefix removed: B<RABBITMQ_NODE_PORT> from the environment becomes B<NODE_PORT> in the -/etc/rabbitmq/rabbitmq.conf file, etc. +F</etc/rabbitmq/rabbitmq.conf> file, etc. + +=back =head1 EXAMPLES -The following is an example of a complete /etc/rabbitmq/rabbitmq.conf file -that overrides the default Erlang node name from "rabbit" to "hare": +The following is an example of a complete +F</etc/rabbitmq/rabbitmq.conf> file that overrides the default Erlang +node name from "rabbit" to "hare": # I am a complete /etc/rabbitmq/rabbitmq.conf file. # Comment lines start with a hash character. @@ -42,7 +51,7 @@ that overrides the default Erlang node name from "rabbit" to "hare": =head1 SEE ALSO -rabbitmq-server(1), rabbitmq-multi(1), rabbitmqctl(1) +L<rabbitmq-server(1)>, L<rabbitmq-multi(1)>, L<rabbitmqctl(1)> =head1 AUTHOR @@ -57,4 +66,4 @@ info@rabbitmq.com. =head1 REFERENCES -RabbitMQ Web Site: http://www.rabbitmq.com +RabbitMQ Web Site: L<http://www.rabbitmq.com> |