summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmile Joubert <emile@lshift.net>2008-10-10 09:11:22 +0100
committerEmile Joubert <emile@lshift.net>2008-10-10 09:11:22 +0100
commita08b0349ffbf045d52df8a72feed20b3518c5699 (patch)
tree563490df714fa3780e6514baff274677346fa4da
parent8297d9d6452ce94635b508e39c8417d436c6d0cb (diff)
downloadrabbitmq-server-a08b0349ffbf045d52df8a72feed20b3518c5699.tar.gz
Moved and modified documentation
-rw-r--r--docs/rabbitmq-service.pod114
-rw-r--r--packaging/windows/Makefile3
-rw-r--r--packaging/windows/rabbitmq-service.pod124
3 files changed, 127 insertions, 114 deletions
diff --git a/docs/rabbitmq-service.pod b/docs/rabbitmq-service.pod
deleted file mode 100644
index 6805c8d4..00000000
--- a/docs/rabbitmq-service.pod
+++ /dev/null
@@ -1,114 +0,0 @@
-=head1 NAME
-
-rabbitmq-service - manage RabbitMQ AMQP service
-
-=head1 SYNOPSIS
-
-rabbitmq-service I<command>
-
-=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-service allows the RabbitMQ broker to be run as a
-service on NT/2000/2003/XP/Vista® environments. The RabbitMQ broker
-service can be started and stopped using the Windows® services
-applet.
-
-By default the service will run in the authentication context of the
-local system account. It is therefore necessary to synchronise Erlang
-cookies between the local system account (typically
-C<C:\WINDOWS\.erlang.cookie> and the account that will be used to
-run rabbitctl.
-
-=head1 COMMANDS
-
-B<help>
- Display usage information.
-
-B<install>
- Install the service. The service will not be started.
- Subsequent invocations will update the service parameters if
- relevant environment variables were modified.
-
-B<remove>
- Remove the service. If the service is running then it will
- automatically be stopped before being removed. No files will be
- deleted as a consequence and I<rabbitmq-server> will remain operable.
-
-B<start>
- Start the service. The service must have been correctly installed
- beforehand.
-
-B<stop>
- Stop the service. The service must be running.
-
-B<disable>
- Disable the service. This is the equivalent of setting the startup
- type to I<Disabled> using the service control panel.
-
-B<enable>
- Enable the service. This is the equivalent of setting the startup
- type to I<Automatic> using the service control panel.
-
-=head1 ENVIRONMENT
-
-B<SERVICENAME>
- Defaults to RabbitMQ.
- This is the location of log and database directories.
-
-B<RABBITMQ_BASE>
- Defaults to the application data directory of the current user.
- This is the location of log and database directories.
-
-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<ERLANG_SERVICE_MANAGER_PATH>
- Defaults to C<C:\Program Files\erl5.5.5\erts-5.5.5\bin>. This is
- the installation location of the Erlang service manager.
-
-B<CLUSTER_CONFIG_FILE>
- 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 EXAMPLES
-
-Start a previously-installed RabbitMQ AMQP service:
-
- rabbitmq-service start
-
-=head1 SEE ALSO
-
-rabbitmq-service(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/packaging/windows/Makefile b/packaging/windows/Makefile
index 1d6e1f6a..3d019c31 100644
--- a/packaging/windows/Makefile
+++ b/packaging/windows/Makefile
@@ -2,6 +2,7 @@ VERSION=0.0.0
SOURCE_DIR=rabbitmq-server-$(VERSION)
TARGET_DIR=rabbitmq_server-$(VERSION)
TARGET_ZIP=rabbitmq-server-windows-$(VERSION)
+TOP_DIR=$(shell pwd)
dist:
make -C ../.. VERSION=$(VERSION) srcdist
@@ -19,6 +20,8 @@ dist:
rm -rf $(SOURCE_DIR)/docs
mv $(SOURCE_DIR) $(TARGET_DIR)
+ pod2text --loose $(TOP_DIR)/rabbitmq-service.pod $(TARGET_DIR)/readme-service.txt
+ unix2dos $(TARGET_DIR)/rabbitmq-service.txt
zip -r $(TARGET_ZIP).zip $(TARGET_DIR)
rm -rf $(TARGET_DIR)
diff --git a/packaging/windows/rabbitmq-service.pod b/packaging/windows/rabbitmq-service.pod
new file mode 100644
index 00000000..b87e4baf
--- /dev/null
+++ b/packaging/windows/rabbitmq-service.pod
@@ -0,0 +1,124 @@
+=head1 NAME
+
+rabbitmq-service - manage RabbitMQ AMQP service
+
+=head1 SYNOPSIS
+
+rabbitmq-service.bat command
+
+=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 B<rabbitmq-service> allows the RabbitMQ broker to be run as a
+service on NT/2000/2003/XP/Vista® environments. The RabbitMQ broker
+service can be started and stopped using the Windows® services
+applet.
+
+By default the service will run in the authentication context of the
+local system account. It is therefore necessary to synchronise Erlang
+cookies between the local system account (typically
+C<C:\WINDOWS\.erlang.cookie> and the account that will be used to
+run B<rabbitctl>.
+
+=head1 COMMANDS
+
+=head2 help
+
+Display usage information.
+
+=head2 install
+
+Install the service. The service will not be started.
+Subsequent invocations will update the service parameters if
+relevant environment variables were modified.
+
+=head2 remove
+
+Remove the service. If the service is running then it will
+automatically be stopped before being removed. No files will be
+deleted as a consequence and B<rabbitmq-server> will remain operable.
+
+=head2 start
+
+Start the service. The service must have been correctly installed
+beforehand.
+
+=head2 stop
+
+Stop the service. The service must be running for this command to
+have any effect.
+
+=head2 disable
+
+Disable the service. This is the equivalent of setting the startup
+type to B<Disabled> using the service control panel.
+
+=head2 enable
+
+Enable the service. This is the equivalent of setting the startup
+type to B<Automatic> using the service control panel.
+
+=head1 ENVIRONMENT
+
+=head2 SERVICENAME
+
+Defaults to RabbitMQ.
+This is the location of log and database directories.
+
+=head2 RABBITMQ_BASE
+
+Defaults to the application data directory of the current user.
+This is the location of log and database directories.
+
+=head2 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 L<http://www.rabbitmq.com/clustering.html#single-machine> for
+details.
+
+=head2 NODE_IP_ADDRESS
+
+Defaults to "0.0.0.0". This can be changed if you only want to bind
+to one network interface.
+
+=head2 NODE_PORT
+
+Defaults to 5672.
+
+=head2 ERLANG_SERVICE_MANAGER_PATH
+
+Defaults to F<C:\Program Files\erl5.5.5\erts-5.5.5\bin>. This is
+the installation location of the Erlang service manager.
+
+=head2 CLUSTER_CONFIG_FILE
+
+If this file is present it is used by the server to
+auto-configure a RabbitMQ cluster. See the clustering guide
+at L<http://www.rabbitmq.com/clustering.html> for details.
+
+=head1 EXAMPLES
+
+Start a previously-installed RabbitMQ AMQP service:
+
+ rabbitmq-service start
+
+=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