debian/docs/koha-sip.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-sip</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-sip">
  12
  13   <refmeta>
  14     <refentrytitle>koha-sip</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-sip</refname>
  20     <refpurpose>Handle SIP server for named Koha instances.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-sip</command>
  27       <arg><option>--start</option>|<option>--stop</option>|<option>--restart</option></arg>
  28       <arg><option>--status</option></arg>
  29       <arg><option>--enable</option></arg>
  30       <arg><option>--disable</option></arg>
  31       <arg><option>--verbose</option>|<option>-v</option></arg>
  32       <arg><option>-h</option>|<option>--help</option></arg>
  33     </cmdsynopsis>
  34   </refsynopsisdiv>
  35
  36   <refsect1><title>Options</title>
  37   <para>All option switches are mutually exclusive</para>
  38   <variablelist>
  39     <varlistentry>
  40       <term><option>--start</option></term>
  41       <listitem>
  42         <para>Starts the SIP server for the specified Koha instances.</para>
  43       </listitem>
  44     </varlistentry>
  45     <varlistentry>
  46       <term><option>--stop</option></term>
  47       <listitem>
  48         <para>Stops the SIP server for the specified Koha instances.</para>
  49       </listitem>
  50     </varlistentry>
  51     <varlistentry>
  52       <term><option>--restart</option></term>
  53       <listitem>
  54         <para>Restarts the SIP server for the specified Koha instances.</para>
  55       </listitem>
  56     </varlistentry>
  57     <varlistentry>
  58       <term><option>--enable</option></term>
  59       <listitem>
  60           <para>Enables the Koha SIP server, installing a default config at /etc/koha/sites/instance/SIPconfig.xml if it doesn't already exist.</para>
  61       </listitem>
  62     </varlistentry>
  63     <varlistentry>
  64       <term><option>--disable</option></term>
  65       <listitem>
  66         <para>Disables the SIP server and shuts down running SIP processes.</para>
  67       </listitem>
  68   </varlistentry>
  69     <varlistentry>
  70       <term><option>--status</option></term>
  71       <listitem>
  72         <para>Show status information about the SIP server for the specified Koha instances.</para>
  73       </listitem>
  74     </varlistentry>
  75     <varlistentry>
  76       <term><option>-v</option>|<option>--verbose</option></term>
  77       <listitem>
  78         <para>Display progress messages.</para>
  79       </listitem>
  80     </varlistentry>
  81     <varlistentry>
  82       <term><option>-h</option>|<option>--help</option></term>
  83       <listitem>
  84         <para>This help.</para>
  85       </listitem>
  86     </varlistentry>
  87   </variablelist>
  88   </refsect1>
  89
  90   <refsect1><title>Description</title>
  91   <para>This script handles SIP servers for Koha instances.</para>
  92   </refsect1>
  93
  94   <refsect1><title>See also</title>
  95   <simplelist type="inline">
  96     <member><command>koha-list(8)</command></member>
  97   </simplelist>
  98   </refsect1>
  99
 100 </refentry>
 101
 102 </article>