From: Kern Sibbald <kern@sibbald.com>
Date: Sun, 28 Jul 2013 13:18:58 +0000 (+0200)
Subject: Tweak ActionOnPurge documentation
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=f1749254ab33aacf4a205a5febd050b2f536c0c3;p=bacula%2Fdocs

Tweak ActionOnPurge documentation
---

diff --git a/docs/manuals/en/main/newfeatures.tex b/docs/manuals/en/main/newfeatures.tex
index 1e449d39..9608dba6 100644
--- a/docs/manuals/en/main/newfeatures.tex
+++ b/docs/manuals/en/main/newfeatures.tex
@@ -761,17 +761,20 @@ process.
 
 \section{New Features in 5.0.1}
 
-This chapter presents the new features that are in the released Bacula version
-5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
-the ongoing development process.
+This chapter presents the new features that are in the released Bacula
+version 5.0.1.  This version mainly fixes a number of bugs found in version
+5.0.0 during the ongoing development process.
 
 \subsection{Truncate Volume after Purge}
 \label{seccom:actiononpurge}
 
-The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
-the volume when it is purged with the new command \texttt{purge volume
-  action}. It is useful to prevent disk based volumes from consuming too much
-space.
+The Pool directive \textbf{ActionOnPurge=Truncate} permits Bacula
+to truncate a Volume after it has been purged by using the
+the special command \texttt{purge volume action}. 
+
+\smallskip
+This is useful to prevent disk based volumes from consuming too much
+space, while at the same time respecting retention periods.
 
 \begin{lstlisting}
 Pool {
@@ -781,23 +784,29 @@ Pool {
 }
 \end{lstlisting}
 
-As usual you can also set this property with the \texttt{update volume} command
+You may also set this property with the \texttt{update volume}
+command:
+
 \begin{lstlisting}
 *update volume=xxx ActionOnPurge=Truncate
 *update volume=xxx actiononpurge=None
 \end{lstlisting}
 
-To ask \mbacula{} to truncate your \texttt{Purged} volumes, you need to use the
-following command in interactive mode or in a RunScript as shown after:
-\begin{lstlisting}
+To truncate already \texttt{Purged} volumes, you must use
+the following command in interactive mode or in a RunScript as follows:
+
+\begin{lstlisting} 
 *purge volume action=truncate storage=File allpools
-# or by default, action=all
+# or by default, action=all 
 *purge volume action storage=File pool=Default
 \end{lstlisting}
 
-This is possible to specify the volume name, the media type, the pool, the
-storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
-idle when you decide to run this command.
+Note: as a protection, the above commands will truncate only
+Volues that are already \texttt{Purged}.
+
+It is also possible to specify the Volume name, the Media Type, the Pool,
+the Storage, etc on the above commands.
+Please ensure that your storage device is idle when you run this command.
 
 \begin{lstlisting}
 Job {