4 \section{The FileSet Resource}
5 \label{FileSetResource}
6 \index[general]{Resource!FileSet}
7 \index[general]{FileSet Resource}
9 The FileSet resource defines what files are to be included or excluded in a
10 backup job. A {\bf FileSet} resource is required for each backup Job. It
11 consists of a list of files or directories to be included, a list of files
12 or directories to be excluded and the various backup options such as
13 compression, encryption, and signatures that are to be applied to each
16 Any change to the list of the included files will cause Bacula to
17 automatically create a new FileSet (defined by the name and an MD5 checksum
18 of the Include/Exclude contents). Each time a new FileSet is created,
19 Bacula will ensure that the next backup is always a Full save.
21 Bacula is designed to handle most character sets of the world,
22 US ASCII, German, French, Chinese, ... However, it does this by
23 encoding everything in UTF-8, and it expects all configuration files
24 (including those read on Win32 machines) to be in UTF-8 format.
25 UTF-8 is typically the default on Linux machines, but not on all
26 Unix machines, nor on Windows, so you must take some care to ensure
27 that your locale is set properly before starting Bacula.
28 On most modern Win32 machines, you can edit the conf files with {\bf
29 notebook} and choose output encoding UTF-8.
31 To ensure that Bacula configuration files can be correctly read including
32 foreign characters the {bf LANG} environment variable
33 must end in {\bf .UTF-8}. An full example is {\bf en\_US.UTF-8}. The
34 exact syntax may vary a bit from OS to OS, and exactly how you define
37 Bacula assumes that all filenames are in UTF-8 format on Linux and
38 Unix machines. On Win32 they are in Unicode (UTF-16), and will
39 be automatically converted to UTF-8 format.
46 \index[dir]{Directive!FileSet}
47 Start of the FileSet resource. One {\bf FileSet} resource must be
48 defined for each Backup job.
50 \item [Name = \lt{}name\gt{}]
52 \index[dir]{Directive!Name}
53 The name of the FileSet resource. This directive is required.
55 \item [Ignore FileSet Changes = \lt{}yes\vb{}no\gt{}]
56 \index[dir]{Ignore FileSet Changes}
57 \index[dir]{Directive!Ignore FileSet Changes}
58 Normally, if you modify the FileSet Include or Exclude lists,
59 the next backup will be forced to a Full so that Bacula can
60 guarantee that any additions or deletions are properly saved.
62 We strongly recommend against setting this directive to yes,
63 since doing so may cause you to have an incomplete set of backups.
65 If this directive is set to {\bf yes}, any changes you make to the
66 FileSet Include or Exclude lists, will not force a Full during
69 The default is {\bf no}, in which case, if you change the Include or
70 Exclude, Bacula will force a Full backup to ensure that everything is
73 \item [Enable VSS = \lt{}yes\vb{}no\gt{}]
74 \index[dir]{Enable VSS}
75 \index[dir]{Directive!Enable VSS}
76 If this directive is set to {\bf yes} the File daemon will be notified
77 that the user wants to use a Volume Shadow Copy Service (VSS) backup
78 for this job. The default is {\bf yes}. This directive is effective
79 only for VSS enabled Win32 File daemons. It permits a consistent copy
80 of open files to be made for cooperating writer applications, and for
81 applications that are not VSS away, Bacula can at least copy open files.
82 For more information, please see the
83 \ilink{Windows}{VSS} chapter of this manual.
86 \item [Include \{ Options \{\lt{}file-options\gt{}\} ...;
87 \lt{}file-list\gt{} \} ]
88 \index[dir]{Include \{ [ Options \{\lt{}file-options\gt{}\} ...]
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:/...) 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:/} ...). 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:
153 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. In this case, on Bacula
160 versions prior to 1.32f-5-09Mar04 due to a bug, you will not be able to
161 restore hard linked files that were backed up twice.
163 If you have used Bacula prior to version 1.36.3, you will note three things in
164 the new FileSet syntax:
167 \item There is no equal sign (=) after the Include and before the opening
168 brace (\{). The same is true for the Exclude.
169 \item Each directory (or filename) to be included or excluded is preceded by a {\bf File
170 =}. Previously they were simply listed on separate lines.
171 \item The options that previously appeared on the Include line now must be
172 specified within their own Options resource.
173 \item The Exclude resource does not accept Options.
174 \item When using wild-cards or regular expressions, directory names are
175 always terminated with a slash (/) and filenames have no trailing slash.
178 The Options resource is optional, but when specified, it will contain a
179 list of {\bf keyword=value} options to be applied to the file-list.
180 See below for the definition of file-list.
181 Multiple Options resources may be specified one after another. As the
182 files are found in the specified directories, the Options will applied to
183 the filenames to determine if and how the file should be backed up. The
184 wildcard and regular expression pattern matching parts of the
185 Options resources are checked in the order they are specified in the
186 FileSet until the first one that matches. Once one matches, the
187 compression and other flags within the Options specification will
188 apply to the pattern matched.
190 A key point is that in the absence of an Option or no other Option is
191 matched, every file is accepted for backing up. This means that if
192 you want to exclude something, you must explicitly specify an Option
193 with an {\bf exclude = yes} and some pattern matching.
195 Once Bacula determines that the Options resource matches the file under
196 consideration, that file will be saved without looking at any other Options
197 resources that may be present. This means that any wild cards must appear
198 before an Options resource without wild cards.
200 If for some reason, Bacula checks all the Options resources to a file under
201 consideration for backup, but there are no matches (generally because of wild
202 cards that don't match), Bacula as a default will then backup the file. This
203 is quite logical if you consider the case of no Options clause is specified,
204 where you want everything to be backed up, and it is important to keep in mind
205 when excluding as mentioned above.
207 However, one additional point is that in the case that no match was found,
208 Bacula will use the options found in the last Options resource. As a
209 consequence, if you want a particular set of "default" options, you should put
210 them in an Options resource after any other Options.
212 It is a good idea to put all your wild-card and regex expressions inside
213 double quotes to prevent conf file scanning problems.
215 This is perhaps a bit overwhelming, so there are a number of examples included
216 below to illustrate how this works.
218 You find yourself using a lot of Regex statements, which will cost quite a lot
219 of CPU time, we recommend you simplify them if you can, or better yet
220 convert them to Wild statements which are much more efficient.
222 The directives within an Options resource may be one of the following:
226 \item [compression=GZIP]
227 \index[dir]{compression}
228 \index[dir]{Directive!compression}
229 All files saved will be software compressed using the GNU ZIP
230 compression format. The compression is done on a file by file basis by
231 the File daemon. If there is a problem reading the tape in a single
232 record of a file, it will at most affect that file and none of the other
233 files on the tape. Normally this option is {\bf not} needed if you have
234 a modern tape drive as the drive will do its own compression. In fact,
235 if you specify software compression at the same time you have hardware
236 compression turned on, your files may actually take more space on the
239 Software compression is very important if you are writing your Volumes
240 to a file, and it can also be helpful if you have a fast computer but a
241 slow network, otherwise it is generally better to rely your tape drive's
242 hardware compression. As noted above, it is not generally a good idea
243 to do both software and hardware compression.
245 Specifying {\bf GZIP} uses the default compression level 6 (i.e. {\bf
246 GZIP} is identical to {\bf GZIP6}). If you want a different compression
247 level (1 through 9), you can specify it by appending the level number
248 with no intervening spaces to {\bf GZIP}. Thus {\bf compression=GZIP1}
249 would give minimum compression but the fastest algorithm, and {\bf
250 compression=GZIP9} would give the highest level of compression, but
251 requires more computation. According to the GZIP documentation,
252 compression levels greater than six generally give very little extra
253 compression and are rather CPU intensive.
255 \item [signature=SHA1]
256 \index[dir]{signature}
258 \index[dir]{Directive!signature}
259 An SHA1 signature will be computed for all The SHA1 algorithm is
260 purported to be some what slower than the MD5 algorithm, but at the same
261 time is significantly better from a cryptographic point of view (i.e.
262 much fewer collisions, much lower probability of being hacked.) It adds
263 four more bytes than the MD5 signature. We strongly recommend that
264 either this option or MD5 be specified as a default for all files.
265 Note, only one of the two options MD5 or SHA1 can be computed for any
268 \item [signature=MD5]
269 \index[dir]{signature}
271 \index[dir]{Directive!signature}
272 An MD5 signature will be computed for all files saved. Adding this
273 option generates about 5\% extra overhead for each file saved. In
274 addition to the additional CPU time, the MD5 signature adds 16 more
275 bytes per file to your catalog. We strongly recommend that this option
276 or the SHA1 option be specified as a default for all files.
279 \item[basejob=\lt{}options\gt{}]
281 \index[dir]{Directive!basejob}
283 The options letters specified are used when running a {\bf Backup Level=Full}
284 with BaseJobs. The options letters are the same than in the \textbf{verify=}
287 \item[accurate=\lt{}options\gt{}]
288 \index[dir]{accurate}
289 \index[dir]{Directive!accurate}
290 The options letters specified are used when running a {\bf Backup
291 Level=Incremental/Differential} in Accurate mode. The options
292 letters are the same than in the \textbf{verify=} option below.
294 \item [verify=\lt{}options\gt{}]
296 \index[dir]{Directive!verify}
297 The options letters specified are used when running a {\bf Verify
298 Level=Catalog} as well as the {\bf DiskToCatalog} level job. The options
299 letters may be any combination of the following:
307 compare the permission bits
310 compare the number of links
322 compare the access time
325 compare the modification time (st\_mtime)
328 compare the change time (st\_ctime)
331 report file size decreases
334 compare the MD5 signature
337 compare the SHA1 signature
340 A useful set of general options on the {\bf Level=Catalog} or {\bf
341 Level=DiskToCatalog} verify is {\bf pins5} i.e. compare permission bits,
342 inodes, number of links, size, and MD5 changes.
344 \item [onefs=yes\vb{}no]
346 \index[dir]{Directive!onefs}
347 If set to {\bf yes} (the default), {\bf Bacula} will remain on a single
348 file system. That is it will not backup file systems that are mounted
349 on a subdirectory. If you are using a *nix system, you may not even be
350 aware that there are several different filesystems as they are often
351 automatically mounted by the OS (e.g. /dev, /net, /sys, /proc, ...).
352 With Bacula 1.38.0 or later, it will inform you when it decides not to
353 traverse into another filesystem. This can be very useful if you forgot
354 to backup a particular partition. An example of the informational
355 message in the job report is:
359 rufus-fd: /misc is a different filesystem. Will not descend from / into /misc
360 rufus-fd: /net is a different filesystem. Will not descend from / into /net
361 rufus-fd: /var/lib/nfs/rpc_pipefs is a different filesystem. Will not descend from /var/lib/nfs into /var/lib/nfs/rpc_pipefs
362 rufus-fd: /selinux is a different filesystem. Will not descend from / into /selinux
363 rufus-fd: /sys is a different filesystem. Will not descend from / into /sys
364 rufus-fd: /dev is a different filesystem. Will not descend from / into /dev
365 rufus-fd: /home is a different filesystem. Will not descend from / into /home
369 Note: in previous versions of Bacula, the above message was of the form:
373 Filesystem change prohibited. Will not descend into /misc
377 If you wish to backup multiple filesystems, you can explicitly
378 list each filesystem you want saved. Otherwise, if you set the onefs option
379 to {\bf no}, Bacula will backup all mounted file systems (i.e. traverse mount
380 points) that are found within the {\bf FileSet}. Thus if you have NFS or
381 Samba file systems mounted on a directory listed in your FileSet, they will
382 also be backed up. Normally, it is preferable to set {\bf onefs=yes} and to
383 explicitly name each filesystem you want backed up. Explicitly naming the
384 filesystems you want backed up avoids the possibility of getting into a
385 infinite loop recursing filesystems. Another possibility is to
386 use {\bf onefs=no} and to set {\bf fstype=ext2, ...}.
387 See the example below for more details.
389 If you think that Bacula should be backing up a particular directory
390 and it is not, and you have {\bf onefs=no} set, before you complain,
400 where you replace {\bf filesystem} with the one in question. If the
401 {\bf Device:} number is different for / and for your filesystem, then they
402 are on different filesystems. E.g.
407 Size: 4096 Blocks: 16 IO Block: 4096 directory
408 Device: 302h/770d Inode: 2 Links: 26
409 Access: (0755/drwxr-xr-x) Uid: ( 0/ root) Gid: ( 0/ root)
410 Access: 2005-11-10 12:28:01.000000000 +0100
411 Modify: 2005-09-27 17:52:32.000000000 +0200
412 Change: 2005-09-27 17:52:32.000000000 +0200
416 Size: 4096 Blocks: 16 IO Block: 4096 directory
417 Device: 308h/776d Inode: 2 Links: 7
418 Access: (0755/drwxr-xr-x) Uid: ( 0/ root) Gid: ( 0/ root)
419 Access: 2005-11-10 12:28:02.000000000 +0100
420 Modify: 2005-11-06 12:36:48.000000000 +0100
421 Change: 2005-11-06 12:36:48.000000000 +0100
425 Also be aware that even if you include {\bf /home} in your list
426 of files to backup, as you most likely should, you will get the
427 informational message that "/home is a different filesystem" when
428 Bacula is processing the {\bf /} directory. This message does not
429 indicate an error. This message means that while examining the
430 {\bf File =} referred to in the second part of the message, Bacula will
431 not descend into the directory mentioned in the first part of the message.
432 However, it is possible that the separate filesystem will be backed up
433 despite the message. For example, consider the following FileSet:
442 where {\bf /var} is a separate filesystem. In this example, you will get a
443 message saying that Bacula will not decend from {\bf /} into {\bf /var}. But
444 it is important to realise that Bacula will descend into {\bf /var} from the
445 second File directive shown above. In effect, the warning is bogus,
446 but it is supplied to alert you to possible omissions from your FileSet. In
447 this example, {\bf /var} will be backed up. If you changed the FileSet such
448 that it did not specify {\bf /var}, then {\bf /var} will not be backed up.
451 \item [honor nodump flag=\lt{}yes\vb{}no\gt{}]
452 \index[dir]{honornodumpflag}
453 \index[dir]{Directive!honornodumpflag}
454 If your file system supports the {\bf nodump} flag (e. g. most
455 BSD-derived systems) Bacula will honor the setting of the flag
456 when this option is set to {\bf yes}. Files having this flag set
457 will not be included in the backup and will not show up in the
458 catalog. For directories with the {\bf nodump} flag set recursion
459 is turned off and the directory will be listed in the catalog.
460 If the {\bf honor nodump flag} option is not defined
461 or set to {\bf no} every file and directory will be eligible for
466 \item [portable=yes\vb{}no]
467 \index[dir]{portable}
468 \index[dir]{Directive!portable}
469 If set to {\bf yes} (default is {\bf no}), the Bacula File daemon will
470 backup Win32 files in a portable format, but not all Win32 file
471 attributes will be saved and restored. By default, this option is set
472 to {\bf no}, which means that on Win32 systems, the data will be backed
473 up using Windows API calls and on WinNT/2K/XP, all the security and
474 ownership attributes will be properly backed up (and restored). However
475 this format is not portable to other systems -- e.g. Unix, Win95/98/Me.
476 When backing up Unix systems, this option is ignored, and unless you
477 have a specific need to have portable backups, we recommend accept the
478 default ({\bf no}) so that the maximum information concerning your files
481 \item [recurse=yes\vb{}no]
483 \index[dir]{Directive!recurse}
484 If set to {\bf yes} (the default), Bacula will recurse (or descend) into
485 all subdirectories found unless the directory is explicitly excluded
486 using an {\bf exclude} definition. If you set {\bf recurse=no}, Bacula
487 will save the subdirectory entries, but not descend into the
488 subdirectories, and thus will not save the files or directories
489 contained in the subdirectories. Normally, you will want the default
492 \item [sparse=yes\vb{}no]
494 \index[dir]{Directive!sparse}
495 Enable special code that checks for sparse files such as created by
496 ndbm. The default is {\bf no}, so no checks are made for sparse files.
497 You may specify {\bf sparse=yes} even on files that are not sparse file.
498 No harm will be done, but there will be a small additional overhead to
499 check for buffers of all zero, and a small additional amount of space on
500 the output archive will be used to save the seek address of each
501 non-zero record read.
503 {\bf Restrictions:} Bacula reads files in 32K buffers. If the whole
504 buffer is zero, it will be treated as a sparse block and not written to
505 tape. However, if any part of the buffer is non-zero, the whole buffer
506 will be written to tape, possibly including some disk sectors (generally
507 4098 bytes) that are all zero. As a consequence, Bacula's detection of
508 sparse blocks is in 32K increments rather than the system block size.
509 If anyone considers this to be a real problem, please send in a request
510 for change with the reason.
512 If you are not familiar with sparse files, an example is say a file
513 where you wrote 512 bytes at address zero, then 512 bytes at address 1
514 million. The operating system will allocate only two blocks, and the
515 empty space or hole will have nothing allocated. However, when you read
516 the sparse file and read the addresses where nothing was written, the OS
517 will return all zeros as if the space were allocated, and if you backup
518 such a file, a lot of space will be used to write zeros to the volume.
519 Worse yet, when you restore the file, all the previously empty space
520 will now be allocated using much more disk space. By turning on the
521 {\bf sparse} option, Bacula will specifically look for empty space in
522 the file, and any empty space will not be written to the Volume, nor
523 will it be restored. The price to pay for this is that Bacula must
524 search each block it reads before writing it. On a slow system, this
525 may be important. If you suspect you have sparse files, you should
526 benchmark the difference or set sparse for only those files that are
530 \item [readfifo=yes\vb{}no]
531 \index[dir]{readfifo}
532 \index[dir]{Directive!readfifo}
533 If enabled, tells the Client to read the data on a backup and write the
534 data on a restore to any FIFO (pipe) that is explicitly mentioned in the
535 FileSet. In this case, you must have a program already running that
536 writes into the FIFO for a backup or reads from the FIFO on a restore.
537 This can be accomplished with the {\bf RunBeforeJob} directive. If this
538 is not the case, Bacula will hang indefinitely on reading/writing the
539 FIFO. When this is not enabled (default), the Client simply saves the
540 directory entry for the FIFO.
542 Unfortunately, when Bacula runs a RunBeforeJob, it waits until that
543 script terminates, and if the script accesses the FIFO to write
544 into the it, the Bacula job will block and everything will stall.
545 However, Vladimir Stavrinov as supplied tip that allows this feature
546 to work correctly. He simply adds the following to the beginning
547 of the RunBeforeJob script:
553 \item [noatime=yes\vb{}no]
555 \index[dir]{Directive!noatime}
556 If enabled, and if your Operating System supports the O\_NOATIME file
557 open flag, Bacula will open all files to be backed up with this option.
558 It makes it possible to read a file without updating the inode atime
559 (and also without the inode ctime update which happens if you try to set
560 the atime back to its previous value). It also prevents a race
561 condition when two programs are reading the same file, but only one does
562 not want to change the atime. It's most useful for backup programs and
563 file integrity checkers (and bacula can fit on both categories).
565 This option is particularly useful for sites where users are sensitive
566 to their MailBox file access time. It replaces both the {\bf keepatime}
567 option without the inconveniences of that option (see below).
569 If your Operating System does not support this option, it will be
570 silently ignored by Bacula.
573 \item [mtimeonly=yes\vb{}no]
574 \index[dir]{mtimeonly}
575 \index[dir]{Directive!mtimeonly}
576 If enabled, tells the Client that the selection of files during
577 Incremental and Differential backups should based only on the st\_mtime
578 value in the stat() packet. The default is {\bf no} which means that
579 the selection of files to be backed up will be based on both the
580 st\_mtime and the st\_ctime values. In general, it is not recommended
583 \item [keepatime=yes\vb{}no]
584 \index[dir]{keepatime}
585 \index[dir]{Directive!keepatime}
586 The default is {\bf no}. When enabled, Bacula will reset the st\_atime
587 (access time) field of files that it backs up to their value prior to
588 the backup. This option is not generally recommended as there are very
589 few programs that use st\_atime, and the backup overhead is increased
590 because of the additional system call necessary to reset the times.
591 However, for some files, such as mailboxes, when Bacula backs up the
592 file, the user will notice that someone (Bacula) has accessed the
593 file. In this, case keepatime can be useful.
594 (I'm not sure this works on Win32).
596 Note, if you use this feature, when Bacula resets the access time, the
597 change time (st\_ctime) will automatically be modified by the system,
598 so on the next incremental job, the file will be backed up even if
599 it has not changed. As a consequence, you will probably also want
600 to use {\bf mtimeonly = yes} as well as keepatime (thanks to
601 Rudolf Cejka for this tip).
603 \item [checkfilechanges=yes\vb{}no]
604 \index[dir]{checkfilechanges}
605 \index[dir]{Directive!checkfilechanges}
606 On versions 2.0.4 or greater,
607 if enabled, the Client will checks size, age of each file after
608 their backup to see if they have changed during backup. If time
609 or size mismatch, an error will raise.
612 zog-fd: Client1.2007-03-31_09.46.21 Error: /tmp/test mtime changed during backup.
615 In general, it is recommended to use this option.
617 \item [hardlinks=yes\vb{}no]
618 \index[dir]{hardlinks}
619 \index[dir]{Directive!hardlinks}
620 When enabled (default), this directive will cause hard links to be
621 backed up. However, the File daemon keeps track of hard linked files and
622 will backup the data only once. The process of keeping track of the
623 hard links can be quite expensive if you have lots of them (tens of
624 thousands or more). This doesn't occur on normal Unix systems, but if
625 you use a program like BackupPC, it can create hundreds of thousands, or
626 even millions of hard links. Backups become very long and the File daemon
627 will consume a lot of CPU power checking hard links. In such a case,
628 set {\bf hardlinks=no} and hard links will not be backed up. Note, using
629 this option will most likely backup more data and on a restore the file
630 system will not be restored identically to the original.
632 \item [wild=\lt{}string\gt{}]
634 \index[dir]{Directive!wild}
635 Specifies a wild-card string to be applied to the filenames and
636 directory names. Note, if {\bf Exclude} is not enabled, the wild-card
637 will select which files are to be included. If {\bf Exclude=yes} is
638 specified, the wild-card will select which files are to be excluded.
639 Multiple wild-card directives may be specified, and they will be applied
640 in turn until the first one that matches. Note, if you exclude a
641 directory, no files or directories below it will be matched.
643 You may want to test your expressions prior to running your
644 backup by using the bwild program. Please see the
645 \ilink{Utilities}{bwild} chapter of this manual for
646 more. You can also test your full FileSet definition by using
647 the \ilink{estimate}{estimate} command in the Console
648 chapter of this manual.
649 It is recommended to enclose the string in double quotes.
651 \item [wilddir=\lt{}string\gt{}]
653 \index[dir]{Directive!wilddir}
654 Specifies a wild-card string to be applied to directory names only. No
655 filenames will be matched by this directive. Note, if {\bf Exclude} is
656 not enabled, the wild-card will select directories to be
657 included. If {\bf Exclude=yes} is specified, the wild-card will select
658 which directories are to be excluded. Multiple wild-card directives may be
659 specified, and they will be applied in turn until the first one that
660 matches. Note, if you exclude a directory, no files or directories
661 below it will be matched.
663 It is recommended to enclose the string in double quotes.
665 You may want to test your expressions prior to running your
666 backup by using the bwild program. Please see the
667 \ilink{Utilities}{bwild} chapter of this manual for
668 more. You can also test your full FileSet definition by using
669 the \ilink{estimate}{estimate} command in the Console
670 chapter of this manual.
671 An example of excluding with the WildDir option on Win32 machines is
674 \item [wildfile=\lt{}string\gt{}]
675 \index[dir]{wildfile}
676 \index[dir]{Directive!wildfile}
677 Specifies a wild-card string to be applied to non-directories. That
678 is no directory entries will be matched by this directive.
679 However, note that the match is done against the full path and filename,
680 so your wild-card string must take into account that filenames
681 are preceded by the full path.
683 is not enabled, the wild-card will select which files are to be
684 included. If {\bf Exclude=yes} is specified, the wild-card will select
685 which files are to be excluded. Multiple wild-card directives may be
686 specified, and they will be applied in turn until the first one that
689 It is recommended to enclose the string in double quotes.
691 You may want to test your expressions prior to running your
692 backup by using the bwild program. Please see the
693 \ilink{Utilities}{bwild} chapter of this manual for
694 more. You can also test your full FileSet definition by using
695 the \ilink{estimate}{estimate} command in the Console
696 chapter of this manual.
697 An example of excluding with the WildFile option on Win32 machines is
701 \item [regex=\lt{}string\gt{}]
703 \index[dir]{Directive!regex}
704 Specifies a POSIX extended regular expression to be applied to the
705 filenames and directory names, which include the full path. If {\bf
706 Exclude} is not enabled, the regex will select which files are to be
707 included. If {\bf Exclude=yes} is specified, the regex will select
708 which files are to be excluded. Multiple regex directives may be
709 specified within an Options resource, and they will be applied in turn
710 until the first one that matches. Note, if you exclude a directory, no
711 files or directories below it will be matched.
713 It is recommended to enclose the string in double quotes.
715 The regex libraries differ from one operating system to
716 another, and in addition, regular expressions are complicated,
717 so you may want to test your expressions prior to running your
718 backup by using the bregex program. Please see the
719 \ilink{Utilities}{bwild} chapter of this manual for
720 more. You can also test your full FileSet definition by using
721 the \ilink{estimate}{estimate} command in the Console
722 chapter of this manual.
724 You find yourself using a lot of Regex statements, which will cost quite a lot
725 of CPU time, we recommend you simplify them if you can, or better yet
726 convert them to Wild statements which are much more efficient.
729 \item [regexfile=\lt{}string\gt{}]
730 \index[dir]{regexfile}
731 \index[dir]{Directive!regexfile}
732 Specifies a POSIX extended regular expression to be applied to
733 non-directories. No directories will be matched by this directive.
734 However, note that the match is done against the full path and
735 filename, so your regex string must take into account that filenames
736 are preceded by the full path.
737 If {\bf Exclude} is not enabled, the regex will select which files are
738 to be included. If {\bf Exclude=yes} is specified, the regex will
739 select which files are to be excluded. Multiple regex directives may be
740 specified, and they will be applied in turn until the first one that
743 It is recommended to enclose the string in double quotes.
745 The regex libraries differ from one operating system to
746 another, and in addition, regular expressions are complicated,
747 so you may want to test your expressions prior to running your
748 backup by using the bregex program. Please see the
749 \ilink{Utilities}{bregex} chapter of this manual for
753 \item [regexdir=\lt{}string\gt{}]
754 \index[dir]{regexdir}
755 \index[dir]{Directive!regexdir}
756 Specifies a POSIX extended regular expression to be applied to directory
757 names only. No filenames will be matched by this directive. Note, if
758 {\bf Exclude} is not enabled, the regex will select directories
759 files are to be included. If {\bf Exclude=yes} is specified, the
760 regex will select which files are to be excluded. Multiple
761 regex directives may be specified, and they will be applied in turn
762 until the first one that matches. Note, if you exclude a directory, no
763 files or directories below it will be matched.
765 It is recommended to enclose the string in double quotes.
767 The regex libraries differ from one operating system to
768 another, and in addition, regular expressions are complicated,
769 so you may want to test your expressions prior to running your
770 backup by using the bregex program. Please see the
771 \ilink{Utilities}{bregex} chapter of this manual for
775 \item [exclude=yes\vb{}no]
777 \index[dir]{Directive!exclude}
778 The default is {\bf no}. When enabled, any files matched within the
779 Options will be excluded from the backup.
782 \item [aclsupport=yes\vb{}no]
783 \index[dir]{aclsupport}
784 \index[dir]{Directive!aclsupport}
785 The default is {\bf no}. If this option is set to yes, and you have the
786 POSIX {\bf libacl} installed on your system, Bacula will backup the file
787 and directory UNIX Access Control Lists (ACL) as defined in IEEE Std
788 1003.1e draft 17 and "POSIX.1e" (abandoned). This feature is
789 available on UNIX only and depends on the ACL library. Bacula is
790 automatically compiled with ACL support if the {\bf libacl} library is
791 installed on your system (shown in config.out). While restoring the
792 files Bacula will try to restore the ACLs, if there is no ACL support
793 available on the system, Bacula restores the files and directories but
794 not the ACL information. Please note, if you backup an EXT3 or XFS
795 filesystem with ACLs, then you restore them to a different filesystem
796 (perhaps reiserfs) that does not have ACLs, the ACLs will be ignored.
798 \item [ignore case=yes\vb{}no]
799 \index[dir]{ignore case}
800 \index[dir]{Directive!ignore case}
801 The default is {\bf no}. On Windows systems, you will almost surely
802 want to set this to {\bf yes}. When this directive is set to {\bf yes}
803 all the case of character will be ignored in wild-card and regex
804 comparisons. That is an uppercase A will match a lowercase a.
806 \item [fstype=filesystem-type]
808 \index[dir]{Directive!fstype}
809 This option allows you to select files and directories by the
810 filesystem type. The permitted filesystem-type names are:
812 ext2, jfs, ntfs, proc, reiserfs, xfs, usbdevfs, sysfs, smbfs,
813 iso9660. For ext3 systems, use ext2.
815 You may have multiple Fstype directives, and thus permit matching
816 of multiple filesystem types within a single Options resource. If
817 the type specified on the fstype directive does not match the
818 filesystem for a particular directive, that directory will not be
819 backed up. This directive can be used to prevent backing up
820 non-local filesystems. Normally, when you use this directive, you
821 would also set {\bf onefs=no} so that Bacula will traverse filesystems.
823 This option is not implemented in Win32 systems.
825 \item [DriveType=Windows-drive-type]
826 \index[dir]{DriveType}
827 \index[dir]{Directive!DriveType}
828 This option is effective only on Windows machines and is
829 somewhat similar to the Unix/Linux {\bf fstype} described
830 above, except that it allows you to select what Windows
831 drive types you want to allow. By default all drive
834 The permitted drivetype names are:
836 removable, fixed, remote, cdrom, ramdisk
838 You may have multiple Driveype directives, and thus permit matching
839 of multiple drive types within a single Options resource. If
840 the type specified on the drivetype directive does not match the
841 filesystem for a particular directive, that directory will not be
842 backed up. This directive can be used to prevent backing up
843 non-local filesystems. Normally, when you use this directive, you
844 would also set {\bf onefs=no} so that Bacula will traverse filesystems.
846 This option is not implemented in Unix/Linux systems.
849 \item [hfsplussupport=yes\vb{}no]
850 \index[dir]{hfsplussupport}
851 \index[dir]{Directive!hfsplussupport}
852 This option allows you to turn on support for Mac OSX HFS plus
855 \item [strippath=\lt{}integer\gt{}]
856 \index[dir]{strippath}
857 \index[dir]{Directive!strippath}
858 This option will cause {\bf integer} paths to be stripped from
859 the front of the full path/filename being backed up. This can
860 be useful if you are migrating data from another vendor or if
861 you have taken a snapshot into some subdirectory. This directive
862 can cause your filenames to be overlayed with regular backup data,
863 so should be used only by experts and with great care.
866 {\bf \lt{}file-list\gt{}} is a list of directory and/or filename names
867 specified with a {\bf File =} directive. To include names containing spaces,
868 enclose the name between double-quotes. Wild-cards are not interpreted
869 in file-lists. They can only be specified in Options resources.
871 There are a number of special cases when specifying directories and files in a
872 {\bf file-list}. They are:
875 \item Any name preceded by an at-sign (@) is assumed to be the name of a
876 file, which contains a list of files each preceded by a "File =". The
877 named file is read once when the configuration file is parsed during the
878 Director startup. Note, that the file is read on the Director's machine
879 and not on the Client's. In fact, the @filename can appear anywhere
880 within the conf file where a token would be read, and the contents of
881 the named file will be logically inserted in the place of the @filename.
882 What must be in the file depends on the location the @filename is
883 specified in the conf file. For example:
888 Options { compression=GZIP }
889 @/home/files/my-files
894 \item Any name beginning with a vertical bar (\vb) is assumed to be the name of
895 a program. This program will be executed on the Director's machine at
896 the time the Job starts (not when the Director reads the configuration
897 file), and any output from that program will be assumed to be a list of
898 files or directories, one per line, to be included. Before submitting the
899 specified command bacula will performe
900 \ilink{character substitution}{character substitution}.
902 This allows you to have a job that, for example, includes all the local
903 partitions even if you change the partitioning by adding a disk. The
904 examples below show you how to do this. However, please note two
906 1. if you want the local filesystems, you probably should be
907 using the new {\bf fstype} directive, which was added in version 1.36.3
908 and set {\bf onefs=no}.
911 2. the exact syntax of the command needed in the examples below is very
912 system dependent. For example, on recent Linux systems, you may need to
913 add the -P option, on FreeBSD systems, the options will be different as
916 In general, you will need to prefix your command or commands with a {\bf
917 sh -c} so that they are invoked by a shell. This will not be the case
918 if you are invoking a script as in the second example below. Also, you
919 must take care to escape (precede with a \textbackslash{}) wild-cards,
920 shell character, and to ensure that any spaces in your command are
921 escaped as well. If you use a single quotes (') within a double quote
922 ("), Bacula will treat everything between the single quotes as one field
923 so it will not be necessary to escape the spaces. In general, getting
924 all the quotes and escapes correct is a real pain as you can see by the
925 next example. As a consequence, it is often easier to put everything in
926 a file and simply use the file name within Bacula. In that case the
927 {\bf sh -c} will not be necessary providing the first line of the file
936 Options { signature = SHA1 }
937 File = "|sh -c 'df -l | grep \"^/dev/hd[ab]\" | grep -v \".*/tmp\" \
938 | awk \"{print \\$6}\"'"
943 will produce a list of all the local partitions on a Red Hat Linux system.
944 Note, the above line was split, but should normally be written on one line.
945 Quoting is a real problem because you must quote for Bacula which consists of
946 preceding every \textbackslash{} and every " with a \textbackslash{}, and
947 you must also quote for the shell command. In the end, it is probably easier
948 just to execute a small file with:
957 File = "|my_partitions"
962 where my\_partitions has:
967 df -l | grep "^/dev/hd[ab]" | grep -v ".*/tmp" \
972 If the vertical bar (|) in front of my\_partitions is preceded by a
973 backslash as in \textbackslash{}|, the program will be executed on the
974 Client's machine instead of on the Director's machine.
975 Please note that if the filename is given within quotes, you
976 will need to use two slashes. An example, provided by John Donagher,
977 that backs up all the local UFS partitions on a remote system is:
982 Name = "All local partitions"
984 Options { signature=SHA1; onefs=yes; }
985 File = "\\|bash -c \"df -klF ufs | tail +2 | awk '{print \$6}'\""
991 The above requires two backslash characters after the double quote (one
992 preserves the next one). If you are a Linux user, just change the {\bf ufs}
993 to {\bf ext3} (or your preferred filesystem type), and you will be in
996 If you know what filesystems you have mounted on your system, e.g.
997 for Red Hat Linux normally only ext2 and ext3, you can backup
998 all local filesystems using something like:
1004 Options { signature = SHA1; onfs=no; fstype=ext2 }
1011 \item Any file-list item preceded by a less-than sign (\lt{}) will be taken
1012 to be a file. This file will be read on the Director's machine (see
1013 below for doing it on the Client machine) at the time
1014 the Job starts, and the data will be assumed to be a list of directories or
1015 files, one per line, to be included. The names should start in column 1 and
1016 should not be quoted even if they contain spaces. This feature allows you to
1017 modify the external file and change what will be saved without stopping and
1018 restarting Bacula as would be necessary if using the @ modifier noted above.
1024 Options { signature = SHA1 }
1025 File = "</home/files/local-filelist"
1030 If you precede the less-than sign (\lt{}) with a backslash as in
1031 \textbackslash{}\lt{}, the file-list will be read on the Client machine
1032 instead of on the Director's machine. Please note that if the filename
1033 is given within quotes, you will need to use two slashes.
1038 Options { signature = SHA1 }
1039 File = "\\</home/xxx/filelist-on-client"
1044 \item If you explicitly specify a block device such as {\bf /dev/hda1}, then
1045 Bacula (starting with version 1.28) will assume that this is a raw partition
1046 to be backed up. In this case, you are strongly urged to specify a {\bf
1047 sparse=yes} include option, otherwise, you will save the whole partition
1048 rather than just the actual data that the partition contains. For example:
1053 Options { signature=MD5; sparse=yes }
1059 will backup the data in device /dev/hd6. Note, the {bf /dev/hd6} must be
1060 the raw partition itself. Bacula will not back it up as a raw device if
1061 you specify a symbolic link to a raw device such as my be created by the
1062 LVM Snapshot utilities.
1064 Ludovic Strappazon has pointed out that this feature can be used to backup a
1065 full Microsoft Windows disk. Simply boot into the system using a Linux Rescue
1066 disk, then load a statically linked Bacula as described in the
1067 \ilink{ Disaster Recovery Using Bacula}{RescueChapter} chapter of
1068 this manual. Then save the whole disk partition. In the case of a disaster,
1069 you can then restore the desired partition by again booting with the rescue
1070 disk and doing a restore of the partition.
1071 \item If you explicitly specify a FIFO device name (created with mkfifo), and
1072 you add the option {\bf readfifo=yes} as an option, Bacula will read the FIFO
1073 and back its data up to the Volume. For example:
1082 File = /home/abc/fifo
1087 if {\bf /home/abc/fifo} is a fifo device, Bacula will open the fifo,
1088 read it, and store all data thus obtained on the Volume. Please note,
1089 you must have a process on the system that is writing into the fifo, or
1090 Bacula will hang, and after one minute of waiting, Bacula will give up
1091 and go on to the next file. The data read can be anything since Bacula
1092 treats it as a stream.
1094 This feature can be an excellent way to do a "hot" backup of a very
1095 large database. You can use the {\bf RunBeforeJob} to create the fifo
1096 and to start a program that dynamically reads your database and writes
1097 it to the fifo. Bacula will then write it to the Volume. Be sure to
1098 read the \ilink{readfifo section}{readfifo} that gives a
1099 tip to ensure that the RunBeforeJob does not block Bacula.
1101 During the restore operation, the inverse is true, after Bacula creates
1102 the fifo if there was any data stored with it (no need to explicitly
1103 list it or add any options), that data will be written back to the fifo.
1104 As a consequence, if any such FIFOs exist in the fileset to be restored,
1105 you must ensure that there is a reader program or Bacula will block, and
1106 after one minute, Bacula will time out the write to the fifo and move on
1109 \item A file-list may not contain wild-cards. Use directives in the
1110 Options resource if you wish to specify wild-cards or regular expression
1114 \index[general]{IgnoreDir}
1115 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a directive that
1116 can be added to the Include section of the FileSet resource. If the specified
1117 filename ({\bf filename-string}) is found on the Client in any directory to be
1118 backed up, the whole directory will be ignored (not backed up). For example:
1121 # List of files to be backed up
1129 Exclude Dir Containing = .excludeme
1134 But in /home, there may be hundreds of directories of users and some
1135 people want to indicate that they don't want to have certain
1136 directories backed up. For example, with the above FileSet, if
1137 the user or sysadmin creates a file named {\bf .excludeme} in
1138 specific directories, such as
1141 /home/user/www/cache/.excludeme
1142 /home/user/temp/.excludeme
1145 then Bacula will not backup the two directories named:
1148 /home/user/www/cache
1152 NOTE: subdirectories will not be backed up. That is, the directive
1153 applies to the two directories in question and any children (be they
1154 files, directories, etc).
1158 \section{FileSet Examples}
1159 \index[general]{Examples!FileSet }
1160 \index[general]{FileSet Examples}
1162 The following is an example of a valid FileSet resource definition. Note,
1163 the first Include pulls in the contents of the file {\bf /etc/backup.list}
1164 when Bacula is started (i.e. the @), and that file must have each filename
1165 to be backed up preceded by a {\bf File =} and on a separate line.
1186 File = /usr/lib/another_file
1192 In the above example, all the files contained in /etc/backup.list will
1193 be compressed with GZIP compression, an SHA1 signature will be computed on the
1194 file's contents (its data), and sparse file handling will apply.
1196 The two directories /root/myfile and /usr/lib/another\_file will also be saved
1197 without any options, but all files in those directories with the extensions
1198 {\bf .o} and {\bf .exe} will be excluded.
1200 Let's say that you now want to exclude the directory /tmp. The simplest way
1201 to do so is to add an exclude directive that lists /tmp. The example
1202 above would then become:
1223 File = /usr/lib/another_file
1233 You can add wild-cards to the File directives listed in the Exclude
1234 directory, but you need to take care because if you exclude a directory,
1235 it and all files and directories below it will also be excluded.
1237 Now lets take a slight variation on the above and suppose
1238 you want to save all your whole filesystem except {\bf /tmp}.
1239 The problem that comes up is that Bacula will not normally
1240 cross from one filesystem to another.
1241 Doing a {\bf df} command, you get the following output:
1246 Filesystem 1k-blocks Used Available Use% Mounted on
1247 /dev/hda5 5044156 439232 4348692 10% /
1248 /dev/hda1 62193 4935 54047 9% /boot
1249 /dev/hda9 20161172 5524660 13612372 29% /home
1250 /dev/hda2 62217 6843 52161 12% /rescue
1251 /dev/hda8 5044156 42548 4745376 1% /tmp
1252 /dev/hda6 5044156 2613132 2174792 55% /usr
1253 none 127708 0 127708 0% /dev/shm
1254 //minimatou/c$ 14099200 9895424 4203776 71% /mnt/mmatou
1255 lmatou:/ 1554264 215884 1258056 15% /mnt/matou
1256 lmatou:/home 2478140 1589952 760072 68% /mnt/matou/home
1257 lmatou:/usr 1981000 1199960 678628 64% /mnt/matou/usr
1258 lpmatou:/ 995116 484112 459596 52% /mnt/pmatou
1259 lpmatou:/home 19222656 2787880 15458228 16% /mnt/pmatou/home
1260 lpmatou:/usr 2478140 2038764 311260 87% /mnt/pmatou/usr
1261 deuter:/ 4806936 97684 4465064 3% /mnt/deuter
1262 deuter:/home 4806904 280100 4282620 7% /mnt/deuter/home
1263 deuter:/files 44133352 27652876 14238608 67% /mnt/deuter/files
1267 And we see that there are a number of separate filesystems (/ /boot
1268 /home /rescue /tmp and /usr not to mention mounted systems).
1269 If you specify only {\bf /} in your Include list, Bacula will only save the
1270 Filesystem {\bf /dev/hda5}. To save all filesystems except {\bf /tmp} with
1271 out including any of the Samba or NFS mounted systems, and explicitly
1272 excluding a /tmp, /proc, .journal, and .autofsck, which you will not want to
1273 be saved and restored, you can use the following:
1278 Name = Include_example
1283 wildfile = "/.journal"
1284 wildfile = "/.autofsck"
1297 Since /tmp is on its own filesystem and it was not explicitly named in the
1298 Include list, it is not really needed in the exclude list. It is better to
1299 list it in the Exclude list for clarity, and in case the disks are changed so
1300 that it is no longer in its own partition.
1302 Now, lets assume you only want to backup .Z and .gz files and nothing
1303 else. This is a bit trickier because Bacula by default will select
1304 everything to backup, so we must exclude everything but .Z and .gz files.
1305 If we take the first example above and make the obvious modifications
1306 to it, we might come up with a FileSet that looks like this:
1312 Include { !!!!!!!!!!!!
1314 wildfile = "*.Z" example
1315 wildfile = "*.gz" doesn't
1324 The *.Z and *.gz files will indeed be backed up, but all other files
1325 that are not matched by the Options directives will automatically
1326 be backed up too (i.e. that is the default rule).
1328 To accomplish what we want, we must explicitly exclude all other files.
1329 We do this with the following:
1350 The "trick" here was to add a RegexFile expression that matches
1351 all files. It does not match directory names, so all directories in
1352 /myfile will be backed up (the directory entry) and any *.Z and *.gz
1353 files contained in them. If you know that certain directories do
1354 not contain any *.Z or *.gz files and you do not want the directory
1355 entries backed up, you will need to explicitly exclude those directories.
1356 Backing up a directory entries is not very expensive.
1358 Bacula uses the system regex library and some of them are
1359 different on different OSes. The above has been reported not to work
1360 on FreeBSD. This can be tested by using the {\bf estimate job=job-name
1361 listing} command in the console and adapting the RegexFile expression
1362 appropriately. In a future version of Bacula, we will supply our own
1363 Regex code to avoid such system dependencies.
1365 Please be aware that allowing Bacula to traverse or change file systems can be
1366 {\bf very} dangerous. For example, with the following:
1371 Name = "Bad example"
1373 Options { onefs=no }
1380 you will be backing up an NFS mounted partition ({\bf /mnt/matou}), and since
1381 {\bf onefs} is set to {\bf no}, Bacula will traverse file systems. Now if {\bf
1382 /mnt/matou} has the current machine's file systems mounted, as is often the
1383 case, you will get yourself into a recursive loop and the backup will never
1386 As a final example, let's say that you have only one or two
1387 subdirectories of /home that you want to backup. For example,
1388 you want to backup only subdirectories beginning with the letter
1389 a and the letter b -- i.e. /home/a* and /home/b*. Now, you might first
1397 wilddir = "/home/a*"
1398 wilddir = "/home/b*"
1406 The problem is that the above will include everything in /home. To get
1407 things to work correctly, you need to start with the idea of exclusion
1408 instead of inclusion. So, you could simply exclude all directories
1409 except the two you want to use:
1416 RegexDir = "^/home/[c-z]"
1425 And assuming that all subdirectories start with a lowercase letter, this
1428 An alternative would be to include the two subdirectories desired and
1429 exclude everything else:
1436 wilddir = "/home/a*"
1437 wilddir = "/home/b*"
1450 The following example shows how to back up only the My Pictures directory inside
1451 the My Documents directory for all users in C:/Documents and Settings, i.e.
1452 everything matching the pattern:
1454 C:/Documents and Settings/*/My Documents/My Pictures/*
1456 To understand how this can be achieved, there are two important points to
1459 Firstly, Bacula walks over the filesystem depth-first starting from the File =
1460 lines. It stops descending when a directory is excluded, so you must include
1461 all ancestor directories of each directory containing files to be included.
1463 Secondly, each directory and file is compared to the Options clauses in the
1464 order they appear in the FileSet. When a match is found, no further clauses
1465 are compared and the directory or file is either included or excluded.
1467 The FileSet resource definition below implements this by including specifc
1468 directories and files and excluding everything else.
1473 Name = "AllPictures"
1477 File = "C:/Documents and Settings"
1484 # Include all users' directories so we reach the inner ones. Unlike a
1485 # WildDir pattern ending in *, this RegExDir only matches the top-level
1486 # directories and not any inner ones.
1487 RegExDir = "^C:/Documents and Settings/[^/]+$"
1489 # Ditto all users' My Documents directories.
1490 WildDir = "C:/Documents and Settings/*/My Documents"
1492 # Ditto all users' My Documents/My Pictures directories.
1493 WildDir = "C:/Documents and Settings/*/My Documents/My Pictures"
1495 # Include the contents of the My Documents/My Pictures directories and
1496 # any subdirectories.
1497 Wild = "C:/Documents and Settings/*/My Documents/My Pictures/*"
1504 # Exclude everything else, in particular any files at the top level and
1505 # any other directories or files in the users' directories.
1506 Wild = "C:/Documents and Settings/*"
1513 \section{Backing up Raw Partitions}
1514 \index[general]{Backing up!Partitions }
1515 \index[general]{Backing up Raw Partitions }
1517 The following FileSet definition will backup a raw partition:
1522 Name = "RawPartition"
1524 Options { sparse=yes }
1531 While backing up and restoring a raw partition, you should ensure that no
1532 other process including the system is writing to that partition. As a
1533 precaution, you are strongly urged to ensure that the raw partition is not
1534 mounted or is mounted read-only. If necessary, this can be done using the {\bf
1535 RunBeforeJob} directive.
1538 \section{Excluding Files and Directories}
1539 \index[general]{Directories!Excluding Files and }
1540 \index[general]{Excluding Files and Directories }
1542 You may also include full filenames or directory names in addition to using
1543 wild-cards and {\bf Exclude=yes} in the Options resource as specified above by
1544 simply including the files to be excluded in an Exclude resource within the
1545 FileSet. For example:
1550 Name = Exclusion_example
1572 \section{Windows FileSets}
1573 \index[general]{Windows FileSets }
1574 \index[general]{FileSets!Windows }
1575 If you are entering Windows file names, the directory path may be preceded by
1576 the drive and a colon (as in c:). However, the path separators must be
1577 specified in Unix convention (i.e. forward slash (/)). If you wish to include
1578 a quote in a file name, precede the quote with a backslash
1579 (\textbackslash{}). For example you might use the following
1580 for a Windows machine to backup the "My Documents" directory:
1585 Name = "Windows Set"
1592 File = "c:/My Documents"
1598 For exclude lists to work correctly on Windows, you must observe the following
1602 \item Filenames are case sensitive, so you must use the correct case.
1603 \item To exclude a directory, you must not have a trailing slash on the
1605 \item If you have spaces in your filename, you must enclose the entire name
1606 in double-quote characters ("). Trying to use a backslash before the space
1608 \item If you are using the old Exclude syntax (noted below), you may not
1609 specify a drive letter in the exclude. The new syntax noted above
1610 should work fine including driver letters.
1613 Thanks to Thiago Lima for summarizing the above items for us. If you are
1614 having difficulties getting includes or excludes to work, you might want to
1615 try using the {\bf estimate job=xxx listing} command documented in the
1616 \ilink{Console chapter}{estimate} of this manual.
1618 On Win32 systems, if you move a directory or file or rename a file into the
1619 set of files being backed up, and a Full backup has already been made, Bacula
1620 will not know there are new files to be saved during an Incremental or
1621 Differential backup (blame Microsoft, not me). To avoid this problem, please
1622 {\bf copy} any new directory or files into the backup area. If you do not have
1623 enough disk to copy the directory or files, move them, but then initiate a
1627 \paragraph*{A Windows Example FileSet}
1628 \index[general]{FileSet!Windows Example }
1629 \index[general]{Windows Example FileSet }
1631 The following example was contributed by Russell Howe. Please note that
1632 for presentation purposes, the lines beginning with Data and Internet
1633 have been wrapped and should included on the previous line with one
1638 This is my Windows 2000 fileset:
1640 Name = "Windows 2000"
1646 # Exclude Mozilla-based programs' file caches
1647 WildDir = "[A-Z]:/Documents and Settings/*/Application
1648 Data/*/Profiles/*/*/Cache"
1649 WildDir = "[A-Z]:/Documents and Settings/*/Application
1650 Data/*/Profiles/*/*/Cache.Trash"
1651 WildDir = "[A-Z]:/Documents and Settings/*/Application
1652 Data/*/Profiles/*/*/ImapMail"
1654 # Exclude user's registry files - they're always in use anyway.
1655 WildFile = "[A-Z]:/Documents and Settings/*/Local Settings/Application
1656 Data/Microsoft/Windows/usrclass.*"
1657 WildFile = "[A-Z]:/Documents and Settings/*/ntuser.*"
1659 # Exclude directories full of lots and lots of useless little files
1660 WildDir = "[A-Z]:/Documents and Settings/*/Cookies"
1661 WildDir = "[A-Z]:/Documents and Settings/*/Recent"
1662 WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/History"
1663 WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/Temp"
1664 WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/Temporary
1667 # These are always open and unable to be backed up
1668 WildFile = "[A-Z]:/Documents and Settings/All Users/Application
1669 Data/Microsoft/Network/Downloader/qmgr[01].dat"
1671 # Some random bits of Windows we want to ignore
1672 WildFile = "[A-Z]:/WINNT/security/logs/scepol.log"
1673 WildDir = "[A-Z]:/WINNT/system32/config"
1674 WildDir = "[A-Z]:/WINNT/msdownld.tmp"
1675 WildDir = "[A-Z]:/WINNT/Internet Logs"
1676 WildDir = "[A-Z]:/WINNT/$Nt*Uninstall*"
1677 WildDir = "[A-Z]:/WINNT/sysvol"
1678 WildFile = "[A-Z]:/WINNT/cluster/CLUSDB"
1679 WildFile = "[A-Z]:/WINNT/cluster/CLUSDB.LOG"
1680 WildFile = "[A-Z]:/WINNT/NTDS/edb.log"
1681 WildFile = "[A-Z]:/WINNT/NTDS/ntds.dit"
1682 WildFile = "[A-Z]:/WINNT/NTDS/temp.edb"
1683 WildFile = "[A-Z]:/WINNT/ntfrs/jet/log/edb.log"
1684 WildFile = "[A-Z]:/WINNT/ntfrs/jet/ntfrs.jdb"
1685 WildFile = "[A-Z]:/WINNT/ntfrs/jet/temp/tmp.edb"
1686 WildFile = "[A-Z]:/WINNT/system32/CPL.CFG"
1687 WildFile = "[A-Z]:/WINNT/system32/dhcp/dhcp.mdb"
1688 WildFile = "[A-Z]:/WINNT/system32/dhcp/j50.log"
1689 WildFile = "[A-Z]:/WINNT/system32/dhcp/tmp.edb"
1690 WildFile = "[A-Z]:/WINNT/system32/LServer/edb.log"
1691 WildFile = "[A-Z]:/WINNT/system32/LServer/TLSLic.edb"
1692 WildFile = "[A-Z]:/WINNT/system32/LServer/tmp.edb"
1693 WildFile = "[A-Z]:/WINNT/system32/wins/j50.log"
1694 WildFile = "[A-Z]:/WINNT/system32/wins/wins.mdb"
1695 WildFile = "[A-Z]:/WINNT/system32/wins/winstmp.mdb"
1697 # Temporary directories & files
1698 WildDir = "[A-Z]:/WINNT/Temp"
1699 WildDir = "[A-Z]:/temp"
1701 WildDir = "[A-Z]:/tmp"
1702 WildDir = "[A-Z]:/var/tmp"
1705 WildDir = "[A-Z]:/RECYCLER"
1708 WildFile = "[A-Z]:/pagefile.sys"
1710 # These are programs and are easier to reinstall than restore from
1712 WildDir = "[A-Z]:/cygwin"
1713 WildDir = "[A-Z]:/Program Files/Grisoft"
1714 WildDir = "[A-Z]:/Program Files/Java"
1715 WildDir = "[A-Z]:/Program Files/Java Web Start"
1716 WildDir = "[A-Z]:/Program Files/JavaSoft"
1717 WildDir = "[A-Z]:/Program Files/Microsoft Office"
1718 WildDir = "[A-Z]:/Program Files/Mozilla Firefox"
1719 WildDir = "[A-Z]:/Program Files/Mozilla Thunderbird"
1720 WildDir = "[A-Z]:/Program Files/mozilla.org"
1721 WildDir = "[A-Z]:/Program Files/OpenOffice*"
1724 # Our Win2k boxen all have C: and D: as the main hard drives.
1732 Note, the three line of the above Exclude were split to fit on the document
1733 page, they should be written on a single line in real use.
1735 \paragraph*{Windows NTFS Naming Considerations}
1736 \index[general]{Windows NTFS Naming Considerations }
1737 \index[general]{Considerations!Windows NTFS Naming }
1739 NTFS filenames containing Unicode characters should now be supported
1740 as of version 1.37.30 or later.
1742 \section{Testing Your FileSet}
1743 \index[general]{FileSet!Testing Your }
1744 \index[general]{Testing Your FileSet }
1746 If you wish to get an idea of what your FileSet will really backup or if your
1747 exclusion rules will work correctly, you can test it by using the {\bf
1748 estimate} command in the Console program. See the
1749 \ilink{estimate}{estimate} in the Console chapter of this
1752 As an example, suppose you add the following test FileSet:
1759 File = /home/xxx/test
1768 You could then add some test files to the directory {\bf /home/xxx/test}
1769 and use the following command in the console:
1773 estimate job=<any-job-name> listing client=<desired-client> fileset=Test
1777 to give you a listing of all files that match.