]> git.sur5r.net Git - bacula/docs/blobdiff - docs/manuals/en/main/fileset.tex
Commit two patches from Philippe to cleanup the manuals
[bacula/docs] / docs / manuals / en / main / fileset.tex
index 3d53156464c118921e0502641bb28bc72fa5d28d..3d99df73b31fd16f71f4e80a87c028804455a603 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.
 
@@ -300,13 +300,13 @@ The directives within an Options resource may be one of the following:
 \index[dir]{Directive!basejob}
 
 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.
+with BaseJobs. The options letters are the same as in the \textbf{verify=}
+options 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. 
+  options letters are the same as in the \textbf{verify=} directive below. 
 
 \item [verify=\lt{}options\gt{}]
 \index[dir]{verify}
@@ -370,7 +370,7 @@ option below.
    on a subdirectory.  If you are using a *nix system, you may not even be
    aware that there are several different filesystems as they are often
    automatically mounted by the OS (e.g.  /dev, /net, /sys, /proc, ...).
-   With Bacula 1.38.0 or later, it will inform you when it decides not to
+   Bacula will inform you when it decides not to
    traverse into another filesystem.  This can be very useful if you forgot
    to backup a particular partition.  An example of the informational
    message in the job report is:
@@ -387,7 +387,7 @@ rufus-fd: /home is a different filesystem. Will not descend from / into /home
 \end{verbatim}
 \normalsize
 
-   Note: in previous versions of Bacula, the above message was of the form: 
+   Note: in older versions of Bacula, the above message was of the form: 
 
 \footnotesize
 \begin{verbatim}
@@ -491,13 +491,14 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    backup Win32 files in a portable format, but not all Win32 file
    attributes will be saved and restored.  By default, this option is set
    to {\bf no}, which means that on Win32 systems, the data will be backed
-   up using Windows API calls and on WinNT/2K/XP, all the security and
+   up using Windows BackupRead  API calls and all the security and
    ownership attributes will be properly backed up (and restored).  However
-   this format is not portable to other systems -- e.g.  Unix, Win95/98/Me.
+   this format is not portable to other systems -- e.g.  Unix, and
+   very old  Win95/98/Me systems.
    When backing up Unix systems, this option is ignored, and unless you
    have a specific need to have portable backups, we recommend accept the
-   default ({\bf no}) so that the maximum information concerning your files
-   is saved.
+   default ({\bf no}) so that the maximum information concerning your 
+   Windows files is saved.
 
 \item [recurse=yes\vb{}no]
 \index[dir]{recurse}
@@ -517,9 +518,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
@@ -547,6 +548,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}
@@ -663,10 +667,9 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 
    You may want to test your expressions prior to running your
    backup by using the bwild program. Please see the
-   \ilink{Utilities}{bwild} chapter of this manual for
-   more. You can also test your full FileSet definition by using
-   the \ilink{estimate}{estimate} command in the Console        
-   chapter of this manual.
+   \borgxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
+   more information. You can also test your full FileSet definition by using
+   the \borgxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
    It is recommended to enclose the string in double quotes.
 
 \item [wilddir=\lt{}string\gt{}]
@@ -685,10 +688,9 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 
    You may want to test your expressions prior to running your
    backup by using the bwild program. Please see the
-   \ilink{Utilities}{bwild} chapter of this manual for
-   more. You can also test your full FileSet definition by using
-   the \ilink{estimate}{estimate} command in the Console        
-   chapter of this manual.
+   \borgxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
+   more information. You can also test your full FileSet definition by using
+   the \borgxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
    An example of excluding with the WildDir option on Win32 machines is    
    presented below.
 
@@ -711,14 +713,12 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 
    You may want to test your expressions prior to running your
    backup by using the bwild program. Please see the
-   \ilink{Utilities}{bwild} chapter of this manual for
-   more. You can also test your full FileSet definition by using
-   the \ilink{estimate}{estimate} command in the Console        
-   chapter of this manual.
-   An example of excluding with the WildFile option on Win32 machines is    
+   \borgxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
+   more information. You can also test your full FileSet definition by using
+   the \borgxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
+   An example of excluding with the WildFile option on Win32 machines is
    presented below.
 
-
 \item [regex=\lt{}string\gt{}]
 \index[dir]{regex}
 \index[dir]{Directive!regex}
@@ -737,10 +737,9 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    another, and in addition, regular expressions are complicated,
    so you may want to test your expressions prior to running your
    backup by using the bregex program. Please see the
-   \ilink{Utilities}{bwild} chapter of this manual for
-   more. You can also test your full FileSet definition by using
-   the \ilink{estimate}{estimate} command in the Console        
-   chapter of this manual.
+   \borgxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
+   more information. You can also test your full FileSet definition by using
+   the \borgxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
 
    You find yourself using a lot of Regex statements, which will cost quite a lot
    of CPU time, we recommend you simplify them if you can, or better yet
@@ -767,8 +766,7 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    another, and in addition, regular expressions are complicated,
    so you may want to test your expressions prior to running your
    backup by using the bregex program. Please see the
-   \ilink{Utilities}{bregex} chapter of this manual for
-   more.
+   \borgxrlink{bregex}{bregex}{utility}{command} of the \utilityman{} more.
 
 
 \item [regexdir=\lt{}string\gt{}]
@@ -789,8 +787,7 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    another, and in addition, regular expressions are complicated,
    so you may want to test your expressions prior to running your
    backup by using the bregex program. Please see the
-   \ilink{Utilities}{bregex} chapter of this manual for
-   more.
+   \borgxrlink{bregex}{bregex}{utility}{command} of the \utilityman{} more.
 
 
 \item [exclude=yes\vb{}no]
@@ -1687,7 +1684,7 @@ rules:
 Thanks to Thiago Lima for summarizing the above items for us. If you are
 having difficulties getting includes or excludes to work, you might want to
 try using the {\bf estimate job=xxx listing} command documented in the 
-\ilink{Console chapter}{estimate} of this manual. 
+\borgxrlink{estimate}{estimate}{console}{command} of \consoleman{}.
 
 On Win32 systems, if you move a directory or file or rename a file into the
 set of files being backed up, and a Full backup has already been made, Bacula
@@ -1820,8 +1817,7 @@ as of version 1.37.30 or later.
 If you wish to get an idea of what your FileSet will really backup or if your
 exclusion rules will work correctly, you can test it by using the {\bf
 estimate} command in the Console program. See the 
-\ilink{estimate}{estimate} in the Console chapter of this
-manual.
+\borgxrlink{estimate}{estimate}{console}{command} of \consoleman{}.
 
 As an example, suppose you add the following test FileSet:
 
@@ -1832,7 +1828,7 @@ FileSet {
   Include {
     File = /home/xxx/test
     Options {
-       regex = ".*\.c$"
+       regex = ".*\\.c$"
     }
   }
 }
@@ -1848,4 +1844,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}.