]> git.sur5r.net Git - bacula/docs/blobdiff - docs/manuals/en/main/fileset.tex
Tweak doc text
[bacula/docs] / docs / manuals / en / main / fileset.tex
index a0675bcf81a7f603ca327a9651026ed10fbabebb..7eea8e740bac73452b1fd6c701104d521d756e16 100644 (file)
@@ -29,8 +29,8 @@ On most modern Win32 machines, you can edit the conf files with {\bf
 notebook} and choose output encoding UTF-8.
 
 To ensure that Bacula configuration files can be correctly read including
-foreign characters the {bf LANG} environment variable
-must end in {\bf .UTF-8}. An full example is {\bf en\_US.UTF-8}. The
+foreign characters the {\bf LANG} environment variable
+must end in {\bf .UTF-8}. A full example is {\bf en\_US.UTF-8}. The
 exact syntax may vary a bit from OS to OS, and exactly how you define
 it will also vary.
 
@@ -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}
@@ -287,12 +303,10 @@ The options letters specified are used when running a {\bf Backup Level=Full}
 with BaseJobs. The options letters are the same than in the \textbf{verify=}
 option below.
 
-\item[accurate=\lt{}options\gt{}] 
-\index[dir]{accurate}
-\index[dir]{Directive!accurate}
-   The options letters specified are used  when running a {\bf Backup
-   Level=Incremental/Differential} in Accurate mode. The options
-   letters are the same than in the \textbf{verify=} option below.  
+\item[accurate=\lt{}options\gt{}] \index[dir]{accurate}
+  \index[dir]{Directive!accurate} The options letters specified are used when
+  running a {\bf Backup Level=Incremental/Differential} in Accurate mode. The
+  options letters are the same than in the \textbf{verify=} option below. 
 
 \item [verify=\lt{}options\gt{}]
 \index[dir]{verify}
@@ -338,6 +352,10 @@ option below.
 
       \item {\bf 1}
       compare the SHA1 signature  
+
+      \item {\bf A}
+      Only for Accurate option, it allows to always backup the file
+
       \end{description}
 
    A useful set of general options on the {\bf Level=Catalog}  or {\bf
@@ -499,9 +517,9 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    ndbm.  The default is {\bf no}, so no checks are made for sparse files.
    You may specify {\bf sparse=yes} even on files that are not sparse file.
    No harm will be done, but there will be a small additional overhead to
-   check for buffers of all zero, and a small additional amount of space on
-   the output archive will be used to save the seek address of each
-   non-zero record read.
+   check for buffers of all zero, and if there is a 32K block of all zeros
+   (see below), that block will become a hole in the file, which 
+   may not be desirable if the original file was not a sparse file.
 
    {\bf Restrictions:} Bacula reads files in 32K buffers.  If the whole
    buffer is zero, it will be treated as a sparse block and not written to
@@ -529,6 +547,9 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    benchmark the difference or set sparse for only those files that are
    really sparse.
 
+   You probably should not use this option on files or raw disk devices
+   that are not really sparse files (i.e. have holes in them).
+
 \label{readfifo}
 \item [readfifo=yes\vb{}no]
 \index[dir]{readfifo}
@@ -786,18 +807,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}
@@ -813,7 +886,7 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    filesystem type.  The permitted filesystem-type names are:
 
    ext2, jfs, ntfs, proc, reiserfs, xfs, usbdevfs, sysfs, smbfs,
-   iso9660.  For ext3 systems, use ext2.
+   iso9660.
 
    You may have multiple Fstype directives, and thus permit matching
    of multiple filesystem types within a single Options resource.  If
@@ -1201,7 +1274,7 @@ without any options, but all files in those directories with the extensions
 {\bf .o} and {\bf .exe} will be excluded. 
 
 Let's say that you now want to exclude the directory /tmp. The simplest way
-to do so is to add an exclude directive that lists /tmp.  The example
+to do so is to add an Exclude directive that lists /tmp.  The example
 above would then become:
 
 \footnotesize 
@@ -1226,7 +1299,7 @@ FileSet {
      File = /usr/lib/another_file
   }
   Exclude {
-     File = /tmp
+     File = /tmp                          # don't add trailing /
   }
 }
 \end{verbatim}
@@ -1234,11 +1307,11 @@ FileSet {
 
 
 You can add wild-cards to the File directives listed in the Exclude
-directory, but you need to take care because if you exclude a directory,
+directive, but you need to take care because if you exclude a directory,
 it and all files and directories below it will also be excluded.
 
-Now lets take a slight variation on the above and suppose
-you want to save all your whole filesystem except {\bf /tmp}. 
+Now let's make a slight variation on the above and suppose
+you want to save all your filesystems except {\bf /tmp}.
 The problem that comes up is that Bacula will not normally
 cross from one filesystem to another.
 Doing a {\bf df} command, you get the following output: 
@@ -1545,7 +1618,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 +1637,7 @@ FileSet {
   }
   Exclude {
     File = /proc
-    File = /tmp
+    File = /tmp                          # Don't add trailing /
     File = .journal
     File = .autofsck
   }
@@ -1761,7 +1835,7 @@ FileSet {
   Include {
     File = /home/xxx/test
     Options {
-       regex = ".*\.c$"
+       regex = ".*\\.c$"
     }
   }
 }
@@ -1777,4 +1851,5 @@ estimate job=<any-job-name> listing client=<desired-client> fileset=Test
 \end{verbatim}
 \normalsize
 
-to give you a listing of all files that match.
+to give you a listing of all files that match.  In the above
+example, it should be only files with names ending in  {\bf .c}.