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>--uploaded_files</option>
  31         <option>--uploaded_temp_files</option>
  32         <option>--quiet</option>|<option>-q</option>
  33       </arg>
  34       <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
  35     </cmdsynopsis>
  36   </refsynopsisdiv>
  37
  38   <refsect1>
  39     <title>Options</title>
  40     <variablelist>
  41
  42       <varlistentry>
  43         <term><option>--exclude-indexes</option></term>
  44         <listitem>
  45           <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>
  46         </listitem>
  47       </varlistentry>
  48
  49       <varlistentry>
  50         <term><option>--quiet</option>|<option>-q</option></term>
  51         <listitem>
  52           <para>Make <command>koha-dump</command> run silently.</para>
  53         </listitem>
  54       </varlistentry>
  55
  56       <varlistentry>
  57         <term><option>--uploaded_files</option></term>
  58         <listitem>
  59           <para>Make <command>koha-dump</command> include uploaded files</para>
  60         </listitem>
  61       </varlistentry>
  62
  63       <varlistentry>
  64         <term><option>--uploaded_temp_files</option></term>
  65         <listitem>
  66           <para>Make <command>koha-dump</command> include temporary uploaded files</para>
  67         </listitem>
  68       </varlistentry>
  69
  70       <varlistentry>
  71         <term><option>--help</option>|<option>-h</option></term>
  72         <listitem>
  73           <para>Show usage information.</para>
  74         </listitem>
  75       </varlistentry>
  76
  77     </variablelist>
  78   </refsect1>
  79
  80   <refsect1><title>Description</title>
  81   <para>Dump all contents and configs for one or more Koha instances.</para>
  82   </refsect1>
  83
  84   <refsect1><title>See also</title>
  85   <simplelist type="inline">
  86     <member><command>koha-disable(8)</command></member>
  87     <member><command>koha-enable(8)</command></member>
  88     <member><command>koha-remove(8)</command></member>
  89     <member><command>koha-restore(8)</command></member>
  90   </simplelist>
  91   </refsect1>
  92
  93 </refentry>
  94
  95 </article>