debian/docs/koha-list.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-list</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-list">
  12
  13   <refmeta>
  14     <refentrytitle>koha-list</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-list</refname>
  20     <refpurpose>Lists Koha instances, and optionally only those that are enabled/disabled or have email and/or SIP turned on/off.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-list</command>
  27       <arg><option>--enabled</option>|<option>--disabled</option></arg>
  28       <arg><option>--email</option>|<option>--noemail</option></arg>
  29       <arg><option>--sip</option>|<option>--nosip</option></arg>
  30       <arg><option>-h</option>|<option>--help</option></arg>
  31     </cmdsynopsis>
  32   </refsynopsisdiv>
  33
  34   <refsect1><title>Options</title>
  35   <para>The filtering options can be combined, and you probably want to do this (except --email and --noemail,  or --enabled and --disabled, that's just silly.)</para>
  36   <variablelist>
  37     <varlistentry>
  38       <term><option>--enabled</option></term>
  39       <listitem>
  40         <para>Only show instances that are enabled.</para>
  41       </listitem>
  42     </varlistentry>
  43     <varlistentry>
  44       <term><option>--disabled</option></term>
  45       <listitem>
  46         <para>Only show instances that are disabled.</para>
  47       </listitem>
  48     </varlistentry>
  49     <varlistentry>
  50       <term><option>--email</option></term>
  51       <listitem>
  52         <para>Only show instances that have email enabled.</para>
  53       </listitem>
  54     </varlistentry>
  55     <varlistentry>
  56       <term><option>--noemail</option></term>
  57       <listitem>
  58         <para>Only show instances that do not have email enabled.</para>
  59       </listitem>
  60     </varlistentry>
  61     <varlistentry>
  62       <term><option>--sip</option></term>
  63       <listitem>
  64         <para>Only show instances that have SIP enabled.</para>
  65       </listitem>
  66     </varlistentry>
  67     <varlistentry>
  68       <term><option>--nosip</option></term>
  69       <listitem>
  70         <para>Only show instances that do not have SIP enabled.</para>
  71       </listitem>
  72     </varlistentry>
  73
  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>
  82
  83   <refsect1><title>Description</title>
  84   <para>This script lists Koha instances on a server. Optionally only those that are enabled or disabled can be listed. There are also options for listing only servers that have email or SIP enabled/disabled. These limits can be applied alone or in combination.</para>
  85   </refsect1>
  86
  87   <refsect1><title>See also</title>
  88   <simplelist type="inline">
  89     <member><command>koha-create-dirs(8)</command></member>
  90     <member><command>koha-foreach(8)</command></member>
  91   </simplelist>
  92   </refsect1>
  93
  94 </refentry>
  95
  96 </article>