Convert all the other man pages to DocBook, fix rabbitmq-multi usage message.

1 files changed, 143 insertions, 0 deletions

diff --git a/docs/rabbitmq-server.1.xml b/docs/rabbitmq-server.1.xml
new file mode 100644
index 0000000000..25c2aefb8b
--- /dev/null
+++ b/docs/rabbitmq-server.1.xml
@@ -0,0 +1,143 @@
+<?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-server</refentrytitle>
+        <manvolnum>1</manvolnum>
+        <refmiscinfo class="manual">RabbitMQ Server</refmiscinfo>
+    </refmeta>
+
+    <refnamediv>
+        <refname>rabbitmq-server</refname>
+        <refpurpose>start RabbitMQ AMQP server</refpurpose>
+    </refnamediv>
+
+    <refsynopsisdiv>
+        <cmdsynopsis>
+          <command>rabbitmq-multi</command>
+          <arg choice="opt">-detached</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 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).
+        </para>
+    </refsect1>
+
+    <refsect1>
+      <title>Environment</title>
+      <variablelist>
+
+        <varlistentry>
+          <term>RABBITMQ_MNESIA_BASE</term>
+          <listitem>
+            <para>
+Defaults to <filename>/var/lib/rabbitmq/mnesia</filename>. Set this to the directory where
+Mnesia database files should be placed.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>RABBITMQ_LOG_BASE</term>
+          <listitem>
+            <para>
+Defaults to <filename>/var/log/rabbitmq</filename>. Log files generated by the server will
+be placed in this directory.
+            </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>RABBITMQ_CLUSTER_CONFIG_FILE</term>
+          <listitem>
+            <para>
+Defaults to <filename>/etc/rabbitmq/rabbitmq_cluster.config</filename>. 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>
+
+      </variablelist>
+    </refsect1>
+
+    <refsect1>
+      <title>Options</title>
+      <variablelist>
+        <varlistentry>
+          <term>-detached</term>
+          <listitem>
+            <para>
+              start the server process in the background
+            </para>
+            <para role="example-prefix">For example:</para>
+            <screen role="example">rabbitmq-server -detached</screen>
+            <para role="example">
+              Runs RabbitMQ AMQP server in the background.
+            </para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect1>
+
+    <refsect1>
+        <title>See also</title>
+        <para>
+            <citerefentry><refentrytitle>rabbitmq.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+            <citerefentry><refentrytitle>rabbitmq-multi</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+            <citerefentry><refentrytitle>rabbitmqctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+        </para>
+    </refsect1>
+</refentry>