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