Bug 17467: Add koha-zebra documentation

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

diff --git a/debian/docs/koha-zebra.xml b/debian/docs/koha-zebra.xml
new file mode 100644 (file)
index 0000000..2cb1955
--- /dev/null
+++ b/debian/docs/koha-zebra.xml
@@ -0,0 +1,88 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-zebra</title>
+<info>
+<productname>Koha</productname> is the first free software library automation package.
+<author>
+  <orgname>The Koha Community</orgname>
+  <uri>http://koha-community.org/</uri>
+</author>
+</info>
+
+<refentry xml:id="koha-zebra">
+
+  <refmeta>
+    <refentrytitle>koha-zebra</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>koha-zebra</refname>
+    <refpurpose>Handle Zebra for named Koha instances.</refpurpose>
+    <refclass>UNIX/Linux</refclass>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>koha-zebra</command>
+      <arg><option>--start</option>|<option>--stop</option>|<option>--restart</option></arg>
+      <arg><option>--status</option></arg>
+      <arg><option>--quiet</option>|<option>-q</option></arg>
+      <arg><option>-h</option>|<option>--help</option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1><title>Options</title>
+  <para>All option switches are mutually exclusive</para>
+  <variablelist>
+    <varlistentry>
+      <term><option>--start</option></term>
+      <listitem>
+        <para>Start Zebra for named Koha instances.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>--stop</option></term>
+      <listitem>
+        <para>Stop Zebra for named Koha instances.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>--restart</option></term>
+      <listitem>
+        <para>Restart Zebra for named Koha instances.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>--status</option></term>
+      <listitem>
+        <para>Show status information about Zebra daemon for named Koha instances.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>-v</option>|<option>--verbose</option></term>
+      <listitem>
+        <para>Display progress messages.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>-h</option>|<option>--help</option></term>
+      <listitem>
+        <para>This help.</para>
+      </listitem>
+    </varlistentry>
+  </variablelist>
+  </refsect1>
+
+  <refsect1><title>Description</title>
+  <para>This script handles Zebra server daemons for Koha instances.</para>
+  </refsect1>
+
+  <refsect1><title>See also</title>
+  <simplelist type="inline">
+    <member><command>koha-rebuild-zebra(8)</command></member>
+  </simplelist>
+  </refsect1>
+
+</refentry>
+
+</article>