Apply Marco's doc patch

[bacula/docs] / docs / manuals / en / main / fileset.tex

diff --git a/docs/manuals/en/main/fileset.tex b/docs/manuals/en/main/fileset.tex
index a0675bcf81a7f603ca327a9651026ed10fbabebb..282b224dc8169acc579e3e29db3b276034bffc52 100644 (file)
--- 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}
@@ -786,18 +802,70 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 \index[dir]{aclsupport}
 \index[dir]{Directive!aclsupport}
    The default is {\bf no}.  If this option is set to yes, and you have the
-   POSIX {\bf libacl} installed on your system, Bacula will backup the file
-   and directory UNIX Access Control Lists (ACL) as defined in IEEE Std
+   POSIX {\bf libacl} installed on your Linux system, Bacula will backup the
+   file and directory Unix Access Control Lists (ACL) as defined in IEEE Std
    1003.1e draft 17 and "POSIX.1e" (abandoned).  This feature is
-   available on UNIX only and depends on the ACL library.  Bacula is
+   available on Unix systems only and requires the Linux ACL library. Bacula is
    automatically compiled with ACL support if the {\bf libacl} library is
-   installed on your system (shown in config.out).  While restoring the
+   installed on your Linux system (shown in config.out).  While restoring the
    files Bacula will try to restore the ACLs, if there is no ACL support
    available on the system, Bacula restores the files and directories but
    not the ACL information.  Please note, if you backup an EXT3 or XFS
    filesystem with ACLs, then you restore them to a different filesystem
    (perhaps reiserfs) that does not have ACLs, the ACLs will be ignored.
 
+   For other operating systems there is support for either POSIX ACLs or
+   the more extensible NFSv4 ACLs.
+
+   The ACL stream format between Operation Systems is \textbf{not}
+   compatible so for example an ACL saved on Linux cannot be restored on
+   Solaris.
+
+   The following Operating Systems are currently supported:
+
+   \begin{enumerate}
+   \item AIX (pre-5.3 (POSIX) and post 5.3 (POSIX and NFSv4) ACLs)
+   \item Darwin
+   \item FreeBSD (POSIX and NFSv4/ZFS ACLs)
+   \item HPUX
+   \item IRIX
+   \item Linux
+   \item Solaris (POSIX and NFSv4/ZFS ACLs)
+   \item Tru64
+   \end{enumerate}
+
+\label{XattrSupport}
+\item [xattrsupport=yes\vb{}no]
+\index[dir]{xattrsupport}
+\index[dir]{Directive!xattrsupport}
+   The default is {\bf no}.  If this option is set to yes, and your
+   operating system support either so called Extended Attributes or
+   Extensible Attributes Bacula will backup the file and directory
+   XATTR data. This feature is available on UNIX only and depends on
+   support of some specific library calls in libc.
+
+   The XATTR stream format between Operating Systems is {\bf not}
+   compatible so an XATTR saved on Linux cannot for example be restored
+   on Solaris.
+
+   On some operating systems ACLs are also stored as Extended Attributes
+   (Linux, Darwin, FreeBSD) Bacula checks if you have the aclsupport
+   option enabled and if so will not save the same info when saving
+   extended attribute information. Thus ACLs are only saved once.
+
+   The following Operating Systems are currently supported:
+
+   \begin{enumerate}
+   \item AIX (Extended Attributes)
+   \item Darwin (Extended Attributes)
+   \item FreeBSD (Extended Attributes)
+   \item IRIX (Extended Attributes)
+   \item Linux (Extended Attributes)
+   \item NetBSD (Extended Attributes)
+   \item Solaris (Extended Attributes and Extensible Attributes)
+   \item Tru64 (Extended Attributes)
+   \end{enumerate}
+
 \item [ignore case=yes\vb{}no]
 \index[dir]{ignore case}
 \index[dir]{Directive!ignore case}
@@ -1226,7 +1294,7 @@ FileSet {
      File = /usr/lib/another_file
   }
   Exclude {
-     File = /tmp
+     File = /tmp                          # don't add trailing /
   }
 }
 \end{verbatim}
@@ -1545,7 +1613,8 @@ RunBeforeJob} directive.
 You may also include full filenames or directory names in addition to using
 wild-cards and {\bf Exclude=yes} in the Options resource as specified above by
 simply including the files to be excluded in an Exclude resource within the
-FileSet. For example: 
+FileSet. It accepts wild-cards pattern, so for a directory, don't add a trailing
+/. For example:
 
 \footnotesize
 \begin{verbatim}
@@ -1563,7 +1632,7 @@ FileSet {
   }
   Exclude {
     File = /proc
-    File = /tmp
+    File = /tmp                          # Don't add trailing /
     File = .journal
     File = .autofsck
   }