debian/docs/koha-foreach.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-foreach</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-foreach">
  12
  13   <refmeta>
  14     <refentrytitle>koha-foreach</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-foreach</refname>
  20     <refpurpose>Run a command for each Koha instance. Takes the same arguments as koha-list.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-foreach</command> <arg><option>--chdir</option></arg> <arg><option>--enabled</option></arg> <arg><option>--email</option>|<option>--noemail</option></arg> <arg><option>command</option></arg>
  27     </cmdsynopsis>
  28   </refsynopsisdiv>
  29
  30   <refsect1><title>Description</title>
  31   <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
  32   <para>The string "__instancename__" is replaced in the argument list with the name of the Koha instance in each iteration.</para>
  33   </refsect1>
  34
  35   <refsect1>
  36     <title>Options</title>
  37       <variablelist>
  38       <varlistentry>
  39         <term><option>--chdir</option></term>
  40         <listitem>
  41           <para>This option makes the command jump into the instance's home directory before running the required command. This prevents
  42             directory traversal permissions issues.</para>
  43         </listitem>
  44       </varlistentry>
  45     </variablelist>
  46   </refsect1>
  47
  48   <refsect1><title>See also</title>
  49   <simplelist type="inline">
  50     <member><command>koha-create-dirs(8)</command></member>
  51     <member><command>koha-list(8)</command></member>
  52   </simplelist>
  53   </refsect1>
  54
  55 </refentry>
  56
  57 </article>