Koha/debian/docs/koha-list.xml
Tomas Cohen Arazi a4b88d5568
Bug 33108: Teach koha-list filter elasticsearch
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-03-20 09:39:46 -03:00

122 lines
4 KiB
XML

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-list</title>
<info>
<productname>Koha</productname> is the first free software library automation package.
<author>
<orgname>The Koha Community</orgname>
<uri>http://koha-community.org/</uri>
</author>
</info>
<refentry xml:id="koha-list">
<refmeta>
<refentrytitle>koha-list</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-list</refname>
<refpurpose>Lists Koha instances, and optionally only those that are enabled/disabled or have email and/or SIP turned on/off.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-list</command>
<arg><option>--enabled</option>|<option>--disabled</option></arg>
<arg><option>--elasticsearch</option>|<option>--noelasticsearch</option></arg>
<arg><option>--email</option>|<option>--noemail</option></arg>
<arg><option>--sip</option>|<option>--nosip</option></arg>
<arg><option>--plack</option>|<option>--noplack</option></arg>
<arg><option>-h</option>|<option>--help</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Options</title>
<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>
<variablelist>
<varlistentry>
<term><option>--enabled</option></term>
<listitem>
<para>Only show instances that are enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--disabled</option></term>
<listitem>
<para>Only show instances that are disabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--elasticsearch</option></term>
<listitem>
<para>Only show instances that have elasticsearch enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--noelasticsearch</option></term>
<listitem>
<para>Only show instances that do not have elasticsearch enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--email</option></term>
<listitem>
<para>Only show instances that have email enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--noemail</option></term>
<listitem>
<para>Only show instances that do not have email enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--sip</option></term>
<listitem>
<para>Only show instances that have SIP enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--nosip</option></term>
<listitem>
<para>Only show instances that do not have SIP enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--plack</option></term>
<listitem>
<para>Only show instances that have Plack enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--noplack</option></term>
<listitem>
<para>Only show instances that do not have Plack enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>|<option>--help</option></term>
<listitem>
<para>This help.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Description</title>
<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>
</refsect1>
<refsect1><title>See also</title>
<simplelist type="inline">
<member><command>koha-create-dirs(8)</command></member>
<member><command>koha-foreach(8)</command></member>
</simplelist>
</refsect1>
</refentry>
</article>