Fix description of Volume Retention -- bug 1844

[bacula/docs] / docs / manuals / en / main / dirdconf.tex

diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex
index 3675b9484ae14495ad72f2a4ae4b57060ea7e13f..2293665c1b00e7575715f2a31b30704e771b0394 100644 (file)
--- a/docs/manuals/en/main/dirdconf.tex
+++ b/docs/manuals/en/main/dirdconf.tex
@@ -2246,18 +2246,18 @@ console run command.  This directive is required.
    keep File records in the Catalog database after the End time of the
    Job corresponding to the File records.
    When this time period expires, and if
-   {\bf AutoPrune} is set to  {\bf yes} Bacula will prune (remove) File records
-   that  are older than the specified File Retention period. Note, this  affects
-   only records in the catalog database. It does not  affect your archive
-   backups.  
-
-   File records  may actually be retained for a shorter period than you specify
-   on  this directive if you specify either a shorter {\bf Job Retention}  or a
-   shorter {\bf Volume Retention} period. The shortest  retention period of the
-   three takes precedence.  The time may be expressed in seconds, minutes, 
-   hours, days, weeks, months, quarters, or years. See the 
-   \ilink{Configuration chapter}{Time} of this  manual for
-   additional details of time specification. 
+   {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File
+   records that are older than the specified File Retention period.  Note,
+   this affects only records in the catalog database.  It does not affect
+   your archive backups.
+
+   File records may actually be retained for a shorter period than you
+   specify on this directive if you specify either a shorter {\bf Job
+   Retention} or a shorter {\bf Volume Retention} period.  The shortest
+   retention period of the three takes precedence.  The time may be
+   expressed in seconds, minutes, hours, days, weeks, months, quarters, or
+   years.  See the \ilink{Configuration chapter}{Time} of this manual for
+   additional details of time specification.
 
    The  default is 60 days. 
 
@@ -2834,27 +2834,37 @@ The Pool Resource defined in the Director's configuration file
 \item [Volume Retention = \lt{}time-period-specification\gt{}]
    \index[dir]{Volume Retention}
    \index[dir]{Directive!Volume Retention}
-   The Volume Retention directive defines the length of time that {\bf
-   Bacula} will keep records associated with the Volume in
-   the Catalog database after the End time of each Job written to the
-   Volume.  When this time period expires, and if {\bf AutoPrune} is set to
-   {\bf yes} Bacula may prune (remove) Job records that are older than the
-   specified Volume Retention period if it is necessary to free up a
-   Volume.  Recycling will not occur until it is absolutely necessary to
+   The Volume Retention directive defines the longest amount of time that
+   {\bf Bacula} will keep records associated with the Volume in the Catalog
+   database after the End time of each Job written to the Volume.  When
+   this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
+   Bacula may prune (remove) Job records that are older than the specified
+   Volume Retention period if it is necessary to free up a Volume.  Note,
+   it is also possible for all the Job and File records to be pruned before
+   the Volume Retention period is reached.  In that case the Volume can
+   then be marked Pruned and subsequently recycled prior to expiration of
+   the Volume Retention period.
+
+\smallskip
+   Recycling will not occur until it is absolutely necessary to
    free up a volume (i.e. no other writable volume exists).
    All File records associated with pruned Jobs are also
    pruned.  The time may be specified as seconds, minutes, hours, days,
    weeks, months, quarters, or years.  The {\bf Volume Retention} is
    applied independently of the {\bf Job Retention} and the {\bf File
    Retention} periods defined in the Client resource.  This means that all
-   the retentions periods are applied in turn and that the shorter period
+   the retention periods are applied in turn and that the shorter period
    is the one that effectively takes precedence.  Note, that when the {\bf
    Volume Retention} period has been reached, and it is necessary to obtain
-   a new volume, Bacula will prune both the Job and the File records.  This
-   pruning could also occur during a {\bf status dir} command because it
-   uses similar algorithms for finding the next available Volume.
+   a new volume, Bacula will prune both the Job and the File records. And
+   the inverse is also true that if all the Job and File records that
+   refer to a Volume are pruned, then the Volume may be pruned and recycled
+   regardless of its retention period.  Pruning may also occur during a
+   {\bf status dir} command because it uses similar algorithms for finding
+   the next available Volume.
 
    It is important to know that when the Volume Retention period expires, 
+   or all the Job and File records have been pruned that refer to a Volume,
    Bacula does not automatically recycle a Volume. It attempts to keep the
    Volume data intact as long as possible before over writing the Volume.