From 7e9d1ce3275a8e92739bb9c34a06a2162af19461 Mon Sep 17 00:00:00 2001
From: Kern Sibbald <kern@sibbald.com>
Date: Fri, 18 Oct 2013 16:12:25 +0200
Subject: [PATCH] Fix documentation of Action on Purge fixes bug #16

---
 docs/manuals/en/main/dirdconf.tex | 32 ++++++++++++++++++++++---------
 1 file changed, 23 insertions(+), 9 deletions(-)

diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex
index 6a335b15..b1d45c13 100644
--- a/docs/manuals/en/main/dirdconf.tex
+++ b/docs/manuals/en/main/dirdconf.tex
@@ -3092,11 +3092,23 @@ The Pool Resource defined in the Director's configuration file
 \item [Action On Purge = \lt{Truncate}]
 \index[dir]{actiononpurge}
 
-This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the
-volume when it is purged with the \texttt{purge volume action=truncate}
-command. It is useful to prevent disk based volumes from consuming too much
-space.
-
+The directive \textbf{ActionOnPurge=Truncate} instructs Bacula to 
+permit the Volume to be truncated after it has been purged.
+Note: the ActionOnPurge is a bit misleading since the volume
+is not actually truncated when it is purged, but is enabled
+to be truncated. The actual truncation is done with the Truncate
+command/
+
+To actually truncate a Volume, you must first set the ActionOnPurge
+to Truncate in the Pool, then you must ensure that any existing
+Volumes also have this information in them, by doing an
+{\bf update Volumes}  comand.  Finally, after the Volume
+has been purged, you may then truncate it. 
+It is useful to prevent disk based volumes from consuming too much
+space.  See below for more details of how to ensure Volumes are
+truncated after being purged.
+
+First set the Pool to permit truncation.
 \begin{lstlisting}
 Pool {
   Name = Default
@@ -3105,7 +3117,8 @@ Pool {
 }
 \end{lstlisting}
 
-You can schedule the truncate operation at the end of your CatalogBackup job
+Then assuming a Volume has been Purged, you can schedule
+truncate operation at the end of your CatalogBackup job
 like in this example:
 
 \begin{lstlisting}
@@ -3115,13 +3128,14 @@ Job {
  RunScript {
    RunsWhen=After
    RunsOnClient=No
-   Console = "purge volume action=all allpools storage=File"
+   Console = "truncate Volume allpools storage=File"
  }
 }
 \end{lstlisting}
-\label{PoolScratchPool}
 
-   \label{Director:Pool:ScratchPool}
+
+\label{PoolScratchPool}
+\label{Director:Pool:ScratchPool}
 \item [ScratchPool = \lt{}pool-resource-name\gt{}]
    \index[dir]{ScratchPool}
    \index[dir]{Directive!ScratchPool}
-- 
2.39.5