debian/docs/koha-rebuild-zebra.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-rebuild-zebra</title>
   3 <info>
   4 <productname>Koha</productname> is the first free software library automation package.
   5 <author>
   6   <orgname>The Koha Community</orgname>
   7   <uri>http://koha-community.org/</uri>
   8 </author>
   9 </info>
  10
  11 <refentry xml:id="koha-rebuild-zebra">
  12
  13   <refmeta>
  14     <refentrytitle>koha-rebuild-zebra</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-rebuild-zebra</refname>
  20     <refpurpose>Rebuild the Zebra database for Koha instances.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <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>
  27     </cmdsynopsis>
  28   </refsynopsisdiv>
  29
  30   <refsect1><title>Options</title>
  31   <variablelist>
  32     <varlistentry>
  33       <term><option>-u, --usmarc</option></term>
  34       <listitem>
  35         <para>Runs the process as USMARC rather than the default of MARCXML.</para>
  36       </listitem>
  37     </varlistentry>
  38     <varlistentry>
  39       <term><option>--force</option></term>
  40       <listitem>
  41         <para>Force incremental indexing when <option>USE_INDEXER_DAEMON=yes</option>.</para>
  42       </listitem>
  43     </varlistentry>
  44     <varlistentry>
  45       <term><option>-f, --full</option></term>
  46       <listitem>
  47         <para>Does a reindex of the whole collection. Will run even if <option>USE_INDEXER_DAEMON=yes</option>.</para>
  48       </listitem>
  49     </varlistentry>
  50     <varlistentry>
  51       <term><option>-a, --authorities</option></term>
  52       <listitem>
  53         <para>Only run the indexing process for authority records.</para>
  54       </listitem>
  55     </varlistentry>
  56     <varlistentry>
  57       <term><option>-b, --biblios</option></term>
  58       <listitem>
  59         <para>Only run the indexing process for biblio records.</para>
  60       </listitem>
  61     </varlistentry>
  62     <varlistentry>
  63       <term><option>-q, --quiet</option></term>
  64       <listitem>
  65         <para>Sometimes be a bit quieter for scripts/cronjobs.</para>
  66       </listitem>
  67     </varlistentry>
  68     <varlistentry>
  69       <term><option>-v, --verbose</option></term>
  70       <listitem>
  71         <para>Be verbose. Useful for debugging indexing problems.</para>
  72       </listitem>
  73     </varlistentry>
  74     <varlistentry>
  75       <term><option>-...</option></term>
  76       <listitem>
  77         <para>Anything else is passed directly to rebuild_zebra.</para>
  78       </listitem>
  79     </varlistentry>
  80   </variablelist>
  81   </refsect1>
  82
  83   <refsect1><title>Description</title>
  84   <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>
  85   </refsect1>
  86
  87   <refsect1><title>See also</title>
  88   <simplelist type="inline">
  89     <member><command>koha-restart-zebra(8)</command></member>
  90     <member><command>koha-start-zebra(8)</command></member>
  91     <member><command>koha-stop-zebra(8)</command></member>
  92   </simplelist>
  93   </refsect1>
  94
  95 </refentry>
  96
  97 </article>