Bug 15774: Add missing tests for Koha::Object::Mixin::AdditionalFields
[koha.git] / debian / docs / koha-rebuild-zebra.xml
index e5b319c..81e1364 100644 (file)
@@ -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>
 
   <refnamediv>
     <refname>koha-rebuild-zebra</refname>
-    <refpurpose>Rebuild the Zebra database for a Koha instance.</refpurpose>
+    <refpurpose>Rebuild the Zebra database for Koha instances.</refpurpose>
     <refclass>UNIX/Linux</refclass>
   </refnamediv>
 
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>koha-rebuild-zebra</command> <arg><option>-u</option>|<option>--usmarc</option></arg> <arg><option>-f</option>|<option>--full</option></arg> <arg><option>...</option></arg> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+      <command>koha-rebuild-zebra</command> <arg><option>-u</option>|<option>--usmarc</option></arg> <arg><option>--force</option></arg> <arg><option>-f</option>|<option>--full</option></arg> <arg><option>-a</option>|<option>--authorities</option></arg> <arg><option>-b</option>|<option>--biblios</option></arg> <arg><option>-q</option>|<option>--quiet</option></arg> <arg><option>-v</option>|<option>--verbose</option></arg> <arg><option>...</option></arg> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
   
         <para>Runs the process as USMARC rather than the default of MARCXML.</para>
       </listitem>
     </varlistentry>
+    <varlistentry>
+      <term><option>--force</option></term>
+      <listitem>
+        <para>Force incremental indexing when <option>USE_INDEXER_DAEMON=yes</option>.</para>
+      </listitem>
+    </varlistentry>
     <varlistentry>
       <term><option>-f, --full</option></term>
       <listitem>
-        <para>Does a reindex of the whole collection.</para>
+        <para>Does a reindex of the whole collection. Will run even if <option>USE_INDEXER_DAEMON=yes</option>.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>-a, --authorities</option></term>
+      <listitem>
+        <para>Only run the indexing process for authority records.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>-b, --biblios</option></term>
+      <listitem>
+        <para>Only run the indexing process for biblio records.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>-q, --quiet</option></term>
+      <listitem>
+        <para>Sometimes be a bit quieter for scripts/cronjobs.</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term><option>-v, --verbose</option></term>
+      <listitem>
+        <para>Be verbose. Useful for debugging indexing problems.</para>
       </listitem>
     </varlistentry>
     <varlistentry>
       <term><option>-...</option></term>
       <listitem>
-        <para>Anything else is passed directly to rebuild_zebra. This is useful in particular for -v.</para>
+        <para>Anything else is passed directly to rebuild_zebra.</para>
       </listitem>
     </varlistentry>
   </variablelist>
   </refsect1>
 
   <refsect1><title>Description</title>
-  <para>Rebuild the Zebra database for a Koha instance.</para>
+  <para>Rebuild the Zebra database for Koha instances. It will run incremental updates by default. It will be skipped if <option>USE_INDEXER_DAEMON=yes</option> in /etc/default/koha-common, unless <option>--force</option> or <option>--full</option> are used.</para>
   </refsect1>
   
   <refsect1><title>See also</title>
   <simplelist type="inline">
-    <member><command>koha-restart-zebra(8)</command></member>
-    <member><command>koha-start-zebra(8)</command></member>
-    <member><command>koha-stop-zebra(8)</command></member>
+    <member><command>koha-zebra(8)</command></member>
   </simplelist>
   </refsect1>