Koha/debian/docs/koha-indexer.xml
Tomas Cohen Arazi 3d519c8977 Bug 24306: (QA follow-up) Fix the XML
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2020-08-13 07:55:44 +02:00

100 lines
2.9 KiB
XML

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-indexer</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-indexer">
<refmeta>
<refentrytitle>koha-indexer</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-indexer</refname>
<refpurpose>Manage the indexer daemon for Koha instances.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-indexer</command>
<arg choice="req"><option>--start</option>|<option>--stop</option>|<option>--restart</option>|<option>--status</option>|<option>--help</option>|<option>-h</option>|<option>--quiet</option>|<option>-q</option></arg>
<arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
<term><option>--start</option></term>
<listitem>
<para>Start the indexer daemon for the desired Koha instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--stop</option></term>
<listitem>
<para>Stop the indexer daemon for the desired Koha instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--restart</option></term>
<listitem>
<para>Restart the indexer daemon for the desired Koha instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--status</option></term>
<listitem>
<para>Show the status of the indexer for the specified instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--debug</option></term>
<listitem>
<para>Raise the verbosity of the script to debug level. Note this is very verbose and contains a lot of information, it is not intended for production use but debugging purposes only.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--quiet|-q</option></term>
<listitem>
<para>Make the script quiet about non existent instance names. Useful when calling <command>koha-indexer</command> from another scripts.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help|-h</option></term>
<listitem>
<para>Show usage information.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Description</title>
<para>The <command>koha-indexer</command> script lets you manage your Koha instances indexer daemon.</para>
</refsect1>
<refsect1><title>See also</title>
<simplelist type="inline">
<member><command>/etc/default/koha-common</command></member>
</simplelist>
</refsect1>
</refentry>
</article>