renaming shbackup to sitarba

[sitarba.git] / sitarba.docbook

diff --git a/sitarba.docbook b/sitarba.docbook
new file mode 100644 (file)
index 0000000..1eacde1
--- /dev/null
+++ b/sitarba.docbook
@@ -0,0 +1,157 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+"file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd"
+[]>
+
+<refentry>
+
+       <refentryinfo>
+               <author>
+                       <firstname>Stefan</firstname>
+                       <surname>Huber</surname>
+               </author>
+               <date>2012-05-13</date>
+       </refentryinfo>
+
+       <refmeta>
+               <refentrytitle>sitarba</refentrytitle>
+               <manvolnum>1</manvolnum>
+       </refmeta>
+
+       <refnamediv>
+               <refname>sitarba</refname> 
+               <refpurpose>a simple backup solution</refpurpose>
+       </refnamediv>
+
+       <refsynopsisdiv>
+               <cmdsynopsis>
+                       <command>sitarba</command>
+                       <arg>options</arg>
+                       <arg choice="req"><replaceable>command</replaceable></arg>
+               </cmdsynopsis>
+       </refsynopsisdiv>
+  
+       <refsect1>
+               <title>DESCRIPTION</title>
+       
+               <para>
+                       <command>sitarba</command> is a simple backup solution
+                       which packs user-defined file sets with tar. Each
+                       backup belongs to an epoch, which is 'sporadic' or one
+                       of the user-defined epochs. Standard epochs are year,
+                       month, week, day, or hour. The backup can be made
+                       either full, differential or incremental.
+
+                       <command>sitarba</command> takes care for pruning old
+                       backups. The user defines for every epoch the number of
+                       backups to keep, except for 'sporadic'. Sporadic
+                       backups need to be removed manually.
+
+               </para>
+       
+       </refsect1>
+
+       <refsect1>
+               <title>COMMANDS</title>
+       
+               <variablelist>
+       
+               <varlistentry>
+                       <term><option>backup</option></term>
+                       <listitem>
+                               <para>Make a backup</para>
+                       </listitem>
+               </varlistentry>
+
+               <varlistentry>
+                       <term><option>list</option></term>
+                       <listitem>
+                               <para>List all backups</para>
+                       </listitem>
+               </varlistentry>
+
+               <varlistentry>
+                       <term><option>prune</option></term>
+                       <listitem>
+                               <para>Prune outdated/stale backups</para>
+                       </listitem>
+               </varlistentry>
+
+               </variablelist>
+       </refsect1>
+  
+
+       <refsect1>
+               <title>OPTIONS</title>
+       
+               <variablelist>
+       
+               <varlistentry>
+                       <term><option>-h, --help</option></term>
+                       <listitem>
+                               <para>Print out a help summary.</para>
+                       </listitem>
+               </varlistentry>
+       
+               <varlistentry>
+                       <term><option>-c, --conf FILE</option></term>
+                       <listitem>
+                               <para>Use given configuration file instead of
+                                       /etc/sitarba.conf.</para>
+                       </listitem>
+               </varlistentry>
+       
+               <varlistentry>
+                       <term><option>-e, --epoch EPOCH</option></term>
+                       <listitem>
+                               <para>Do not determine epoch automatically, but
+                                       use EPOCH, which can be sporadic or one
+                                       of the epochs defined in the
+                                       configuration file.</para>
+                       </listitem>
+               </varlistentry> 
+       
+               <varlistentry>
+                       <term><option>-m, --mode MODE</option></term>
+                       <listitem>
+                               <para>Instead of configured mode use MODE,
+                                       which can be full, diff or incr.</para>
+                       </listitem>
+               </varlistentry>
+
+               <varlistentry>
+                       <term><option>-v, --verbose</option></term>
+                       <listitem>
+                               <para>Be more verbose and interact with user.
+                                       Equal to --verbosity info.</para>
+                       </listitem>
+               </varlistentry>
+
+               <varlistentry>
+                       <term><option>--verbosity LEVEL</option></term>
+                       <listitem>
+                               <para>Set verbosity to LEVEL, which can be
+                                       error, warning, info, debug.</para>
+                       </listitem>
+               </varlistentry>
+
+               <varlistentry>
+                       <term><option>-V, --version</option></term>
+                       <listitem>
+                               <para>Print version info.</para>
+                       </listitem>
+               </varlistentry>
+
+
+       </variablelist>
+       </refsect1>
+
+       <refsect1>
+               <title>AUTHOR</title>
+       
+               <para>
+                       Stefan HUBER
+               </para>
+       </refsect1>
+</refentry>