Commit ed3159dd authored by Daniel Armbruster's avatar Daniel Armbruster Committed by thomas.forbriger
Browse files

csback documentation - installation section

This is a legacy commit from before 2015-05-18.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.


SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/trunk
SVN Revision: 4405
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 6599ca73
......@@ -79,7 +79,7 @@ Blackforest Observatory (BFO)\\
\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
provide the possibility to calculate \emph{checksum files} 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.
......@@ -111,8 +111,37 @@ status notifications to the operating system's system logger i.e.
the \texttt{csback} logfile checking tool \texttt{csbackntfy} is able to
investigate the logfile and send a report via email to the admin.
Actually the work is done by three scripts.
\begin{itemize}
\item \texttt{csbackgen}: Generate or rather update \texttt{csback}
checksum files if there is already an existing checksum file located in the
current directory. Up to now 4 different hashfunction algorithms are provided
which include \emph{sha224}, \emph{sha256}, \emph{sha384}, \emph{sha512}. If a
directory contains subdirectories each subdirectory will contain its own
checksum file.
\item \texttt{csbackchk}: Check the checksums of files listed in the checksum
file. Notice that \texttt{csbackchk} does not check if there are new files in
the directory existing.
\item \texttt{csbackntfy}: Check the \texttt{csback} logfiles and send a email
to the admin that contains the current status.
\end{itemize}
\section{Installation}
\textbf{Notice:} Up to now only provided for *nix operating systems.
To install the \texttt{csback} toolkit just use the provided \emph{Makefile} and
enter
\medskip
\texttt{make install}
\medskip
to the command line. If you prefer the installation by hand just guarantee that
your environment knows the \texttt{csback} scripts. First make the scripts
executable. Then use the appropriated names for the softlinks your are creating
in your local binary directory. For \texttt{csbackgen.py} use
\texttt{csbackgen}, for \texttt{csbackchk.py} use \texttt{csbackchk} and for
\texttt{csbackntfy.py} use \texttt{csbackntfy}. Otherwise you might run into
problems while using the \emph{crontab} generated by \texttt{csback2cron}.
\section{Configuration}
\end{document}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment