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

smaller adjustments

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: 5336
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 9fa54eba
......@@ -16,6 +16,7 @@
% 12/03/2013 V0.6.1 adjusted keychain related notes
% 15/03/2013 V0.6.2 optional locking for secure copy section
% 20/03/2013 V0.6.3 adjustments in mail section
% 09/11/2013 V0.6.4 smaller adjustments
%
% ============================================================================
%
......@@ -66,7 +67,7 @@
Daniel Armbruster\\
Blackforest Observatory (BFO)\\
\vspace{3pt}
\today\ (\mbox{\texttt{$$Revision: 0.6 $$}})\par
\today\ (\mbox{\texttt{$$Revision: 0.6.4 $$}})\par
\end{raggedleft}
\bigskip]
\thispagestyle{plain}
......@@ -130,7 +131,7 @@ same directory the checksumfile is located.
\item \texttt{csbackscp}: As an alternative to \texttt{csbackobs} and
\texttt{rsync} this tool first checks the integrity of data files before
copying them to the backup device. \texttt{csbackscp} strongly relies on
both on the programs \texttt{rsync} and \texttt{scp} such that a working
both the programs \texttt{rsync} and \texttt{scp} such that a working
instance of the tools is required.
\item \texttt{csbackntfy}: Check the \texttt{csback} logfile and send an email
which contains the current status to the admin.
......@@ -153,7 +154,7 @@ problems while using the \emph{crontab} generated by \texttt{csback2cron}.
\section{Configuration}
Before using \texttt{csback2cron} to generate a \emph{crontab} a
\texttt{csback} configuration file has to be set up. This package already
contains such a configuration file which contains a description of available
comes along with a configuration file which contains a description of available
commands and configuration options. Afterwards either \texttt{csback2cron} has
to be called with the command
\begin{verbatim}
......@@ -166,9 +167,9 @@ csback2cron crontab
\end{verbatim}
is sufficient to generate a \emph{crontab} file with the filename
\texttt{crontab}. Then install the \texttt{crontab} using the appropriate
\emph{crontab} command. Note that an exemplary \texttt{csbackrc} configuration
file comes along with this package and is appended to this document
\ref{subsec:csbackrc}.
\emph{crontab} command. Note once again that an exemplary \texttt{csbackrc}
configuration file comes along with this package and is appended to this
document \ref{subsec:csbackrc}.
While converting the \texttt{csback} configuration file entries to
\texttt{crontab} lines \texttt{csback2cron} does not perform any logical checks.
......@@ -183,7 +184,7 @@ does not.
A configuration file consists of sections, led by a \texttt{[section]} header
and followed by \texttt{name: value} entries; \texttt{name=value} is also
accepted. Note that leading whitespace is removed from values.
accepted. Note that leading whitespaces are removed from the values.
\subsection{Configuration parameters}
\subsubsection{\texttt{copy} configuration}
......@@ -263,8 +264,8 @@ more information on available patterns. \label{item:copy_exclude}
argument passed. Since the argument directly will be passed to the *nix
\href{http://www.gnu.org/software/findutils/findutils.html}{find} command, the
syntax is equal to the syntax of the program \texttt{find}. See also the
\texttt{find} info page. Note, that this option version $\ge\text{V}4.3.3$ of
the \texttt{find} program.
\texttt{find} info page. Note, that this option only is available for version
$\ge\text{V}4.3.3$ of the \texttt{find} program.
\item \texttt{lock}: While copying lock directories which currently are
considered. The value passed is the timeout in seconds to wait on already
available locks of other \texttt{csback} tools. Enabling this option only has
......@@ -347,7 +348,7 @@ Default value is \texttt{no}.
\texttt{exclude} key in a \texttt{[copy]} rule section in section
\ref{item:copy_exclude}.
\item \texttt{copy-special}: Provides the same functionalism as the
\texttt{specialcommands} kex in a \texttt{[copy]} rule section in section
\texttt{specialcommands} key in a \texttt{[copy]} rule section in section
\ref{item:copy_special}.
\item \texttt{exclude}: A comma separated list of \emph{regular expressions}.
Files or directories matching one of those regular expressions will be excluded
......@@ -358,17 +359,18 @@ If you are not familiar with regular expressions read
\url{http://en.wikipedia.org/wiki/Regular_expression} or
\url{http://www.regular-expressions.info/}. \label{item:exclude}
\item \texttt{daystart}: If set to \texttt{yes} then measure times (for
\texttt{amin}, \texttt{atime}, \texttt{cmin}, \texttt{ctime}, \texttt{mmin}, and
\texttt{mtime}) from the beginning of today rather than from 24 hours ago.
Default value is \texttt{no}.
\texttt{atime}, \texttt{ctime} and \texttt{mtime}) from the beginning of today
rather than from 24 hours ago. Notice, that using this option together with the
options \texttt{amin}, \texttt{cmin} or \texttt{mmin} will force the checksum
generation process to fail. Default value is \texttt{no}.
\item \texttt{amin}: Exclude files which were last accessed \texttt{N} minutes
ago.
\item \texttt{atime}: Exclude files which were accessed at least \texttt{N}*24
\item \texttt{atime}: Exclude files which were accessed at least \texttt{N}*24
hours ago. To match \texttt{atime} +1, a file has to have been accessed at least
two days ago.
\item \texttt{cmin}: Exclude files which status was last changed \texttt{N}
minutes ago.
\item \texttt{ctime}:Exclude files which status was last changed \texttt{N}*24
\item \texttt{ctime}: Exclude files which status was last changed \texttt{N}*24
hours ago.
\item \texttt{mmin}: Exclude files which data was last modified \texttt{N}
minutes ago.
......@@ -391,11 +393,11 @@ Available values are \texttt{sha224}, \texttt{sha256}, \texttt{sha384} and
is \texttt{yes}.
\item \texttt{tolerant}: Be tolerant. If set to \texttt{yes} \texttt{csbackchk}
only will issue a \emph{WARNING} to the system logger if a file listed in a
checksum file is not available anymore. Else a \emph{ERROR} will be send. This
key might be useful if \texttt{csback} is used on a filesystem that works as a
ring buffer. Default is \texttt{no}. Notice that the \texttt{csback} logging
mechanism must be enabled by setting the \texttt{logging} key from below to
\texttt{yes}. \label{item:tolerant}
checksum file is not available anymore. Else an \emph{ERROR} will be issued.
This key might be useful if \texttt{csback} is used on a filesystem that works
as a ring buffer. Default is \texttt{no}. Notice that the \texttt{csback}
logging mechanism must be enabled by setting the \texttt{logging} key from
below to \texttt{yes}. \label{item:tolerant}
\item \texttt{logging}: Enable the \texttt{csback} logging mechanism. Log
reports will be send to the system logger. A default \texttt{syslog-ng V3.0}
configuration file comes along with \texttt{csback} which send the log messages
......@@ -410,11 +412,12 @@ is \texttt{yes}. Logging is strongly recommended. For an advanced
\begin{itemize}
\item Time specification parameters all take a list of whitespace separated
parameters.
\item Files matching the time specification will be excluded from checksum
generation process. The syntax is similar to the commands of the Unix
\texttt{find} tool. Fractional parameters are not supported. See also the
\href{http://www.gnu.org/software/findutils/manual/html_mono/find.html}
{find man page}.
\item Files matching the time specification only will be excluded from the
checksum generation process (i.e. \texttt{csbackgen.py}). The syntax is
similar to the commands of the Unix \texttt{find} tool. Fractional parameters
are not supported. See also the
\href{http://www.gnu.org/software/findutils/manual/html_mono/find.html} {find
man page}.
\item Allowed parameters are:
\begin{enumerate}
\item \texttt{+N}$\quad$for greater/older than \texttt{N},
......
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