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, optionally only those that are enabled or have email turned on.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-list</command> <arg><option>--enabled</option></arg> <arg><option>--email</option></arg> <arg><option>-h</option></arg>
  27     </cmdsynopsis>
  28   </refsynopsisdiv>
  29
  30   <refsect1><title>Options</title>
  31   <para>The filtering options can be combined, and you probably want to do this (except --email and --noemail, that's just silly.)</para>
  32   <variablelist>
  33     <varlistentry>
  34       <term><option>--enabled</option></term>
  35       <listitem>
  36         <para>Only show instances that are enabled.</para>
  37       </listitem>
  38     </varlistentry>
  39     <varlistentry>
  40       <term><option>--email</option></term>
  41       <listitem>
  42         <para>Only show instances that have email enabled.</para>
  43       </listitem>
  44     </varlistentry>
  45     <varlistentry>
  46       <term><option>--noemail</option></term>
  47       <listitem>
  48         <para>Only show instances that do not have email enabled.</para>
  49       </listitem>
  50     </varlistentry>
  51     <varlistentry>
  52       <term><option>-h</option></term>
  53       <listitem>
  54         <para>This help.</para>
  55       </listitem>
  56     </varlistentry>
  57   </variablelist>
  58   </refsect1>
  59
  60   <refsect1><title>Description</title>
  61   <para>Lists Koha instances, optionally only those that are enabled or have email turned on.</para>
  62   </refsect1>
  63
  64   <refsect1><title>See also</title>
  65   <simplelist type="inline">
  66     <member><command>koha-create-dirs(8)</command></member>
  67     <member><command>koha-foreach(8)</command></member>
  68   </simplelist>
  69   </refsect1>
  70
  71 </refentry>
  72
  73 </article>