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