debian/docs/koha-dump.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-dump</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-dump">
  12
  13   <refmeta>
  14     <refentrytitle>koha-dump</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-dump</refname>
  20     <refpurpose>Dump all contents and configs for a Koha site.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-dump</command>
  27       <arg choice="noreq">
  28         <option>--help</option>|<option>-h</option>
  29         <option>--exclude-indexes</option>
  30         <option>--quiet</option>|<option>-q</option>
  31       </arg>
  32       <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
  33     </cmdsynopsis>
  34   </refsynopsisdiv>
  35
  36   <refsect1>
  37     <title>Options</title>
  38     <variablelist>
  39
  40       <varlistentry>
  41         <term><option>--exclude-indexes</option></term>
  42         <listitem>
  43           <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>
  44         </listitem>
  45       </varlistentry>
  46
  47       <varlistentry>
  48         <term><option>--quiet</option>|<option>-q</option></term>
  49         <listitem>
  50           <para>Make <command>koha-dump</command> run silently.</para>
  51         </listitem>
  52       </varlistentry>
  53
  54       <varlistentry>
  55         <term><option>--help</option>|<option>-h</option></term>
  56         <listitem>
  57           <para>Show usage information.</para>
  58         </listitem>
  59       </varlistentry>
  60
  61     </variablelist>
  62   </refsect1>
  63
  64   <refsect1><title>Description</title>
  65   <para>Dump all contents and configs for one or more Koha instances.</para>
  66   </refsect1>
  67
  68   <refsect1><title>See also</title>
  69   <simplelist type="inline">
  70     <member><command>koha-disable(8)</command></member>
  71     <member><command>koha-enable(8)</command></member>
  72     <member><command>koha-remove(8)</command></member>
  73     <member><command>koha-restore(8)</command></member>
  74   </simplelist>
  75   </refsect1>
  76
  77 </refentry>
  78
  79 </article>