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

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

  <refnamediv>
    <refname>koha-dump</refname>
    <refpurpose>Dump all contents and configs for a Koha site.</refpurpose>
    <refclass>UNIX/Linux</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>koha-dump</command>
      <arg choice="noreq">
        <option>--help</option>|<option>-h</option>
        <option>--exclude-indexes</option>
        <option>--quiet</option>|<option>-q</option>
      </arg>
      <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Options</title>
    <variablelist>

      <varlistentry>
        <term><option>--exclude-indexes</option></term>
        <listitem>
          <para>Make <command>koha-dump</command> exclude Zebra indexes during the dump operation. Having the Zebra indexes on the dump is useful for fast recovering Koha instances using <command>koha-restore</command> but the dumps tend to be a lot bigger and slower to create. Use this option to skip it.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--quiet</option>|<option>-q</option></term>
        <listitem>
          <para>Make <command>koha-dump</command> run silently.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--help</option>|<option>-h</option></term>
        <listitem>
          <para>Show usage information.</para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1><title>Description</title>
  <para>Dump all contents and configs for one or more Koha instances.</para>
  </refsect1>
  
  <refsect1><title>See also</title>
  <simplelist type="inline">
    <member><command>koha-disable(8)</command></member>
    <member><command>koha-enable(8)</command></member>
    <member><command>koha-remove(8)</command></member>
    <member><command>koha-restore(8)</command></member>
  </simplelist>
  </refsect1>
  
</refentry>

</article>
