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>--help</option>|<option>-h</option>
  35         |<option>--quiet</option>|<option>-q</option>
  36       </arg>
  37       <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
  38     </cmdsynopsis>
  39   </refsynopsisdiv>
  40
  41   <refsect1><title>Options</title>
  42
  43   <variablelist>
  44
  45     <varlistentry>
  46       <term><option>--start</option></term>
  47       <listitem>
  48         <para>Start the Plack daemon for the desired Koha instances.</para>
  49       </listitem>
  50     </varlistentry>
  51
  52     <varlistentry>
  53       <term><option>--stop</option></term>
  54       <listitem>
  55         <para>Stop the Plack daemon for the desired Koha instances.</para>
  56       </listitem>
  57     </varlistentry>
  58
  59     <varlistentry>
  60       <term><option>--restart</option></term>
  61       <listitem>
  62         <para>Restart the Plack daemon for the desired Koha instances.</para>
  63       </listitem>
  64     </varlistentry>
  65
  66     <varlistentry>
  67       <term><option>--reload</option></term>
  68       <listitem>
  69         <para>Reload the Plack daemon for the desired Koha instances, letting the busy workers finish processing their requests before restarting them.</para>
  70       </listitem>
  71     </varlistentry>
  72
  73     <varlistentry>
  74       <term><option>--enable</option></term>
  75       <listitem>
  76         <para>Enable the use of Plack for the desired Koha instances.</para>
  77       </listitem>
  78     </varlistentry>
  79
  80     <varlistentry>
  81       <term><option>--disable</option></term>
  82       <listitem>
  83         <para>Disable the use of Plack for the desired Koha instances.</para>
  84       </listitem>
  85     </varlistentry>
  86
  87     <varlistentry>
  88       <term><option>--quiet|-q</option></term>
  89       <listitem>
  90         <para>Make the script quiet about non existent instance names. Useful when calling <command>koha-plack</command> from another scripts.</para>
  91       </listitem>
  92     </varlistentry>
  93
  94     <varlistentry>
  95       <term><option>--help|-h</option></term>
  96       <listitem>
  97         <para>Show usage information.</para>
  98       </listitem>
  99     </varlistentry>
 100
 101   </variablelist>
 102   </refsect1>
 103
 104   <refsect1><title>Description</title>
 105     <para>The <command>koha-plack</command> script lets you manage your Koha instances Plack daemon.</para>
 106   </refsect1>
 107
 108   <refsect1><title>See also</title>
 109   <simplelist type="inline">
 110     <member><command>/etc/default/koha-common</command></member>
 111   </simplelist>
 112   </refsect1>
 113
 114 </refentry>
 115
 116 </article>