From 202451d37d3950d6db6c2d29d97f9e85ade14f52 Mon Sep 17 00:00:00 2001
From: Eric Bollengier <eric@eb.homelinux.org>
Date: Wed, 6 Jul 2011 14:33:26 +0200
Subject: [PATCH] Add documentation submited by Laurent for LZO

---
 docs/manuals/en/main/fileset.tex     | 18 +++++++++++-
 docs/manuals/en/main/newfeatures.tex | 43 +++++++++++++++++++++++++---
 2 files changed, 56 insertions(+), 5 deletions(-)

diff --git a/docs/manuals/en/main/fileset.tex b/docs/manuals/en/main/fileset.tex
index d8655bfd..cc7e43b1 100644
--- a/docs/manuals/en/main/fileset.tex
+++ b/docs/manuals/en/main/fileset.tex
@@ -151,9 +151,9 @@ Including a directory twice is very easy to do.  For example:
 \footnotesize
 \begin{verbatim}
   Include {
+    Options { compression=GZIP }
     File = /
     File = /usr
-    Options { compression=GZIP }
   }
 \end{verbatim}
 \normalsize
@@ -255,6 +255,22 @@ The directives within an Options resource may be one of the following:
    You can overwrite this option per Storage resource with
    \ilink{AllowCompression}{AllowCompression} option.
 
+\item [compression=LZO]
+\index[dir]{compression}
+\index[dir]{Directive!compression}
+   All files saved will be software compressed using the LZO
+   compression format. The compression is done on a file by file basis by
+   the File daemon. Everything else about GZIP is true for LZO.
+
+   LZO provides much faster compression and decompression speed but lower
+   compression ratio than GZIP. If your CPU is fast enough you should be able
+   to compress your data without making the backup duration longer.
+
+   Note that bacula only use one compression level LZO1X-1 specified by LZO.
+
+   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 50852304..be0db00b 100644
--- a/docs/manuals/en/main/newfeatures.tex
+++ b/docs/manuals/en/main/newfeatures.tex
@@ -1,12 +1,47 @@
 \chapter{Community Bacula New Features in 5.1.x}
-This chapter presents the new features that have been added to the
-current Community version of Bacula that is under development. This version will be
+This chapter presents the new features that have been added to the current
+Community version of Bacula that is under development. This version will be
 released at some later date, probably near the end of April 2011.
 
 There are additional features (plugins) available in the Enterprise version
 that are described in another chapter. A subscription to Bacula Systems
 is required for the Enterprise version.
 
+
+\section{LZO Compression}
+
+LZO compression was added in the File Daemon. From the user point of view, it
+works like the GZIP compression (just replace {\bf compression=GZIP} with {\bf
+  compression=LZO}).
+
+For example:
+\begin{verbatim}
+Include {
+   Options { compression=LZO }
+   File = /home
+   File = /data
+}
+\end{verbatim}
+
+LZO provides much faster compression and decompression speed but lower
+compression ratio than GZIP. It is a good option when you backup to disk. For
+tape, the built-in compression may be a better option.
+
+LZO is a good altenative for GZIP1 when you don't want to slow down your
+backup. On a modern CPU it should be able to run almost as fast as:
+
+\begin{itemize}
+\item your client can read data from disk. Unless you have very fast disks like
+  SSD or large/fast RAID array.
+\item the data transfers between the file daemon and the storage daemon even on
+  a 1Gb/s link.
+\end{itemize}
+
+Note that bacula only use one compression level LZO1X-1.
+
+\medskip
+The code for this feature was contributed by Laurent Papier.
+
 \section{New Tray Monitor}
 
 Since the old integrated Windows tray monitor doesn't work anymore with
@@ -322,11 +357,11 @@ This project was funded by Bacula Systems and is available with Bacula
 Enterprise Edition and Community Edition.
 
 \section{Additions to RunScript variables}
-You can have access to JobBytes and JobFiles using \%b and \%f in your runscript
+You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
 command. The Client address is now available through \%h.
 
 \begin{verbatim}
-RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%f ClientAddress=%h"
+RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
 \end{verbatim}
 
 %\section{Changes in drivetype.exe}
-- 
2.39.5