gitea
/
Koha-clms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Bug 27839: (follow-up) Update docs for koha-worker 

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: David Nind <david@davidnind.com>

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

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
This commit is contained in:
Tomas Cohen Arazi 2021-03-02 16:33:29 -03:00 committed by Jonathan Druart
parent 90291914f9
commit 65542edbe0
2 changed files with 83 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
debian/docs/koha-worker.xml vendored Normal file
View File

@ -0,0 +1,82 @@
<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>--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>-v</option>|<option>--verbose</option></term>
<listitem>
<para>Enable verbose output.</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>

1
debian/scripts/koha-worker vendored
View File

@ -41,6 +41,7 @@ This script lets you manage the worker daemon for your Koha instances.
Usage:
$scriptname [--start|--stop|--restart] [--quiet|-q] instancename1 [instancename2...]
$scriptname --status instancename1 [instancename2...]
$scriptname -h|--help
--start Start the worker daemon for the specified instances