bug 9784: add koha-shell to the koha-common man page
authorLiz Rea <liz@catalyst.net.nz>
Tue, 12 Mar 2013 03:49:31 +0000 (16:49 +1300)
committerJared Camins-Esakov <jcamins@cpbibliography.com>
Wed, 13 Mar 2013 12:46:21 +0000 (08:46 -0400)
To test:

Build a package from a git checkout with this patch included
once installed, run man koha-common - koha-shell should appear near the bottom.

Signed-off-by: Robin Sheat <robin@catalyst.net.nz>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>
Signed-off-by: Jared Camins-Esakov <jcamins@cpbibliography.com>

debian/docs/koha-common.xml

index bbef4f2..4dc2179 100644 (file)
           <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><option>koha-shell</option></term>
+        <listitem>
+          <para>This command behaves something like su(1), but provides you with a shell as the koha user, and with the environment pointing to the right places.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
     </refsect2>
   </refsect1>
+
   
   <refsect1><title>Bugs</title>
   <para>The scripts are a bit fragile. If something goes wrong, they do not clean up after themselves.</para>