Bug 8773 - Start per-instance koha-index-daemon in .deb setup

[koha_fer] / debian / docs / koha-common.xml

diff --git a/debian/docs/koha-common.xml b/debian/docs/koha-common.xml
index 0e70595..2790341 100644 (file)
--- a/debian/docs/koha-common.xml
+++ b/debian/docs/koha-common.xml
@@ -3,7 +3,7 @@
 <info>
 <productname>Koha</productname> is the first free software library automation package.
 <author>
-  <orgname>The Koha Communnity</orgname>
+  <orgname>The Koha Community</orgname>
   <uri>http://koha-community.org/</uri>
 </author>
 </info>
@@ -32,6 +32,13 @@
     <variablelist>
 
       <varlistentry>
+        <term><option>koha-create</option></term>
+        <listitem>
+          <para>Create new Koha instances.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term><option>koha-disable</option></term>
         <listitem>
           <para>Disable a Koha instance.</para>
@@ -60,6 +67,13 @@
       </varlistentry>
 
       <varlistentry>
+        <term><option>koha-run-backups</option></term>
+        <listitem>
+          <para>Performs backups of the koha installations on the system, except an instance called 'demo'.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term><option>koha-remove</option></term>
         <listitem>
           <para>Remove a Koha instance.</para>
@@ -131,6 +145,13 @@
           <para>Stop Zebra for named Koha instances.</para>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><option>koha-indexer</option></term>
+        <listitem>
+          <para>Manage the indexer daemon for named Koha instances.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
     </refsect2>
 
@@ -153,6 +174,32 @@
     </variablelist>
     </refsect2>
 
+    <refsect2><title>SIP2-related</title>
+    <variablelist>
+
+      <varlistentry>
+        <term><option>koha-enable-sip</option></term>
+        <listitem>
+          <para>Copies the SIP configuration file to allow SIP to be controlled by init scripts.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>koha-start-sip</option></term>
+        <listitem>
+          <para>Starts the SIP daemon for the specified Koha instances.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>koha-stop-sip</option></term>
+        <listitem>
+          <para>Stops the SIP daemon for the specified Koha instances.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+    </refsect2>
+
     <refsect2><title>Misc</title>
     <variablelist>
 
@@ -188,9 +235,17 @@
           <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><option>koha-shell</option></term>
+        <listitem>
+          <para>This command behaves something like su(1), but provides you with a shell as the koha user, and with the environment pointing to the right places.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
     </refsect2>
   </refsect1>
+
   
   <refsect1><title>Bugs</title>
   <para>The scripts are a bit fragile. If something goes wrong, they do not clean up after themselves.</para>