Convert Windows Service instructions to DocBook verbatim.

3 files changed, 234 insertions, 135 deletions

diff --git a/packaging/windows/Makefile b/packaging/windows/Makefile
index c9e818ac..2212075d 100644
--- a/packaging/windows/Makefile
+++ b/packaging/windows/Makefile
@@ -21,10 +21,13 @@ dist:
 	rm -rf $(SOURCE_DIR)/docs
 
 	mv $(SOURCE_DIR) $(TARGET_DIR)
-	pod2text --loose rabbitmq-service.pod $(TARGET_DIR)/readme-service.txt
+	mkdir -p $(TARGET_DIR)
+	xmlto xhtml-nochunks rabbitmq-service.xml
+	elinks -dump -no-references -no-numbering rabbitmq-service.html \
+		> $(TARGET_DIR)/readme-service.txt
 	todos $(TARGET_DIR)/readme-service.txt
 	zip -r $(TARGET_ZIP).zip $(TARGET_DIR)
-	rm -rf $(TARGET_DIR)
+	rm -rf $(TARGET_DIR) rabbitmq-service.html
 
 clean: clean_partial
 	rm -f rabbitmq-server-windows-*.zip
diff --git a/packaging/windows/rabbitmq-service.pod b/packaging/windows/rabbitmq-service.pod
deleted file mode 100644
index 8a2d2e5b..00000000
--- a/packaging/windows/rabbitmq-service.pod
+++ /dev/null
@@ -1,133 +0,0 @@
-=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<rabbitmqctl>.
-
-=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 RABBITMQ_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 RABBITMQ_NODENAME
-
-Defaults to "rabbit". This can be useful if you want to run more 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
-L<http://www.rabbitmq.com/clustering.html#single-machine> for details.
-
-=head2 RABBITMQ_NODE_IP_ADDRESS
-
-Defaults to "0.0.0.0". This can be changed if you only want to bind
-to one network interface. 
-
-=head2 RABBITMQ_NODE_PORT
-
-Defaults to 5672. 
-
-=head2 ERLANG_SERVICE_MANAGER_PATH
-
-Defaults to F<C:\Program Files\erl5.5.5\erts-5.5.5\bin>
-(or F<C:\Program Files (x86)\erl5.5.5\erts-5.5.5\bin> for 64-bit
-environments). 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.
-
-=head2 RABBITMQ_CONSOLE_LOG
-
-Set this varable to B<new> or B<reuse> to have the console 
-output from the server redirected to a file named B<SERVICENAME>.debug
-in the  application data directory of the user that installed the service.
-Under Vista this will be F<C:\Documents and Settings\User\AppData\username\SERVICENAME>.
-Under previous versions of Windows this will be 
-F<C:\Documents and Settings\username\Application Data\SERVICENAME>.
-If B<RABBITMQ_CONSOLE_LOG> is set to B<new> then a new file will be
-created each time the service starts. If B<RABBITMQ_CONSOLE_LOG> is
-set to B<reuse> then the file will be overwritten each time the
-service starts.  The default behaviour when B<RABBITMQ_CONSOLE_LOG> is
-not set or set to a value other than B<new> or B<reuse> is to discard
-the server output.
-
-=head1 EXAMPLES
-
-Start a previously-installed RabbitMQ AMQP service:
-
-          rabbitmq-service start
-
-=head1 AUTHOR
-
-The RabbitMQ Team <info@rabbitmq.com>
-
-=head1 REFERENCES
-
-RabbitMQ Web Site: http://www.rabbitmq.com
diff --git a/packaging/windows/rabbitmq-service.xml b/packaging/windows/rabbitmq-service.xml
new file mode 100644
index 00000000..7eb9490d
--- /dev/null
+++ b/packaging/windows/rabbitmq-service.xml
@@ -0,0 +1,229 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd">
+<refentry lang="en">
+    <refentryinfo>
+        <productname>RabbitMQ Server</productname>
+        <authorgroup>
+            <corpauthor>The RabbitMQ Team &lt;<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>&gt;</corpauthor>
+        </authorgroup>
+    </refentryinfo>
+
+    <refmeta>
+        <refentrytitle>rabbitmq-service</refentrytitle>
+        <refmiscinfo class="manual">RabbitMQ Server</refmiscinfo>
+    </refmeta>
+
+    <refnamediv>
+        <refname>rabbitmq-service</refname>
+        <refpurpose>manage RabbitMQ AMQP service</refpurpose>
+    </refnamediv>
+
+    <refsynopsisdiv>
+        <cmdsynopsis>
+          <command>rabbitmq-service.bat</command>
+          <arg choice="opt">command</arg>
+        </cmdsynopsis>
+    </refsynopsisdiv>
+    
+    <refsect1>
+        <title>Description</title>
+        <para>
+           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.
+        </para>
+        <para>
+Running <command>rabbitmq-service</command> 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. 
+        </para>
+        <para>
+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 
+<filename>C:\WINDOWS\.erlang.cookie</filename> and the account that will be used to
+run <command>rabbitmqctl</command>.
+        </para>
+    </refsect1>
+
+    <refsect1>
+      <title>Commands</title>
+      <variablelist>
+
+        <varlistentry>
+          <term>help</term>
+          <listitem>
+            <para>
+Display usage information.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>install</term>
+          <listitem>
+            <para>
+Install the service. The service will not be started.
+Subsequent invocations will update the service parameters if
+relevant environment variables were modified.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>remove</term>
+          <listitem>
+            <para>
+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 <command>rabbitmq-server</command> will remain operable.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>start</term>
+          <listitem>
+            <para>
+Start the service. The service must have been correctly installed
+beforehand. 
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>stop</term>
+          <listitem>
+            <para>
+Stop the service. The service must be running for this command to 
+have any effect.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>disable</term>
+          <listitem>
+            <para>
+Disable the service. This is the equivalent of setting the startup
+type to <code>Disabled</code> using the service control panel.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>enable</term>
+          <listitem>
+            <para>
+Enable the service. This is the equivalent of setting the startup
+type to <code>Automatic</code> using the service control panel.
+            </para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect1>
+
+    <refsect1>
+      <title>Environment</title>
+      <variablelist>
+
+        <varlistentry>
+          <term>RABBITMQ_SERVICENAME</term>
+          <listitem>
+            <para>
+Defaults to RabbitMQ.
+This is the location of log and database directories.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>RABBITMQ_BASE</term>
+          <listitem>
+            <para>
+Defaults to the application data directory of the current user.
+This is the location of log and database directories.
+
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>RABBITMQ_NODENAME</term>
+          <listitem>
+            <para>
+Defaults to rabbit. This can be useful if you want to run more than
+one node per machine - <envar>RABBITMQ_NODENAME</envar> should be unique per
+erlang-node-and-machine combination. See the 
+<ulink url="http://www.rabbitmq.com/clustering.html#single-machine">clustering on a single
+machine guide</ulink> for details.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>RABBITMQ_NODE_IP_ADDRESS</term>
+          <listitem>
+            <para>
+Defaults to 0.0.0.0. This can be changed if you only want to bind to
+one network interface.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>RABBITMQ_NODE_PORT</term>
+          <listitem>
+            <para>
+Defaults to 5672. 
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>ERLANG_SERVICE_MANAGER_PATH</term>
+          <listitem>
+            <para>
+Defaults to <filename>C:\Program Files\erl5.5.5\erts-5.5.5\bin</filename>
+(or <filename>C:\Program Files (x86)\erl5.5.5\erts-5.5.5\bin</filename> for 64-bit
+environments). This is the installation location of the Erlang service
+manager.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>CLUSTER_CONFIG_FILE</term>
+          <listitem>
+            <para>
+If this file is
+present it is used by the server to auto-configure a RabbitMQ cluster.
+See the <ulink url="http://www.rabbitmq.com/clustering.html">clustering guide</ulink>
+for details.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>RABBITMQ_CONSOLE_LOG</term>
+          <listitem>
+            <para>
+Set this varable to <code>new</code> or <code>reuse</code> to have the console 
+output from the server redirected to a file named <code>SERVICENAME</code>.debug
+in the  application data directory of the user that installed the service.
+Under Vista this will be <filename>C:\Documents and Settings\User\AppData\username\SERVICENAME</filename>.
+Under previous versions of Windows this will be 
+<filename>C:\Documents and Settings\username\Application Data\SERVICENAME</filename>.
+If <code>RABBITMQ_CONSOLE_LOG</code> is set to <code>new</code> then a new file will be
+created each time the service starts. If <code>RABBITMQ_CONSOLE_LOG</code> is
+set to <code>reuse</code> then the file will be overwritten each time the
+service starts.  The default behaviour when <code>RABBITMQ_CONSOLE_LOG</code> is
+not set or set to a value other than <code>new</code> or <code>reuse</code> is to discard
+the server output.
+            </para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect1>
+</refentry>