38a7e5e724
koha-zebra has a nice, informative --status switch, koha-indexer does not. This patch adds it. To test: - Run "sudo koha-indexer --status kohadev" - you get an error: "Error: invalid option switch (--status)" - Apply this patch - If you are on e.g. kohadevbox you need to copy koha-indexer to where it is actually run from: sudo cp debian/scripts/koha-indexer /usr/sbin/koha-indexer - Run "sudo koha-indexer --status kohadev" again and you should get a nice status telling if the indexer is running or not - Toggle the indexer on and off with koha-indexer --start/--stop and verify the status is telling the truth about the state of the indexer - Run "sudo koha-indexer --help" and check there is a description of the --status option - Have a look at debian/docs/koha-indexer.xml and verify there is an adequate description of the --status option. - Run "prove -v xt/verify-debian-docbook.t" to check the structure of the man page in DocBook format. PS: I tried to generate a manpage from the DocBook as described at https://wiki.koha-community.org/wiki/Testing_man_pages but the output did not look good for any of our DocBook files. Not sure why. Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
93 lines
2.6 KiB
XML
93 lines
2.6 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>--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>
|