1 \section{The FileSet Resource}
2 \label{FileSetResource}
3 \index[general]{Resource!FileSet}
4 \index[general]{FileSet Resource}
6 The FileSet resource defines what files are to be included or excluded in a
7 backup job. A {\bf FileSet} resource is required for each backup Job. It
8 consists of a list of files or directories to be included, a list of files
9 or directories to be excluded and the various backup options such as
10 compression, encryption, and signatures that are to be applied to each
13 Any change to the list of the included files will cause Bacula to
14 automatically create a new FileSet (defined by the name and an MD5 checksum
15 of the Include/Exclude contents). Each time a new FileSet is created,
16 Bacula will ensure that the next backup is always a Full save.
18 Bacula is designed to handle most character sets of the world,
19 US ASCII, German, French, Chinese, \ldots{} However, it does this by
20 encoding everything in UTF-8, and it expects all configuration files
21 (including those read on Win32 machines) to be in UTF-8 format.
22 UTF-8 is typically the default on Linux machines, but not on all
23 Unix machines, nor on Windows, so you must take some care to ensure
24 that your locale is set properly before starting Bacula.
25 On most modern Win32 machines, you can edit the conf files with {\bf
26 notebook} and choose output encoding UTF-8.
28 To ensure that Bacula configuration files can be correctly read including
29 foreign characters the {bf LANG} environment variable
30 must end in {\bf .UTF-8}. An full example is {\bf en\_US.UTF-8}. The
31 exact syntax may vary a bit from OS to OS, and exactly how you define
34 Bacula assumes that all filenames are in UTF-8 format on Linux and
35 Unix machines. On Win32 they are in Unicode (UTF-16), and will
36 be automatically converted to UTF-8 format.
43 \index[dir]{Directive!FileSet}
44 Start of the FileSet resource. One {\bf FileSet} resource must be
45 defined for each Backup job.
47 \item [Name = \lt{}name\gt{}]
49 \index[dir]{Directive!Name}
50 The name of the FileSet resource. This directive is required.
52 \item [Ignore FileSet Changes = \lt{}yes\vb{}no\gt{}]
53 \index[dir]{Ignore FileSet Changes}
54 \index[dir]{Directive!Ignore FileSet Changes}
55 Normally, if you modify the FileSet Include or Exclude lists,
56 the next backup will be forced to a Full so that Bacula can
57 guarantee that any additions or deletions are properly saved.
59 We strongly recommend against setting this directive to yes,
60 since doing so may cause you to have an incomplete set of backups.
62 If this directive is set to {\bf yes}, any changes you make to the
63 FileSet Include or Exclude lists, will not force a Full during
66 The default is {\bf no}, in which case, if you change the Include or
67 Exclude, Bacula will force a Full backup to ensure that everything is
70 \item [Enable VSS = \lt{}yes\vb{}no\gt{}]
71 \index[dir]{Enable VSS}
72 \index[dir]{Directive!Enable VSS}
73 If this directive is set to {\bf yes} the File daemon will be notified
74 that the user wants to use a Volume Shadow Copy Service (VSS) backup
75 for this job. The default is {\bf yes}. This directive is effective
76 only for VSS enabled Win32 File daemons. It permits a consistent copy
77 of open files to be made for cooperating writer applications, and for
78 applications that are not VSS away, Bacula can at least copy open files.
79 The Volume Shadow Copy will only be done on Windows drives where the
80 drive (e.g. C:, D:, \ldots{}) is explicitly mentioned in a {\bf File}
82 For more information, please see the
83 \ilink{Windows}{VSS} chapter of this manual.
86 \item [Include \{ Options \{\lt{}file-options\gt{}\} \ldots{};
87 \lt{}file-list\gt{} \} ]
88 \index[dir]{Include \{ [ Options \{\lt{}file-options\gt{}\} \ldots{}]
89 \lt{}file-list\gt{} \} }
90 \index[dir]{Directive!Include}
92 \item [Options \{ \lt{}file-options\gt{} \} ]
93 \index[dir]{Options \{ \lt{}file-options\gt{} \} }
95 \item [Exclude \{ \lt{}file-list\gt{} \}]
96 \index[dir]{Exclude \{ \lt{}file-list\gt{} \} }
97 \index[dir]{Directive!Exclude}
102 The Include resource must contain a list of directories and/or files to be
103 processed in the backup job. Normally, all files found in all
104 subdirectories of any directory in the Include File list will be backed up.
105 Note, see below for the definition of \lt{}file-list\gt{}.
106 The Include resource may also contain one or more Options resources that
107 specify options such as compression to be applied to all or any subset of
108 the files found when processing the file-list for backup. Please see
109 below for more details concerning Options resources.
111 There can be any number of {\bf Include} resources within the FileSet, each
112 having its own list of directories or files to be backed up and the backup
113 options defined by one or more Options resources. The {\bf file-list}
114 consists of one file or directory name per line. Directory names should be
115 specified without a trailing slash with Unix path notation.
117 Windows users, please take note to specify directories (even c:/\ldots{}) in
118 Unix path notation. If you use Windows conventions, you will most likely
119 not be able to restore your files due to the fact that the Windows
120 path separator was defined as an escape character long before Windows
121 existed, and Bacula adheres to that convention (i.e. \\ means the next character
124 You should always specify a full path for every directory and file that you
125 list in the FileSet. In addition, on Windows machines, you should {\bf
126 always} prefix the directory or filename with the drive specification
127 (e.g. {\bf c:/xxx}) using Unix directory name separators
128 (forward slash). The drive letter itself can be upper or lower case (e.g.
131 Bacula's default for processing directories is to recursively descend in
132 the directory saving all files and subdirectories. Bacula will not by
133 default cross filesystems (or mount points in Unix parlance). This means
134 that if you specify the root partition (e.g. {\bf /}), Bacula will save
135 only the root partition and not any of the other mounted filesystems.
136 Similarly on Windows systems, you must explicitly specify each of the
137 drives you want saved (e.g.
138 {\bf c:/} and {\bf d:/} \ldots{}). In addition, at least for Windows systems, you
139 will most likely want to enclose each specification within double quotes
140 particularly if the directory (or file) name contains spaces. The {\bf df}
141 command on Unix systems will show you which mount points you must specify to
142 save everything. See below for an example.
144 Take special care not to include a directory twice or Bacula will backup
145 the same files two times wasting a lot of space on your archive device.
146 Including a directory twice is very easy to do. For example:
151 Options { compression=GZIP }
158 on a Unix system where /usr is a subdirectory (rather than a mounted
159 filesystem) will cause /usr to be backed up twice.
161 Please take note of the following items in the FileSet syntax:
164 \item There is no equal sign (=) after the Include and before the opening
165 brace (\{). The same is true for the Exclude.
166 \item Each directory (or filename) to be included or excluded is preceded by a {\bf File
167 =}. Previously they were simply listed on separate lines.
168 \item The options that previously appeared on the Include line now must be
169 specified within their own Options resource.
170 \item The Exclude resource does not accept Options.
171 \item When using wild-cards or regular expressions, directory names are
172 always terminated with a slash (/) and filenames have no trailing slash.
175 The Options resource is optional, but when specified, it will contain a
176 list of {\bf keyword=value} options to be applied to the file-list.
177 See below for the definition of file-list.
178 Multiple Options resources may be specified one after another. As the
179 files are found in the specified directories, the Options will applied to
180 the filenames to determine if and how the file should be backed up. The
181 wildcard and regular expression pattern matching parts of the
182 Options resources are checked in the order they are specified in the
183 FileSet until the first one that matches. Once one matches, the
184 compression and other flags within the Options specification will
185 apply to the pattern matched.
187 A key point is that in the absence of an Option or no other Option is
188 matched, every file is accepted for backing up. This means that if
189 you want to exclude something, you must explicitly specify an Option
190 with an {\bf exclude = yes} and some pattern matching.
192 Once Bacula determines that the Options resource matches the file under
193 consideration, that file will be saved without looking at any other Options
194 resources that may be present. This means that any wild cards must appear
195 before an Options resource without wild cards.
197 If for some reason, Bacula checks all the Options resources to a file under
198 consideration for backup, but there are no matches (generally because of wild
199 cards that don't match), Bacula as a default will then backup the file. This
200 is quite logical if you consider the case of no Options clause is specified,
201 where you want everything to be backed up, and it is important to keep in mind
202 when excluding as mentioned above.
204 However, one additional point is that in the case that no match was found,
205 Bacula will use the options found in the last Options resource. As a
206 consequence, if you want a particular set of "default" options, you should put
207 them in an Options resource after any other Options.
209 It is a good idea to put all your wild-card and regex expressions inside
210 double quotes to prevent conf file scanning problems.
212 This is perhaps a bit overwhelming, so there are a number of examples included
213 below to illustrate how this works.
215 You find yourself using a lot of Regex statements, which will cost quite a lot
216 of CPU time, we recommend you simplify them if you can, or better yet
217 convert them to Wild statements which are much more efficient.
219 The directives within an Options resource may be one of the following:
223 \item [compression=GZIP]
224 \index[dir]{compression}
225 \index[dir]{Directive!compression}
226 All files saved will be software compressed using the GNU ZIP
227 compression format. The compression is done on a file by file basis by
228 the File daemon. If there is a problem reading the tape in a single
229 record of a file, it will at most affect that file and none of the other
230 files on the tape. Normally this option is {\bf not} needed if you have
231 a modern tape drive as the drive will do its own compression. In fact,
232 if you specify software compression at the same time you have hardware
233 compression turned on, your files may actually take more space on the
236 Software compression is very important if you are writing your Volumes
237 to a file, and it can also be helpful if you have a fast computer but a
238 slow network, otherwise it is generally better to rely your tape drive's
239 hardware compression. As noted above, it is not generally a good idea
240 to do both software and hardware compression.
242 Specifying {\bf GZIP} uses the default compression level 6 (i.e. {\bf
243 GZIP} is identical to {\bf GZIP6}). If you want a different compression
244 level (1 through 9), you can specify it by appending the level number
245 with no intervening spaces to {\bf GZIP}. Thus {\bf compression=GZIP1}
246 would give minimum compression but the fastest algorithm, and {\bf
247 compression=GZIP9} would give the highest level of compression, but
248 requires more computation. According to the GZIP documentation,
249 compression levels greater than six generally give very little extra
250 compression and are rather CPU intensive.
252 You can overwrite this option per Storage resource with
253 \ilink{AllowCompression}{AllowCompression} option.
255 \item [compression=LZO]
256 \index[dir]{compression}
257 \index[dir]{Directive!compression}
258 All files saved will be software compressed using the LZO
259 compression format. The compression is done on a file by file basis by
260 the File daemon. Everything else about GZIP is true for LZO.
262 LZO provides much faster compression and decompression speed but lower
263 compression ratio than GZIP. If your CPU is fast enough you should be able
264 to compress your data without making the backup duration longer.
266 Note that bacula only use one compression level LZO1X-1 specified by LZO.
268 You can overwrite this option per Storage resource with
269 \ilink{AllowCompression}{AllowCompression} option.
271 \item [signature=SHA1]
272 \index[dir]{signature}
274 \index[dir]{Directive!signature}
275 An SHA1 signature will be computed for all The SHA1 algorithm is
276 purported to be some what slower than the MD5 algorithm, but at the same
277 time is significantly better from a cryptographic point of view (i.e.
278 much fewer collisions, much lower probability of being hacked.) It adds
279 four more bytes than the MD5 signature. We strongly recommend that
280 either this option or MD5 be specified as a default for all files.
281 Note, only one of the two options MD5 or SHA1 can be computed for any
284 \item [signature=MD5]
285 \index[dir]{signature}
287 \index[dir]{Directive!signature}
288 An MD5 signature will be computed for all files saved. Adding this
289 option generates about 5\% extra overhead for each file saved. In
290 addition to the additional CPU time, the MD5 signature adds 16 more
291 bytes per file to your catalog. We strongly recommend that this option
292 or the SHA1 option be specified as a default for all files.
295 \item[basejob=\lt{}options\gt{}]
297 \index[dir]{Directive!basejob}
299 The options letters specified are used when running a {\bf Backup Level=Full}
300 with BaseJobs. The options letters are the same than in the \textbf{verify=}
303 \item[accurate=\lt{}options\gt{}]
304 \index[dir]{accurate}
305 \index[dir]{Directive!accurate}
306 The options letters specified are used when running a {\bf Backup
307 Level=Incremental/Differential} in Accurate mode. The options
308 letters are the same than in the \textbf{verify=} option below.
310 \item [verify=\lt{}options\gt{}]
312 \index[dir]{Directive!verify}
313 The options letters specified are used when running a {\bf Verify
314 Level=Catalog} as well as the {\bf DiskToCatalog} level job. The options
315 letters may be any combination of the following:
323 compare the permission bits
326 compare the number of links
338 compare the access time
341 compare the modification time (st\_mtime)
344 compare the change time (st\_ctime)
347 report file size decreases
350 compare the MD5 signature
353 compare the SHA1 signature
356 A useful set of general options on the {\bf Level=Catalog} or {\bf
357 Level=DiskToCatalog} verify is {\bf pins5} i.e. compare permission bits,
358 inodes, number of links, size, and MD5 changes.
360 \item [onefs=yes\vb{}no]
362 \index[dir]{Directive!onefs}
363 If set to {\bf yes} (the default), {\bf Bacula} will remain on a single
364 file system. That is it will not backup file systems that are mounted
365 on a subdirectory. If you are using a *nix system, you may not even be
366 aware that there are several different filesystems as they are often
367 automatically mounted by the OS (e.g. /dev, /net, /sys, /proc, \ldots{}).
368 With Bacula 1.38.0 or later, it will inform you when it decides not to
369 traverse into another filesystem. This can be very useful if you forgot
370 to backup a particular partition. An example of the informational
371 message in the job report is:
375 rufus-fd: /misc is a different filesystem. Will not descend from / into /misc
376 rufus-fd: /net is a different filesystem. Will not descend from / into /net
377 rufus-fd: /var/lib/nfs/rpc_pipefs is a different filesystem. Will not descend from /var/lib/nfs into /var/lib/nfs/rpc_pipefs
378 rufus-fd: /selinux is a different filesystem. Will not descend from / into /selinux
379 rufus-fd: /sys is a different filesystem. Will not descend from / into /sys
380 rufus-fd: /dev is a different filesystem. Will not descend from / into /dev
381 rufus-fd: /home is a different filesystem. Will not descend from / into /home
385 Note: in previous versions of Bacula, the above message was of the form:
389 Filesystem change prohibited. Will not descend into /misc
393 If you wish to backup multiple filesystems, you can explicitly
394 list each filesystem you want saved. Otherwise, if you set the onefs option
395 to {\bf no}, Bacula will backup all mounted file systems (i.e. traverse mount
396 points) that are found within the {\bf FileSet}. Thus if you have NFS or
397 Samba file systems mounted on a directory listed in your FileSet, they will
398 also be backed up. Normally, it is preferable to set {\bf onefs=yes} and to
399 explicitly name each filesystem you want backed up. Explicitly naming the
400 filesystems you want backed up avoids the possibility of getting into a
401 infinite loop recursing filesystems. Another possibility is to
402 use {\bf onefs=no} and to set {\bf fstype=ext2, \ldots{}}.
403 See the example below for more details.
405 If you think that Bacula should be backing up a particular directory
406 and it is not, and you have {\bf onefs=no} set, before you complain,
416 where you replace {\bf filesystem} with the one in question. If the
417 {\bf Device:} number is different for / and for your filesystem, then they
418 are on different filesystems. E.g.
423 Size: 4096 Blocks: 16 IO Block: 4096 directory
424 Device: 302h/770d Inode: 2 Links: 26
425 Access: (0755/drwxr-xr-x) Uid: ( 0/ root) Gid: ( 0/ root)
426 Access: 2005-11-10 12:28:01.000000000 +0100
427 Modify: 2005-09-27 17:52:32.000000000 +0200
428 Change: 2005-09-27 17:52:32.000000000 +0200
432 Size: 4096 Blocks: 16 IO Block: 4096 directory
433 Device: 308h/776d Inode: 2 Links: 7
434 Access: (0755/drwxr-xr-x) Uid: ( 0/ root) Gid: ( 0/ root)
435 Access: 2005-11-10 12:28:02.000000000 +0100
436 Modify: 2005-11-06 12:36:48.000000000 +0100
437 Change: 2005-11-06 12:36:48.000000000 +0100
441 Also be aware that even if you include {\bf /home} in your list
442 of files to backup, as you most likely should, you will get the
443 informational message that "/home is a different filesystem" when
444 Bacula is processing the {\bf /} directory. This message does not
445 indicate an error. This message means that while examining the
446 {\bf File =} referred to in the second part of the message, Bacula will
447 not descend into the directory mentioned in the first part of the message.
448 However, it is possible that the separate filesystem will be backed up
449 despite the message. For example, consider the following FileSet:
458 where {\bf /var} is a separate filesystem. In this example, you will get a
459 message saying that Bacula will not decend from {\bf /} into {\bf /var}. But
460 it is important to realise that Bacula will descend into {\bf /var} from the
461 second File directive shown above. In effect, the warning is bogus,
462 but it is supplied to alert you to possible omissions from your FileSet. In
463 this example, {\bf /var} will be backed up. If you changed the FileSet such
464 that it did not specify {\bf /var}, then {\bf /var} will not be backed up.
467 \item [honor nodump flag=\lt{}yes\vb{}no\gt{}]
468 \index[dir]{honornodumpflag}
469 \index[dir]{Directive!honornodumpflag}
470 If your file system supports the {\bf nodump} flag (e. g. most
471 BSD-derived systems) Bacula will honor the setting of the flag
472 when this option is set to {\bf yes}. Files having this flag set
473 will not be included in the backup and will not show up in the
474 catalog. For directories with the {\bf nodump} flag set recursion
475 is turned off and the directory will be listed in the catalog.
476 If the {\bf honor nodump flag} option is not defined
477 or set to {\bf no} every file and directory will be eligible for
482 \item [portable=yes\vb{}no]
483 \index[dir]{portable}
484 \index[dir]{Directive!portable}
485 If set to {\bf yes} (default is {\bf no}), the Bacula File daemon will
486 backup Win32 files in a portable format, but not all Win32 file
487 attributes will be saved and restored. By default, this option is set
488 to {\bf no}, which means that on Win32 systems, the data will be backed
489 up using Windows API calls and on WinNT/2K/XP, all the security and
490 ownership attributes will be properly backed up (and restored). However
491 this format is not portable to other systems -- e.g. Unix, Win95/98/Me.
492 When backing up Unix systems, this option is ignored, and unless you
493 have a specific need to have portable backups, we recommend accept the
494 default ({\bf no}) so that the maximum information concerning your files
497 \item [recurse=yes\vb{}no]
499 \index[dir]{Directive!recurse}
500 If set to {\bf yes} (the default), Bacula will recurse (or descend) into
501 all subdirectories found unless the directory is explicitly excluded
502 using an {\bf exclude} definition. If you set {\bf recurse=no}, Bacula
503 will save the subdirectory entries, but not descend into the
504 subdirectories, and thus will not save the files or directories
505 contained in the subdirectories. Normally, you will want the default
508 \item [sparse=yes\vb{}no]
510 \index[dir]{Directive!sparse}
511 Enable special code that checks for sparse files such as created by
512 ndbm. The default is {\bf no}, so no checks are made for sparse files.
513 You may specify {\bf sparse=yes} even on files that are not sparse file.
514 No harm will be done, but there will be a small additional overhead to
515 check for buffers of all zero, and a small additional amount of space on
516 the output archive will be used to save the seek address of each
517 non-zero record read.
519 {\bf Restrictions:} Bacula reads files in 32K buffers. If the whole
520 buffer is zero, it will be treated as a sparse block and not written to
521 tape. However, if any part of the buffer is non-zero, the whole buffer
522 will be written to tape, possibly including some disk sectors (generally
523 4098 bytes) that are all zero. As a consequence, Bacula's detection of
524 sparse blocks is in 32K increments rather than the system block size.
525 If anyone considers this to be a real problem, please send in a request
526 for change with the reason.
528 If you are not familiar with sparse files, an example is say a file
529 where you wrote 512 bytes at address zero, then 512 bytes at address 1
530 million. The operating system will allocate only two blocks, and the
531 empty space or hole will have nothing allocated. However, when you read
532 the sparse file and read the addresses where nothing was written, the OS
533 will return all zeros as if the space were allocated, and if you backup
534 such a file, a lot of space will be used to write zeros to the volume.
535 Worse yet, when you restore the file, all the previously empty space
536 will now be allocated using much more disk space. By turning on the
537 {\bf sparse} option, Bacula will specifically look for empty space in
538 the file, and any empty space will not be written to the Volume, nor
539 will it be restored. The price to pay for this is that Bacula must
540 search each block it reads before writing it. On a slow system, this
541 may be important. If you suspect you have sparse files, you should
542 benchmark the difference or set sparse for only those files that are
546 \item [readfifo=yes\vb{}no]
547 \index[dir]{readfifo}
548 \index[dir]{Directive!readfifo}
549 If enabled, tells the Client to read the data on a backup and write the
550 data on a restore to any FIFO (pipe) that is explicitly mentioned in the
551 FileSet. In this case, you must have a program already running that
552 writes into the FIFO for a backup or reads from the FIFO on a restore.
553 This can be accomplished with the {\bf RunBeforeJob} directive. If this
554 is not the case, Bacula will hang indefinitely on reading/writing the
555 FIFO. When this is not enabled (default), the Client simply saves the
556 directory entry for the FIFO.
558 Unfortunately, when Bacula runs a RunBeforeJob, it waits until that
559 script terminates, and if the script accesses the FIFO to write
560 into the it, the Bacula job will block and everything will stall.
561 However, Vladimir Stavrinov as supplied tip that allows this feature
562 to work correctly. He simply adds the following to the beginning
563 of the RunBeforeJob script:
569 \item [noatime=yes\vb{}no]
571 \index[dir]{Directive!noatime}
572 If enabled, and if your Operating System supports the O\_NOATIME file
573 open flag, Bacula will open all files to be backed up with this option.
574 It makes it possible to read a file without updating the inode atime
575 (and also without the inode ctime update which happens if you try to set
576 the atime back to its previous value). It also prevents a race
577 condition when two programs are reading the same file, but only one does
578 not want to change the atime. It's most useful for backup programs and
579 file integrity checkers (and bacula can fit on both categories).
581 This option is particularly useful for sites where users are sensitive
582 to their MailBox file access time. It replaces both the {\bf keepatime}
583 option without the inconveniences of that option (see below).
585 If your Operating System does not support this option, it will be
586 silently ignored by Bacula.
589 \item [mtimeonly=yes\vb{}no]
590 \index[dir]{mtimeonly}
591 \index[dir]{Directive!mtimeonly}
592 If enabled, tells the Client that the selection of files during
593 Incremental and Differential backups should based only on the st\_mtime
594 value in the stat() packet. The default is {\bf no} which means that
595 the selection of files to be backed up will be based on both the
596 st\_mtime and the st\_ctime values. In general, it is not recommended
599 \item [keepatime=yes\vb{}no]
600 \index[dir]{keepatime}
601 \index[dir]{Directive!keepatime}
602 The default is {\bf no}. When enabled, Bacula will reset the st\_atime
603 (access time) field of files that it backs up to their value prior to
604 the backup. This option is not generally recommended as there are very
605 few programs that use st\_atime, and the backup overhead is increased
606 because of the additional system call necessary to reset the times.
607 However, for some files, such as mailboxes, when Bacula backs up the
608 file, the user will notice that someone (Bacula) has accessed the
609 file. In this, case keepatime can be useful.
610 (I'm not sure this works on Win32).
612 Note, if you use this feature, when Bacula resets the access time, the
613 change time (st\_ctime) will automatically be modified by the system,
614 so on the next incremental job, the file will be backed up even if
615 it has not changed. As a consequence, you will probably also want
616 to use {\bf mtimeonly = yes} as well as keepatime (thanks to
617 Rudolf Cejka for this tip).
619 \item [checkfilechanges=yes\vb{}no]
620 \index[dir]{checkfilechanges}
621 \index[dir]{Directive!checkfilechanges}
622 On versions 2.0.4 or greater,
623 if enabled, the Client will check size, age of each file after
624 their backup to see if they have changed during backup. If time
625 or size mismatch, an error will raise.
628 zog-fd: Client1.2007-03-31_09.46.21 Error: /tmp/test mtime changed during backup.
631 In general, it is recommended to use this option.
633 \item [hardlinks=yes\vb{}no]
634 \index[dir]{hardlinks}
635 \index[dir]{Directive!hardlinks}
636 When enabled (default), this directive will cause hard links to be
637 backed up. However, the File daemon keeps track of hard linked files and
638 will backup the data only once. The process of keeping track of the
639 hard links can be quite expensive if you have lots of them (tens of
640 thousands or more). This doesn't occur on normal Unix systems, but if
641 you use a program like BackupPC, it can create hundreds of thousands, or
642 even millions of hard links. Backups become very long and the File daemon
643 will consume a lot of CPU power checking hard links. In such a case,
644 set {\bf hardlinks=no} and hard links will not be backed up. Note, using
645 this option will most likely backup more data and on a restore the file
646 system will not be restored identically to the original.
648 \item [wild=\lt{}string\gt{}]
650 \index[dir]{Directive!wild}
651 Specifies a wild-card string to be applied to the filenames and
652 directory names. Note, if {\bf Exclude} is not enabled, the wild-card
653 will select which files are to be included. If {\bf Exclude=yes} is
654 specified, the wild-card will select which files are to be excluded.
655 Multiple wild-card directives may be specified, and they will be applied
656 in turn until the first one that matches. Note, if you exclude a
657 directory, no files or directories below it will be matched.
659 You may want to test your expressions prior to running your
660 backup by using the bwild program. Please see the
661 \bsysxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
662 more information. You can also test your full FileSet definition by using
663 the \bsysxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
664 It is recommended to enclose the string in double quotes.
666 \item [wilddir=\lt{}string\gt{}]
668 \index[dir]{Directive!wilddir}
669 Specifies a wild-card string to be applied to directory names only. No
670 filenames will be matched by this directive. Note, if {\bf Exclude} is
671 not enabled, the wild-card will select directories to be
672 included. If {\bf Exclude=yes} is specified, the wild-card will select
673 which directories are to be excluded. Multiple wild-card directives may be
674 specified, and they will be applied in turn until the first one that
675 matches. Note, if you exclude a directory, no files or directories
676 below it will be matched.
678 It is recommended to enclose the string in double quotes.
680 You may want to test your expressions prior to running your
681 backup by using the bwild program. Please see the
682 \bsysxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
683 more information. You can also test your full FileSet definition by using
684 the \bsysxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
685 An example of excluding with the WildDir option on Win32 machines is
688 \item [wildfile=\lt{}string\gt{}]
689 \index[dir]{wildfile}
690 \index[dir]{Directive!wildfile}
691 Specifies a wild-card string to be applied to non-directories. That
692 is no directory entries will be matched by this directive.
693 However, note that the match is done against the full path and filename,
694 so your wild-card string must take into account that filenames
695 are preceded by the full path.
697 is not enabled, the wild-card will select which files are to be
698 included. If {\bf Exclude=yes} is specified, the wild-card will select
699 which files are to be excluded. Multiple wild-card directives may be
700 specified, and they will be applied in turn until the first one that
703 It is recommended to enclose the string in double quotes.
705 You may want to test your expressions prior to running your
706 backup by using the bwild program. Please see the
707 \bsysxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
708 more information. You can also test your full FileSet definition by using
709 the \bsysxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
710 An example of excluding with the WildFile option on Win32 machines is
714 \item [regex=\lt{}string\gt{}]
716 \index[dir]{Directive!regex}
717 Specifies a POSIX extended regular expression to be applied to the
718 filenames and directory names, which include the full path. If {\bf
719 Exclude} is not enabled, the regex will select which files are to be
720 included. If {\bf Exclude=yes} is specified, the regex will select
721 which files are to be excluded. Multiple regex directives may be
722 specified within an Options resource, and they will be applied in turn
723 until the first one that matches. Note, if you exclude a directory, no
724 files or directories below it will be matched.
726 It is recommended to enclose the string in double quotes.
728 The regex libraries differ from one operating system to
729 another, and in addition, regular expressions are complicated,
730 so you may want to test your expressions prior to running your
731 backup by using the bregex program. Please see the
732 \bsysxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for
733 more information. You can also test your full FileSet definition by using
734 the \bsysxrlink{estimate}{estimate}{console}{command} in the \consoleman{}.
737 You find yourself using a lot of Regex statements, which will cost quite a
738 lot of CPU time, we recommend you simplify them if you can, or better yet
739 convert them to Wild statements which are much more efficient.
742 \item [regexfile=\lt{}string\gt{}]
743 \index[dir]{regexfile}
744 \index[dir]{Directive!regexfile}
745 Specifies a POSIX extended regular expression to be applied to
746 non-directories. No directories will be matched by this directive.
747 However, note that the match is done against the full path and
748 filename, so your regex string must take into account that filenames
749 are preceded by the full path.
750 If {\bf Exclude} is not enabled, the regex will select which files are
751 to be included. If {\bf Exclude=yes} is specified, the regex will
752 select which files are to be excluded. Multiple regex directives may be
753 specified, and they will be applied in turn until the first one that
756 It is recommended to enclose the string in double quotes.
758 The regex libraries differ from one operating system to
759 another, and in addition, regular expressions are complicated,
760 so you may want to test your expressions prior to running your
761 backup by using the bregex program. Please see the
762 \bsysxrlink{bregex}{bregex}{utility}{command} of the \utilityman{} more.
765 \item [regexdir=\lt{}string\gt{}]
766 \index[dir]{regexdir}
767 \index[dir]{Directive!regexdir}
768 Specifies a POSIX extended regular expression to be applied to directory
769 names only. No filenames will be matched by this directive. Note, if
770 {\bf Exclude} is not enabled, the regex will select directories
771 files are to be included. If {\bf Exclude=yes} is specified, the
772 regex will select which files are to be excluded. Multiple
773 regex directives may be specified, and they will be applied in turn
774 until the first one that matches. Note, if you exclude a directory, no
775 files or directories below it will be matched.
777 It is recommended to enclose the string in double quotes.
779 The regex libraries differ from one operating system to
780 another, and in addition, regular expressions are complicated,
781 so you may want to test your expressions prior to running your
782 backup by using the bregex program. Please see the
783 \bsysxrlink{bregex}{bregex}{utility}{command} of the \utilityman{} more.
786 \item [exclude=yes\vb{}no]
788 \index[dir]{Directive!exclude}
789 The default is {\bf no}. When enabled, any files matched within the
790 Options will be excluded from the backup.
793 \item [aclsupport=yes\vb{}no]
794 \index[dir]{aclsupport}
795 \index[dir]{Directive!aclsupport}
796 The default is {\bf no}. If this option is set to yes, and you have the
797 POSIX {\bf libacl} installed on your Linux system, Bacula will backup the
798 file and directory Unix Access Control Lists (ACL) as defined in IEEE Std
799 1003.1e draft 17 and "POSIX.1e" (abandoned). This feature is
800 available on Unix systems only and requires the Linux ACL library. Bacula is
801 automatically compiled with ACL support if the {\bf libacl} library is
802 installed on your Linux system (shown in config.out). While restoring the
803 files Bacula will try to restore the ACLs, if there is no ACL support
804 available on the system, Bacula restores the files and directories but
805 not the ACL information. Please note, if you backup an EXT3 or XFS
806 filesystem with ACLs, then you restore them to a different filesystem
807 (perhaps reiserfs) that does not have ACLs, the ACLs will be ignored.
809 For other operating systems there is support for either POSIX ACLs or
810 the more extensible NFSv4 ACLs.
812 The ACL stream format between Operation Systems is \textbf{not}
813 compatible so for example an ACL saved on Linux cannot be restored on
816 The following Operating Systems are currently supported:
819 \item AIX (pre-5.3 (POSIX) and post 5.3 (POSIX and NFSv4) ACLs)
821 \item FreeBSD (POSIX and NFSv4/ZFS ACLs)
825 \item Solaris (POSIX and NFSv4/ZFS ACLs)
830 \item [xattrsupport=yes\vb{}no]
831 \index[dir]{xattrsupport}
832 \index[dir]{Directive!xattrsupport}
833 The default is {\bf no}. If this option is set to yes, and your
834 operating system support either so called Extended Attributes or
835 Extensible Attributes Bacula will backup the file and directory
836 XATTR data. This feature is available on UNIX only and depends on
837 support of some specific library calls in libc.
839 The XATTR stream format between Operating Systems is {\bf not}
840 compatible so an XATTR saved on Linux cannot for example be restored
843 On some operating systems ACLs are also stored as Extended Attributes
844 (Linux, Darwin, FreeBSD) Bacula checks if you have the aclsupport
845 option enabled and if so will not save the same info when saving
846 extended attribute information. Thus ACLs are only saved once.
848 The following Operating Systems are currently supported:
851 \item AIX (Extended Attributes)
852 \item Darwin (Extended Attributes)
853 \item FreeBSD (Extended Attributes)
854 \item IRIX (Extended Attributes)
855 \item Linux (Extended Attributes)
856 \item NetBSD (Extended Attributes)
857 \item Solaris (Extended Attributes and Extensible Attributes)
858 \item Tru64 (Extended Attributes)
861 \item [ignore case=yes\vb{}no]
862 \index[dir]{ignore case}
863 \index[dir]{Directive!ignore case}
864 The default is {\bf no}. On Windows systems, you will almost surely
865 want to set this to {\bf yes}. When this directive is set to {\bf yes}
866 all the case of character will be ignored in wild-card and regex
867 comparisons. That is an uppercase A will match a lowercase a.
869 \item [fstype=filesystem-type]
871 \index[dir]{Directive!fstype}
872 This option allows you to select files and directories by the
873 filesystem type. The permitted filesystem-type names are:
875 ext2, jfs, ntfs, proc, reiserfs, xfs, usbdevfs, sysfs, smbfs,
876 iso9660. For ext3 systems, use ext2.
878 You may have multiple Fstype directives, and thus permit matching
879 of multiple filesystem types within a single Options resource. If
880 the type specified on the fstype directive does not match the
881 filesystem for a particular directive, that directory will not be
882 backed up. This directive can be used to prevent backing up
883 non-local filesystems. Normally, when you use this directive, you
884 would also set {\bf onefs=no} so that Bacula will traverse filesystems.
886 This option is not implemented in Win32 systems.
888 \item [DriveType=Windows-drive-type]
889 \index[dir]{DriveType}
890 \index[dir]{Directive!DriveType}
891 This option is effective only on Windows machines and is
892 somewhat similar to the Unix/Linux {\bf fstype} described
893 above, except that it allows you to select what Windows
894 drive types you want to allow. By default all drive
897 The permitted drivetype names are:
899 removable, fixed, remote, cdrom, ramdisk
901 You may have multiple Driveype directives, and thus permit matching
902 of multiple drive types within a single Options resource. If
903 the type specified on the drivetype directive does not match the
904 filesystem for a particular directive, that directory will not be
905 backed up. This directive can be used to prevent backing up
906 non-local filesystems. Normally, when you use this directive, you
907 would also set {\bf onefs=no} so that Bacula will traverse filesystems.
909 This option is not implemented in Unix/Linux systems.
912 \item [hfsplussupport=yes\vb{}no]
913 \index[dir]{hfsplussupport}
914 \index[dir]{Directive!hfsplussupport}
915 This option allows you to turn on support for Mac OSX HFS plus
918 \item [strippath=\lt{}integer\gt{}]
919 \index[dir]{strippath}
920 \index[dir]{Directive!strippath}
921 This option will cause {\bf integer} paths to be stripped from
922 the front of the full path/filename being backed up. This can
923 be useful if you are migrating data from another vendor or if
924 you have taken a snapshot into some subdirectory. This directive
925 can cause your filenames to be overlayed with regular backup data,
926 so should be used only by experts and with great care.
929 {\bf \lt{}file-list\gt{}} is a list of directory and/or filename names
930 specified with a {\bf File =} directive. To include names containing spaces,
931 enclose the name between double-quotes. Wild-cards are not interpreted
932 in file-lists. They can only be specified in Options resources.
934 There are a number of special cases when specifying directories and files in a
935 {\bf file-list}. They are:
938 \item Any name preceded by an at-sign (@) is assumed to be the name of a
939 file, which contains a list of files each preceded by a "File =". The
940 named file is read once when the configuration file is parsed during the
941 Director startup. Note, that the file is read on the Director's machine
942 and not on the Client's. In fact, the @filename can appear anywhere
943 within the conf file where a token would be read, and the contents of
944 the named file will be logically inserted in the place of the @filename.
945 What must be in the file depends on the location the @filename is
946 specified in the conf file. For example:
951 Options { compression=GZIP }
952 @/home/files/my-files
957 \item Any name beginning with a vertical bar (\vb) is assumed to be the name of
958 a program. This program will be executed on the Director's machine at
959 the time the Job starts (not when the Director reads the configuration
960 file), and any output from that program will be assumed to be a list of
961 files or directories, one per line, to be included. Before submitting the
962 specified command bacula will performe
963 \ilink{character substitution}{character substitution}.
965 This allows you to have a job that, for example, includes all the local
966 partitions even if you change the partitioning by adding a disk. The
967 examples below show you how to do this. However, please note two
969 1. if you want the local filesystems, you probably should be
970 using the new {\bf fstype} directive, which was added in version 1.36.3
971 and set {\bf onefs=no}.
974 2. the exact syntax of the command needed in the examples below is very
975 system dependent. For example, on recent Linux systems, you may need to
976 add the -P option, on FreeBSD systems, the options will be different as
979 In general, you will need to prefix your command or commands with a {\bf
980 sh -c} so that they are invoked by a shell. This will not be the case
981 if you are invoking a script as in the second example below. Also, you
982 must take care to escape (precede with a \textbackslash{}) wild-cards,
983 shell character, and to ensure that any spaces in your command are
984 escaped as well. If you use a single quotes (') within a double quote
985 ("), Bacula will treat everything between the single quotes as one field
986 so it will not be necessary to escape the spaces. In general, getting
987 all the quotes and escapes correct is a real pain as you can see by the
988 next example. As a consequence, it is often easier to put everything in
989 a file and simply use the file name within Bacula. In that case the
990 {\bf sh -c} will not be necessary providing the first line of the file
999 Options { signature = SHA1 }
1000 File = "|sh -c 'df -l | grep \"^/dev/hd[ab]\" | grep -v \".*/tmp\" \
1001 | awk \"{print \\$6}\"'"
1006 will produce a list of all the local partitions on a Red Hat Linux system.
1007 Note, the above line was split, but should normally be written on one line.
1008 Quoting is a real problem because you must quote for Bacula which consists of
1009 preceding every \textbackslash{} and every " with a \textbackslash{}, and
1010 you must also quote for the shell command. In the end, it is probably easier
1011 just to execute a small file with:
1020 File = "|my_partitions"
1025 where my\_partitions has:
1030 df -l | grep "^/dev/hd[ab]" | grep -v ".*/tmp" \
1035 If the vertical bar (\lstinline+|+) in front of my\_partitions is preceded by a
1036 backslash as in \textbackslash{}\lstinline+|+, the program will be executed on the
1037 Client's machine instead of on the Director's machine.
1038 Please note that if the filename is given within quotes, you
1039 will need to use two slashes. An example, provided by John Donagher,
1040 that backs up all the local UFS partitions on a remote system is:
1045 Name = "All local partitions"
1047 Options { signature=SHA1; onefs=yes; }
1048 File = "\\|bash -c \"df -klF ufs | tail +2 | awk '{print \$6}'\""
1054 The above requires two backslash characters after the double quote (one
1055 preserves the next one). If you are a Linux user, just change the {\bf ufs}
1056 to {\bf ext3} (or your preferred filesystem type), and you will be in
1059 If you know what filesystems you have mounted on your system, e.g.
1060 for Red Hat Linux normally only ext2 and ext3, you can backup
1061 all local filesystems using something like:
1067 Options { signature = SHA1; onfs=no; fstype=ext2 }
1074 \item Any file-list item preceded by a less-than sign (\lt{}) will be taken
1075 to be a file. This file will be read on the Director's machine (see
1076 below for doing it on the Client machine) at the time
1077 the Job starts, and the data will be assumed to be a list of directories or
1078 files, one per line, to be included. The names should start in column 1 and
1079 should not be quoted even if they contain spaces. This feature allows you to
1080 modify the external file and change what will be saved without stopping and
1081 restarting Bacula as would be necessary if using the @ modifier noted above.
1087 Options { signature = SHA1 }
1088 File = "</home/files/local-filelist"
1093 If you precede the less-than sign (\lt{}) with a backslash as in
1094 \textbackslash{}\lt{}, the file-list will be read on the Client machine
1095 instead of on the Director's machine. Please note that if the filename
1096 is given within quotes, you will need to use two slashes.
1101 Options { signature = SHA1 }
1102 File = "\\</home/xxx/filelist-on-client"
1107 \item If you explicitly specify a block device such as {\bf /dev/hda1}, then
1108 Bacula (starting with version 1.28) will assume that this is a raw partition
1109 to be backed up. In this case, you are strongly urged to specify a {\bf
1110 sparse=yes} include option, otherwise, you will save the whole partition
1111 rather than just the actual data that the partition contains. For example:
1116 Options { signature=MD5; sparse=yes }
1122 will backup the data in device /dev/hd6. Note, the {bf /dev/hd6} must be
1123 the raw partition itself. Bacula will not back it up as a raw device if
1124 you specify a symbolic link to a raw device such as my be created by the
1125 LVM Snapshot utilities.
1127 Ludovic Strappazon has pointed out that this feature can be used to backup a
1128 full Microsoft Windows disk. Simply boot into the system using a Linux Rescue
1129 disk, then load a statically linked Bacula as described in the
1130 \ilink{ Disaster Recovery Using Bacula}{RescueChapter} chapter of
1131 this manual. Then save the whole disk partition. In the case of a disaster,
1132 you can then restore the desired partition by again booting with the rescue
1133 disk and doing a restore of the partition.
1134 \item If you explicitly specify a FIFO device name (created with mkfifo), and
1135 you add the option {\bf readfifo=yes} as an option, Bacula will read the FIFO
1136 and back its data up to the Volume. For example:
1145 File = /home/abc/fifo
1150 if {\bf /home/abc/fifo} is a fifo device, Bacula will open the fifo,
1151 read it, and store all data thus obtained on the Volume. Please note,
1152 you must have a process on the system that is writing into the fifo, or
1153 Bacula will hang, and after one minute of waiting, Bacula will give up
1154 and go on to the next file. The data read can be anything since Bacula
1155 treats it as a stream.
1157 This feature can be an excellent way to do a "hot" backup of a very
1158 large database. You can use the {\bf RunBeforeJob} to create the fifo
1159 and to start a program that dynamically reads your database and writes
1160 it to the fifo. Bacula will then write it to the Volume. Be sure to
1161 read the \ilink{readfifo section}{readfifo} that gives a
1162 tip to ensure that the RunBeforeJob does not block Bacula.
1164 During the restore operation, the inverse is true, after Bacula creates
1165 the fifo if there was any data stored with it (no need to explicitly
1166 list it or add any options), that data will be written back to the fifo.
1167 As a consequence, if any such FIFOs exist in the fileset to be restored,
1168 you must ensure that there is a reader program or Bacula will block, and
1169 after one minute, Bacula will time out the write to the fifo and move on
1172 \item A file-list may not contain wild-cards. Use directives in the
1173 Options resource if you wish to specify wild-cards or regular expression
1177 \index[general]{IgnoreDir}
1178 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a directive that
1179 can be added to the Include section of the FileSet resource. If the specified
1180 filename ({\bf filename-string}) is found on the Client in any directory to be
1181 backed up, the whole directory will be ignored (not backed up). For example:
1184 # List of files to be backed up
1192 Exclude Dir Containing = .excludeme
1197 But in /home, there may be hundreds of directories of users and some
1198 people want to indicate that they don't want to have certain
1199 directories backed up. For example, with the above FileSet, if
1200 the user or sysadmin creates a file named {\bf .excludeme} in
1201 specific directories, such as
1204 /home/user/www/cache/.excludeme
1205 /home/user/temp/.excludeme
1208 then Bacula will not backup the two directories named:
1211 /home/user/www/cache
1215 NOTE: subdirectories will not be backed up. That is, the directive
1216 applies to the two directories in question and any children (be they
1217 files, directories, etc).
1221 \section{FileSet Examples}
1222 \index[general]{Examples!FileSet }
1223 \index[general]{FileSet Examples}
1225 The following is an example of a valid FileSet resource definition. Note,
1226 the first Include pulls in the contents of the file {\bf /etc/backup.list}
1227 when Bacula is started (i.e. the @), and that file must have each filename
1228 to be backed up preceded by a {\bf File =} and on a separate line.
1249 File = /usr/lib/another_file
1255 In the above example, all the files contained in /etc/backup.list will
1256 be compressed with GZIP compression, an SHA1 signature will be computed on the
1257 file's contents (its data), and sparse file handling will apply.
1259 The two directories /root/myfile and /usr/lib/another\_file will also be saved
1260 without any options, but all files in those directories with the extensions
1261 {\bf .o} and {\bf .exe} will be excluded.
1263 Let's say that you now want to exclude the directory /tmp. The simplest way
1264 to do so is to add an exclude directive that lists /tmp. The example
1265 above would then become:
1286 File = /usr/lib/another_file
1289 File = /tmp # don't add trailing /
1296 You can add wild-cards to the File directives listed in the Exclude
1297 directory, but you need to take care because if you exclude a directory,
1298 it and all files and directories below it will also be excluded.
1300 Now lets take a slight variation on the above and suppose
1301 you want to save all your whole filesystem except {\bf /tmp}.
1302 The problem that comes up is that Bacula will not normally
1303 cross from one filesystem to another.
1304 Doing a {\bf df} command, you get the following output:
1309 Filesystem 1k-blocks Used Available Use% Mounted on
1310 /dev/hda5 5044156 439232 4348692 10% /
1311 /dev/hda1 62193 4935 54047 9% /boot
1312 /dev/hda9 20161172 5524660 13612372 29% /home
1313 /dev/hda2 62217 6843 52161 12% /rescue
1314 /dev/hda8 5044156 42548 4745376 1% /tmp
1315 /dev/hda6 5044156 2613132 2174792 55% /usr
1316 none 127708 0 127708 0% /dev/shm
1317 //minimatou/c$ 14099200 9895424 4203776 71% /mnt/mmatou
1318 lmatou:/ 1554264 215884 1258056 15% /mnt/matou
1319 lmatou:/home 2478140 1589952 760072 68% /mnt/matou/home
1320 lmatou:/usr 1981000 1199960 678628 64% /mnt/matou/usr
1321 lpmatou:/ 995116 484112 459596 52% /mnt/pmatou
1322 lpmatou:/home 19222656 2787880 15458228 16% /mnt/pmatou/home
1323 lpmatou:/usr 2478140 2038764 311260 87% /mnt/pmatou/usr
1324 deuter:/ 4806936 97684 4465064 3% /mnt/deuter
1325 deuter:/home 4806904 280100 4282620 7% /mnt/deuter/home
1326 deuter:/files 44133352 27652876 14238608 67% /mnt/deuter/files
1330 And we see that there are a number of separate filesystems (/ /boot
1331 /home /rescue /tmp and /usr not to mention mounted systems).
1332 If you specify only {\bf /} in your Include list, Bacula will only save the
1333 Filesystem {\bf /dev/hda5}. To save all filesystems except {\bf /tmp} with
1334 out including any of the Samba or NFS mounted systems, and explicitly
1335 excluding a /tmp, /proc, .journal, and .autofsck, which you will not want to
1336 be saved and restored, you can use the following:
1341 Name = Include_example
1346 wildfile = "/.journal"
1347 wildfile = "/.autofsck"
1360 Since /tmp is on its own filesystem and it was not explicitly named in the
1361 Include list, it is not really needed in the exclude list. It is better to
1362 list it in the Exclude list for clarity, and in case the disks are changed so
1363 that it is no longer in its own partition.
1365 Now, lets assume you only want to backup .Z and .gz files and nothing
1366 else. This is a bit trickier because Bacula by default will select
1367 everything to backup, so we must exclude everything but .Z and .gz files.
1368 If we take the first example above and make the obvious modifications
1369 to it, we might come up with a FileSet that looks like this:
1375 Include { !!!!!!!!!!!!
1377 wildfile = "*.Z" example
1378 wildfile = "*.gz" doesn't
1387 The *.Z and *.gz files will indeed be backed up, but all other files
1388 that are not matched by the Options directives will automatically
1389 be backed up too (i.e. that is the default rule).
1391 To accomplish what we want, we must explicitly exclude all other files.
1392 We do this with the following:
1413 The "trick" here was to add a RegexFile expression that matches
1414 all files. It does not match directory names, so all directories in
1415 /myfile will be backed up (the directory entry) and any *.Z and *.gz
1416 files contained in them. If you know that certain directories do
1417 not contain any *.Z or *.gz files and you do not want the directory
1418 entries backed up, you will need to explicitly exclude those directories.
1419 Backing up a directory entries is not very expensive.
1421 Bacula uses the system regex library and some of them are
1422 different on different OSes. The above has been reported not to work
1423 on FreeBSD. This can be tested by using the {\bf estimate job=job-name
1424 listing} command in the console and adapting the RegexFile expression
1425 appropriately. In a future version of Bacula, we will supply our own
1426 Regex code to avoid such system dependencies.
1428 Please be aware that allowing Bacula to traverse or change file systems can be
1429 {\bf very} dangerous. For example, with the following:
1434 Name = "Bad example"
1436 Options { onefs=no }
1443 you will be backing up an NFS mounted partition ({\bf /mnt/matou}), and since
1444 {\bf onefs} is set to {\bf no}, Bacula will traverse file systems. Now if {\bf
1445 /mnt/matou} has the current machine's file systems mounted, as is often the
1446 case, you will get yourself into a recursive loop and the backup will never
1449 As a final example, let's say that you have only one or two
1450 subdirectories of /home that you want to backup. For example,
1451 you want to backup only subdirectories beginning with the letter
1452 a and the letter b -- i.e. /home/a* and /home/b*. Now, you might first
1460 wilddir = "/home/a*"
1461 wilddir = "/home/b*"
1469 The problem is that the above will include everything in /home. To get
1470 things to work correctly, you need to start with the idea of exclusion
1471 instead of inclusion. So, you could simply exclude all directories
1472 except the two you want to use:
1479 RegexDir = "^/home/[c-z]"
1488 And assuming that all subdirectories start with a lowercase letter, this
1491 An alternative would be to include the two subdirectories desired and
1492 exclude everything else:
1499 wilddir = "/home/a*"
1500 wilddir = "/home/b*"
1513 The following example shows how to back up only the My Pictures directory inside
1514 the My Documents directory for all users in C:/Documents and Settings, i.e.
1515 everything matching the pattern:
1517 C:/Documents and Settings/*/My Documents/My Pictures/*
1519 To understand how this can be achieved, there are two important points to
1522 Firstly, Bacula walks over the filesystem depth-first starting from the File =
1523 lines. It stops descending when a directory is excluded, so you must include
1524 all ancestor directories of each directory containing files to be included.
1526 Secondly, each directory and file is compared to the Options clauses in the
1527 order they appear in the FileSet. When a match is found, no further clauses
1528 are compared and the directory or file is either included or excluded.
1530 The FileSet resource definition below implements this by including specifc
1531 directories and files and excluding everything else.
1536 Name = "AllPictures"
1540 File = "C:/Documents and Settings"
1547 # Include all users' directories so we reach the inner ones. Unlike a
1548 # WildDir pattern ending in *, this RegExDir only matches the top-level
1549 # directories and not any inner ones.
1550 RegExDir = "^C:/Documents and Settings/[^/]+$"
1552 # Ditto all users' My Documents directories.
1553 WildDir = "C:/Documents and Settings/*/My Documents"
1555 # Ditto all users' My Documents/My Pictures directories.
1556 WildDir = "C:/Documents and Settings/*/My Documents/My Pictures"
1558 # Include the contents of the My Documents/My Pictures directories and
1559 # any subdirectories.
1560 Wild = "C:/Documents and Settings/*/My Documents/My Pictures/*"
1567 # Exclude everything else, in particular any files at the top level and
1568 # any other directories or files in the users' directories.
1569 Wild = "C:/Documents and Settings/*"
1576 \section{Backing up Raw Partitions}
1577 \index[general]{Backing up!Partitions }
1578 \index[general]{Backing up Raw Partitions }
1580 The following FileSet definition will backup a raw partition:
1585 Name = "RawPartition"
1587 Options { sparse=yes }
1594 While backing up and restoring a raw partition, you should ensure that no
1595 other process including the system is writing to that partition. As a
1596 precaution, you are strongly urged to ensure that the raw partition is not
1597 mounted or is mounted read-only. If necessary, this can be done using the {\bf
1598 RunBeforeJob} directive.
1601 \section{Excluding Files and Directories}
1602 \index[general]{Directories!Excluding Files and }
1603 \index[general]{Excluding Files and Directories }
1605 You may also include full filenames or directory names in addition to using
1606 wild-cards and {\bf Exclude=yes} in the Options resource as specified above by
1607 simply including the files to be excluded in an Exclude resource within the
1608 FileSet. It accepts wild-cards pattern, so for a directory, don't add a trailing
1614 Name = Exclusion_example
1627 File = /tmp # Don't add trailing /
1636 \section{Windows FileSets}
1637 \index[general]{Windows FileSets }
1638 \index[general]{FileSets!Windows }
1639 If you are entering Windows file names, the directory path may be preceded by
1640 the drive and a colon (as in c:). However, the path separators must be
1641 specified in Unix convention (i.e. forward slash (/)). If you wish to include
1642 a quote in a file name, precede the quote with a backslash
1643 (\textbackslash{}). For example you might use the following
1644 for a Windows machine to backup the "My Documents" directory:
1649 Name = "Windows Set"
1656 File = "c:/My Documents"
1662 For exclude lists to work correctly on Windows, you must observe the following
1666 \item Filenames are case sensitive, so you must use the correct case.
1667 \item To exclude a directory, you must not have a trailing slash on the
1669 \item If you have spaces in your filename, you must enclose the entire name
1670 in double-quote characters ("). Trying to use a backslash before the space
1672 \item If you are using the old Exclude syntax (noted below), you may not
1673 specify a drive letter in the exclude. The new syntax noted above
1674 should work fine including driver letters.
1677 Thanks to Thiago Lima for summarizing the above items for us. If you are
1678 having difficulties getting includes or excludes to work, you might want to
1679 try using the {\bf estimate job=xxx listing} command documented in the
1680 \bsysxrlink{estimate}{estimate}{console}{command} of \consoleman{}.
1682 On Win32 systems, if you move a directory or file or rename a file into the
1683 set of files being backed up, and a Full backup has already been made, Bacula
1684 will not know there are new files to be saved during an Incremental or
1685 Differential backup (blame Microsoft, not me). To avoid this problem, please
1686 {\bf copy} any new directory or files into the backup area. If you do not have
1687 enough disk to copy the directory or files, move them, but then initiate a
1691 \paragraph*{A Windows Example FileSet}
1692 \index[general]{FileSet!Windows Example }
1693 \index[general]{Windows Example FileSet }
1695 The following example was contributed by Russell Howe. Please note that
1696 for presentation purposes, the lines beginning with Data and Internet
1697 have been wrapped and should included on the previous line with one
1702 This is my Windows 2000 fileset:
1704 Name = "Windows 2000"
1710 # Exclude Mozilla-based programs' file caches
1711 WildDir = "[A-Z]:/Documents and Settings/*/Application
1712 Data/*/Profiles/*/*/Cache"
1713 WildDir = "[A-Z]:/Documents and Settings/*/Application
1714 Data/*/Profiles/*/*/Cache.Trash"
1715 WildDir = "[A-Z]:/Documents and Settings/*/Application
1716 Data/*/Profiles/*/*/ImapMail"
1718 # Exclude user's registry files - they're always in use anyway.
1719 WildFile = "[A-Z]:/Documents and Settings/*/Local Settings/Application
1720 Data/Microsoft/Windows/usrclass.*"
1721 WildFile = "[A-Z]:/Documents and Settings/*/ntuser.*"
1723 # Exclude directories full of lots and lots of useless little files
1724 WildDir = "[A-Z]:/Documents and Settings/*/Cookies"
1725 WildDir = "[A-Z]:/Documents and Settings/*/Recent"
1726 WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/History"
1727 WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/Temp"
1728 WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/Temporary
1731 # These are always open and unable to be backed up
1732 WildFile = "[A-Z]:/Documents and Settings/All Users/Application
1733 Data/Microsoft/Network/Downloader/qmgr[01].dat"
1735 # Some random bits of Windows we want to ignore
1736 WildFile = "[A-Z]:/WINNT/security/logs/scepol.log"
1737 WildDir = "[A-Z]:/WINNT/system32/config"
1738 WildDir = "[A-Z]:/WINNT/msdownld.tmp"
1739 WildDir = "[A-Z]:/WINNT/Internet Logs"
1740 WildDir = "[A-Z]:/WINNT/$Nt*Uninstall*"
1741 WildDir = "[A-Z]:/WINNT/sysvol"
1742 WildFile = "[A-Z]:/WINNT/cluster/CLUSDB"
1743 WildFile = "[A-Z]:/WINNT/cluster/CLUSDB.LOG"
1744 WildFile = "[A-Z]:/WINNT/NTDS/edb.log"
1745 WildFile = "[A-Z]:/WINNT/NTDS/ntds.dit"
1746 WildFile = "[A-Z]:/WINNT/NTDS/temp.edb"
1747 WildFile = "[A-Z]:/WINNT/ntfrs/jet/log/edb.log"
1748 WildFile = "[A-Z]:/WINNT/ntfrs/jet/ntfrs.jdb"
1749 WildFile = "[A-Z]:/WINNT/ntfrs/jet/temp/tmp.edb"
1750 WildFile = "[A-Z]:/WINNT/system32/CPL.CFG"
1751 WildFile = "[A-Z]:/WINNT/system32/dhcp/dhcp.mdb"
1752 WildFile = "[A-Z]:/WINNT/system32/dhcp/j50.log"
1753 WildFile = "[A-Z]:/WINNT/system32/dhcp/tmp.edb"
1754 WildFile = "[A-Z]:/WINNT/system32/LServer/edb.log"
1755 WildFile = "[A-Z]:/WINNT/system32/LServer/TLSLic.edb"
1756 WildFile = "[A-Z]:/WINNT/system32/LServer/tmp.edb"
1757 WildFile = "[A-Z]:/WINNT/system32/wins/j50.log"
1758 WildFile = "[A-Z]:/WINNT/system32/wins/wins.mdb"
1759 WildFile = "[A-Z]:/WINNT/system32/wins/winstmp.mdb"
1761 # Temporary directories & files
1762 WildDir = "[A-Z]:/WINNT/Temp"
1763 WildDir = "[A-Z]:/temp"
1765 WildDir = "[A-Z]:/tmp"
1766 WildDir = "[A-Z]:/var/tmp"
1769 WildDir = "[A-Z]:/RECYCLER"
1772 WildFile = "[A-Z]:/pagefile.sys"
1774 # These are programs and are easier to reinstall than restore from
1776 WildDir = "[A-Z]:/cygwin"
1777 WildDir = "[A-Z]:/Program Files/Grisoft"
1778 WildDir = "[A-Z]:/Program Files/Java"
1779 WildDir = "[A-Z]:/Program Files/Java Web Start"
1780 WildDir = "[A-Z]:/Program Files/JavaSoft"
1781 WildDir = "[A-Z]:/Program Files/Microsoft Office"
1782 WildDir = "[A-Z]:/Program Files/Mozilla Firefox"
1783 WildDir = "[A-Z]:/Program Files/Mozilla Thunderbird"
1784 WildDir = "[A-Z]:/Program Files/mozilla.org"
1785 WildDir = "[A-Z]:/Program Files/OpenOffice*"
1788 # Our Win2k boxen all have C: and D: as the main hard drives.
1796 Note, the three line of the above Exclude were split to fit on the document
1797 page, they should be written on a single line in real use.
1799 \paragraph*{Windows NTFS Naming Considerations}
1800 \index[general]{Windows NTFS Naming Considerations }
1801 \index[general]{Considerations!Windows NTFS Naming }
1803 NTFS filenames containing Unicode characters should now be supported
1804 as of version 1.37.30 or later.
1806 \section{Testing Your FileSet}
1807 \index[general]{FileSet!Testing Your }
1808 \index[general]{Testing Your FileSet }
1810 If you wish to get an idea of what your FileSet will really backup or if your
1811 exclusion rules will work correctly, you can test it by using the {\bf
1812 estimate} command in the Console program. See the
1813 \bsysxrlink{estimate}{estimate}{console}{command} of \consoleman{}.
1815 As an example, suppose you add the following test FileSet:
1822 File = /home/xxx/test
1831 You could then add some test files to the directory {\bf /home/xxx/test}
1832 and use the following command in the console:
1836 estimate job=<any-job-name> listing client=<desired-client> fileset=Test
1840 to give you a listing of all files that match. In the above
1841 example, it should be only files with names ending in \textbf{.c}.