debian/docs/koha-run-backups.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-run-backups</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-run-backups">
  12
  13   <refmeta>
  14     <refentrytitle>koha-run-backups</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-run-backups</refname>
  20     <refpurpose>Performs backups of the koha installations on the system, except an instance called 'demo'.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-run-backups</command>
  27       <arg><option>--output</option> /some/path</arg>
  28       <arg><option>--days</option> 2</arg>
  29     </cmdsynopsis>
  30   </refsynopsisdiv>
  31
  32   <refsect1><title>Options</title>
  33   <variablelist>
  34
  35     <varlistentry>
  36       <term><option>--output</option></term>
  37       <listitem>
  38         <para>The directory that the resulting files will be placed into (default: /var/spool/koha).</para>
  39       </listitem>
  40     </varlistentry>
  41
  42     <varlistentry>
  43       <term><option>--days</option></term>
  44       <listitem>
  45         <para>The number of days to keep backups around for (default: 2).</para>
  46       </listitem>
  47     </varlistentry>
  48
  49     <varlistentry>
  50       <term><option>--exclude-indexes</option></term>
  51       <listitem>
  52         <para>Exclude Zebra indexes from the backups (default: false).</para>
  53       </listitem>
  54     </varlistentry>
  55
  56   </variablelist>
  57   </refsect1>
  58
  59   <refsect1><title>Description</title>
  60     <para><command>koha-run-backups</command> allows automation of backing up the koha data and configuration to the filesystem. It will keep the past so many backups, discarding older ones. This script uses <command>koha-dump</command> to do the actual backup.</para>
  61     <para>If there is an instance called 'demo', it will be skipped by this script.</para>
  62     <para>Note: backups produced using this tool can be restored using <command>koha-restore</command>.</para>
  63   </refsect1>
  64
  65   <refsect1><title>See also</title>
  66
  67   <simplelist type="inline">
  68     <member><command>koha-dump(8)</command></member>
  69     <member><command>koha-restore(8)</command></member>
  70   </simplelist>
  71
  72   </refsect1>
  73
  74 </refentry>
  75
  76 </article>