Bug 10622 - [SIGNED OFF] Followup: Add --sip, --nosip and --help to man page
authorMagnus Enger <magnus@enger.priv.no>
Fri, 9 Aug 2013 08:05:23 +0000 (10:05 +0200)
committerGalen Charlton <gmc@esilibrary.com>
Sat, 21 Sep 2013 17:45:48 +0000 (17:45 +0000)
The original patch for bug 10622 added the --sip, --nosip and
--help switches to the koha-list command, but did not update the
manpage for the command. This patch does.

To test:

Run these commands and look at the formatted man page:
$ xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
  debian/docs/koha-list.xml
$ man -l koha-list.8

Make sure this test passes:
$ prove -v xt/verify-debian-docbook.t

Signed-off-by: Tomas Cohen Arazi <tomascohen@gmail.com>
Forgot the docs this time, good catch Magnus

Signed-off-by: Robin Sheat <robin@catalyst.net.nz>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>
debian/docs/koha-list.xml

index b58847e..39eee43 100644 (file)
 
   <refnamediv>
     <refname>koha-list</refname>
-    <refpurpose>Lists Koha instances, optionally only those that are enabled or have email turned on.</refpurpose>
+    <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>--email</option>|<option>--noemail</option></arg> <arg><option>-h</option></arg>
+      <command>koha-list</command>
+      <arg><option>--enabled</option>|<option>--disabled</option></arg>
+      <arg><option>--email</option>|<option>--noemail</option></arg>
+      <arg><option>--sip</option>|<option>--nosip</option></arg>
+      <arg><option>-h</option>|<option>--help</option></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
   
       </listitem>
     </varlistentry>
     <varlistentry>
-      <term><option>-h</option></term>
+      <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>-h</option>|<option>--help</option></term>
       <listitem>
         <para>This help.</para>
       </listitem>
@@ -64,7 +81,7 @@
   </refsect1>
 
   <refsect1><title>Description</title>
-  <para>Lists Koha instances, optionally only those that are enabled or have email turned on.</para>
+  <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>