Tweak to the way the makefile generates the manpages, in preparation

for some documentation for /etc/default/rabbitmq.

5 files changed, 32 insertions, 24 deletions

diff --git a/.hgignore b/.hgignore
index 0781e32faf..dbfb1dbbb3 100644
--- a/.hgignore
+++ b/.hgignore
@@ -15,3 +15,5 @@ syntax: regexp
 ^packaging/debs/apt-repository/debian$
 ^packaging/generic-unix/rabbitmq-server-generic-unix-.*\.tar\.gz$
 ^packaging/windows/rabbitmq-server-windows-.*\.zip$
+
+^docs/.*\.[15]\.gz$
diff --git a/Makefile b/Makefile
index 69bfb3ecc0..26495b3662 100644
--- a/Makefile
+++ b/Makefile
@@ -6,6 +6,7 @@ INCLUDE_DIR=include
 SOURCES=$(wildcard $(SOURCE_DIR)/*.erl)
 TARGETS=$(EBIN_DIR)/rabbit_framing.beam $(patsubst $(SOURCE_DIR)/%.erl, $(EBIN_DIR)/%.beam,$(SOURCES))
 WEB_URL=http://stage.rabbitmq.com/
+MANPAGES=$(patsubst %.pod, %.gz, $(wildcard docs/*.[0-9].pod))
 
 ifndef USE_SPECS
 # our type specs rely on features / bug fixes in dialyzer that are
@@ -54,6 +55,7 @@ clean: cleandb
 	rm -f $(EBIN_DIR)/*.beam
 	rm -f $(EBIN_DIR)/rabbit.boot $(EBIN_DIR)/rabbit.script
 	rm -f $(INCLUDE_DIR)/rabbit_framing.hrl $(SOURCE_DIR)/rabbit_framing.erl codegen.pyc
+	rm -f docs/*.[0-9].gz
 
 cleandb: stop-node
 	erl -mnesia dir '"$(MNESIA_DIR)"' -noshell -eval 'lists:foreach(fun file:delete/1, filelib:wildcard(mnesia:system_info(directory) ++ "/*")), halt().'
@@ -123,7 +125,12 @@ distclean: clean
 	rm -rf dist
 	find . -name '*~' -exec rm {} \;
 
-install: all
+%.gz: %.pod
+	pod2man -c "RabbitMQ AMQP Server" -d "" -r "" $< | gzip --best > $@
+
+docs_all: $(MANPAGES)
+
+install: all docs_all
 	@[ -n "$(TARGET_DIR)" ] || (echo "Please set TARGET_DIR."; false)
 	@[ -n "$(SBIN_DIR)" ] || (echo "Please set SBIN_DIR."; false)
 	@[ -n "$(MAN_DIR)" ] || (echo "Please set MAN_DIR."; false)
@@ -133,13 +140,13 @@ install: all
 
 	chmod 0755 scripts/*
 	mkdir -p $(SBIN_DIR)
-	mkdir -p $(MAN_DIR)/man1
 	cp scripts/rabbitmq-server $(SBIN_DIR)
 	cp scripts/rabbitmqctl $(SBIN_DIR)
 	cp scripts/rabbitmq-multi $(SBIN_DIR)
 	cp scripts/rabbitmq-mnesia-current $(SBIN_DIR)
-	for manpage in docs/*.pod ; do \
-		pod2man -c "RabbitMQ AMQP Server" -d "" -r "" \
-		$$manpage | gzip --best > \
-		$(MAN_DIR)/man1/`echo $$manpage | sed -e 's:docs/\(.*\)\.pod:\1\.1\.gz:g'`; \
+	for section in 1 5; do \
+		mkdir -p $(MAN_DIR)/man$$section; \
+		for manpage in docs/*.$$section.pod; do \
+			cp $$manpage $(MAN_DIR)/man$$section; \
+		done; \
 	done
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