From: Eric Bollengier <eric@eb.homelinux.org>
Date: Wed, 9 Sep 2009 08:01:48 +0000 (+0000)
Subject: Add ExcludeDirContaining doc to the fileset manual
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=d39e190b8276dff7d85b184d267205e5a5f2d3b6;p=bacula%2Fdocs

Add ExcludeDirContaining doc to the fileset manual
---

diff --git a/docs/manuals/en/install/fileset.tex b/docs/manuals/en/install/fileset.tex
index e8afbc96..ffcfe72b 100644
--- a/docs/manuals/en/install/fileset.tex
+++ b/docs/manuals/en/install/fileset.tex
@@ -102,7 +102,7 @@ defined for each Backup job.
 The Include resource must contain a list of directories and/or files to be
 processed in the backup job.  Normally, all files found in all
 subdirectories of any directory in the Include File list will be backed up.
-Note, see below for the definition of \lt{}file-list\gt{}. 
+Note, see below for the definition of \lt{}file-list\gt{}.
 The Include resource may also contain one or more Options resources that
 specify options such as compression to be applied to all or any subset of
 the files found when processing the file-list for backup. Please see
@@ -891,7 +891,7 @@ Include {
 \end{verbatim}
 \normalsize
 
-\item Any name beginning with a vertical bar (|) is  assumed to be the name of
+\item Any name beginning with a vertical bar (\vb) is  assumed to be the name of
    a program.  This program will be executed on the Director's machine at
    the time the Job starts (not when the Director reads the configuration
    file), and any output from that program will be assumed to be a list of
@@ -1109,6 +1109,50 @@ Include {
 \item A file-list may not contain wild-cards. Use directives in the
    Options resource if you wish to specify wild-cards or regular expression
    matching.
+
+\item
+\index[general]{IgnoreDir}
+The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a directive that
+can be added to the Include section of the FileSet resource.  If the specified
+filename ({\bf filename-string}) is found on the Client in any directory to be
+backed up, the whole directory will be ignored (not backed up).  For example:
+
+\begin{verbatim}
+  # List of files to be backed up
+  FileSet {
+    Name = "MyFileSet"
+    Include {
+      Options {
+        signature = MD5
+      }
+      File = /home
+      Exclude Dir Containing = .excludeme
+    }
+  }
+\end{verbatim}
+
+But in /home, there may be hundreds of directories of users and some
+people want to indicate that they don't want to have certain
+directories backed up. For example, with the above FileSet, if
+the user or sysadmin creates a file named {\bf .excludeme} in 
+specific directories, such as
+
+\begin{verbatim}
+   /home/user/www/cache/.excludeme
+   /home/user/temp/.excludeme
+\end{verbatim}
+
+then Bacula will not backup the two directories named:
+
+\begin{verbatim}
+   /home/user/www/cache
+   /home/user/temp
+\end{verbatim}
+
+NOTE: subdirectories will not be backed up.  That is, the directive
+applies to the two directories in question and any children (be they
+files, directories, etc).
+
 \end{itemize}
 
 \section{FileSet Examples}