merge bug19914 into default

4 files changed, 77 insertions, 18 deletions

diff --git a/docs/rabbitmq-multi.pod b/docs/rabbitmq-multi.1.pod
index 82c3911681..82c3911681 100644
--- a/docs/rabbitmq-multi.pod
+++ b/docs/rabbitmq-multi.1.pod
diff --git a/docs/rabbitmq-server.pod b/docs/rabbitmq-server.1.pod
index e3152b5873..00210c8b5c 100644
--- a/docs/rabbitmq-server.pod
+++ b/docs/rabbitmq-server.1.pod
@@ -20,30 +20,30 @@ process or use rabbitmqctl(1).
 
 =head1 ENVIRONMENT
 
-B<MNESIA_BASE>
+B<RABBITMQ_MNESIA_BASE>
     Defaults to /var/lib/rabbitmq/mnesia. Set this to the directory 
     where Mnesia database files should be placed. 
 
-B<LOG_BASE>
+B<RABBITMQ_LOG_BASE>
     Defaults to /var/log/rabbitmq. Log files generated by the server
     will be placed in this directory. 
 
-B<NODENAME>
+B<RABBITMQ_NODENAME>
     Defaults to rabbit. This can be useful if you want to run more
-    than one node per machine - B<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. 
+    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<NODE_IP_ADDRESS>
+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<NODE_PORT>
+B<RABBITMQ_NODE_PORT>
     Defaults to 5672. 
 
-B<CLUSTER_CONFIG_FILE>
+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.
diff --git a/docs/rabbitmq.5.pod b/docs/rabbitmq.5.pod
new file mode 100644
index 0000000000..e6972935f5
--- /dev/null
+++ b/docs/rabbitmq.5.pod
@@ -0,0 +1,60 @@
+=head1 NAME
+
+/etc/default/rabbitmq - default settings for RabbitMQ AMQP server
+
+=head1 DESCRIPTION
+
+/etc/default/rabbitmq 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
+a sequence of shell environment variable definitions. Normal shell
+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/default/rabbitmq, 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 
+
+B<NODENAME>
+    from /etc/default/rabbitmq is checked next. 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/default/rabbitmq 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/default/rabbitmq file, etc.
+
+=head1 EXAMPLES
+
+The following is an example of a complete /etc/default/rabbitmq file
+that overrides the default Erlang node name from "rabbit" to "hare":
+
+    # I am a complete /etc/default/rabbitmq file.
+    # Comment lines start with a hash character.
+    # This is a /bin/sh script file - use ordinary envt var syntax
+    NODENAME=hare
+
+=head1 SEE ALSO
+
+rabbitmq-server(1), 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
diff --git a/docs/rabbitmqctl.pod b/docs/rabbitmqctl.1.pod
index 1de311717a..34a51d1b15 100644
--- a/docs/rabbitmqctl.pod
+++ b/docs/rabbitmqctl.1.pod
@@ -20,13 +20,12 @@ It performs all actions by connecting to one of the broker's nodes.
 
 B<-n> I<node>
     default node is C<rabbit@server>, where server is the local host.
-    On a host named C<server.example.com>, the node name of the RabbitMQ
-    Erlang node will usually be rabbit@server (unless NODENAME has been
-    set to some non-default value at broker startup time).
-    The output of hostname -s is usually the correct suffix to use
-    after the "@" sign. See rabbitmq-server(1) for details of configur-
-    ing the RabbitMQ broker.
-   
+    On a host named C<server.example.com>, the node name of the
+    RabbitMQ Erlang node will usually be rabbit@server (unless
+    RABBITMQ_NODENAME has been set to some non-default value at broker
+    startup time).  The output of hostname -s is usually the correct
+    suffix to use after the "@" sign. See rabbitmq-server(1) for
+    details of configur- ing the RabbitMQ broker.
 
 =head1 COMMANDS