% This is <manual.tex>
% ----------------------------------------------------------------------------
% $Id$
% 
% Propose: Documentation of csback toolkit.

% Copyright (c) 2011 by Daniel Armbruster (BFO Schiltach) 
% 
% REVISIONS and CHANGES 
%    16/01/2012   V0.1   Daniel Armbruster
% 
% ============================================================================
%
%%fakesection defines 
\documentclass[twoside]{article}
%\usepackage{ngerman}
\usepackage{pslatex}
\usepackage{anysize}
\usepackage{amsmath}
%\usepackage[slantedgreek]{mathtime}
\usepackage{graphicx}
\usepackage{textfit}
\usepackage{fancyhdr}
\usepackage{booktabs}
\usepackage{hyperref}
\usepackage[bf,small]{caption}
\usepackage[round,authoryear]{natbib}
\usepackage{xspace}
%----------------------------------------------------------------------
\newcommand{\mytitle}{Documentation csback toolkit}
%----------------------------------------------------------------------
\marginsize{2.5cm}{1.5cm}{1.5cm}{1.5cm}
\pagestyle{fancy}
\rhead[\mytitle]{\thepage}
\lhead[\thepage]{\mytitle}
\chead{}
\rfoot[Blackforest Observatory (BFO), \today]
{Daniel Armbruster}
\lfoot[Daniel Armbruster]{Blackforest Observatory (BFO), \today}
\cfoot{}
\sloppy
\columnsep20pt
%======================================================================
\newcommand{\Smu}{\ensuremath{\mu}}
\newcommand{\SO}{\ensuremath{\Omega}}
\newcommand{\SMO}{\ensuremath{\text{M}\Omega}}
\newcommand{\SkO}{\ensuremath{\text{k}\Omega}}
\newcommand{\EHV}{\ensuremath{\text{V}}}
\newcommand{\EHmA}{\ensuremath{\text{mA}}}
\newcommand{\EHA}{\ensuremath{\text{A}}}
\newcommand{\EHdC}{\ensuremath{^\circ\text{C}}}
\newcommand{\SUo}{\ensuremath{U_{\text{o}}}}
\newcommand{\SRxcc}{\ensuremath{R_{\text{x}19}}}
%======================================================================
\begin{document}
%%fakesection header
\twocolumn[
\mbox{ }\par
\vspace{-1.5cm}
%\hrule
\medskip
{\noindent\Large\textbf{\mytitle}\par}
%\smallskip\hrule
\rule{\textwidth}{1pt}
%\bigskip
\par
\begin{raggedleft}
Daniel Armbruster\\
Blackforest Observatory (BFO)\\
\vspace{3pt}
\today\ (\mbox{\texttt{$$Revision: 0.1 $$}})\par
\end{raggedleft}
\bigskip]
\thispagestyle{plain}
%-------------------------------------------------------------
\tableofcontents
%\listoftables
%\listoffigures
\enlargethispage{12pt}
\section{Overview of \texttt{csback}}
The \texttt{csback} utility is a collection of small python scripts which
provide the possibility to calculate \emph{checksumfiles} and check the
checksums of the corresponding files from time to time. This manual describes
the installation and configuration of \texttt{csback} which was developed by
Daniel Armbruster.

\texttt{csback} was developed both for python2 and python3 and therefore should
be platform independent. Because it uses several already existing unix tools
especially unix users shouldn't have any problems installing \texttt{csback}.
Open Source tools which are used and should be provided or rather installed on
the operating system are:
\begin{itemize}
\item \texttt{cron deamon}
\item \texttt{rsync}
\item \texttt{syslog-ng}
\item \texttt{logrotate}
\end{itemize}
If you are familiar with writing \texttt{crontabs} using other programs
providing the same functionality as the tools mentioned above should be no
obstacle. Additionally make sure to use a current version of your python
interpreter. Privileged are python3 interpreters.

After setting up a \texttt{csback} configuration file the command
\texttt{csback2cron} generates a crontab. The crontab must be added to the
locally installed \texttt{cron deamon} which is responsible for the scheduling
of backing up files, generating checksums and testing the files integrity from
time to time. The \texttt{csback} logging mechanism sends log information and
status notifications to the operating system's system logger i.e.
\texttt{syslog-ng} which writes the reports to logfiles or sends the results to
\emph{stdout} depending of its configuration. If logging to a logfile is desired
the \texttt{csback} logfile checking tool \texttt{csbackntfy} is able to
investigate the logfile and send a report via email to the admin.
\section{Installation}
\section{Configuration}

\end{document}
% ----- END OF manual.tex -----