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>--elasticsearch</option>|<option>--noelasticsearch</option></arg>
  29       <arg><option>--email</option>|<option>--noemail</option></arg>
  30       <arg><option>--sip</option>|<option>--nosip</option></arg>
  31       <arg><option>--plack</option>|<option>--noplack</option></arg>
  32       <arg><option>-h</option>|<option>--help</option></arg>
  33     </cmdsynopsis>
  34   </refsynopsisdiv>
  35
  36   <refsect1><title>Options</title>
  37   <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>
  38   <variablelist>
  39     <varlistentry>
  40       <term><option>--enabled</option></term>
  41       <listitem>
  42         <para>Only show instances that are enabled.</para>
  43       </listitem>
  44     </varlistentry>
  45     <varlistentry>
  46       <term><option>--disabled</option></term>
  47       <listitem>
  48         <para>Only show instances that are disabled.</para>
  49       </listitem>
  50     </varlistentry>
  51     <varlistentry>
  52       <term><option>--elasticsearch</option></term>
  53         <listitem>
  54           <para>Only show instances that have elasticsearch enabled.</para>
  55         </listitem>
  56       </varlistentry>
  57       <varlistentry>
  58         <term><option>--noelasticsearch</option></term>
  59         <listitem>
  60           <para>Only show instances that do not have elasticsearch enabled.</para>
  61         </listitem>
  62       </varlistentry>
  63     <varlistentry>
  64       <term><option>--email</option></term>
  65       <listitem>
  66         <para>Only show instances that have email enabled.</para>
  67       </listitem>
  68     </varlistentry>
  69     <varlistentry>
  70       <term><option>--noemail</option></term>
  71       <listitem>
  72         <para>Only show instances that do not have email enabled.</para>
  73       </listitem>
  74     </varlistentry>
  75     <varlistentry>
  76       <term><option>--sip</option></term>
  77       <listitem>
  78         <para>Only show instances that have SIP enabled.</para>
  79       </listitem>
  80     </varlistentry>
  81     <varlistentry>
  82       <term><option>--nosip</option></term>
  83       <listitem>
  84         <para>Only show instances that do not have SIP enabled.</para>
  85       </listitem>
  86     </varlistentry>
  87     <varlistentry>
  88       <term><option>--plack</option></term>
  89       <listitem>
  90         <para>Only show instances that have Plack enabled.</para>
  91       </listitem>
  92     </varlistentry>
  93     <varlistentry>
  94       <term><option>--noplack</option></term>
  95       <listitem>
  96         <para>Only show instances that do not have Plack enabled.</para>
  97       </listitem>
  98     </varlistentry>
  99
 100     <varlistentry>
 101       <term><option>-h</option>|<option>--help</option></term>
 102       <listitem>
 103         <para>This help.</para>
 104       </listitem>
 105     </varlistentry>
 106   </variablelist>
 107   </refsect1>
 108
 109   <refsect1><title>Description</title>
 110   <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>
 111   </refsect1>
 112
 113   <refsect1><title>See also</title>
 114   <simplelist type="inline">
 115     <member><command>koha-create-dirs(8)</command></member>
 116     <member><command>koha-foreach(8)</command></member>
 117   </simplelist>
 118   </refsect1>
 119
 120 </refentry>
 121
 122 </article>