From: Eric Bollengier <eric@eb.homelinux.org>
Date: Wed, 20 Jan 2010 15:19:46 +0000 (+0100)
Subject: Document File/Job Retention by Pool
X-Git-Tag: Release-5.0.0~12
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=9c7b295a9eb4e249f9af63b052090859b6471863;p=bacula%2Fdocs

Document File/Job Retention by Pool
---

diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex
index e262af1a..c1223b9b 100644
--- a/docs/manuals/en/main/dirdconf.tex
+++ b/docs/manuals/en/main/dirdconf.tex
@@ -2177,6 +2177,7 @@ console run command.  This directive is required.
 
 \label{FileRetention}
 \item [File Retention = \lt{}time-period-specification\gt{}]
+   \label{FileRetention}
    \index[dir]{File Retention}
    \index[dir]{Directive!File Retention}
    The File Retention directive defines the length of time that  Bacula will
@@ -2200,6 +2201,7 @@ console run command.  This directive is required.
 
 \label{JobRetention}
 \item [Job Retention = \lt{}time-period-specification\gt{}]
+   \label{JobRetention}
    \index[dir]{Job Retention}
    \index[dir]{Directive!Job Retention}
    The Job Retention directive defines the length of time that  Bacula will keep
@@ -2962,6 +2964,39 @@ Pool {
    sure that some day, Bacula will recycle a Volume that contains current
    data.  The default is {\bf no}.
 
+\item [File Retention = \lt{}time-period-specification\gt{}]
+   \index[dir]{File Retention}
+   \index[dir]{Directive!File Retention}
+   The File Retention directive defines the length of time that  Bacula will
+   keep File records in the Catalog database after the End time of the
+   Job corresponding to the File records. 
+
+   This directive takes precedence over Client directives of the same name. For
+   example, you can decide to increase Retention times for Archive or OffSite
+   Pool.
+
+   Note, this affects only records in the catalog database. It does not affect
+   your archive backups.
+
+   For more information see Client documentation about
+   \ilink{FileRetention}{FileRetention}
+
+\item [Job Retention = \lt{}time-period-specification\gt{}]
+   \index[dir]{Job Retention}
+   \index[dir]{Directive!Job Retention}
+
+   The Job Retention directive defines the length of time that Bacula will keep
+   Job records in the Catalog database after the Job End time.  As with the
+   other retention periods, this affects only records in the catalog and not
+   data in your archive backup.
+
+   This directive takes precedence over Client directives of the same name.
+   For example, you can decide to increase Retention times for Archive or
+   OffSite Pool.
+
+   For more information see Client side documentation
+   \ilink{JobRetention}{JobRetention}
+
 \item [Cleaning Prefix = \lt{}string\gt{}]
    \index[dir]{Cleaning Prefix}
    \index[dir]{Directive!Cleaning Prefix}
diff --git a/docs/manuals/en/main/newfeatures.tex b/docs/manuals/en/main/newfeatures.tex
index fdf16b68..903b492f 100644
--- a/docs/manuals/en/main/newfeatures.tex
+++ b/docs/manuals/en/main/newfeatures.tex
@@ -208,7 +208,8 @@ This project was funded by Bacula Systems.
 % TODO check
 We added two new Pool directives, \texttt{FileRetention} and
 \texttt{JobRetention}, that take precedence over Client directives of the same
-name. It allows you to control the Catalog pruning algorithm Pool by Pool.
+name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
+example, you can decide to increase Retention times for Archive or OffSite Pool.
 
 \section{Read-only File Daemon using capabilities}
 \label{sec:fdreadonly}