Koha/debian/docs/koha-worker.xml
Magnus Enger 3eff8d02b7
Bug 36009: Document koha-worker --queue elastic_index
To test:
- Copy the koha-worker script to the standard location:
  $ sudo cp debian/scripts/koha-worker /usr/sbin/koha-worker
- Check "sudo koha-worker --help" and verify elastic_index is
  mentioned in the list of "current queues"
- See https://wiki.koha-community.org/wiki/Testing_man_pages for
  how to check the "man" page. There should be a new paragraph
  about "Current queues" under "--queue"

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Julian Maurice <julian.maurice@biblibre.com>
Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
2024-03-07 15:02:48 +01:00

84 lines
2.5 KiB
XML

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-worker</title>
<info>
<productname>Koha</productname> is the first free software library automation package.
<author>
<orgname>The Koha Community</orgname>
<uri>https://koha-community.org/</uri>
</author>
</info>
<refentry xml:id="koha-worker">
<refmeta>
<refentrytitle>koha-worker</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-worker</refname>
<refpurpose>Handle worker daemon for named Koha instances.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-worker</command>
<arg><option>--start</option>|<option>--stop</option>|<option>--restart</option></arg>
<arg><option>--status</option></arg>
<arg><option>--queue</option></arg>
<arg><option>--quiet</option>|<option>-q</option></arg>
<arg><option>-h</option>|<option>--help</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Options</title>
<para>All option switches are mutually exclusive</para>
<variablelist>
<varlistentry>
<term><option>--start</option></term>
<listitem>
<para>Start worker daemon for named Koha instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--stop</option></term>
<listitem>
<para>Stop worker daemon for named Koha instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--restart</option></term>
<listitem>
<para>Restart worker daemon for named Koha instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--status</option></term>
<listitem>
<para>Show status information about worker daemon for named Koha instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--queue</option></term>
<listitem>
<para>Allows specifying the queue worker (defaults to 'default').</para>
<para>Current queues are: default, long_tasks, elastic_index.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>|<option>--help</option></term>
<listitem>
<para>This help.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Description</title>
<para>This script handles worker daemons for Koha instances.</para>
</refsect1>
</refentry>
</article>