koha-foreach.xml

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-foreach</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-foreach">

  <refmeta>
    <refentrytitle>koha-foreach</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>koha-foreach</refname>
    <refpurpose>Run a command for each Koha instance. Takes the same arguments as koha-list.</refpurpose>
    <refclass>UNIX/Linux</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <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>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1><title>Description</title>
  <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
  <para>The string "__instancename__" is replaced in the argument list with the name of the Koha instance in each iteration.</para>
  </refsect1>

  <refsect1>
    <title>Options</title>
      <variablelist>
      <varlistentry>
        <term><option>--chdir</option></term>
        <listitem>
          <para>This option makes the command jump into the instance's home directory before running the required command. This prevents
            directory traversal permissions issues.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1><title>See also</title>
  <simplelist type="inline">
    <member><command>koha-create-dirs(8)</command></member>
    <member><command>koha-list(8)</command></member>
  </simplelist>
  </refsect1>
  
</refentry>

</article>