summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTony Garnock-Jones <tonyg@lshift.net>2008-12-08 19:44:27 +0000
committerTony Garnock-Jones <tonyg@lshift.net>2008-12-08 19:44:27 +0000
commit432189d9f79a3b2e4a30aea118ee51f0c859d003 (patch)
tree571a0b81924abdc9c222876140ce9e6563830fb9 /docs
parentbd040e16342c4d2b1983261188b28204d9123e33 (diff)
downloadrabbitmq-server-git-432189d9f79a3b2e4a30aea118ee51f0c859d003.tar.gz
Tweak to the way the makefile generates the manpages, in preparation
for some documentation for /etc/default/rabbitmq.
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmq-multi.1.pod (renamed from docs/rabbitmq-multi.pod)0
-rw-r--r--docs/rabbitmq-server.1.pod (renamed from docs/rabbitmq-server.pod)22
-rw-r--r--docs/rabbitmqctl.1.pod (renamed from docs/rabbitmqctl.pod)13
3 files changed, 17 insertions, 18 deletions
diff --git a/docs/rabbitmq-multi.pod b/docs/rabbitmq-multi.1.pod
index 65d058337c..65d058337c 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 1eaf2dfdfb..bb64224d18 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/rabbitmqctl.pod b/docs/rabbitmqctl.1.pod
index b34cbca754..769fea4fc0 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