4 \subsection*{The FileSet Resource}
5 \label{FileSetResource}
6 \index[general]{Resource!FileSet }
7 \index[general]{FileSet Resource }
8 \addcontentsline{toc}{subsection}{FileSet Resource}
10 The FileSet resource defines what files are to be included or excluded in a
11 backup job. A {\bf FileSet} resource is required for each backup Job. It
12 consists of a list of files or directories to be included, a list of files
13 or directories to be excluded and the various backup options such as
14 compression, encryption, and signatures that are to be applied to each
17 Any change to the list of the included files will cause Bacula to
18 automatically create a new FileSet (defined by the name and an MD5 checksum
19 of the Include/Exclude contents). Each time a new FileSet is created,
20 Bacula will ensure that the next backup is always a Full save.
26 Start of the FileSet resource. One {\bf FileSet} resource must be
27 defined for each Backup job.
29 \item [Name = \lt{}name\gt{}]
31 The name of the FileSet resource. This directive is required.
33 \item [Ignore FileSet Changes = \lt{}yes|no\gt{}]
34 \index[dir]{Ignore FileSet Changes}
35 If this directive is set to {\bf yes}, any changes you make to the FileSet
36 Include or Exclude lists will be ignored and not cause Bacula to immediately
37 perform a Full backup. The default is {\bf no}, in which case, if you change
38 the Include or Exclude, Bacula will force a Full backup to ensure that
39 everything is properly backed up. It is not recommended to set this directive
40 to yes. This directive is available in Bacula version 1.35.4 or later.
42 \item [Enable VSS = \lt{}yes|no\gt{}]
43 \index[dir]{Enable VSS}
44 If this directive is set to {\bf yes} the File daemon will be notified
45 that the user wants to use a Volume Shadow Copy Service (VSS) backup
46 for this job. The default is {\bf no}. This directive is effective
47 only for VSS enabled Win32 File daemons. It permits a consistent copy
48 of open files to be made for cooperating writer applications, and for
49 applications that are not VSS away, Bacula can at least copy open files.
50 For more information, please see the
51 \ilink{Windows}{VSS} chapter of this manual.
53 \item [Include \{ Options \{\lt{}file-options\gt{}\} ...;
54 \lt{}file-list\gt{} \} ]
55 \index[dir]{Include \{ [ Options \{\lt{}file-options\gt{}\} ...]
56 \lt{}file-list\gt{} \} }
58 \item [Options \{ \lt{}file-options\gt{} \} ]
59 \index[dir]{Options \{ \lt{}file-options\gt{} \} }
61 \item [Exclude \{ \lt{}file-list\gt{} \}]
62 \index[dir]{Exclude \{ \lt{}file-list\gt{} \} }
66 The Include resource must contain a list of directories and/or files to be
67 processed in the backup job. Normally, all files found in all
68 subdirectories of any directory in the Include File list will be backed up.
69 Note, see below for the definition of \lt{}file-list\gt{}.
70 The Include resource may also contain one or more Options resources that
71 specify options such as compression to be applied to all or any subset of
72 the files found for backup.
74 There can be any number of {\bf Include} resources within the FileSet, each
75 having its own list of directories or files to be backed up and the backup
76 options defined by one or more Options resources. The {\bf file-list}
77 consists of one file or directory name per line. Directory names should be
78 specified without a trailing slash with Unix path notation.
80 You should always specify a full path for every directory and file that you
81 list in the FileSet. In addition, on Windows machines, you should {\bf
82 always} prefix the directory or filename with the drive specification in
83 lower case (e.g. {\bf c:/xxx}) using Unix directory name separators
86 Bacula's default for processing directories is to recursively descend in
87 the directory saving all files and subdirectories. Bacula will not by
88 default cross filesystems (or mount points in Unix parlance). This means
89 that if you specify the root partition (e.g. {\bf /}), Bacula will save
90 only the root partition and not any of the other mounted filesystems.
91 Similarly on Windows systems, you must explicitly specify each of the
92 drives you want saved (e.g.
93 {\bf c:/} and {\bf d:/} ...). In addition, at least for Windows systems, you
94 will most likely want to enclose each specification within double quotes
95 particularly if the directory (or file) name contains spaces. The {\bf df}
96 command on Unix systems will show you which mount points you must specify to
97 save everything. See below for an example.
99 Take special care not to include a directory twice or Bacula will backup
100 the same files two times wasting a lot of space on your archive device.
101 Including a directory twice is very easy to do. For example:
108 Options { compression=GZIP }
113 on a Unix system where /usr is a subdirectory (rather than a mounted
114 filesystem) will cause /usr to be backed up twice. In this case, on Bacula
115 versions prior to 1.32f-5-09Mar04 due to a bug, you will not be able to
116 restore hard linked files that were backed up twice.
118 If you have used Bacula prior to version 1.36.3, you will note three things in
119 the new FileSet syntax:
122 \item There is no equal sign (=) after the Include and before the opening
123 brace (\{). The same is true for the Exclude.
124 \item Each directory (or filename) to be included or excluded is preceded by a {\bf File
125 =}. Previously they were simply listed on separate lines.
126 \item The options that previously appeared on the Include line now must be
127 specified within their own Options resource.
128 \item The Exclude resource does not accept Options.
129 \item When using wild-cards or regular expressions, directory names are
130 always terminated with a slash (/) and filenames have no trailing slash.
133 The Options resource is optional, but when specified, it will contain a
134 list of {\bf keyword=value} options to be applied to the file-list.
135 See below for the definition of file-list.
136 Multiple Options resources may be specified one after another. As the
137 files are found in the specified directories, the Options will applied to
138 the filenames to determine if and how the file should be backed up. The
139 Options resources are applied in the order they are specified in the
140 FileSet until the first one that matches.
142 Once Bacula determines that the Options resource matches the file under
143 consideration, that file will be saved without looking at any other Options
144 resources that may be present. This means that any wild cards must appear
145 before an Options resource without wild cards.
147 If for some reason, Bacula applies all the Options resources to a file
148 under consideration for backup, but there are no matches (generally because
149 of wild cards that don't match), Bacula as a default will then backup the
150 file. This is quite logical if you consider the case of no Options, where
151 you want everything to be backed up.
153 However, one additional point is that
154 in the case that no match was found, Bacula will use the options found in
155 the last Options resource. As a consequence, if you want a particular set
156 of "default" options, you should put them in an Options resource after
159 It is a good idea to put all your wild-card and regex expressions inside
160 double quotes to prevent conf file scanning problems.
162 This is perhaps a bit overwhelming, so there are a number of examples included
163 below to illustrate how this works.
165 The directives within an Options resource may be one of the following:
169 \item [compression=GZIP]
170 \index[fd]{compression }
171 All files saved will be software compressed using the GNU ZIP compression
172 format. The compression is done on a file by file basis by the File daemon.
173 If there is a problem reading the tape in a single record of a file, it will
174 at most affect that file and none of the other files on the tape. Normally
175 this option is {\bf not} needed if you have a modern tape drive as the drive
176 will do its own compression. In fact, if you specify software compression at
177 the same time you have hardware compression turned on, your files may
178 actually take more space on the volume.
180 Software compression is very important if you are writing your Volumes to a
181 file, and it can also be helpful if you have a fast computer but a slow
182 network, otherwise it is generally better to rely your tape drive's hardware
183 compression. As noted above, it is not generally a good idea to do both software
184 and hardware compression.
186 Specifying {\bf GZIP} uses the default compression level six (i.e. {\bf GZIP}
187 is identical to {\bf GZIP6}). If you want a different compression level (1
188 through 9), you can specify it by appending the level number with no
189 intervening spaces to {\bf GZIP}. Thus {\bf compression=GZIP1} would give
190 minimum compression but the fastest algorithm, and {\bf compression=GZIP9}
191 would give the highest level of compression, but requires more computation.
192 According to the GZIP documentation, compression levels greater than 6
193 generally give very little extra compression and are rather CPU intensive.
195 \item [signature=SHA1]
196 \index[fd]{signature }
197 An SHA1 signature will be computed for all The SHA1 algorithm is purported to
198 be some what slower than the MD5 algorithm, but at the same time is
199 significantly better from a cryptographic point of view (i.e. much fewer
200 collisions, much lower probability of being hacked.) It adds four more bytes
201 than the MD5 signature. We strongly recommend that either this option or MD5
202 be specified as a default for all files. Note, only one of the two options
203 MD5 or SHA1 can be computed for any file.
205 \item [signature=MD5]
206 \index[fd]{signature }
207 An MD5 signature will be computed for all files saved. Adding this option
208 generates about 5\% extra overhead for each file saved. In addition to the
209 additional CPU time, the MD5 signature adds 16 more bytes per file to your
210 catalog. We strongly recommend that this option or the SHA1 option be
211 specified as a default for all files.
213 \item [verify=\lt{}options\gt{}]
215 The options letters specified are used when running a {\bf Verify
216 Level=Catalog} as well as the {\bf DiskToCatalog} level job. The options
217 letters may be any combination of the following:
225 compare the permission bits
228 compare the number of links
240 compare the access time
243 compare the modification time (st\_mtime)
246 compare the change time (st\_ctime)
249 report file size decreases
252 compare the MD5 signature
255 compare the SHA1 signature
258 A useful set of general options on the {\bf Level=Catalog} or {\bf
259 Level=DiskToCatalog} verify is {\bf pins5} i.e. compare permission bits,
260 inodes, number of links, size, and MD5 changes.
264 If set to {\bf yes} (the default), {\bf Bacula} will remain on a single file
265 system. That is it will not backup file systems that are mounted on a
266 subdirectory. If you wish to backup multiple filesystems, you can explicitly
267 list each file system you want saved. Otherwise, if you set the onefs option
268 to {\bf no}, Bacula will backup all mounted file systems (i.e. traverse mount
269 points) that are found within the {\bf FileSet}. Thus if you have NFS or
270 Samba file systems mounted on a directory listed in your FileSet, they will
271 also be backed up. Normally, it is preferable to set {\bf onefs=yes} and to
272 explicitly name each filesystem you want backed up. Explicitly naming the
273 filesystems you want backed up avoids the possibility of getting into a
274 infinite loop recursing filesystems. See the example below for more details.
278 \item [portable=yes|no]
279 \index[dir]{portable }
280 If set to {\bf yes} (default is {\bf no}), the Bacula File daemon will backup
281 Win32 files in a portable format, but not all Win32 file attributes will be
282 saved and restored. By default, this option is set to {\bf no}, which means
283 that on Win32 systems, the data will be backed up using Windows API calls and
284 on WinNT/2K/XP, all the security and ownership attributes will be properly
285 backed up (and restored). However this format is not portable to other
286 systems -- e.g. Unix, Win95/98/Me. When backing up Unix systems, this option
287 is ignored, and unless you have a specific need to have portable backups, we
288 recommend accept the default ({\bf no}) so that the maximum information
289 concerning your files is saved.
291 \item [recurse=yes|no]
293 If set to {\bf yes} (the default), Bacula will recurse (or descend) into all
294 subdirectories found unless the directory is explicitly excluded using an
295 {\bf exclude} definition. If you set {\bf recurse=no}, Bacula will save the
296 subdirectory entries, but not descend into the subdirectories, and thus will
297 not save the files or directories contained in the subdirectories. Normally,
298 you will want the default ({\bf yes}).
300 \item [sparse=yes|no]
302 Enable special code that checks for sparse files such as created by
303 ndbm. The default is {\bf no}, so no checks are made for sparse files.
304 You may specify {\bf sparse=yes} even on files that are not sparse file.
305 No harm will be done, but there will be a small additional overhead to
306 check for buffers of all zero, and a small additional amount of space on
307 the output archive will be used to save the seek address of each
308 non-zero record read.
310 {\bf Restrictions:} Bacula reads files in 32K buffers. If the whole
311 buffer is zero, it will be treated as a sparse block and not written to
312 tape. However, if any part of the buffer is non-zero, the whole buffer
313 will be written to tape, possibly including some disk sectors (generally
314 4098 bytes) that are all zero. As a consequence, Bacula's detection of
315 sparse blocks is in 32K increments rather than the system block size.
316 If anyone considers this to be a real problem, please send in a request
317 for change with the reason.
319 If you are not familiar with sparse files, an example is say a file
320 where you wrote 512 bytes at address zero, then 512 bytes at address 1
321 million. The operating system will allocate only two blocks, and the
322 empty space or hole will have nothing allocated. However, when you read
323 the sparse file and read the addresses where nothing was written, the OS
324 will return all zeros as if the space were allocated, and if you backup
325 such a file, a lot of space will be used to write zeros to the volume.
326 Worse yet, when you restore the file, all the previously empty space
327 will now be allocated using much more disk space. By turning on the
328 {\bf sparse} option, Bacula will specifically look for empty space in
329 the file, and any empty space will not be written to the Volume, nor
330 will it be restored. The price to pay for this is that Bacula must
331 search each block it reads before writing it. On a slow system, this
332 may be important. If you suspect you have sparse files, you should
333 benchmark the difference or set sparse for only those files that are
338 \item [readfifo=yes|no]
339 \index[fd]{readfifo }
340 If enabled, tells the Client to read the data on a backup and write the
341 data on a restore to any FIFO (pipe) that is explicitly mentioned in the
342 FileSet. In this case, you must have a program already running that
343 writes into the FIFO for a backup or reads from the FIFO on a restore.
344 This can be accomplished with the {\bf RunBeforeJob} directive. If this
345 is not the case, Bacula will hang indefinitely on reading/writing the
346 FIFO. When this is not enabled (default), the Client simply saves the
347 directory entry for the FIFO.
349 \item [mtimeonly=yes|no]
350 \index[dir]{mtimeonly }
351 If enabled, tells the Client that the selection of files during
352 Incremental and Differential backups should based only on the st\_mtime
353 value in the stat() packet. The default is {\bf no} which means that
354 the selection of files to be backed up will be based on both the
355 st\_mtime and the st\_ctime values. In general, it is not recommended
358 \item [keepatime=yes|no]
359 \index[dir]{keepatime }
360 The default is {\bf no}. When enabled, Bacula will reset the st\_atime
361 (access time) field of files that it backs up to their value prior to
362 the backup. This option is not generally recommended as there are very
363 few programs that use st\_atime, and the backup overhead is increased
364 because of the additional system call necessary to reset the times.
365 However, for some files, such as mailboxes, when Bacula backs up the
366 file, the user will notice that someone (Bacula) has accessed the
367 file. In this, case keepatime can be useful.
368 (I'm not sure this works on Win32).
370 Note, if you use this feature, when Bacula resets the access time, the
371 change time (st\_ctime) will automatically be modified by the system,
372 so on the next incremental job, the file will be backed up even if
373 it has not changed. As a consequence, you will probably also want
374 to use {\bf mtimeonly = yes} as well as keepatime (thanks to
375 Rudolf Cejka for this tip).
377 \item [hardlinks=yes|no]
378 \index[dir]{hardlinks}
379 When enabled (default), this directive will cause hard inks to be
380 backed up. However, the File daemon keeps track of hard linked files and
381 will backup the data only once. The process of keeping track of the
382 hard links can be quite expensive if you have lots of them (tens of
383 thousands or more). This doesn't occur on normal Unix systems, but if
384 you use a program like BackupPC, it can create hundreds of thousands, or
385 even millions of hard links. Backups become very long and the File daemon
386 will consume a lot of CPU power checking hard links. In such a case,
387 set {\bf hardlinks=no} and hard links will not be backed up. Note, using
388 this option will most likely backup more data and on a restore the file
389 system will not be restored identically to the original.
391 \item [wild=\lt{}string\gt{}]
393 Specifies a wild-card string to be applied to the filenames and
394 directory names. Note, if {\bf Exclude} is not enabled, the wild-card
395 will select which files are to be included. If {\bf Exclude=yes} is
396 specified, the wild-card will select which files are to be excluded.
397 Multiple wild-card directives may be specified, and they will be applied
398 in turn until the first one that matches. Note, if you exclude a
399 directory, no files or directories below it will be matched.
400 It is recommended to enclose the string in double quotes.
402 \item [wildfile=\lt{}string\gt{}]
403 \index[dir]{wildfile }
404 Specifies a wild-card string to be applied to filenames only. No
405 directories will be matched by this directive. Note, if {\bf Exclude}
406 is not enabled, the wild-card will select which files are to be
407 included. If {\bf Exclude=yes} is specified, the wild-card will select
408 which files are to be excluded. Multiple wild-card directives may be
409 specified, and they will be applied in turn until the first one that
411 It is recommended to enclose the string in double quotes.
413 \item [wilddir=\lt{}string\gt{}]
414 \index[dir]{wilddir }
415 Specifies a wild-card string to be applied to directory names only. No
416 filenames will be matched by this directive. Note, if {\bf Exclude} is
417 not enabled, the wild-card will select directories files are to be
418 included. If {\bf Exclude=yes} is specified, the wild-card will select
419 which files are to be excluded. Multiple wild-card directives may be
420 specified, and they will be applied in turn until the first one that
421 matches. Note, if you exclude a directory, no files or directories
422 below it will be matched.
423 It is recommended to enclose the string in double quotes.
426 \item [regex=\lt{}string\gt{}]
428 Specifies a POSIX extended regular expression to be applied to the
429 filenames and directory names.
430 This directive is available in version 1.35 and later. If {\bf
431 Exclude} is not enabled, the regex will select which files are to be
432 included. If {\bf Exclude=yes} is specified, the regex will select
433 which files are to be excluded. Multiple regex directives may be
434 specified within an Options resource, and they will be applied in turn
435 until the first one that matches. Note, if you exclude a
436 directory, no files or directories below it will be matched.
437 It is recommended to enclose the string in double quotes.
439 \item [regexfile=\lt{}string\gt{}]
440 \index[dir]{regexfile }
441 Specifies a POSIX extended regular expression to be applied to filenames
442 only. No directories will be matched by this directive. Note, if {\bf
443 Exclude} is not enabled, the regex will select which files are to be
444 included. If {\bf Exclude=yes} is specified, the regex will select
445 which files are to be excluded. Multiple regex directives may be
446 specified, and they will be applied in turn until the first one that
448 It is recommended to enclose the string in double quotes.
450 \item [regexdir=\lt{}string\gt{}]
451 \index[dir]{regexdir }
452 Specifies a POSIX extended regular expression to be applied to directory
453 names only. No filenames will be matched by this directive. Note, if
454 {\bf Exclude} is not enabled, the regex will select directories
455 files are to be included. If {\bf Exclude=yes} is specified, the
456 regex will select which files are to be excluded. Multiple
457 regex directives may be specified, and they will be applied in turn
458 until the first one that matches. Note, if you exclude a directory, no
459 files or directories below it will be matched.
460 It is recommended to enclose the string in double quotes.
462 \item [exclude=yes|no]
463 \index[dir]{exclude }
464 The default is {\bf no}. When enabled, any files matched within the Options
465 will be excluded from the backup.
469 \item [aclsupport=yes|no]
470 \index[dir]{aclsupport }
471 The default is {\bf no}. If this option is set to yes, and you have the
472 POSIX {\bf libacl} installed on your system, Bacula will backup the file
473 and directory UNIX Access Control Lists (ACL) as defined in IEEE Std
474 1003.1e draft 17 and "POSIX.1e" (abandoned). This feature is
475 available on UNIX only and depends on the ACL library. Bacula is
476 automatically compiled with ACL support if the {\bf libacl} library is
477 installed on your system (shown in config.out). While restoring the
478 files Bacula will try to restore the ACLs, if there is no ACL support
479 available on the system, Bacula restores the files and directories but
480 not the ACL information. Please note, if you backup an EXT3 or XFS
481 filesystem with ACLs, then you restore them to a different filesystem
482 (perhaps reiserfs) that does not have ACLs, the ACLs will be ignored.
484 \item [ignore case=yes|no]
485 \index[dir]{ignore case }
486 The default is {\bf no}, except on Windows systems where the default
487 is {\bf yes}. When this directive is set to {\bf yes} all the case
488 of character will be ignored in wild-card and regex comparisons.
489 That is an uppercase A will match a lowercase a.
491 \item [fstype=filesystem-type]
493 This option allows you to select files and directories by the
494 filesystem type. The permitted filesystem-type names are:
496 ext2, jfs, ntfs, proc, reiserfs, xfs, usbdevfs, sysfs, smbfs,
497 iso9660. For ext3 systems, use ext2.
499 You may have multiple Fstype directives, and thus permit matching
500 of multiple filesystem types within a single Options resource. If
501 the type specified on the fstype directive does not match the
502 filesystem for a particular directive, that directory will not be
503 backed up. This directive can be used to prevent backing up
504 non-local filesystems.
506 This option is not implemented in Win32 systems.
509 \item [hfsplussupport=yes|no]
510 \index[dir]{hfsplussupport }
511 This option allows you to turn on support for Mac OSX HFS plus
516 {\bf \lt{}file-list\gt{}} is a list of directory and/or filename names
517 specified with a {\bf File =} directive. To include names containing spaces,
518 enclose the name between double-quotes.
520 There are a number of special cases when specifying directories and files in a
521 {\bf file-list}. They are:
524 \item Any name preceded by an at-sign (@) is assumed to be the name of a
525 file, which contains a list of files each preceded by a "File =". The
526 named file is read once when the configuration file is parsed during the
527 Director startup. Note, that the file is read on the Director's machine
528 and not on the Client's. In fact, the @filename can appear anywhere
529 within the conf file where a token would be read, and the contents of
530 the named file will be logically inserted in the place of the @filename.
531 What must be in the file depends on the location the @filename is
532 specified in the conf file. For example:
537 Options { compression=GZIP }
538 @/home/files/my-files
543 \item Any name beginning with a vertical bar (|) is assumed to be the name of
544 a program. This program will be executed on the Director's machine at
545 the time the Job starts (not when the Director reads the configuration
546 file), and any output from that program will be assumed to be a list of
547 files or directories, one per line, to be included.
550 have a job that, for example, includes all the local partitions even if
551 you change the partitioning by adding a disk. The examples
552 below show you how to do this. However, please note two
553 things: 1. if you want the local filesystems, you probably
554 should be using the new {\bf fstype} directive, which was
555 added in version 1.36.3. 2. the exact syntax of the command
556 needed in the examples below is very system dependent. For
557 example, on recent Linux systems, you may need to add the -P
558 option, on FreeBSD systems, the options will be different as
561 In general, you will need
562 to prefix your command or commands with a {\bf sh -c} so that they are
563 invoked by a shell. This will not be the case if you are invoking a
564 script as in the second example below. Also, you must take care to
565 escape (precede with a \textbackslash{}) wild-cards, shell character,
566 and to ensure that any spaces in your command are escaped as well. If
567 you use a single quotes (') within a double quote ("), Bacula will
568 treat everything between the single quotes as one field so it will not
569 be necessary to escape the spaces. In general, getting all the quotes
570 and escapes correct is a real pain as you can see by the next example.
571 As a consequence, it is often easier to put everything in a file and
572 simply use the file name within Bacula. In that case the {\bf sh -c}
573 will not be necessary providing the first line of the file is {\bf
582 Options { signature = SHA1 }
583 File = "|sh -c 'df -l | grep \"^/dev/hd[ab]\" | grep -v \".*/tmp\" \
584 | awk \"{print \\$6}\"'"
589 will produce a list of all the local partitions on a RedHat Linux system.
590 Note, the above line was split, but should normally be written on one line.
591 Quoting is a real problem because you must quote for Bacula which consists of
592 preceding every \textbackslash{} and every " with a \textbackslash{}, and
593 you must also quote for the shell command. In the end, it is probably easier
594 just to execute a small file with:
602 File = "|my_partitions"
607 where my\_partitions has:
612 df -l | grep "^/dev/hd[ab]" | grep -v ".*/tmp" \
617 If the vertical bar (|) in front of my\_partitions is preceded by a
618 backslash as in \textbackslash{}|, the program will be executed on the
619 Client's machine instead of on the Director's machine.
620 Please note that if the filename is given within quotes, you
621 will need to use two slashes. An example, provided by John Donagher,
622 that backs up all the local UFS partitions on a remote system is:
627 Name = "All local partitions"
629 Options { signature=SHA1; onefs=yes; }
630 File = "\\|bash -c \"df -klF ufs | tail +2 | awk '{print \$6}'\""
636 The above requires two backslash characters after the double quote (one
637 preserves the next one). If you are a Linux user, just change the {\bf ufs}
638 to {\bf ext3} (or your preferred filesystem type), and you will be in
641 \item Any file-list item preceded by a less-than sign (\lt{}) will be taken
642 to be a file. This file will be read on the Director's machine at the time
643 the Job starts, and the data will be assumed to be a list of directories or
644 files, one per line, to be included. The names should start in column 1 and
645 should not be quoted even if they contain spaces. This feature allows you to
646 modify the external file and change what will be saved without stopping and
647 restarting Bacula as would be necessary if using the @ modifier noted above.
653 Options { signature = SHA1 }
654 File = "</home/files/local-filelist"
659 If you precede the less-than sign (\lt{}) with a backslash as in
660 \textbackslash{}\lt{}, the file-list will be read on the Client machine
661 instead of on the Director's machine. Please note that if the filename
662 is given within quotes, you will need to use two slashes.
667 Options { signature = SHA1 }
668 File = "\\</home/xxx/filelist-on-client"
673 \item If you explicitly specify a block device such as {\bf /dev/hda1}, then
674 Bacula (starting with version 1.28) will assume that this is a raw partition
675 to be backed up. In this case, you are strongly urged to specify a {\bf
676 sparse=yes} include option, otherwise, you will save the whole partition
677 rather than just the actual data that the partition contains. For example:
682 Options { signature=MD5; sparse=yes }
688 will backup the data in device /dev/hd6.
690 Ludovic Strappazon has pointed out that this feature can be used to backup a
691 full Microsoft Windows disk. Simply boot into the system using a Linux Rescue
692 disk, then load a statically linked Bacula as described in the
693 \ilink{ Disaster Recovery Using Bacula}{_ChapterStart38} chapter of
694 this manual. Then save the whole disk partition. In the case of a disaster,
695 you can then restore the desired partition by again booting with the rescue
696 disk and doing a restore of the partition.
697 \item If you explicitly specify a FIFO device name (created with mkfifo), and
698 you add the option {\bf readfifo=yes} as an option, Bacula will read the FIFO
699 and back its data up to the Volume. For example:
708 File = /home/abc/fifo
713 if {\bf /home/abc/fifo} is a fifo device, Bacula will open the fifo, read it,
714 and store all data thus obtained on the Volume. Please note, you must have a
715 process on the system that is writing into the fifo, or Bacula will hang,
716 and after one minute of waiting, Bacula will give up and go on to the next
717 file. The data read can be anything since Bacula treats it as a stream.
719 This feature can be an excellent way to do a "hot" backup of a very large
720 database. You can use the {\bf RunBeforeJob} to create the fifo and to start
721 a program that dynamically reads your database and writes it to the fifo.
722 Bacula will then write it to the Volume.
724 During the restore operation, the inverse is true, after Bacula creates the
725 fifo if there was any data stored with it (no need to explicitly list it or
726 add any options), that data will be written back to the fifo. As a
727 consequence, if any such FIFOs exist in the fileset to be restored, you must
728 ensure that there is a reader program or Bacula will block, and after one
729 minute, Bacula will time out the write to the fifo and move on to the next
733 \subsubsection*{FileSet Examples}
734 \index[general]{Examples!FileSet }
735 \index[general]{FileSet Examples}
736 \addcontentsline{toc}{subsection}{FileSet Examples}
738 The following is an example of a valid FileSet resource definition. Note, the
739 first Include pulls in the contents of the file {\bf /etc/backup.list} when
740 Bacula is started (i.e. the @), and that file must have each filename to be
741 backed up preceded by a {\bf File =} and on a separate line.
762 File = /usr/lib/another_file
768 In the above example, all the files contained in /etc/backup.list will
769 be compressed with GZIP compression, an SHA1 signature will be computed on the
770 file's contents (its data), and sparse file handling will apply.
772 The two directories /root/myfile and /usr/lib/another\_file will also be saved
773 without any options, but all files in those directories with the extensions
774 {\bf .o} and {\bf .exe} will be excluded.
776 Let's say that you now want to exclude the directory /tmp. The simplest way
777 to do so is to add an exclude directive that lists /tmp. The example
778 above would then become:
799 File = /usr/lib/another_file
809 You can add wild-cards to the File directives listed in the Exclude
810 directory, but you need to take care because if you exclude a directory,
811 it and all files and directories below it will also be excluded.
813 Now lets take a slight variation on the above and suppose
814 you want to save all your whole filesystem except {\bf /tmp}.
815 The problem that comes up is that Bacula will not normally
816 cross from one filesystem to another.
817 Doing a {\bf df} command, you get the following output:
822 Filesystem 1k-blocks Used Available Use% Mounted on
823 /dev/hda5 5044156 439232 4348692 10% /
824 /dev/hda1 62193 4935 54047 9% /boot
825 /dev/hda9 20161172 5524660 13612372 29% /home
826 /dev/hda2 62217 6843 52161 12% /rescue
827 /dev/hda8 5044156 42548 4745376 1% /tmp
828 /dev/hda6 5044156 2613132 2174792 55% /usr
829 none 127708 0 127708 0% /dev/shm
830 //minimatou/c$ 14099200 9895424 4203776 71% /mnt/mmatou
831 lmatou:/ 1554264 215884 1258056 15% /mnt/matou
832 lmatou:/home 2478140 1589952 760072 68% /mnt/matou/home
833 lmatou:/usr 1981000 1199960 678628 64% /mnt/matou/usr
834 lpmatou:/ 995116 484112 459596 52% /mnt/pmatou
835 lpmatou:/home 19222656 2787880 15458228 16% /mnt/pmatou/home
836 lpmatou:/usr 2478140 2038764 311260 87% /mnt/pmatou/usr
837 deuter:/ 4806936 97684 4465064 3% /mnt/deuter
838 deuter:/home 4806904 280100 4282620 7% /mnt/deuter/home
839 deuter:/files 44133352 27652876 14238608 67% /mnt/deuter/files
843 And we see that there are a number of separate filesystems (/ /boot
844 /home /rescue /tmp and /usr not to mention mounted systems).
845 If you specify only {\bf /} in your Include list, Bacula will only save the
846 Filesystem {\bf /dev/hda5}. To save all filesystems except {\bf /tmp} with
847 out including any of the Samba or NFS mounted systems, and explicitly
848 excluding a /tmp, /proc, .journal, and .autofsck, which you will not want to
849 be saved and restored, you can use the following:
854 Name = Include_example
859 wildfile = ".journal"
860 wildfile = ".autofsck"
873 Since /tmp is on its own filesystem and it was not explicitly named in the
874 Include list, it is not really needed in the exclude list. It is better to
875 list it in the Exclude list for clarity, and in case the disks are changed so
876 that it is no longer in its own partition.
878 Now, lets assume you only want to backup .Z and .gz files and nothing
879 else. This is a bit trickier because Bacula by default will select
880 everything to backup, so we must exclude everything but .Z and .gz files.
881 If we take the first example above and make the obvious modifications
882 to it, we might come up with a FileSet that looks like this:
888 Include { !!!!!!!!!!!!
890 wildfile = "*.Z" example
891 wildfile = "*.gz" doesn't
900 The *.Z and *.gz files will indeed be backed up, but all other files
901 that are not matched by the Options directives will automatically
902 be backed up too (i.e. that is the default rule).
904 To accomplish what we want, we must explicitly exclude all other files.
905 We do this with the fillowing:
926 The "trick" here was to add a RegexFile expression that matches
927 all files. It does not match directory names, so all directories in
928 /myfile will be backed up (the directory entry) and any *.Z and *.gz
929 files contained in them. If you know that certain directories do
930 not contain any *.Z or *.gz files and you do not want the directory
931 entries backed up, you will need to explicitly exclude those directories.
932 Backing up a directory entries is not very expensive.
934 Bacula uses the system regex library and some of them are
935 different on different OSes. The above has been reported not to work
936 on FreeBSD. This can be tested by using the {\bf estimate job=job-name
937 listing} command in the console and adapting the RegexFile expression
938 appropriately. In a future version of Bacula, we will supply our own
939 Regex code to avoid such system dependencies.
941 Please be aware that allowing Bacula to traverse or change file systems can be
942 {\bf very} dangerous. For example, with the following:
956 you will be backing up an NFS mounted partition ({\bf /mnt/matou}), and since
957 {\bf onefs} is set to {\bf no}, Bacula will traverse file systems. Now if {\bf
958 /mnt/matou} has the current machine's file systems mounted, as is often the
959 case, you will get yourself into a recursive loop and the backup will never
962 \subsubsection*{Backing up Raw Partitions}
963 \index[general]{Backing up!Partitions }
964 \index[general]{Backing up Raw Partitions }
965 \addcontentsline{toc}{subsection}{Backing up Raw Partitions}
967 The following FileSet definition will backup a raw partition:
972 Name = "RawPartition"
974 Options { sparse=yes }
981 While backing up and restoring a raw partition, you should ensure that no
982 other process including the system is writing to that partition. As a
983 precaution, you are strongly urged to ensure that the raw partition is not
984 mounted or is mounted read-only. If necessary, this can be done using the {\bf
985 RunBeforeJob} directive.
988 \subsubsection*{Excluding Files and Directories}
989 \index[general]{Directories!Excluding Files and }
990 \index[general]{Excluding Files and Directories }
991 \addcontentsline{toc}{subsubsection}{Excluding Files and Directories}
993 You may also include full filenames or directory names in addition to using
994 wild-cards and {\bf Exclude=yes} in the Options resource as specified above by
995 simply including the files to be excluded in an Exclude resource within the
996 FileSet. For example:
1001 Name = Exclusion_example
1024 \subsubsection*{Windows FileSets}
1025 \index[general]{Windows FileSets }
1026 \index[general]{FileSets!Windows }
1027 \addcontentsline{toc}{subsection}{Windows FileSets}
1028 If you are entering Windows file names, the directory path may be preceded by
1029 the drive and a colon (as in c:). However, the path separators must be
1030 specified in Unix convention (i.e. forward slash (/)). If you wish to include
1031 a quote in a file name, precede the quote with a backslash
1032 (\textbackslash{}). For example you might use the following
1033 for a Windows machine to backup the "My Documents" directory:
1038 Name = "Windows Set"
1045 File = "c:/My Documents"
1051 For exclude lists to work correctly on Windows, you must observe the following
1055 \item Filenames are case sensitive, so you must use the correct case.
1056 \item To exclude a directory, you must not have a trailing slash on the
1058 \item If you have spaces in your filename, you must enclose the entire name
1059 in double-quote characters ("). Trying to use a backslash before the space
1061 \item If you are using the old Exclude syntax (noted below), you may not
1062 specify a drive letter in the exclude. The new syntax noted above should work
1063 fine including driver letters.
1066 Thanks to Thiago Lima for summarizing the above items for us. If you are
1067 having difficulties getting includes or excludes to work, you might want to
1068 try using the {\bf estimate job=xxx listing} command documented in the
1069 \ilink{Console chapter}{estimate} of this manual.
1071 On Win32 systems, if you move a directory or file or rename a file into the
1072 set of files being backed up, and a Full backup has already been made, Bacula
1073 will not know there are new files to be saved during an Incremental or
1074 Differential backup (blame Microsoft, not me). To avoid this problem, please
1075 {\bf copy} any new directory or files into the backup area. If you do not have
1076 enough disk to copy the directory or files, move them, but then initiate a
1080 \paragraph*{A Windows Example FileSet}
1081 \index[general]{FileSet!Windows Example }
1082 \index[general]{Windows Example FileSet }
1083 \addcontentsline{toc}{paragraph}{Windows Example FileSet}
1085 The following example was contributed by Russell Howe. Please note that
1086 for presentation purposes, the lines beginning with Data and Internet
1087 have been wrapped and should included on the previous line with one
1092 This is my Windows 2000 fileset:
1094 Name = "Windows 2000"
1100 # Exclude Mozilla-based programs' file caches
1101 WildDir = "[A-Z]:/Documents and Settings/*/Application
1102 Data/*/Profiles/*/*/Cache"
1103 WildDir = "[A-Z]:/Documents and Settings/*/Application
1104 Data/*/Profiles/*/*/Cache.Trash"
1105 WildDir = "[A-Z]:/Documents and Settings/*/Application
1106 Data/*/Profiles/*/*/ImapMail"
1108 # Exclude user's registry files - they're always in use anyway.
1109 WildFile = "[A-Z]:/Documents and Settings/*/Local Settings/Application
1110 Data/Microsoft/Windows/usrclass.*"
1111 WildFile = "[A-Z]:/Documents and Settings/*/ntuser.*"
1113 # Exclude directories full of lots and lots of useless little files
1114 WildDir = "[A-Z]:/Documents and Settings/*/Cookies"
1115 WildDir = "[A-Z]:/Documents and Settings/*/Recent"
1116 WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/History"
1117 WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/Temp"
1118 WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/Temporary
1121 # These are always open and unable to be backed up
1122 WildFile = "[A-Z]:/Documents and Settings/All Users/Application
1123 Data/Microsoft/Network/Downloader/qmgr[01].dat"
1125 # Some random bits of Windows we want to ignore
1126 WildFile = "[A-Z]:/WINNT/security/logs/scepol.log"
1127 WildDir = "[A-Z]:/WINNT/system32/config"
1128 WildDir = "[A-Z]:/WINNT/msdownld.tmp"
1129 WildDir = "[A-Z]:/WINNT/Internet Logs"
1130 WildDir = "[A-Z]:/WINNT/$Nt*Uninstall*"
1131 WildDir = "[A-Z]:/WINNT/sysvol"
1132 WildFile = "[A-Z]:/WINNT/cluster/CLUSDB"
1133 WildFile = "[A-Z]:/WINNT/cluster/CLUSDB.LOG"
1134 WildFile = "[A-Z]:/WINNT/NTDS/edb.log"
1135 WildFile = "[A-Z]:/WINNT/NTDS/ntds.dit"
1136 WildFile = "[A-Z]:/WINNT/NTDS/temp.edb"
1137 WildFile = "[A-Z]:/WINNT/ntfrs/jet/log/edb.log"
1138 WildFile = "[A-Z]:/WINNT/ntfrs/jet/ntfrs.jdb"
1139 WildFile = "[A-Z]:/WINNT/ntfrs/jet/temp/tmp.edb"
1140 WildFile = "[A-Z]:/WINNT/system32/CPL.CFG"
1141 WildFile = "[A-Z]:/WINNT/system32/dhcp/dhcp.mdb"
1142 WildFile = "[A-Z]:/WINNT/system32/dhcp/j50.log"
1143 WildFile = "[A-Z]:/WINNT/system32/dhcp/tmp.edb"
1144 WildFile = "[A-Z]:/WINNT/system32/LServer/edb.log"
1145 WildFile = "[A-Z]:/WINNT/system32/LServer/TLSLic.edb"
1146 WildFile = "[A-Z]:/WINNT/system32/LServer/tmp.edb"
1147 WildFile = "[A-Z]:/WINNT/system32/wins/j50.log"
1148 WildFile = "[A-Z]:/WINNT/system32/wins/wins.mdb"
1149 WildFile = "[A-Z]:/WINNT/system32/wins/winstmp.mdb"
1151 # Temporary directories & files
1152 WildDir = "[A-Z]:/WINNT/Temp"
1153 WildDir = "[A-Z]:/temp"
1155 WildDir = "[A-Z]:/tmp"
1156 WildDir = "[A-Z]:/var/tmp"
1159 WildDir = "[A-Z]:/RECYCLER"
1162 WildFile = "[A-Z]:/pagefile.sys"
1164 # These are programs and are easier to reinstall than restore from
1166 WildDir = "[A-Z]:/cygwin"
1167 WildDir = "[A-Z]:/Program Files/Grisoft"
1168 WildDir = "[A-Z]:/Program Files/Java"
1169 WildDir = "[A-Z]:/Program Files/Java Web Start"
1170 WildDir = "[A-Z]:/Program Files/JavaSoft"
1171 WildDir = "[A-Z]:/Program Files/Microsoft Office"
1172 WildDir = "[A-Z]:/Program Files/Mozilla Firefox"
1173 WildDir = "[A-Z]:/Program Files/Mozilla Thunderbird"
1174 WildDir = "[A-Z]:/Program Files/mozilla.org"
1175 WildDir = "[A-Z]:/Program Files/OpenOffice*"
1178 # Our Win2k boxen all have C: and D: as the main hard drives.
1186 Note, the three line of the above Exclude were split to fit on the document
1187 page, they should be written on a single line in real use.
1189 \paragraph*{Windows NTFS Naming Considerations}
1190 \index[general]{Windows NTFS Naming Considerations }
1191 \index[general]{Considerations!Windows NTFS Naming }
1192 \addcontentsline{toc}{paragraph}{Windows NTFS Naming Considerations}
1194 NTFS filenames containing Unicode characters should now be supported
1195 as of version 1.37.30 or later.
1197 \subsubsection*{Testing Your FileSet}
1198 \index[general]{FileSet!Testing Your }
1199 \index[general]{Testing Your FileSet }
1200 \addcontentsline{toc}{subsection}{Testing Your FileSet}
1202 If you wish to get an idea of what your FileSet will really backup or if your
1203 exclusion rules will work correctly, you can test it by using the {\bf
1204 estimate} command in the Console program. See the
1205 \ilink{estimate command}{estimate} in the Console chapter of this