From: Eric Bollengier <eric@eb.homelinux.org>
Date: Thu, 10 Dec 2009 08:15:34 +0000 (+0100)
Subject: Update documentation for AllowCompression feature
X-Git-Tag: Release-5.0.0~36^2
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=de9a4e66dd38ce9fb3b05b6b6c78e9848cf427ef;p=bacula%2Fdocs

Update documentation for AllowCompression feature
---

diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex
index e7b61546..e262af1a 100644
--- a/docs/manuals/en/main/dirdconf.tex
+++ b/docs/manuals/en/main/dirdconf.tex
@@ -2442,6 +2442,17 @@ the Director.
    turn data spooling on as documented in the \ilink{Data
    Spooling}{SpoolingChapter} chapter of this manual.
 
+\item [AllowCompression = \lt{}yes\vb{}no\gt{}]
+  \label{AllowCompression}
+   \index[dir]{AllowCompression}
+   \index[dir]{Directive!AllowCompression}
+
+   This directive is optional, and if you specify {\bf No} (the default is {\bf
+     Yes}), it will cause backups jobs running on this storage resource to run
+   without client File Daemon compression.  This effectively overrides
+   compression options in FileSets used by jobs which use this storage
+   resource.
+
 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
    \index[dir]{Heartbeat Interval}
    \index[dir]{Directive!Heartbeat}
diff --git a/docs/manuals/en/main/fileset.tex b/docs/manuals/en/main/fileset.tex
index ffcfe72b..357621d5 100644
--- a/docs/manuals/en/main/fileset.tex
+++ b/docs/manuals/en/main/fileset.tex
@@ -252,6 +252,9 @@ The directives within an Options resource may be one of the following:
    compression levels greater than six generally give very little extra
    compression and are rather CPU intensive.
 
+   You can overwrite this option per Storage resource with
+   \ilink{AllowCompression}{AllowCompression} option.
+
 \item [signature=SHA1]
 \index[dir]{signature}
 \index[dir]{SHA1}
diff --git a/docs/manuals/en/main/newfeatures.tex b/docs/manuals/en/main/newfeatures.tex
index 7a7d94d8..0004808e 100644
--- a/docs/manuals/en/main/newfeatures.tex
+++ b/docs/manuals/en/main/newfeatures.tex
@@ -113,6 +113,34 @@ FileSet {
 
 This project was funded by Bacula Systems.
 
+\section{AllowCompression = \lt{}yes\vb{}no\gt{}}
+\index[dir]{AllowCompression}
+
+This new directive may be added to Storage resource within the Director's
+configuration to allow users to selectively disable the client compression for
+any job which writes to this storage resource.
+
+For example:
+\begin{verbatim}
+Storage {
+  Name = UltriumTape
+  Address = ultrium-tape
+  Password = storage_password # Password for Storage Daemon
+  Device = Ultrium
+  Media Type = LTO 3
+  AllowCompression = No # Tape drive has hardware compression
+}
+\end{verbatim}
+The above example would cause any jobs running with the UltriumTape storage
+resource to run without compression from the client file daemons.  This
+effectively overrides any compression settings defined at the FileSet level.
+
+This feature is probably most useful if you have a tape drive which supports
+hardware compression.  By setting the \texttt{AllowCompression = No} directive
+for your tape drive storage resource, you can avoid additional load on the file
+daemon and possibly speed up tape backups.
+
+This project was funded by Collaborative Fusion, Inc.
 
 \section{Accurate Fileset Options}
 \label{sec:accuratefileset}