106 lines
3.6 KiB
XML
106 lines
3.6 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>--enable</option>|<option>--disable</option></arg>
|
|
<arg><option>--status</option></arg>
|
|
<arg><option>--queue</option></arg>
|
|
<arg><option>--all-queues</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>--enable</option></term>
|
|
<listitem>
|
|
<para>Enable the worker daemon for named Koha instances so it is started at boot. Only meaningful with the koha-systemd package, where it enables the corresponding systemd unit; with koha-sysv it is a no-op because the init script starts every enabled instance's daemons.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>--disable</option></term>
|
|
<listitem>
|
|
<para>Disable the worker daemon for named Koha instances so it is no longer started at boot. As with <option>--enable</option>, this only has an effect with the koha-systemd package.</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.</para>
|
|
<para>Note: There used to be a queue called elastic_index, but since the introduction of koha-es-indexer this queue should not be active.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>--all-queues</option></term>
|
|
<listitem>
|
|
<para>Makes the requested action to be performed to all defined queues.</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>
|