X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fmanual%2Ffileset.tex;h=c8a2dd2b5603ad668f6036d292a1c7910789e771;hb=36e0823cfc06500cab2b9a7d8e359310a2ac8a3a;hp=419b7b8e1ac66bf250f9f1c6978fca8ec5292b09;hpb=b2c22d8fa33f49930cd90c62bb0354a5950958d6;p=bacula%2Fdocs diff --git a/docs/manual/fileset.tex b/docs/manual/fileset.tex index 419b7b8e..c8a2dd2b 100644 --- a/docs/manual/fileset.tex +++ b/docs/manual/fileset.tex @@ -1,7 +1,7 @@ -% %% -\chapter{The FileSet Resource} +\section{The FileSet Resource} \label{FileSetResource} \index[general]{Resource!FileSet} \index[general]{FileSet Resource} @@ -18,6 +18,27 @@ automatically create a new FileSet (defined by the name and an MD5 checksum of the Include/Exclude contents). Each time a new FileSet is created, Bacula will ensure that the next backup is always a Full save. +Bacula is designed to handle most character sets of the world, +US ASCII, German, French, Chinese, ... However, it does this by +encoding everything in UTF-8, and it expects all configuration files +(including those read on Win32 machines) to be in UTF-8 format. +UTF-8 is typically the default on Linux machines, but not on all +Unix machines, nor on Windows, so you must take some care to ensure +that your locale is set properly before starting Bacula. +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 +exact syntax may vary a bit from OS to OS, and exactly how you define +it will also vary. + +Bacula assumes that all filenames are in UTF-8 format on Linux and +Unix machines. On Win32 they are in Unicode (UTF-16), and will +be automatically converted to UTF-8 format. + + \begin{description} \item [FileSet] @@ -36,14 +57,18 @@ defined for each Backup job. \index[dir]{Directive!Ignore FileSet Changes} Normally, if you modify the FileSet Include or Exclude lists, the next backup will be forced to a Full so that Bacula can - guarantee that any additions or deletions are properly backed - up. + guarantee that any additions or deletions are properly saved. + + We strongly recommend against setting this directive to yes, + since doing so may cause you to have an incomplete set of backups. + If this directive is set to {\bf yes}, any changes you make to the - FileSet Include or Exclude lists will be ignored and not cause Bacula to - immediately perform a Full backup. The default is {\bf no}, in which - case, if you change the Include or Exclude, Bacula will force a Full - backup to ensure that everything is properly backed up. It is not - recommended to set this directive to yes. + FileSet Include or Exclude lists, will not force a Full during + subsequent backups. + + The default is {\bf no}, in which case, if you change the Include or + Exclude, Bacula will force a Full backup to ensure that everything is + properly backed up. \item [Enable VSS = \lt{}yes|no\gt{}] \index[dir]{Enable VSS} @@ -279,7 +304,7 @@ The directives within an Options resource may be one of the following: \item {\bf c} compare the change time (st\_ctime) - \item {\bf s} + \item {\bf d} report file size decreases \item {\bf 5} @@ -540,6 +565,20 @@ Change: 2005-11-06 12:36:48.000000000 +0100 to use {\bf mtimeonly = yes} as well as keepatime (thanks to Rudolf Cejka for this tip). +\item [checkfilechanges=yes|no] +\index[dir]{checkfilechanges} +\index[dir]{Directive!checkfilechanges} + On versions 2.0.4 or greater, + if enabled, the Client will checks size, age of each file after + their backup to see if they have changed during backup. If time + or size mismatch, an error will raise. + +\begin{verbatim} + zog-fd: Client1.2007-03-31_09.46.21 Error: /tmp/test mtime changed during backup. +\end{verbatim} + + In general, it is recommended to use this option. + \item [hardlinks=yes|no] \index[dir]{hardlinks} \index[dir]{Directive!hardlinks} @@ -568,9 +607,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{UtilitiesChapter}{Utilities} chapter of this manual for + \ilink{Utilities}{bwild} chapter of this manual for more. You can also test your full FileSet definition by using - the \ilink{estimate command}{estimate} command in the Console + the \ilink{estimate}{estimate} command in the Console chapter of this manual. It is recommended to enclose the string in double quotes. @@ -579,9 +618,9 @@ Change: 2005-11-06 12:36:48.000000000 +0100 \index[dir]{Directive!wilddir} Specifies a wild-card string to be applied to directory names only. No filenames will be matched by this directive. Note, if {\bf Exclude} is - not enabled, the wild-card will select directories files are to be + not enabled, the wild-card will select directories to be included. If {\bf Exclude=yes} is specified, the wild-card will select - which files are to be excluded. Multiple wild-card directives may be + which directories are to be excluded. Multiple wild-card directives may be specified, and they will be applied in turn until the first one that matches. Note, if you exclude a directory, no files or directories below it will be matched. @@ -590,9 +629,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{UtilitiesChapter}{Utilities} chapter of this manual for + \ilink{Utilities}{bwild} chapter of this manual for more. You can also test your full FileSet definition by using - the \ilink{estimate command}{estimate} command in the Console + the \ilink{estimate}{estimate} command in the Console chapter of this manual. An example of excluding with the WildDir option on Win32 machines is presented below. @@ -616,9 +655,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{UtilitiesChapter}{Utilities} chapter of this manual for + \ilink{Utilities}{bwild} chapter of this manual for more. You can also test your full FileSet definition by using - the \ilink{estimate command}{estimate} command in the Console + the \ilink{estimate}{estimate} command in the Console chapter of this manual. An example of excluding with the WildFile option on Win32 machines is presented below. @@ -642,9 +681,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{UtilitiesChapter}{Utilities} chapter of this manual for + \ilink{Utilities}{bwild} chapter of this manual for more. You can also test your full FileSet definition by using - the \ilink{estimate command}{estimate} command in the Console + the \ilink{estimate}{estimate} command in the Console chapter of this manual. @@ -668,7 +707,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{UtilitiesChapter}{Utilities} chapter of this manual for + \ilink{Utilities}{bregex} chapter of this manual for more. @@ -690,7 +729,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{UtilitiesChapter}{Utilities} chapter of this manual for + \ilink{Utilities}{bregex} chapter of this manual for more. @@ -701,7 +740,6 @@ Change: 2005-11-06 12:36:48.000000000 +0100 Options will be excluded from the backup. \label{ACLSupport} - \item [aclsupport=yes|no] \index[dir]{aclsupport} \index[dir]{Directive!aclsupport} @@ -752,6 +790,15 @@ Change: 2005-11-06 12:36:48.000000000 +0100 This option allows you to turn on support for Mac OSX HFS plus finder information. +\item [strippath=\lt{}integer\gt{}] +\index[dir]{strippath} +\index[dir]{Directive!strippath} + This option will cause {\bf integer} paths to be stripped from + the front of the full path/filename being backed up. This can + be useful if you are migrating data from another vendor or if + you have taken a snapshot into some subdirectory. This directive + can cause your filenames to be overlayed with regular backup data, + so should be used only by experts and with great care. \end{description} {\bf \lt{}file-list\gt{}} is a list of directory and/or filename names @@ -786,7 +833,9 @@ Include { 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 - files or directories, one per line, to be included. + files or directories, one per line, to be included. Before submitting the + specified command bacula will performe + \ilink{character substitution}{character substitution}. This allows you to have a job that, for example, includes all the local partitions even if you change the partitioning by adding a disk. The @@ -898,7 +947,8 @@ Include { \item Any file-list item preceded by a less-than sign (\lt{}) will be taken - to be a file. This file will be read on the Director's machine at the time + to be a file. This file will be read on the Director's machine (see + below for doing it on the Client machine) at the time the Job starts, and the data will be assumed to be a list of directories or files, one per line, to be included. The names should start in column 1 and should not be quoted even if they contain spaces. This feature allows you to @@ -1523,7 +1573,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 command}{estimate} in the Console chapter of this +\ilink{estimate}{estimate} in the Console chapter of this manual. As an example, suppose you add the following test FileSet: