Bug 23050: Add missing template filters
[koha.git] / debian / docs / koha-sip.xml
blob40cb57da49a25d9092847f153400381fbab3fcd6
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>
11 <refentry xml:id="koha-sip">
13   <refmeta>
14     <refentrytitle>koha-sip</refentrytitle>
15     <manvolnum>8</manvolnum>
16   </refmeta>
18   <refnamediv>
19     <refname>koha-sip</refname>
20     <refpurpose>Handle SIP server for named Koha instances.</refpurpose>
21     <refclass>UNIX/Linux</refclass>
22   </refnamediv>
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>--verbose</option>|<option>-v</option></arg>
31       <arg><option>-h</option>|<option>--help</option></arg>
32     </cmdsynopsis>
33   </refsynopsisdiv>
35   <refsect1><title>Options</title>
36   <para>All option switches are mutually exclusive</para>
37   <variablelist>
38     <varlistentry>
39       <term><option>--start</option></term>
40       <listitem>
41         <para>Starts the SIP server for the specified Koha instances.</para>
42       </listitem>
43     </varlistentry>
44     <varlistentry>
45       <term><option>--stop</option></term>
46       <listitem>
47         <para>Stops the SIP server for the specified Koha instances.</para>
48       </listitem>
49     </varlistentry>
50     <varlistentry>
51       <term><option>--restart</option></term>
52       <listitem>
53         <para>Restarts the SIP server for the specified Koha instances.</para>
54       </listitem>
55     </varlistentry>
56     <varlistentry>
57       <term><option>--enable</option></term>
58       <listitem>
59         <para>Copies the default SIP configuration file (/etc/koha/SIPconfig.xml) to the instance's configuration directory (/etc/koha/sites/)</para>
60       </listitem>
61     </varlistentry>
62     <varlistentry>
63       <term><option>--status</option></term>
64       <listitem>
65         <para>Show status information about the SIP server for the specified Koha instances.</para>
66       </listitem>
67     </varlistentry>
68     <varlistentry>
69       <term><option>-v</option>|<option>--verbose</option></term>
70       <listitem>
71         <para>Display progress messages.</para>
72       </listitem>
73     </varlistentry>
74     <varlistentry>
75       <term><option>-h</option>|<option>--help</option></term>
76       <listitem>
77         <para>This help.</para>
78       </listitem>
79     </varlistentry>
80   </variablelist>
81   </refsect1>
83   <refsect1><title>Description</title>
84   <para>This script handles SIP servers for Koha instances.</para>
85   </refsect1>
87   <refsect1><title>See also</title>
88   <simplelist type="inline">
89     <member><command>koha-list(8)</command></member>
90   </simplelist>
91   </refsect1>
93 </refentry>
95 </article>