Merge the defaults

10 files changed, 295 insertions, 10 deletions

diff --git a/Makefile b/Makefile
index bca9fd4a..2ed64aa5 100644
--- a/Makefile
+++ b/Makefile
@@ -119,6 +119,7 @@ srcdist: distclean
 	cp codegen.py Makefile dist/$(TARBALL_NAME)
 
 	cp -r scripts dist/$(TARBALL_NAME)
+	cp -r docs dist/$(TARBALL_NAME)
 	chmod 0755 dist/$(TARBALL_NAME)/scripts/*
 
 	(cd dist; tar -zcf $(TARBALL_NAME).tar.gz $(TARBALL_NAME))
@@ -133,12 +134,20 @@ distclean: clean
 install: 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)
 
 	$(MAKE) VERSION=$(VERSION) GENERIC_STAGE_DIR=$(TARGET_DIR) generic_stage
 
 	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)
+	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'`; \
+	done
+	 
 	rm -f $(TARGET_DIR)/BUILD
diff --git a/docs/rabbitmq-multi.pod b/docs/rabbitmq-multi.pod
new file mode 100644
index 00000000..2e3f28c8
--- /dev/null
+++ b/docs/rabbitmq-multi.pod
@@ -0,0 +1,52 @@
+=head1 NAME
+
+rabbitmq-multi - start/stop local cluster RabbitMQ nodes
+
+=head1 SYNOPSIS
+
+rabbitmq-multi I<command> [command option]
+
+=head1 DESCRIPTION
+
+RabbitMQ is an implementation of AMQP, the emerging standard for high
+performance enterprise messaging. The RabbitMQ server is a robust and
+scalable implementation of an AMQP broker.
+
+rabbitmq-multi scripts allows for easy set-up of a cluster on a single
+machine.
+
+See also rabbitmq-server(1) for configuration information.
+
+=head1 COMMANDS
+
+start_all I<count>
+    start count nodes with unique names, listening on all IP addresses
+    and on sequential ports starting from 5672.
+
+stop_all
+    stop all local RabbitMQ nodes
+
+=head1 EXAMPLES
+
+Start 3 local RabbitMQ nodes with unique, sequential port numbers:
+
+          rabbitmq-multi start_all 3
+
+=head1 SEE ALSO
+
+rabbitmq-server(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/rabbitmq-server.pod b/docs/rabbitmq-server.pod
new file mode 100644
index 00000000..1eaf2dfd
--- /dev/null
+++ b/docs/rabbitmq-server.pod
@@ -0,0 +1,80 @@
+=head1 NAME
+
+rabbitmq-server - start RabbitMQ AMQP server
+
+=head1 SYNOPSIS
+
+rabbitmq-server [-detached]
+
+=head1 DESCRIPTION
+
+RabbitMQ is an implementation of AMQP, the emerging standard for high
+performance enterprise messaging. The RabbitMQ server is a robust and
+scalable implementation of an AMQP broker.
+
+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). 
+
+=head1 ENVIRONMENT
+
+B<MNESIA_BASE>
+    Defaults to /var/lib/rabbitmq/mnesia. Set this to the directory 
+    where Mnesia database files should be placed. 
+
+B<LOG_BASE>
+    Defaults to /var/log/rabbitmq. Log files generated by the server
+    will be placed in this directory. 
+
+B<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. 
+
+B<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>
+    Defaults to 5672. 
+
+B<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.
+    See the clustering guide at http://www.rabbitmq.com/clustering.html
+    for details.
+
+=head1 OPTIONS
+
+B<-detached> start the server process in the background
+
+=head1 EXAMPLES
+
+Run RabbitMQ AMQP server in the background:
+
+          rabbitmq-server -detached
+
+=head1 SEE ALSO
+
+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.pod
new file mode 100644
index 00000000..db31b621
--- /dev/null
+++ b/docs/rabbitmqctl.pod
@@ -0,0 +1,139 @@
+=head1 NAME
+
+rabbitmqctl - command line tool for managing a RabbitMQ broker
+
+=head1 SYNOPSIS
+
+rabbitmqctl [-n I<node>] I<<command>> [command options]
+
+=head1 DESCRIPTION
+
+RabbitMQ is an implementation of AMQP, the emerging standard for high
+performance enterprise messaging. The RabbitMQ server is a robust and
+scalable implementation of an AMQP broker.
+
+rabbitmqctl is a command line tool for managing a RabbitMQ broker.
+It performs all actions by connecting to one of the broker's nodes.
+
+
+=head1 OPTIONS
+
+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.
+   
+
+=head1 COMMANDS
+
+=head2 APPLICATION AND CLUSTER MANAGEMENT
+
+stop
+    stop the Erlang node on which RabbitMQ broker is running.
+
+stop_app
+    stop the RabbitMQ application, leaving the Erlang node running.
+    This command is typically run prior to performing other management
+    actions that require the RabbitMQ application to be stopped,
+    e.g. I<reset>.
+    
+start_app
+    start the RabbitMQ application.
+    This command is typically run prior to performing other management
+    actions that require the RabbitMQ application to be stopped,
+    e.g. I<reset>.
+    
+status
+    display various information about the RabbitMQ broker, such as
+    whether the RabbitMQ application on the current node, its version
+    number, what nodes are part of the broker, which of these are
+    running.
+    
+force
+    return a RabbitMQ node to its virgin state.
+    Removes the node from any cluster it belongs to, removes all data
+    from the management database, such as configured users, vhosts and
+    deletes all persistent messages.
+    
+force_reset
+    the same as I<force> command, but resets the node unconditionally,
+    regardless of the current management database state and cluster
+    configuration.
+    It should only be used as a last resort if the database or cluster
+    configuration has been corrupted.
+    
+cluster I<clusternode> ...
+    instruct the node to become member of a cluster with the specified
+    nodes determined by I<clusternode> option(s).
+    See http://www.rabbitmq.com/clustering.html for more information
+    about clustering.
+    
+=head2 USER MANAGEMENT
+    
+add_user I<username> I<password>
+    create a user named I<username> with (initial) password I<password>.
+    
+change_password I<username> I<newpassword>
+    change the password for the user named I<username> to I<newpassword>.
+
+list_users
+    list all users.
+    
+=head2 ACCESS CONTROL
+
+add_vhost I<vhostpath>
+    create a new virtual host called I<vhostpath>.
+    
+delete_vhost I<vhostpath>
+    delete a virtual host I<vhostpath>.
+    That command deletes also all its exchanges, queues and user mappings.
+    
+list_vhosts
+    list all virtual hosts.
+    
+map_user_vhost I<username> I<vhostpath>
+    grant the user named I<username> access to the virtual host called
+    I<vhostpath>.
+    
+unmap_user_vhost I<username> I<vhostpath>
+    deny the user named I<username> access to the virtual host called
+    I<vhostpath>.
+
+list_user_vhost I<username> 
+    list all the virtual hosts to which the user named I<username> has
+    been granted access.
+    
+=head1 EXAMPLES
+
+Create a user named foo with (initial) password bar at the Erlang node
+rabbit@test:
+
+    rabbitmqctl -n rabbit@test add_user foo bar
+    
+Grant user named foo access to the virtual host called test at the
+default Erlang node:
+
+    rabbitmqctl map_user_vhost foo test
+
+=head1 SEE ALSO
+
+rabbitmq-multi(1), rabbitmq-server(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/packaging/RPMS/Fedora/rabbitmq-server.spec b/packaging/RPMS/Fedora/rabbitmq-server.spec
index dd12e1e5..25213816 100644
--- a/packaging/RPMS/Fedora/rabbitmq-server.spec
+++ b/packaging/RPMS/Fedora/rabbitmq-server.spec
@@ -20,6 +20,7 @@ scalable implementation of an AMQP broker.
 
 %define _libdir /usr/lib/erlang
 %define _docdir /usr/share/doc
+%define _mandir /usr/share/man
 %define _maindir $RPM_BUILD_ROOT%{_libdir}/lib/rabbitmq_server-%{main_version}
 %define package_name rabbitmq-server-dist
 
@@ -36,8 +37,10 @@ fi
 %build
 mkdir %{package_name}
 mkdir %{package_name}/sbin
+mkdir %{package_name}/man
 make install TARGET_DIR=`pwd`/%{package_name} \
              SBIN_DIR=`pwd`/%{package_name}/sbin \
+             MAN_DIR=`pwd`/%{package_name}/man
              VERSION=%{main_version}
 
 %install
@@ -45,6 +48,7 @@ mkdir -p %{_maindir}
 mkdir -p $RPM_BUILD_ROOT%{_docdir}/rabbitmq-server
 mkdir -p $RPM_BUILD_ROOT/etc/init.d
 mkdir -p $RPM_BUILD_ROOT/usr/sbin
+mkdir -p $RPM_BUILD_ROOT%{_mandir}
 
 mkdir -p $RPM_BUILD_ROOT/var/lib/rabbitmq/mnesia
 mkdir -p $RPM_BUILD_ROOT/var/log/rabbitmq
@@ -55,6 +59,7 @@ cp -r %{package_name}/src %{_maindir}
 cp -r %{package_name}/include %{_maindir}
 chmod 755  %{package_name}/sbin/*
 cp %{package_name}/sbin/* $RPM_BUILD_ROOT/usr/sbin/
+cp -r %{package_name}/man/* $RPM_BUILD_ROOT%{_mandir}/
 
 cp ../init.d $RPM_BUILD_ROOT/etc/init.d/rabbitmq-server
 chmod 775 $RPM_BUILD_ROOT/etc/init.d/rabbitmq-server
@@ -63,6 +68,8 @@ mv $RPM_BUILD_ROOT/usr/sbin/rabbitmqctl $RPM_BUILD_ROOT/usr/sbin/rabbitmqctl_rea
 cp ../rabbitmqctl_wrapper $RPM_BUILD_ROOT/usr/sbin/rabbitmqctl
 chmod 755 $RPM_BUILD_ROOT/usr/sbin/rabbitmqctl
 
+cp %{buildroot}%{_mandir}/man1/rabbitmqctl.1.gz %{buildroot}%{_mandir}/man1/rabbitmqctl_real.1.gz
+
 %post
 # create rabbitmq group
 if ! getent group rabbitmq >/dev/null; then
@@ -107,10 +114,8 @@ fi
 %defattr(-,root,root)
 %{_libdir}/lib/rabbitmq_server-%{main_version}/
 %{_docdir}/rabbitmq-server/
-/usr/sbin/rabbitmq-server
-/usr/sbin/rabbitmq-multi
-/usr/sbin/rabbitmqctl
-/usr/sbin/rabbitmqctl_real
+%{_mandir}
+/usr/sbin
 /var/lib/rabbitmq
 /var/log/rabbitmq
 /etc/init.d/rabbitmq-server
diff --git a/packaging/debs/Debian/debian/control b/packaging/debs/Debian/debian/control
index ae698e1e..df9a330b 100644
--- a/packaging/debs/Debian/debian/control
+++ b/packaging/debs/Debian/debian/control
@@ -12,4 +12,4 @@ Description: An AMQP server written in Erlang
  RabbitMQ is an implementation of AMQP, the emerging standard for high
  performance enterprise messaging. The RabbitMQ server is a robust and
  scalable implementation of an AMQP broker.
-  Homepage: http://www.rabbitmq.com/
+Homepage: http://www.rabbitmq.com/
diff --git a/packaging/debs/Debian/debian/dirs b/packaging/debs/Debian/debian/dirs
index 74ff60e2..0b3f55b9 100644
--- a/packaging/debs/Debian/debian/dirs
+++ b/packaging/debs/Debian/debian/dirs
@@ -1,6 +1,6 @@
 usr/lib/erlang/lib
 usr/sbin
-usr/share/linda/overrides
+usr/share/man
 var/lib/rabbitmq/mnesia
 var/log/rabbitmq
 
diff --git a/packaging/debs/Debian/debian/rules b/packaging/debs/Debian/debian/rules
index 15b0d50a..6edf27c1 100644
--- a/packaging/debs/Debian/debian/rules
+++ b/packaging/debs/Debian/debian/rules
@@ -5,7 +5,7 @@ include /usr/share/cdbs/1/class/makefile.mk
 
 RABBIT_LIB=$(DEB_DESTDIR)usr/lib/erlang/lib/rabbitmq_server-$(DEB_UPSTREAM_VERSION)
 
-DEB_MAKE_INSTALL_TARGET := install TARGET_DIR=$(RABBIT_LIB)/ SBIN_DIR=$(DEB_DESTDIR)usr/sbin
+DEB_MAKE_INSTALL_TARGET := install TARGET_DIR=$(RABBIT_LIB)/ SBIN_DIR=$(DEB_DESTDIR)usr/sbin MAN_DIR=$(DEB_DESTDIR)usr/share/man
 
 DOCDIR=$(DEB_DESTDIR)usr/share/doc/rabbitmq-server/
 
@@ -14,5 +14,5 @@ install/rabbitmq-server::
 	rm $(RABBIT_LIB)/LICENSE*
 	mv $(DEB_DESTDIR)usr/sbin/rabbitmqctl $(DEB_DESTDIR)usr/sbin/rabbitmqctl_real
 	cp debian/rabbitmqctl_wrapper $(DEB_DESTDIR)usr/sbin/rabbitmqctl
+	cp $(DEB_DESTDIR)usr/share/man/man1/rabbitmqctl.1.gz $(DEB_DESTDIR)usr/share/man/man1/rabbitmqctl_real.1.gz
 	chmod a+x $(DEB_DESTDIR)usr/sbin/rabbitmqctl
-	echo "Tag: usr-lib-in-arch-all" > $(DEB_DESTDIR)usr/share/linda/overrides/rabbitmq-server
diff --git a/packaging/generic-unix/Makefile b/packaging/generic-unix/Makefile
index 13257522..b3988696 100644
--- a/packaging/generic-unix/Makefile
+++ b/packaging/generic-unix/Makefile
@@ -7,11 +7,10 @@ dist:
 	make -C ../.. VERSION=$(VERSION) srcdist
 	tar -zxvf ../../dist/$(SOURCE_DIR).tar.gz
 
-	mkdir $(TARGET_DIR)
-	mkdir $(TARGET_DIR)/sbin
 	make -C $(SOURCE_DIR) \
 		TARGET_DIR=`pwd`/$(TARGET_DIR) \
 		SBIN_DIR=`pwd`/$(TARGET_DIR)/sbin \
+		MAN_DIR=`pwd`/$(TARGET_DIR)/share/man \
 			install
 
 	tar -zcf $(TARGET_TARBALL).tar.gz $(TARGET_DIR)
diff --git a/packaging/windows/Makefile b/packaging/windows/Makefile
index 077461c5..f9437da7 100644
--- a/packaging/windows/Makefile
+++ b/packaging/windows/Makefile
@@ -15,6 +15,7 @@ dist:
 	rm -rf $(SOURCE_DIR)/scripts
 	rm -rf $(SOURCE_DIR)/codegen* $(SOURCE_DIR)/Makefile
 	rm -f $(SOURCE_DIR)/BUILD
+	rm -rf $(SOURCE_DIR)/docs
 
 	mv $(SOURCE_DIR) $(TARGET_DIR)
 	zip -r $(TARGET_ZIP).zip $(TARGET_DIR)