debian/docs/koha-enable-sip.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-enable-sip</title>
   3 <info>
   4     <productname>Koha</productname> is the first free software library automation package.
   5     <author>
   6         <personname>
   7             <firstname>Robin</firstname>
   8             <surname>Sheat</surname>
   9         </personname>
  10         <affiliation>
  11             <orgname>Catalyst IT</orgname>
  12             <uri>http://www.catalyst.net.nz</uri>
  13         </affiliation>
  14         <contrib>Author</contrib>
  15     </author>
  16 </info>
  17
  18 <refentry xml:id="koha-enable-sip">
  19
  20     <refmeta>
  21         <refentrytitle>koha-enable-sip</refentrytitle>
  22         <manvolnum>8</manvolnum>
  23     </refmeta>
  24
  25     <refnamediv>
  26         <refname>koha-enable-sip</refname>
  27         <refpurpose>Copies the SIP configuration file to allow SIP to be controlled by init scripts.</refpurpose>
  28         <refclass>UNIX/Linux</refclass>
  29     </refnamediv>
  30
  31     <refsynopsisdiv>
  32         <cmdsynopsis>
  33             <command>koha-enable-sip</command>
  34             <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
  35         </cmdsynopsis>
  36     </refsynopsisdiv>
  37
  38     <refsect1><title>Description</title>
  39         <para>This copies the default SIP configuration file /etc/koha/SIPconfig.xml to the
  40             /etc/koha/sites/instancename directory. This allows it to be started by
  41             <command>koha-start-sip(8)</command>, and <command>koha-stop-sip</command>. In turn,
  42             this means that it will be started on boot and stopped on shutdown.</para>
  43         <para>After running this, you will need to edit the newly created file to configure it
  44             for your site.</para>
  45         <para>To disable SIP again, delete or rename the configuration file.</para>
  46     </refsect1>
  47
  48   <refsect1><title>See also</title>
  49   <simplelist type="inline">
  50     <member><command>koha-start-sip(8)</command></member>
  51     <member><command>koha-stop-sip(8)</command></member>
  52   </simplelist>
  53   </refsect1>
  54
  55 </refentry>
  56
  57 </article>