Koha/debian/docs/koha-rebuild-zebra.xml
Tomas Cohen Arazi 385c16174b Bug 17468: Remove koha-*-zebra scripts and its traces
This patch removes traces from the (deprecated) koha-*-zebra scripts.

To test:
- Apply the patch
- Verify no traces of koha-*-zebra remain on the codebase (besides
  Release Notes and the koha-zebra script):
  $ cd kohaclone
  $ git grep koha-start-zebra
  $ git grep koha-stop-zebra
  $ git grep koha-restart-zebra
=> SUCCESS: No traces!
- Create the following symlinks:
  $ sudo ln -s /usr/sbin/koha-zebra  /usr/sbin/koha-start-zebra
  $ sudo ln -s /usr/sbin/koha-zebra  /usr/sbin/koha-stop-zebra
  $ sudo ln -s /usr/sbin/koha-zebra  /usr/sbin/koha-restart-zebra
- Try the koha-*-zebra commands:
  $ sudo koha-stop-zebra kohadev
  $ sudo koha-start-zebra kohadev
  $ sudo koha-restart-zebra kohadev
=> SUCCESS: They all work as expected!

- Sign off :-D!

Sponsored-by: Orex Digital

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2018-03-26 17:31:27 -03:00

95 lines
3.4 KiB
XML

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-rebuild-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-rebuild-zebra">
<refmeta>
<refentrytitle>koha-rebuild-zebra</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-rebuild-zebra</refname>
<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>--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>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
<term><option>-u, --usmarc</option></term>
<listitem>
<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. 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.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Description</title>
<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-zebra(8)</command></member>
</simplelist>
</refsect1>
</refentry>
</article>