debian/docs/koha-plack.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-plack</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>http://koha-community.org/</uri>
   8 </author>
   9 </info>
  10
  11 <refentry xml:id="koha-plack">
  12
  13   <refmeta>
  14     <refentrytitle>koha-plack</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-plack</refname>
  20     <refpurpose>Manage Plack for Koha instances.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-plack</command>
  27       <arg choice="req" rep="norepeat">
  28         <option>--start</option>|
  29         <option>--stop</option>|
  30         <option>--restart</option>|
  31         <option>--reload</option>|
  32         <option>--enable</option>|
  33         <option>--disable</option>|
  34         <option>--status</option>|
  35         <option>--help</option>|<option>-h</option>
  36         |<option>--quiet</option>|<option>-q</option>
  37       </arg>
  38       <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
  39     </cmdsynopsis>
  40   </refsynopsisdiv>
  41
  42   <refsect1><title>Options</title>
  43
  44   <variablelist>
  45
  46     <varlistentry>
  47       <term><option>--start</option></term>
  48       <listitem>
  49         <para>Start the Plack daemon for the desired Koha instances.</para>
  50       </listitem>
  51     </varlistentry>
  52
  53     <varlistentry>
  54       <term><option>--stop</option></term>
  55       <listitem>
  56         <para>Stop the Plack daemon for the desired Koha instances.</para>
  57       </listitem>
  58     </varlistentry>
  59
  60     <varlistentry>
  61       <term><option>--restart</option></term>
  62       <listitem>
  63         <para>Restart the Plack daemon for the desired Koha instances.</para>
  64       </listitem>
  65     </varlistentry>
  66
  67     <varlistentry>
  68       <term><option>--reload</option></term>
  69       <listitem>
  70         <para>Reload the Plack daemon for the desired Koha instances, letting the busy workers finish processing their requests before restarting them.</para>
  71       </listitem>
  72     </varlistentry>
  73
  74     <varlistentry>
  75       <term><option>--enable</option></term>
  76       <listitem>
  77         <para>Enable the use of Plack for the desired Koha instances.</para>
  78       </listitem>
  79     </varlistentry>
  80
  81     <varlistentry>
  82       <term><option>--disable</option></term>
  83       <listitem>
  84         <para>Disable the use of Plack for the desired Koha instances.</para>
  85       </listitem>
  86     </varlistentry>
  87
  88     <varlistentry>
  89       <term><option>--status</option></term>
  90       <listitem>
  91         <para>Show the status of Plack for the specified instances.</para>
  92       </listitem>
  93     </varlistentry>
  94
  95     <varlistentry>
  96       <term><option>--quiet|-q</option></term>
  97       <listitem>
  98         <para>Make the script quiet about non existent instance names. Useful when calling <command>koha-plack</command> from another scripts.</para>
  99       </listitem>
 100     </varlistentry>
 101
 102     <varlistentry>
 103       <term><option>--help|-h</option></term>
 104       <listitem>
 105         <para>Show usage information.</para>
 106       </listitem>
 107     </varlistentry>
 108
 109   </variablelist>
 110   </refsect1>
 111
 112   <refsect1><title>Description</title>
 113     <para>The <command>koha-plack</command> script lets you manage your Koha instances Plack daemon.</para>
 114   </refsect1>
 115
 116   <refsect1><title>See also</title>
 117   <simplelist type="inline">
 118     <member><command>/etc/default/koha-common</command></member>
 119   </simplelist>
 120   </refsect1>
 121
 122 </refentry>
 123
 124 </article>