sitarba.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>2013-01-06</date>
  15         </refentryinfo>
  16
  17         <refmeta>
  18                 <refentrytitle>sitarba</refentrytitle>
  19                 <manvolnum>1</manvolnum>
  20         </refmeta>
  21
  22         <refnamediv>
  23                 <refname>sitarba</refname>
  24                 <refpurpose>a simple backup solution</refpurpose>
  25         </refnamediv>
  26
  27         <refsynopsisdiv>
  28                 <cmdsynopsis>
  29                         <command>sitarba</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>sitarba</command> is a simple backup solution
  40                         which packs user-defined file sets with tar. Each
  41                         backup belongs to an epoch, which is 'sporadic' or one
  42                         of the user-defined epochs. Standard epochs are year,
  43                         month, week, day, or hour. The backup can be made
  44                         either full, differential or incremental.
  45
  46                         <command>sitarba</command> takes care for pruning old
  47                         backups. The user defines for every epoch the number of
  48                         backups to keep, except for 'sporadic'. Sporadic
  49                         backups need to be removed manually.
  50
  51                 </para>
  52
  53         </refsect1>
  54
  55         <refsect1>
  56                 <title>COMMANDS</title>
  57
  58                 <variablelist>
  59
  60                 <varlistentry>
  61                         <term><option>backup</option></term>
  62                         <listitem>
  63                                 <para>Make a backup</para>
  64                         </listitem>
  65                 </varlistentry>
  66
  67                 <varlistentry>
  68                         <term><option>list</option></term>
  69                         <listitem>
  70                                 <para>List all backups</para>
  71                         </listitem>
  72                 </varlistentry>
  73
  74                 <varlistentry>
  75                         <term><option>prune</option></term>
  76                         <listitem>
  77                                 <para>Prune outdated/stale backups</para>
  78                         </listitem>
  79                 </varlistentry>
  80
  81                 </variablelist>
  82         </refsect1>
  83
  84
  85         <refsect1>
  86                 <title>OPTIONS</title>
  87
  88                 <variablelist>
  89
  90                 <varlistentry>
  91                         <term><option>-h, --help</option></term>
  92                         <listitem>
  93                                 <para>Print out a help summary.</para>
  94                         </listitem>
  95                 </varlistentry>
  96
  97                 <varlistentry>
  98                         <term><option>-c, --conf FILE</option></term>
  99                         <listitem>
 100                                 <para>Use given configuration file instead of
 101                                         /etc/sitarba.conf.</para>
 102                         </listitem>
 103                 </varlistentry>
 104
 105                 <varlistentry>
 106                         <term><option>-e, --epoch EPOCH</option></term>
 107                         <listitem>
 108                                 <para>Do not determine epoch automatically, but
 109                                         use EPOCH, which can be sporadic or one
 110                                         of the epochs defined in the
 111                                         configuration file.</para>
 112                         </listitem>
 113                 </varlistentry>
 114
 115                 <varlistentry>
 116                         <term><option>-m, --mode MODE</option></term>
 117                         <listitem>
 118                                 <para>Instead of configured mode use MODE,
 119                                         which can be full, diff or incr.</para>
 120                         </listitem>
 121                   </varlistentry>
 122
 123                 <varlistentry>
 124                         <term><option>-n, --dry-run</option></term>
 125                         <listitem>
 126                                 <para>Don't do anything, just tell what would be done.</para>
 127                         </listitem>
 128                 </varlistentry>
 129
 130                 <varlistentry>
 131                         <term><option>-v, --verbose</option></term>
 132                         <listitem>
 133                                 <para>Be more verbose and interact with user.
 134                                         Equal to --verbosity info.</para>
 135                         </listitem>
 136                 </varlistentry>
 137
 138                 <varlistentry>
 139                         <term><option>--verbosity LEVEL</option></term>
 140                         <listitem>
 141                                 <para>Set verbosity to LEVEL, which can be
 142                                         error, warning, info, debug.</para>
 143                         </listitem>
 144                 </varlistentry>
 145
 146                 <varlistentry>
 147                         <term><option>-V, --version</option></term>
 148                         <listitem>
 149                                 <para>Print version info.</para>
 150                         </listitem>
 151                 </varlistentry>
 152
 153
 154         </variablelist>
 155         </refsect1>
 156
 157         <refsect1>
 158                 <title>AUTHOR</title>
 159
 160                 <para>
 161                         Stefan HUBER
 162                 </para>
 163         </refsect1>
 164 </refentry>