shbackup.docbook

   1 <?xml version="1.0" encoding="utf-8"?>
   2
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   4 "file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd"
   5 []>
   6
   7 <refentry>
   8
   9         <refentryinfo>
  10                 <author>
  11                         <firstname>Stefan</firstname>
  12                         <surname>Huber</surname>
  13                 </author>
  14                 <date>2012-05-13</date>
  15         </refentryinfo>
  16
  17         <refmeta>
  18                 <refentrytitle>shbackup</refentrytitle>
  19                 <manvolnum>1</manvolnum>
  20         </refmeta>
  21
  22         <refnamediv>
  23                 <refname>shbackup</refname>
  24                 <refpurpose>a simple backup solution</refpurpose>
  25         </refnamediv>
  26
  27         <refsynopsisdiv>
  28                 <cmdsynopsis>
  29                         <command>shbackup</command>
  30                         <arg>options</arg>
  31                         <arg choice="req"><replaceable>command</replaceable></arg>
  32                 </cmdsynopsis>
  33         </refsynopsisdiv>
  34
  35         <refsect1>
  36                 <title>DESCRIPTION</title>
  37
  38                 <para>
  39                         <command>shbackup</command> is a simple backup solution
  40                         which packs user-defined file sets with tar. Each
  41                         backup belongs to an epoch, which can be year, month,
  42                         week, day, hour or sporadic. The backup can be made
  43                         either full, differential or incremental.
  44
  45                         <command>shbackup</command> takes care for pruning old
  46                         backups. The user defines for each epoch the number of
  47                         backups to keep, except for 'sporadic'. Sporadic
  48                         backups need to be removed manually.
  49                 </para>
  50
  51         </refsect1>
  52
  53         <refsect1>
  54                 <title>COMMANDS</title>
  55
  56                 <variablelist>
  57
  58                 <varlistentry>
  59                         <term><option>backup</option></term>
  60                         <listitem>
  61                                 <para>Make a backup</para>
  62                         </listitem>
  63                 </varlistentry>
  64
  65                 <varlistentry>
  66                         <term><option>list</option></term>
  67                         <listitem>
  68                                 <para>List all backups</para>
  69                         </listitem>
  70                 </varlistentry>
  71
  72                 <varlistentry>
  73                         <term><option>prune</option></term>
  74                         <listitem>
  75                                 <para>Prune outdated/stale backups</para>
  76                         </listitem>
  77                 </varlistentry>
  78
  79                 </variablelist>
  80         </refsect1>
  81
  82
  83         <refsect1>
  84                 <title>OPTIONS</title>
  85
  86                 <variablelist>
  87
  88                 <varlistentry>
  89                         <term><option>-h, --help</option></term>
  90                         <listitem>
  91                                 <para>Print out a help summary.</para>
  92                         </listitem>
  93                 </varlistentry>
  94
  95                 <varlistentry>
  96                         <term><option>-c, --conf FILE</option></term>
  97                         <listitem>
  98                                 <para>Use given configuration file instead of
  99                                         /etc/shbackup.conf.</para>
 100                         </listitem>
 101                 </varlistentry>
 102
 103                 <varlistentry>
 104                         <term><option>-e, --epoch EPOCH</option></term>
 105                         <listitem>
 106                                 <para>Do not determine epoch automatically, but
 107                                         use EPOCH, which can be year, month,
 108                                         week, day, hour, sporadic.</para>
 109                         </listitem>
 110                 </varlistentry>
 111
 112                 <varlistentry>
 113                         <term><option>-m, --mode MODE</option></term>
 114                         <listitem>
 115                                 <para>Instead of configured mode use MODE,
 116                                         which can be full, diff or incr.</para>
 117                         </listitem>
 118                 </varlistentry>
 119
 120         </variablelist>
 121         </refsect1>
 122
 123         <refsect1>
 124                 <title>AUTHOR</title>
 125
 126                 <para>
 127                         Stefan HUBER
 128                 </para>
 129         </refsect1>
 130 </refentry>