debian/docs/koha-worker.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-worker</title>
   3 <info>
   4 <productname>Koha</productname> is the first free software library automation package.
   5 <author>
   6   <orgname>The Koha Community</orgname>
   7   <uri>https://koha-community.org/</uri>
   8 </author>
   9 </info>
  10
  11 <refentry xml:id="koha-worker">
  12
  13   <refmeta>
  14     <refentrytitle>koha-worker</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-worker</refname>
  20     <refpurpose>Handle worker daemon for named Koha instances.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-worker</command>
  27       <arg><option>--start</option>|<option>--stop</option>|<option>--restart</option></arg>
  28       <arg><option>--status</option></arg>
  29       <arg><option>--quiet</option>|<option>-q</option></arg>
  30       <arg><option>-h</option>|<option>--help</option></arg>
  31     </cmdsynopsis>
  32   </refsynopsisdiv>
  33
  34   <refsect1><title>Options</title>
  35   <para>All option switches are mutually exclusive</para>
  36   <variablelist>
  37     <varlistentry>
  38       <term><option>--start</option></term>
  39       <listitem>
  40         <para>Start worker daemon for named Koha instances.</para>
  41       </listitem>
  42     </varlistentry>
  43     <varlistentry>
  44       <term><option>--stop</option></term>
  45       <listitem>
  46         <para>Stop worker daemon for named Koha instances.</para>
  47       </listitem>
  48     </varlistentry>
  49     <varlistentry>
  50       <term><option>--restart</option></term>
  51       <listitem>
  52         <para>Restart worker daemon for named Koha instances.</para>
  53       </listitem>
  54     </varlistentry>
  55     <varlistentry>
  56       <term><option>--status</option></term>
  57       <listitem>
  58         <para>Show status information about worker daemon for named Koha instances.</para>
  59       </listitem>
  60     </varlistentry>
  61     <varlistentry>
  62       <term><option>-v</option>|<option>--verbose</option></term>
  63       <listitem>
  64         <para>Enable verbose output.</para>
  65       </listitem>
  66     </varlistentry>
  67     <varlistentry>
  68       <term><option>-h</option>|<option>--help</option></term>
  69       <listitem>
  70         <para>This help.</para>
  71       </listitem>
  72     </varlistentry>
  73   </variablelist>
  74   </refsect1>
  75
  76   <refsect1><title>Description</title>
  77   <para>This script handles worker daemons for Koha instances.</para>
  78   </refsect1>
  79
  80 </refentry>
  81
  82 </article>