added autoxflate pictures and docs

Signed-off-by: Joerg Steffens <joerg.steffens@bareos.com>

manuals/en/main/plugins.tex

@@ -100,6 +100,64 @@ \subsection{autoxflate-sd}
 
 This plugin is part of the \package{bareos-storage} package.
 
+The autoxflate-sd plugin can inflate(decompres) and deflate(compress)
+the data being written to or read from a device. It can also do both.
+
+[autoxflate-functionblocks.png]
+
+Therefore the autoxflate plugin inserts a inflate and a deflate function block
+into the stream going to the device (called OUT) and coming from the device (called IN).
+
+Each stream passes first the inflate function block, then the deflate funcion block.
+
+The inflate blocks are controlled by the setting of the \directive{sd}{autoinflate}{yes{\textbar}no}{}{yes}{}
+directive.
+
+The deflate blocks are controlled by the setting of the \directive{sd}{autodeflate}{yes{\textbar}no}{}{yes}{}
+\directive{sd}{autodeflatealgorithm}{yes{\textbar}no}{}{yes}{} and  \directive{sd}{autodeflatelevel}{yes{\textbar}no}{}{yes}{} .
+
+
+\directive{sd}{autodeflate}{yes{\textbar}no}{}{yes}{} \directive{sd}{autoinflate}{yes{\textbar}no}{}{yes}{} control if the
+function block is enabled at all.
+Possible values are:
+\begin{description}
+ \item [in] inflation / deflation is enabled on the incoming data path.
+ \item [out] inflation / deflation is enabled ont the outgoing data path.
+ \item [both] inflation / deflation is enabled both for incoming and outgoing data.
+\end{description}
+
+The \directive{sd}{autodeflatealgorithm}{yes{\textbar}no}{}{yes}{} selects the algorithm used for deflation,
+and can be one of the supported compression algorithms: gzip / lzo / lzfast / lz4 / lz4hc.
+If the compression algorithm supports the selection of compression level like gzip, this level can be configured in \directive{sd}{autodeflatelevel}{yes{\textbar}no}{}{yes}{}
+
+The inflate blocks, if enabled, will uncompress data if it is compressed using the
+algorithm that was used during compression.
+
+The deflate blocks, if enabled, will compress uncompressed data with the algorithm and level configured in the according directives.
+
+The series connection of the inflate and deflate function blocks makes the plugin very flexible.
+
+Szenarios where this plugin can be used are for example:
+
+- client computers with weak cpus can do backups without compression and
+  let the sd do the compression when writing to disk.
+
+- compressed backups can be recompressed to a different compression format (e.g. gzip -> lzo) using migration jobs
+
+- client backups can be compressed with compression algorithms that the client itself does not support.
+
+Multi-core cpus will be utilized when using parallel jobs as the compression is done in each jobs' thread.
+
+When the autoxflate plugin is configured, it will write some status information into the joblog.
+
+This information shows what compression algorithm is used:
+autodeflation: compressor on device FileStorage is FZ4H
+
+How the inflation and deflation blocks are configured:
+autoxflate-sd.c: FileStorage OUT:[SD->inflate=yes->deflate=yes->DEV] IN:[DEV->inflate=yes->deflate=yes->SD]
+
+And how the overall deflation/inflation ratio was:
+autoxflate-sd.c: deflate ratio: 50.59%
 
 \subsection{scsicrypto-sd}
 

manuals/images/autoxflate-functionblocks.fig

@@ -0,0 +1,68 @@
+#FIG 3.2  Produced by xfig version 3.2.5c
+Landscape
+Center
+Metric
+A4
+100.00
+Single
+-2
+1200 2
+6 2475 2700 3150 3150
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+	 2475 2700 3150 2700 3150 3150 2475 3150 2475 2700
+-6
+6 3600 2700 4275 3150
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+	 3600 2700 4275 2700 4275 3150 3600 3150 3600 2700
+-6
+6 2475 3600 3150 4050
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+	 2475 3600 3150 3600 3150 4050 2475 4050 2475 3600
+-6
+6 3600 3600 4275 4050
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+	 3600 3600 4275 3600 4275 4050 3600 4050 3600 3600
+-6
+6 2520 2835 3105 2970
+6 2520 2835 3105 2970
+4 0 0 50 -1 0 12 0.0000 4 135 555 2520 2970 deflate\001
+-6
+-6
+6 3645 3735 4230 3870
+6 3645 3735 4230 3870
+4 0 0 50 -1 0 12 0.0000 4 135 555 3645 3870 deflate\001
+-6
+-6
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+	 900 2925 1800 2925 1800 3600 900 3600 900 2925
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+	 4950 2925 5850 2925 5850 3600 4950 3600 4950 2925
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 1 0 2
+	1 1 1.00 60.00 120.00
+	 3600 2925 3150 2925
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 1 0 2
+	1 1 1.00 60.00 120.00
+	 3150 3825 3600 3825
+3 0 0 1 0 7 50 -1 -1 0.000 0 1 0 4
+	1 1 1.00 60.00 120.00
+	 1800 3465 2025 3465 2250 3870 2475 3870
+	 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 1 0 4
+	1 1 1.00 60.00 120.00
+	 4275 3870 4500 3870 4725 3465 4950 3465
+	 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 1 0 4
+	1 1 1.00 60.00 120.00
+	 4950 3240 4725 3240 4500 3015 4275 3015
+	 0.000 1.000 1.000 0.000
+3 0 0 1 0 7 50 -1 -1 0.000 0 1 0 4
+	1 1 1.00 60.00 120.00
+	 2475 2970 2250 2970 2025 3240 1800 3240
+	 0.000 1.000 1.000 0.000
+4 0 0 50 -1 0 12 0.0000 4 135 675 990 3510 Daemon\001
+4 0 0 50 -1 0 12 0.0000 4 180 615 990 3240 Storage\001
+4 0 0 50 -1 0 12 0.0000 4 135 525 2536 3886 inflate\001
+4 0 0 50 -1 0 12 0.0000 4 135 570 5085 3285 Device\001
+4 0 0 50 -1 0 12 0.0000 4 135 1005 2925 2430 Direction IN\001
+4 0 0 50 -1 0 12 0.0000 4 135 1200 2880 4365 Direction OUT\001
+4 0 0 50 -1 0 12 0.0000 4 135 525 3690 2970 inflate\001