]> git.sur5r.net Git - bacula/docs/commitdiff
Updates
authorKern Sibbald <kern@sibbald.com>
Mon, 20 Mar 2006 07:14:29 +0000 (07:14 +0000)
committerKern Sibbald <kern@sibbald.com>
Mon, 20 Mar 2006 07:14:29 +0000 (07:14 +0000)
docs/developers/version.tex
docs/manual-de/version.tex
docs/manual/critical.tex
docs/manual/filedconf.tex
docs/manual/fileset.tex
docs/manual/progs.tex
docs/manual/storedconf.tex
docs/manual/version.tex

index 0a210a2627b3542c1babfb7fe45e67927c0e99dc..2839c70a5fd7f12615d1032823753b73a1147df0 100644 (file)
@@ -1 +1 @@
-1.38.6-beta5 (14 March 2006)
+1.38.6-beta6 (16 March 2006)
index 0a210a2627b3542c1babfb7fe45e67927c0e99dc..2839c70a5fd7f12615d1032823753b73a1147df0 100644 (file)
@@ -1 +1 @@
-1.38.6-beta5 (14 March 2006)
+1.38.6-beta6 (16 March 2006)
index c8750baa1e7994eea2d2a281d0c4d3b23f607196..563d382aaed7635ea7f2e2b8ff6e38e16764fe19 100644 (file)
@@ -93,7 +93,7 @@ you avoid problems.
 \item After installing and experimenting with Bacula, read and work carefully 
    through the examples in the 
    \ilink{Tutorial}{_ChapterStart1} chapter  of this manual. 
-\item Learn what each of the \ilink{Bacula Utility Programs}{_ChapterStart9
+\item Learn what each of the \ilink{Bacula Utility Programs}{_UtilityChapter
 does. 
 \item Set up reasonable retention periods so that your catalog does not  grow
    to be too big. See the following three chapters:\\
index 3ecacbaa299bf4c75fa380c8c2efc1d21b69f2d0..2c5e757f0af5c987a64014b791e1777a2bbf1288 100644 (file)
@@ -46,20 +46,23 @@ Director connections.
 \begin{description}
 
 \item [Client (or FileDaemon)]
-   \index[fd]{Client (or FileDaemon) }
+   \index[fd]{Client (or FileDaemon)}
+   \index[fd]{Directive!Client (or FileDaemon)}
    Start of the Client records.  There must be one and only one Client resource
 in the  configuration file, since it defines the properties of the  current
 client program. 
 
 \item [Name = \lt{}name\gt{}]
-   \index[fd]{Name  }
+   \index[fd]{Name}
+   \index[fd]{Directive!Name}
    The client name that must be used  by the Director when connecting. Generally,
    it is a good idea  to use a name related to the machine so that error messages
    can be easily identified if you have multiple Clients.  This directive is
    required.  
 
 \item [Working Directory = \lt{}Directory\gt{}]
-   \index[fd]{Working Directory  }
+   \index[fd]{Working Directory}
+   \index[fd]{Directive!Working Directory}
    This directive  is mandatory and specifies a directory in which the File
    daemon  may put its status files. This directory should be used only  by {\bf
    Bacula}, but may be shared by other Bacula daemons provided the daemon
@@ -74,20 +77,22 @@ client program.
    to the Storage daemon).
 
 \item [Pid Directory = \lt{}Directory\gt{}]
-   \index[fd]{Pid Directory  }
+   \index[fd]{Pid Directory}
+   \index[fd]{Directive!Pid Directory}
    This directive  is mandatory and specifies a directory in which the Director 
-may put its process Id file files. The process Id file is used to  shutdown
-Bacula and to prevent multiple copies of  Bacula from running simultaneously. 
-This record is required. Standard shell expansion of the {\bf Directory}  is
-done when the configuration file is read so that values such  as {\bf \$HOME}
-will be properly expanded.  
+   may put its process Id file files. The process Id file is used to  shutdown
+   Bacula and to prevent multiple copies of  Bacula from running simultaneously. 
+   This record is required. Standard shell expansion of the {\bf Directory}  is
+   done when the configuration file is read so that values such  as {\bf \$HOME}
+   will be properly expanded.  
 
-Typically on Linux systems, you will set this to:  {\bf /var/run}. If you are
-not installing Bacula in the  system directories, you can use the {\bf Working
-Directory} as  defined above. 
+   Typically on Linux systems, you will set this to:  {\bf /var/run}. If you are
+   not installing Bacula in the  system directories, you can use the {\bf Working
+   Directory} as  defined above. 
 
 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
-   \index[fd]{Heartbeat Interval  }
+   \index[fd]{Heartbeat Interval}
+   \index[fd]{Directive!Heartbeat Interval}
    \index[general]{Heartbeat Interval}
    \index[general]{Broken pipe}
    This record defines an interval of time.  For each heartbeat that the
@@ -120,7 +125,8 @@ Directory} as  defined above.
 
 
 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
-   \index[fd]{Maximum Concurrent Jobs  }
+   \index[fd]{Maximum Concurrent Jobs}
+   \index[fd]{Directive!Maximum Concurrent Jobs}
    where \lt{}number\gt{} is the maximum number of Jobs that should run
    concurrently.  The default is set to 2, but you may set it to a larger
    number.  Each contact from the Director (e.g.  status request, job start
@@ -129,7 +135,8 @@ Directory} as  defined above.
    will need to set this value greater than 1.
 
 \item [FDAddresses = \lt{}IP-address-specification\gt{}]
-   \index[console]{FDAddresses  }
+   \index[fd]{FDAddresses}
+   \index[fd]{Directive!FDAddresses}
    Specify the ports and addresses on which the Director daemon will listen
    for Bacula Console connections.  Probably the simplest way to explain is
    to show an example:
@@ -170,13 +177,15 @@ the resolution can be made either by IPv4 or  IPv6. If ip4 is specified, then
 only IPv4 resolutions will be permitted,  and likewise with ip6.  
 
 \item [FDPort = \lt{}port-number\gt{}]
-   \index[console]{FDPort  }
+   \index[fd]{FDPort}
+   \index[fd]{Directive!FDPort}
    This specifies the port number  on which the Client listens for Director
 connections. It must agree  with the FDPort specified in the Client resource
 of the Director's  configuration file. The default is 9102. 
 
 \item [FDAddress = \lt{}IP-Address\gt{}]
-   \index[console]{FDAddress  }
+   \index[fd]{FDAddress}
+   \index[fd]{Directive!FDAddress}
    This record is optional,  and if it is specified, it will cause the File
 daemon server (for  Director connections) to bind to the specified {\bf
 IP-Address},  which is either a domain name or an IP address specified as a 
@@ -184,13 +193,15 @@ dotted quadruple. If this record is not specified, the File daemon  will bind
 to any available address (the default). 
 
 \item [SDConnectTimeout = \lt{}time-interval\gt{}]
-   \index[console]{SDConnectTimeout  }
+   \index[fd]{SDConnectTimeout}
+   \index[fd]{Directive!SDConnectTimeout}
    This  record defines an interval of time that  the File daemon will try to
 connect to the  Storage daemon. The default is 30 minutes. If no connection 
 is made in the specified time interval, the File daemon  cancels the Job. 
 
 \item [Maximum Network Buffer Size = \lt{}bytes\gt{}]  
-   \index[console]{Maximum Network Buffer Size  }
+   \index[fd]{Maximum Network Buffer Size}
+   \index[fd]{Directive!Maximum Network Buffer Size}
    where \lt{}bytes\gt{} specifies the initial network buffer  size to use with
 the File daemon. This size will be adjusted down  if it is too large until it
 is accepted by the OS. Please use  care in setting this value since if it is
@@ -222,25 +233,29 @@ permitted to contact this Client.
 \begin{description}
 
 \item [Director]
-   \index[fd]{Director }
+   \index[fd]{Director}
+   \index[fd]{Directive!Director}
    Start of the Director records. There may be any  number of Director resources
 in the Client configuration file. Each  one specifies a Director that is
 allowed to connect to this  Client. 
 
 \item [Name = \lt{}name\gt{}]
-   \index[fd]{Name  }
+   \index[fd]{Name}
+   \index[fd]{Directive!Name}
    The name of the Director  that may contact this Client. This name must be the 
 same as the name specified on the Director resource  in the Director's
 configuration file. This record is required. 
 
 \item [Password = \lt{}password\gt{}]
-   \index[fd]{Password  }
+   \index[fd]{Password}
+   \index[fd]{Directive!Password}
    Specifies the password that must be  supplied for a Director to be authorized.
 This password  must be the same as the password specified in the  Client
 resource in the Director's configuration file.  This record is required. 
 
 \item [Monitor = \lt{}yes|no\gt{}]
-   \index[fd]{Monitor  }
+   \index[fd]{Monitor}
+   \index[fd]{Directive!Monitor}
    If Monitor is set to {\bf no} (default),  this director will have full access
 to this Client. If Monitor is set to  {\bf yes}, this director will only be
 able to fetch the current status  of this Client.
index dfdbad73b9fc9e10e59b39ca1ab057d75006def9..8405a23ff09771b765cbe15e85f885274e9ffd9b 100644 (file)
@@ -1,10 +1,10 @@
-%%
+-%
 %%
 
 \subsection*{The FileSet Resource}
 \label{FileSetResource}
-\index[general]{Resource!FileSet }
-\index[general]{FileSet Resource }
+\index[general]{Resource!FileSet}
+\index[general]{FileSet Resource}
 \addcontentsline{toc}{subsection}{FileSet Resource}
 
 The FileSet resource defines what files are to be included or excluded in a
@@ -23,15 +23,18 @@ Bacula will ensure that the next backup is always a Full save.
 
 \item [FileSet]
 \index[dir]{FileSet}
+\index[dir]{Directive!FileSet}
 Start of the FileSet resource. One {\bf FileSet}  resource must be
 defined for each Backup job.
 
 \item [Name = \lt{}name\gt{}]
 \index[dir]{Name}
+\index[dir]{Directive!Name}
    The name of the FileSet resource.  This directive is required. 
 
 \item [Ignore FileSet Changes = \lt{}yes|no\gt{}]
 \index[dir]{Ignore FileSet Changes}
+\index[dir]{Directive!Ignore FileSet Changes}
    Normally, if you modify the FileSet Include or Exclude lists,
    the next backup will be forced to a Full so that Bacula can
    guarantee that any additions or deletions are properly backed
@@ -45,6 +48,7 @@ defined for each Backup job.
 
 \item [Enable VSS = \lt{}yes|no\gt{}]
 \index[dir]{Enable VSS}
+\index[dir]{Directive!Enable VSS}
   If this directive is set to {\bf yes} the File daemon will be notified
   that the user wants to use a Volume Shadow Copy Service (VSS) backup
   for this job. The default is {\bf no}. This directive is effective
@@ -58,12 +62,14 @@ defined for each Backup job.
    \lt{}file-list\gt{} \} ]
 \index[dir]{Include \{ [ Options \{\lt{}file-options\gt{}\} ...]
    \lt{}file-list\gt{} \}  }
+\index[dir]{Directive!Include}
 
 \item [Options \{ \lt{}file-options\gt{} \} ]
 \index[dir]{Options  \{ \lt{}file-options\gt{} \}  }
 
 \item [Exclude \{ \lt{}file-list\gt{} \}]
 \index[dir]{Exclude \{ \lt{}file-list\gt{} \} }
+\index[dir]{Directive!Exclude}
 
 \end{description}
 
@@ -187,7 +193,8 @@ The directives within an Options resource may be one of the following:
 \begin{description}
 
 \item [compression=GZIP]
-\index[fd]{compression }
+\index[dir]{compression}
+\index[dir]{Directive!compression}
    All files saved will be software compressed using the GNU ZIP compression
    format. The  compression is done on a file by file basis by the File daemon. 
    If there is a problem reading the tape in a  single record of a file, it will
@@ -213,7 +220,8 @@ The directives within an Options resource may be one of the following:
    generally give very little extra compression and are rather CPU intensive. 
 
 \item [signature=SHA1]
-\index[fd]{signature }
+\index[dir]{signature}
+\index[dir]{Directive!signature}
    An SHA1 signature will be computed for all  The SHA1 algorithm is purported to
    be some  what slower than the MD5 algorithm, but at the same time is 
    significantly better from a cryptographic point of view (i.e.  much fewer
@@ -223,7 +231,8 @@ The directives within an Options resource may be one of the following:
    MD5 or SHA1 can be computed for any file. 
 
 \item [signature=MD5]
-   \index[fd]{signature }
+   \index[dir]{signature}
+   \index[dir]{Directive!signature}
    An MD5 signature will be computed for all  files saved. Adding this option
    generates about 5\% extra overhead  for each file saved. In addition to the
    additional CPU time,  the MD5 signature adds 16 more bytes per file to your
@@ -231,7 +240,8 @@ The directives within an Options resource may be one of the following:
    specified as a default for all files. 
 
 \item [verify=\lt{}options\gt{}]
-\index[fd]{verify }
+\index[dir]{verify}
+\index[dir]{Directive!verify}
    The options letters specified are used  when running a {\bf Verify
    Level=Catalog} as well as the  {\bf DiskToCatalog} level job. The options
    letters may be any  combination of the following:  
@@ -280,7 +290,8 @@ The directives within an Options resource may be one of the following:
    inodes, number  of links, size, and MD5 changes. 
 
 \item [onefs=yes|no]
-\index[fd]{onefs}
+\index[dir]{onefs}
+\index[dir]{Directive!onefs}
    If set to {\bf yes} (the default), {\bf Bacula}  will remain on a single file
    system. That is it will not backup  file systems that are mounted on a
    subdirectory. If you are using a *nix system, you may not even be aware 
@@ -310,7 +321,7 @@ rufus-fd: Filesystem change prohibited. Will not descend into /home
    also be backed up. Normally, it is  preferable to set {\bf onefs=yes} and to
    explicitly name  each filesystem you want backed up. Explicitly naming  the
    filesystems you want backed up avoids the possibility  of getting into a
-   infinite loop recursing filesystems.  Another possiblity is to 
+   infinite loop recursing filesystems.  Another possibility is to 
    use {\bf onefs=no} and to set {\bs fstype=ext2, ...}.             
    See the example below for more details. 
 
@@ -358,7 +369,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 
 \label{portable}
 \item [portable=yes|no]
-\index[dir]{portable }
+\index[dir]{portable}
+\index[dir]{Directive!portable}
    If set to {\bf yes} (default is  {\bf no}), the Bacula File daemon will backup
    Win32 files  in a portable format, but not all Win32 file attributes  will be
    saved and restored. By default, this option is set to  {\bf no}, which means
@@ -371,7 +383,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    concerning  your files is saved. 
 
 \item [recurse=yes|no]
-\index[fd]{recurse }
+\index[dir]{recurse}
+\index[dir]{Directive!recurse}
    If set to {\bf yes} (the default),  Bacula will recurse (or descend) into all
    subdirectories  found unless the directory is explicitly excluded  using an
    {\bf exclude} definition.  If you set {\bf recurse=no}, Bacula will save the 
@@ -380,7 +393,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    you  will want the default ({\bf yes}). 
 
 \item [sparse=yes|no]
-\index[dir]{sparse }
+\index[dir]{sparse}
+\index[dir]{Directive!sparse}
    Enable special code that checks for sparse files such as created by
    ndbm.  The default is {\bf no}, so no checks are made for sparse files.
    You may specify {\bf sparse=yes} even on files that are not sparse file.
@@ -417,7 +431,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 
 \label{readfifo}
 \item [readfifo=yes|no]
-\index[fd]{readfifo }
+\index[dir]{readfifo}
+\index[dir]{Directive!readfifo}
    If enabled, tells the Client to read the data on a backup and write the
    data on a restore to any FIFO (pipe) that is explicitly mentioned in the
    FileSet.  In this case, you must have a program already running that
@@ -440,7 +455,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 
 
 \item [mtimeonly=yes|no]
-\index[dir]{mtimeonly }
+\index[dir]{mtimeonly}
+\index[dir]{Directive!mtimeonly}
    If enabled, tells the Client that the selection of files during
    Incremental and Differential backups should based only on the st\_mtime
    value in the stat() packet.  The default is {\bf no} which means that
@@ -449,7 +465,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    to use this option.
 
 \item [keepatime=yes|no]
-\index[dir]{keepatime }
+\index[dir]{keepatime}
+\index[dir]{Directive!keepatime}
    The default is {\bf no}.  When enabled, Bacula will reset the st\_atime
    (access time) field of files that it backs up to their value prior to
    the backup.  This option is not generally recommended as there are very
@@ -469,6 +486,7 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 
 \item [hardlinks=yes|no]
 \index[dir]{hardlinks}
+\index[dir]{Directive!hardlinks}
    When enabled (default), this directive will cause hard inks to be 
    backed up. However, the File daemon keeps track of hard linked files and
    will backup the data only once. The process of keeping track of the 
@@ -482,7 +500,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    system will not be restored identically to the original.
 
 \item [wild=\lt{}string\gt{}]
-\index[dir]{wild }
+\index[dir]{wild}
+\index[dir]{Directive!wild}
    Specifies a wild-card string to be applied to the filenames and
    directory names.  Note, if {\bf Exclude} is not enabled, the wild-card
    will select which files are to be included.  If {\bf Exclude=yes} is
@@ -493,7 +512,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    It is recommended to enclose the string in double quotes.
 
 \item [wildfile=\lt{}string\gt{}]
-\index[dir]{wildfile }
+\index[dir]{wildfile}
+\index[dir]{Directive!wildfile}
    Specifies a wild-card string to be applied to filenames only.  No
    directories will be matched by this directive.  Note, if {\bf Exclude}
    is not enabled, the wild-card will select which files are to be
@@ -506,7 +526,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    presented below.
 
 \item [wilddir=\lt{}string\gt{}]
-\index[dir]{wilddir }
+\index[dir]{wilddir}
+\index[dir]{Directive!wilddir}
    Specifies a wild-card string to be applied to directory names only.  No
    filenames will be matched by this directive.  Note, if {\bf Exclude} is
    not enabled, the wild-card will select directories files are to be
@@ -521,7 +542,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 
 
 \item [regex=\lt{}string\gt{}]
-\index[dir]{regex }
+\index[dir]{regex}
+\index[dir]{Directive!regex}
    Specifies a POSIX extended regular expression to be applied to the
    filenames and directory names. 
    This directive is available in version 1.35 and later.  If {\bf
@@ -533,8 +555,17 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    directory, no files or directories below it will be matched.
    It is recommended to enclose the string in double quotes.
 
+   The regex libraries differ from one operating system to
+   another, and in addition, regular expressions are complicated,
+   so you may want to test your expressions prior to running your
+   backup by using the regex program. Please see the
+   \ilink{UtilitiesChapter}{Utilities} chapter of this manual for
+   more.
+
+
 \item [regexfile=\lt{}string\gt{}]
-\index[dir]{regexfile }
+\index[dir]{regexfile}
+\index[dir]{Directive!regexfile}
    Specifies a POSIX extended regular expression to be applied to filenames
    only.  No directories will be matched by this directive.  Note, if {\bf
    Exclude} is not enabled, the regex will select which files are to be
@@ -544,8 +575,17 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    matches.
    It is recommended to enclose the string in double quotes.
 
+   The regex libraries differ from one operating system to
+   another, and in addition, regular expressions are complicated,
+   so you may want to test your expressions prior to running your
+   backup by using the regex program. Please see the
+   \ilink{UtilitiesChapter}{Utilities} chapter of this manual for
+   more.
+
+
 \item [regexdir=\lt{}string\gt{}]
-\index[dir]{regexdir }
+\index[dir]{regexdir}
+\index[dir]{Directive!regexdir}
    Specifies a POSIX extended regular expression to be applied to directory
    names only.  No filenames will be matched by this directive.  Note, if
    {\bf Exclude} is not enabled, the regex will select directories
@@ -556,15 +596,25 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    files or directories below it will be matched.
    It is recommended to enclose the string in double quotes.
 
+   The regex libraries differ from one operating system to
+   another, and in addition, regular expressions are complicated,
+   so you may want to test your expressions prior to running your
+   backup by using the regex program. Please see the
+   \ilink{UtilitiesChapter}{Utilities} chapter of this manual for
+   more.
+
+
 \item [exclude=yes|no]
-\index[dir]{exclude }
+\index[dir]{exclude}
+\index[dir]{Directive!exclude}
    The default is {\bf no}. When  enabled, any files matched within the Options
    will be  excluded from the backup. 
 
 \label{ACLSupport}
 
 \item [aclsupport=yes|no]
-\index[dir]{aclsupport }
+\index[dir]{aclsupport}
+\index[dir]{Directive!aclsupport}
    The default is {\bf no}.  If this option is set to yes, and you have the
    POSIX {\bf libacl} installed on your system, Bacula will backup the file
    and directory UNIX Access Control Lists (ACL) as defined in IEEE Std
@@ -579,14 +629,16 @@ Change: 2005-11-06 12:36:48.000000000 +0100
    (perhaps reiserfs) that does not have ACLs, the ACLs will be ignored.
 
 \item [ignore case=yes|no]
-\index[dir]{ignore case }
+\index[dir]{ignore case}
+\index[dir]{Directive!ignore case}
    The default is {\bf no}, except on Windows systems where the default
    is {\bf yes}. When this directive is set to {\bf yes} all the case
    of character will be ignored in wild-card and regex comparisons.
    That is an uppercase A will match a lowercase a.
 
 \item [fstype=filesystem-type]
-\index[dir]{fstype }
+\index[dir]{fstype}
+\index[dir]{Directive!fstype}
    This option allows you to select files and directories by the
    filesystem type.  The permitted filesystem-type names are:
 
@@ -605,7 +657,8 @@ Change: 2005-11-06 12:36:48.000000000 +0100
 
 
 \item [hfsplussupport=yes|no]
-\index[dir]{hfsplussupport }
+\index[dir]{hfsplussupport}
+\index[dir]{Directive!hfsplussupport}
    This option allows you to turn on support for Mac OSX HFS plus 
    finder information.
 
@@ -1020,7 +1073,7 @@ that are not matched by the Options directives will automatically
 be backed up too (i.e. that is the default rule).
 
 To accomplish what we want, we must explicitly exclude all other files.
-We do this with the fillowing:
+We do this with the following:
 
 \footnotesize
 \begin{verbatim}
@@ -1033,7 +1086,7 @@ FileSet {
      }
      Options {
         Exclude = yes
-        RegexFile = "^.?*$"
+        RegexFile = ".*"
      }
      File = /myfile
   }
@@ -1100,7 +1153,7 @@ FileSet {
 The problem is that the above will include everything in /home.  To get
 things to work correctly, you need to start with the idea of exclusion
 instead of inclusion.  So, you could simply exclude all directories
-except the two you want using:
+except the two you want to use:
 \footnotesize
 \begin{verbatim}
 FileSet {
@@ -1131,7 +1184,7 @@ FileSet {
         wilddir = "/home/b*"
      }
      Options {
-        RegexDir = "^.?*$"
+        RegexDir = ".*"
         exclude = yes
      }
      File = /home
@@ -1140,10 +1193,6 @@ FileSet {
 \end{verbatim}
 \normalsize
 
-I haven't actually tried the above two examples, so you may need to
-tweak them to get them to work right.
-
-
 \subsubsection*{Backing up Raw Partitions}
 \index[general]{Backing up!Partitions }
 \index[general]{Backing up Raw Partitions }
index f91bf5728e887c06afd7f88910793d9c96502f1e..78dad02b359c2ca763ba5198c89b0547ff8e30d8 100644 (file)
@@ -2,16 +2,16 @@
 %%
 
 \section*{Volume Utility Tools}
-\label{_ChapterStart9}
-\index[general]{Volume Utility Tools }
-\index[general]{Tools!Volume Utility }
+\label{_UtilityChapter}
+\index[general]{Volume Utility Tools}
+\index[general]{Tools!Volume Utility}
 \addcontentsline{toc}{section}{Volume Utility Tools}
 
 This document describes the utility programs written to aid Bacula users and
 developers in dealing with Volumes external to Bacula. 
 
 \subsection*{Specifying the Configuration File}
-\index[general]{Specifying the Configuration File }
+\index[general]{Specifying the Configuration File}
 \addcontentsline{toc}{subsection}{Specifying the Configuration File}
 
 Starting with version 1.27, each of the following programs requires a valid
@@ -24,8 +24,8 @@ configuration file using the {\bf -c} option.
 
 
 \subsection*{Specifying a Device Name For a Tape}
-\index[general]{Tape!Specifying a Device Name For a }
-\index[general]{Specifying a Device Name For a Tape }
+\index[general]{Tape!Specifying a Device Name For a}
+\index[general]{Specifying a Device Name For a Tape}
 \addcontentsline{toc}{subsection}{Specifying a Device Name For a Tape}
 
 Each of these programs require a {\bf device-name} where the Volume can be
@@ -41,8 +41,8 @@ will {\bf busy} because Bacula is using it.
 
 
 \subsection*{Specifying a Device Name For a File}
-\index[general]{File!Specifying a Device Name For a }
-\index[general]{Specifying a Device Name For a File }
+\index[general]{File!Specifying a Device Name For a}
+\index[general]{Specifying a Device Name For a File}
 \addcontentsline{toc}{subsection}{Specifying a Device Name For a File}
 
 If you are attempting to read or write an archive file rather than a tape, the
@@ -54,8 +54,8 @@ to the archive device name, and the filename is equivalent to the volume name.
 
 
 \subsection*{Specifying Volumes}
-\index[general]{Volumes!Specifying }
-\index[general]{Specifying Volumes }
+\index[general]{Volumes!Specifying}
+\index[general]{Specifying Volumes}
 \addcontentsline{toc}{subsection}{Specifying Volumes}
 
 In general, you must specify the Volume name to each of the programs below
@@ -114,7 +114,8 @@ accept any volume. For example:
 
 \subsection*{bls}
 \label{bls}
-\index[general]{bls }
+\index[general]{bls}
+\index[general]{program!bls}
 \addcontentsline{toc}{subsection}{bls}
 
 {\bf bls} can be used to do an {\bf ls} type listing of a {\bf Bacula} tape or
@@ -190,8 +191,8 @@ bls: Got EOF on device /tmp
 \normalsize
 
 \subsubsection*{Listing Jobs}
-\index[general]{Listing Jobs with bls }
-\index[general]{bls!Listing Jobs }
+\index[general]{Listing Jobs with bls}
+\index[general]{bls!Listing Jobs}
 \addcontentsline{toc}{subsubsection}{bls Listing Jobs}
 
 If you are listing a Volume to determine what Jobs to restore, normally the
@@ -227,8 +228,8 @@ Adding the {\bf -v} option will display virtually all information that is
 available for each record: 
 
 \subsubsection*{Listing Blocks}
-\index[general]{Listing Blocks with bls }
-\index[general]{bls!Listing Blocks }
+\index[general]{Listing Blocks with bls}
+\index[general]{bls!Listing Blocks}
 \addcontentsline{toc}{subsubsection}{bls Listing Blocks}
 
 Normally, except for debugging purposes, you will not need to list Bacula
@@ -318,7 +319,8 @@ bls: block.c:92    Rec: VId=1 VT=1035062102 FI=6 Strm=MD5 len=16 p=8101841
 
 \subsection*{bextract}
 \label{bextract}
-\index[general]{Bextract }
+\index[general]{Bextract}
+\index[general]{program!bextract}
 \addcontentsline{toc}{subsection}{bextract}
 
 Normally, you will restore files by running a {\bf Restore} Job from the {\bf
@@ -355,8 +357,8 @@ stripped. If no prefix is specified, the file will be restored to the original
 drive. 
 
 \subsubsection*{Extracting with Include or Exclude Lists}
-\index[general]{Lists!Extracting with Include or Exclude }
-\index[general]{Extracting with Include or Exclude Lists }
+\index[general]{Lists!Extracting with Include or Exclude}
+\index[general]{Extracting with Include or Exclude Lists}
 \addcontentsline{toc}{subsubsection}{Extracting with Include or Exclude Lists}
 
 Using the {\bf -e} option, you can specify a file containing a list of files
@@ -398,8 +400,8 @@ directory {\bf /tmp} (i.e. /tmp/home/kern/bacula/... and
 /tmp/usr/local/bin/...). 
 
 \subsubsection*{Extracting With a Bootstrap File}
-\index[general]{File!Extracting With a Bootstrap }
-\index[general]{Extracting With a Bootstrap File }
+\index[general]{File!Extracting With a Bootstrap}
+\index[general]{Extracting With a Bootstrap File}
 \addcontentsline{toc}{subsubsection}{Extracting With a Bootstrap File}
 
 The {\bf -b} option is used to specify a {\bf bootstrap} file containing the
@@ -424,8 +426,8 @@ applied, and then each file record seen will be compared to the include and
 exclude lists. 
 
 \subsubsection*{Extracting From Multiple Volumes}
-\index[general]{Volumes!Extracting From Multiple }
-\index[general]{Extracting From Multiple Volumes }
+\index[general]{Volumes!Extracting From Multiple}
+\index[general]{Extracting From Multiple Volumes}
 \addcontentsline{toc}{subsubsection}{Extracting From Multiple Volumes}
 
 If you wish to extract files that span several Volumes, you can specify the
@@ -437,7 +439,8 @@ program.
 
 \subsection*{bscan}
 \label{bscan}
-\index[general]{bscan }
+\index[general]{bscan}
+\index[general]{program!bscan}
 \addcontentsline{toc}{subsection}{bscan}
 
 The {\bf bscan} program can be used to re-create a database (catalog) from the
@@ -554,8 +557,8 @@ and will permit restoration of any or all the files in the catalog using the
 normal Bacula console commands. 
 
 \subsubsection*{Using bscan to Compare a Volume to an existing Catalog}
-\index[general]{Catalog!Using bscan to Compare a Volume to an existing }
-\index[general]{Using bscan to Compare a Volume to an existing Catalog }
+\index[general]{Catalog!Using bscan to Compare a Volume to an existing}
+\index[general]{Using bscan to Compare a Volume to an existing Catalog}
 \addcontentsline{toc}{subsubsection}{Using bscan to Compare a Volume to an
 existing Catalog}
 
@@ -567,8 +570,8 @@ as they should be, so we don't particularly recommend this mode other than for
 testing. 
 
 \subsubsection*{Using bscan to Recreate a Catalog from a Volume}
-\index[general]{Volume!Using bscan to Recreate a Catalog from a }
-\index[general]{Using bscan to Recreate a Catalog from a Volume }
+\index[general]{Volume!Using bscan to Recreate a Catalog from a}
+\index[general]{Using bscan to Recreate a Catalog from a Volume}
 \addcontentsline{toc}{subsubsection}{Using bscan to Recreate a Catalog from a
 Volume}
 
@@ -589,12 +592,12 @@ as:
 If there is more than one volume, simply append it to the first one separating
 it with a vertical bar. You may need to precede the vertical bar with a
 forward slash escape the shell -- e.g. {\bf
-TestVolume1\textbackslash{}|TestVolume2 }. The {\bf -v} option was added for
+TestVolume1\textbackslash{}|TestVolume2}. The {\bf -v} option was added for
 verbose output (this can be omitted if desired). The {\bf -s} option that
 tells {\bf bscan} to store information in the database. The physical device
 name {\bf /dev/nst0} is specified after all the options. 
 
-{\bf } For example, after having done a full backup of a directory, then two
+{\bf} For example, after having done a full backup of a directory, then two
 incrementals, I reinitialized the SQLite database as described above, and
 using the bootstrap.bsr file noted above, I entered the following command: 
 
@@ -685,8 +688,8 @@ reconstruction is sufficiently complete, that you can run {\bf restore}
 against it and get valid results. 
 
 \subsubsection*{Using bscan to Correct the Volume File Count}
-\index[general]{Using bscan to Correct the Volume File Count }
-\index[general]{Count!Using bscan to Correct the Volume File }
+\index[general]{Using bscan to Correct the Volume File Count}
+\index[general]{Count!Using bscan to Correct the Volume File}
 \addcontentsline{toc}{subsubsection}{Using bscan to Correct the Volume File
 Count}
 
@@ -701,8 +704,8 @@ bscan} with the {\bf -m} option (but {\bf without} the {\bf -s} option) to
 update only the final Media record for the Volumes read. 
 
 \subsubsection*{After bscan}
-\index[general]{After bscan }
-\index[general]{Bscan!After }
+\index[general]{After bscan}
+\index[general]{Bscan!After}
 \addcontentsline{toc}{subsubsection}{After bscan}
 
 If you use {\bf bscan} to enter the contents of the Volume into an existing
@@ -717,7 +720,8 @@ the catalog.
 
 \subsection*{bcopy}
 \label{bcopy}
-\index[general]{Bcopy }
+\index[general]{Bcopy}
+\index[general]{program!bcopy}
 \addcontentsline{toc}{subsection}{bcopy}
 
 The {\bf bcopy} program can be used to copy one {\bf Bacula} archive file to
@@ -731,8 +735,8 @@ entries. If you wish to be able to use the Volume with the Console restore
 command, for example, you must first bscan the new Volume into the catalog. 
 
 \subsubsection*{bcopy Command Options}
-\index[general]{Options!bcopy Command }
-\index[general]{Bcopy Command Options }
+\index[general]{Options!bcopy Command}
+\index[general]{Bcopy Command Options}
 \addcontentsline{toc}{subsubsection}{bcopy Command Options}
 
 \footnotesize
@@ -763,7 +767,8 @@ this program with two tape drives.
 
 \subsection*{btape}
 \label{btape}
-\index[general]{Btape }
+\index[general]{Btape}
+\index[general]{program!btape}
 \addcontentsline{toc}{subsection}{btape}
 
 This program permits a number of elementary tape operations via a tty command
@@ -798,8 +803,8 @@ Usage: btape [-c config_file] [-d debug_level] [device_name]
 \normalsize
 
 \subsubsection*{Using btape to Verify your Tape Drive}
-\index[general]{Using btape to Verify your Tape Drive }
-\index[general]{Drive!Using btape to Verify your Tape }
+\index[general]{Using btape to Verify your Tape Drive}
+\index[general]{Drive!Using btape to Verify your Tape}
 \addcontentsline{toc}{subsubsection}{Using btape to Verify your Tape Drive}
 
 An important reason for this program is to ensure that a Storage daemon
@@ -815,8 +820,8 @@ reasonably self explanatory. Please see the
 the details. 
 
 \subsubsection*{btape Commands}
-\index[general]{Btape Commands }
-\index[general]{Commands!btape }
+\index[general]{Btape Commands}
+\index[general]{Commands!btape}
 \addcontentsline{toc}{subsubsection}{btape Commands}
 
 The full list of commands are: 
@@ -876,8 +881,8 @@ note for labeling tapes, we recommend that you use the {\bf label} command in
 the {\bf Console} program since it will never overwrite a valid Bacula tape. 
 
 \subsection*{Other Programs}
-\index[general]{Programs!Other }
-\index[general]{Other Programs }
+\index[general]{Programs!Other}
+\index[general]{Other Programs}
 \addcontentsline{toc}{subsection}{Other Programs}
 
 The following programs are general utility programs and in general do not need
@@ -885,7 +890,8 @@ a configuration file nor a device name.
 
 \subsection*{bsmtp}
 \label{bsmtp}
-\index[general]{Bsmtp }
+\index[general]{Bsmtp}
+\index[general]{program!bsmtp}
 \addcontentsline{toc}{subsection}{bsmtp}
 
 {\bf bsmtp} is a simple mail transport program that permits more flexibility
@@ -949,9 +955,14 @@ syntax of the from part of the message. Please test.
 When running {\bf bsmtp} by hand, you will need to terminate the message by
 entering a ctl-d in column 1 of the last line. 
 
+If you are getting incorrect dates (e.g. 1970) and you are
+running with a non-English language setting, you might try adding
+a LANG="en_US" immediately before the bsmtp call.
+
 \subsection*{dbcheck}
 \label{dbcheck}
-\index[general]{Dbcheck }
+\index[general]{Dbcheck}
+\index[general]{program!dbcheck}
 \addcontentsline{toc}{subsection}{dbcheck}
 
 {\bf dbcheck} is a simple program that will search for logical
@@ -1099,9 +1110,48 @@ you should never need to run dbcheck inspite of the
 recommendations given above, which are given so that users don't
 waste their time running dbcheck too often.
 
+\subsection*{regex}
+\label{regex}
+\index[general]{regex}
+\index[general]{program!regex}
+\addcontentsline{toc}{subsection}{regex}
+
+{\bf regex} is a simple program that will allow you to test 
+regex expressions against a file of data. This can be useful
+because the regex libraries on most systems differ, and in
+addition, regex expressions can be complicated.
+
+{\bf regex} is found in the src/tools directory and it is not
+normally installed. To run it, use:
+
+\begin{verbatim}
+Usage: regex [-d debug_level] -f <data-file>
+       -f          specify file of data to be matched
+       -l          suppress line numbers
+       -n          print lines that do not match
+       -?          print this message.
+\end{verbatim}
+
+The \lt{}data-file\gt{} is a filename that contains lines
+of data to be matched (or not) against one or more patterns.
+When the program is run, it will prompt you for a regular 
+expression pattern, then apply it one line at a time against
+the data in the file. Each line that matches will be printed 
+preceded by its line number.  You will then be prompted again  
+for another pattern.  
+
+Enter an empty line for a pattern to terminate the program. You
+can print only lines that do not match by using the -n option,
+and you can suppress printing of line numbers with the -l option.
+
+This program can be useful for testing regex expressions to be 
+applied against a list of filenames.
+
+
 \subsection*{testfind}
 \label{testfind}
-\index[general]{Testfind }
+\index[general]{Testfind}
+\index[general]{program!testfind}
 \addcontentsline{toc}{subsection}{testfind}
 
 {\bf testfind} permits listing of files using the same search engine that is
index a811b7ac7df852c821242aebeae79d198c901b50..cc9007fe9f24145567937e149ca38d54691149f0 100644 (file)
@@ -57,11 +57,13 @@ have one and only one Storage resource definition.
 \begin{description}
 
 \item [Name = \lt{}Storage-Daemon-Name\gt{}]
-   \index[sd]{Name }
+   \index[sd]{Name}
+   \index[sd]{Directive!Name}
    Specifies the Name of the Storage daemon. This  directive is required. 
 
 \item [Working Directory = \lt{}Directory\gt{}]
-   \index[sd]{Working Directory }
+   \index[sd]{Working Directory}
+   \index[sd]{Directive!Working Directory}
    This directive  is mandatory and specifies a directory in which the Storage
    daemon  may put its status files. This directory should be used only  by {\bf
    Bacula}, but may be shared by other Bacula daemons provided the names
@@ -69,7 +71,8 @@ have one and only one Storage resource definition.
    required  
 
 \item [Pid Directory = \lt{}Directory\gt{}]
-   \index[sd]{Pid Directory }
+   \index[sd]{Pid Directory}
+   \index[sd]{Directive!Pid Directory}
    This directive  is mandatory and specifies a directory in which the Director 
    may put its process Id file files. The process Id file is used to  shutdown
    Bacula and to prevent multiple copies of  Bacula from running simultaneously. 
@@ -82,7 +85,8 @@ have one and only one Storage resource definition.
    Directory} as  defined above. 
 
 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
-   \index[sd]{Heartbeat Interval }
+   \index[sd]{Heartbeat Interval}
+   \index[sd]{Directive!Heartbeat Interval}
    \index[general]{Heartbeat Interval}
    \index[general]{Broken pipe}
    This directive defines an interval of time.  When the Storage daemon is
@@ -96,6 +100,7 @@ have one and only one Storage resource definition.
 
 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
    \index[sd]{Maximum Concurrent Jobs}
+   \index[sd]{Directive!Maximum Concurrent Jobs}
    where \lt{}number\gt{} is the maximum number of Jobs that should run
    concurrently.  The default is set to 10, but you may set it to a larger
    number.  Each contact from the Director (e.g.  status request, job start
@@ -110,6 +115,7 @@ have one and only one Storage resource definition.
 
 \item [SDAddresses = \lt{}IP-address-specification\gt{}]
    \index[sd]{SDAddresses}
+   \index[sd]{Directive!SDAddresses}
    Specify the ports and addresses on which the Storage daemon will listen
    for Director connections.  Normally, the default is sufficient and you
    do not need to specify this directive.  Probably the simplest way to
@@ -154,17 +160,20 @@ Using this directive, you can replace both the SDPort and SDAddress
 directives shown below. 
 
 \item [SDPort = \lt{}port-number\gt{}]
-   \index[sd]{SDPort }
+   \index[sd]{SDPort}
+   \index[sd]{Directive!SDPort}
    Specifies port number on which the Storage daemon  listens for Director
    connections. The default is 9103.  
    
 \item [SDAddress = \lt{}IP-Address\gt{}]
-   \index[sd]{SDAddress }
-   This directive is optional,  and if it is specified, it will cause the Storage
-   daemon server (for  Director and File daemon connections) to bind to the
-   specified  {\bf IP-Address}, which is either a domain name or an IP address 
-   specified as a dotted quadruple. If this directive is not specified,  the
-   Storage daemon will bind to any available address (the default).
+   \index[sd]{SDAddress}
+   \index[sd]{Directive!SDAddress}
+   This directive is optional, and if it is specified, it will cause the
+   Storage daemon server (for Director and File daemon connections) to bind
+   to the specified {\bf IP-Address}, which is either a domain name or an
+   IP address specified as a dotted quadruple.  If this directive is not
+   specified, the Storage daemon will bind to any available address (the
+   default).
 
 \end{description}
 
@@ -199,17 +208,20 @@ values in the Director's configuration file.
 \begin{description}
 
 \item [Name = \lt{}Director-Name\gt{}]
-   \index[sd]{Name }
+   \index[sd]{Name}
+   \index[sd]{Directive!Name}
    Specifies the Name of the Director allowed to connect  to the Storage daemon.
    This directive is required.  
 
 \item [Password = \lt{}Director-password\gt{}]
-   \index[sd]{Password }
+   \index[sd]{Password}
+   \index[sd]{Directive!Password}
    Specifies the password that must be supplied by the above named  Director.
    This directive is required.  
 
 \item [Monitor = \lt{}yes|no\gt{}]
-   \index[sd]{Monitor }
+   \index[sd]{Monitor}
+   \index[sd]{Directive!Monitor}
    If Monitor is set to {\bf no} (default), this director will have full
    access to this Storage daemon.  If Monitor is set to {\bf yes}, this
    director will only be able to fetch the current status of this Storage
@@ -246,7 +258,8 @@ specified within the Device resource are specific to the Device.
 \begin{description}
 
 \item [Name = {\it Device-Name}]
-   \index[sd]{Name }
+   \index[sd]{Name}
+   \index[sd]{Directive!Name}
    Specifies the Name that the Director will use when asking to backup or
    restore to or from to this device. This is the logical  Device name, and may
    be any string up to 127 characters in length.  It is generally a good idea to
@@ -258,7 +271,8 @@ specified within the Device resource are specific to the Device.
    resource. 
 
 \item [Archive Device = {\it name-string}]
-   \index[sd]{Archive Device }
+   \index[sd]{Archive Device}
+   \index[sd]{Directive!Archive Device}
    The specified {\bf name-string} gives the system file name of the  storage
    device managed by this storage daemon. This will usually be  the device file
    name of a removable storage device (tape drive),  for example "{\bf
@@ -306,6 +320,7 @@ specified within the Device resource are specific to the Device.
 
 \item [Device Type = {\it type-specification}]
    \index[sd]{Device Type}
+   \index[sd]{Directive!Device Type}
    The Device Type specification allows you to explicitly tell Bacula
    what kind of device you are defining. It the {\it type-specification}
    may be one of the following:
@@ -341,7 +356,8 @@ specified within the Device resource are specific to the Device.
 
 
 \item [Media Type = {\it name-string}]
-   \index[sd]{Media Type }
+   \index[sd]{Media Type}
+   \index[sd]{Directive!Media Type}
    The specified {\bf name-string} names the type of media supported by this
    device, for example, "DLT7000".  Media type names are arbitrary in that you
    set them to anything you want, but they must be known to the volume
@@ -375,6 +391,7 @@ specified within the Device resource are specific to the Device.
 \label{Autochanger}
 \item [Autochanger = {\it Yes|No}]
    \index[sd]{Autochanger}
+   \index[sd]{Directive!Autochanger}
    If {\bf Yes}, this device belongs to an automatic tape changer, and  you should also
    specify a {\bf Changer Device} as well as  a {\bf Changer Command}.  If {\bf
    No} (default), the volume must be manually changed.  You should also
@@ -383,7 +400,8 @@ specified within the Device resource are specific to the Device.
    configuration file so that  when labeling tapes you are prompted for the slot.
 
 \item [Changer Device = {\it name-string}]
-   \index[sd]{Changer Device }
+   \index[sd]{Changer Device}
+   \index[sd]{Directive!Changer Device}
    The specified {\bf name-string} must be the {\bf generic SCSI} device
    name of the autochanger that corresponds to the normal read/write
    {\bf Archive Device}  specified in the Device resource. This
@@ -399,7 +417,8 @@ specified within the Device resource are specific to the Device.
    autochanger directives.
 
 \item [Changer Command = {\it name-string}]
-   \index[sd]{Changer Command }
+   \index[sd]{Changer Command}
+   \index[sd]{Directive!Changer Command}
    The {\bf name-string} specifies an external program to be called  that will
    automatically change volumes as required by {\bf Bacula}.  Most frequently,
    you will specify the Bacula supplied {\bf mtx-changer}  script as follows:  
@@ -419,8 +438,9 @@ Changer Command = "/path/mtx-changer %c %o %S %a %d"
    scripts in {\bf examples/autochangers}.  
 
 \item [Alert Command = {\it name-string}]
-   \index[sd]{Alert Command }
+   \index[sd]{Alert Command}
    The {\bf name-string} specifies an external program to be called  at the
+   \index[sd]{Directive!Changer Command}
    completion of each Job after the device is released.  The purpose of this
    command is to check for Tape Alerts, which  are present when something is
    wrong with your tape drive  (at least for most modern tape drives).  The same
@@ -458,6 +478,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
 
 \item [Drive Index = {\it number}]
    \index[sd]{Drive Index}
+   \index[sd]{Directive!Drive Index}
    The {\bf Drive Index} that you specify is passed to the  {\bf mtx-changer}
    script and is thus passed to the {\bf mtx}  program. By default, the Drive
    Index is zero, so if you have only  one drive in your autochanger, everything
@@ -473,6 +494,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
 
 \item [Autoselect = {\it Yes|No}]
    \index[sd]{Autoselect}
+   \index[sd]{Directive!Autoselect}
    If this directive is set to {\bf yes} (default), and the Device
    belongs to an autochanger, then when the Autochanger is referenced
    by the Director, this device can automatically be selected. If this
@@ -483,6 +505,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
 
 \item [Maximum Changer Wait = {\it time}]
    \index[sd]{Maximum Changer Wait}
+   \index[sd]{Directive!Maximum Changer Wait}
    This directive specifies the maximum time in seconds for Bacula to wait
    for an autochanger to change the volume.  If this time is exceeded,
    Bacula will invalidate the Volume slot number stored in the catalog and
@@ -491,18 +514,21 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
 
 \item [Maximum Rewind Wait = {\it time}]
    \index[sd]{Maximum Rewind Wait}
+   \index[sd]{Directive!Maximum Rewind Wait}
    This directive specifies the maximum time in seconds for Bacula to wait
    for a rewind before timing out.  If this time is exceeded,
    Bacula will cancel the job.  The default is 5 minutes.
 
 \item [Maximum Open Wait = {\it time}]
    \index[sd]{Maximum Open Wait}
+   \index[sd]{Directive!Maximum Open Wait}
    This directive specifies the maximum time in seconds for Bacula to wait
    for a open before timing out.  If this time is exceeded,
    Bacula will cancel the job.  The default is 5 minutes.
 
 \item [Always Open = {\it Yes|No}]
-   \index[sd]{Always Open }
+   \index[sd]{Always Open}
+   \index[sd]{Directive!Always Open}
    If {\bf Yes} (default), Bacula will always keep the device open unless
    specifically {\bf unmounted} by the Console program.  This permits
    Bacula to ensure that the tape drive is always available.  If you set
@@ -529,7 +555,8 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    operation. 
 
 \item [Volume Poll Interval = {\it time}]
-   \index[sd]{Volume Poll Interval }
+   \index[sd]{Volume Poll Interval}
+   \index[sd]{Directive!Volume Poll Interval}
    If the time  specified on this directive is non-zero, after  asking the
    operator to mount a new volume Bacula will  periodically poll (or read) the
    drive at the specified  interval to see if a new volume has been mounted. If
@@ -551,6 +578,7 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
 
 \item [Close on Poll= {\it Yes|No}]
    \index[sd]{Close on Poll}
+   \index[sd]{Directive!Close on Poll}
    If {\bf Yes}, Bacula close the device (equivalent to  an unmount except no
    mount is required) and reopen it at each  poll. Normally this is not too
    useful unless you have the  {\bf Offline on Unmount} directive set, in which
@@ -560,7 +588,8 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    Please see above more more details.
 
 \item [Maximum Open Wait = {\it time}]
-   \index[sd]{Maximum Open Wait }
+   \index[sd]{Maximum Open Wait}
+   \index[sd]{Directive!Maximum Open Wait}
    This directive specifies the maximum amount of time in seconds that
    Bacula will wait for a device that is busy.  The default is 5 minutes.
    If the device cannot be obtained, the current Job will be terminated in
@@ -568,19 +597,22 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    starts that needs the the drive.
 
 \item [Removable media = {\it Yes|No}]
-   \index[sd]{Removable media }
-   If {\bf Yes}, this device supports removable media (for  example, tapes or
-   CDs). If {\bf No}, media cannot be removed  (for example, an intermediate
-   backup area on a hard disk).  
+   \index[sd]{Removable media}
+   \index[sd]{Directive!Removable media}
+   If {\bf Yes}, this device supports removable media (for example, tapes
+   or CDs).  If {\bf No}, media cannot be removed (for example, an
+   intermediate backup area on a hard disk).
 
 \item [Random access = {\it Yes|No}]
-   \index[sd]{Random access }
-   If {\bf Yes}, the archive device is assumed to be a random  access medium
-   which supports the {\bf lseek} (or  {\bf lseek64} if Largefile is enabled
-   during configuration) facility.  
+   \index[sd]{Random access}
+   \index[sd]{Directive!Random access}
+   If {\bf Yes}, the archive device is assumed to be a random access medium
+   which supports the {\bf lseek} (or {\bf lseek64} if Largefile is enabled
+   during configuration) facility.
 
 \item [Minimum block size = {\it size-in-bytes}]
-   \index[sd]{Minimum block size }
+   \index[sd]{Minimum block size}
+   \index[sd]{Directive!Minimum block size}
    On most modern tape drives, you will not need or wamt to specify this
    directive, and if you do so, it will be to make Bacula use fixed block
    sizes.  This statement applies only to non-random access devices (e.g.
@@ -629,7 +661,8 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
 \normalsize
 
 \item [Maximum block size = {\it size-in-bytes}]
-   \index[sd]{Maximum block size }
+   \index[sd]{Maximum block size}
+   \index[sd]{Directive!Maximum block size}
    On most modern tape drives, you will not need to specify this directive.
    If you do so, it will most likely be to use fixed block sizes (see
    Minimum block size above).  The Storage daemon will aways attempt to
@@ -644,7 +677,8 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    use a default block size of 64,512 bytes (126 * 512).
 
 \item [Hardware End of Medium = {\it Yes|No}]
-   \index[sd]{Hardware End of Medium }
+   \index[sd]{Hardware End of Medium}
+   \index[sd]{Directive!Hardware End of Medium}
    If {\bf No}, the archive device is not required to support end  of medium
    ioctl request, and the storage daemon will use the forward  space file
    function to find the end of the recorded data. If  {\bf Yes}, the archive
@@ -665,7 +699,8 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    feature.  
    
 \item [Fast Forward Space File = {\it Yes|No}]
-   \index[sd]{Fast Forward Space File }
+   \index[sd]{Fast Forward Space File}
+   \index[sd]{Directive!Fast Forward Space File}
    If {\bf No}, the archive device is not required to support  keeping track of
    the file number ({\bf MTIOCGET} ioctl) during  forward space file. If {\bf
    Yes}, the archive device must support  the {\tt ioctl} {\tt MTFSF} call, which
@@ -678,7 +713,8 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    Default setting for Fast Forward Space File is {\bf Yes}.
    
 \item [Use MTIOCGET = {\it Yes|No}]
-   \index[sd]{Fast Forward Space File }
+   \index[sd]{Fast Forward Space File}
+   \index[sd]{Directive!Fast Forward Space File}
    If {\bf No}, the operating system is not required to support keeping track of
    the file number and reporting it in the ({\bf MTIOCGET} ioctl). The default
    is {\bf Yes}. If you must set this to No, Bacula will do the proper file
@@ -689,7 +725,8 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    Solaris, Linux and FreeBSD.
 
 \item [BSF at EOM = {\it Yes|No}]
-   \index[sd]{BSF at EOM }
+   \index[sd]{BSF at EOM}
+   \index[sd]{Directive!BSF at EOM}
    If {\bf No}, the default, no special action is taken by  Bacula with the End
    of Medium (end of tape) is reached because  the tape will be positioned after
    the last EOF tape mark, and  Bacula can append to the tape as desired.
@@ -702,13 +739,15 @@ bacula-sd  Alert: TapeAlert[32]: Interface: Problem with SCSI interface
    is done using the {\bf test} command  in the {\bf btape} program.
 
 \item [TWO EOF = {\it Yes|No}]
-   \index[sd]{TWO EOF }
+   \index[sd]{TWO EOF}
+   \index[sd]{Directive!TWO EOF}
    If {\bf Yes}, Bacula will write two end of file marks when  terminating a tape
 -- i.e. after the last job or at the end of  the medium. If {\bf No}, the
 default, Bacula will only write  one end of file to terminate the tape. 
 
 \item [Backward Space Record = {\it Yes|No}]
    \index[sd]{Backward Space Record}
+   \index[sd]{Directive!Backward Space Record}
    If {\it Yes}, the archive device supports the {\tt MTBSR  ioctl} to backspace
    records. If {\it No}, this call is not  used and the device must be rewound
    and advanced forward to the  desired position. Default is {\bf Yes} for non
@@ -719,7 +758,8 @@ default, Bacula will only write  one end of file to terminate the tape.
    precautionary rather than required.
 
 \item [Backward Space File = {\it Yes|No}]
-   \index[sd]{Backward Space File }
+   \index[sd]{Backward Space File}
+   \index[sd]{Directive!Backward Space File}
    If {\it Yes}, the archive device supports the {\bf MTBSF} and  {\bf MTBSF
   ioctl}s to backspace over an end of file mark and to the  start of a file. If
   {\it No}, these calls are not used and the  device must be rewound and
@@ -727,20 +767,23 @@ default, Bacula will only write  one end of file to terminate the tape.
   random-access devices. 
 
 \item [Forward Space Record = {\it Yes|No}]
-   \index[sd]{Forward Space Record }
+   \index[sd]{Forward Space Record}
+   \index[sd]{Directive!Forward Space Record}
    If {\it Yes}, the archive device must support the {\bf MTFSR  ioctl} to
    forward space over records. If {\bf No}, data must  be read in order to
    advance the position on the device. Default is  {\bf Yes} for non
    random-access devices. 
 
 \item [Forward Space File = {\it Yes|No}]
-   \index[sd]{Forward Space File }
+   \index[sd]{Forward Space File}
+   \index[sd]{Directive!Forward Space File}
    If {\bf Yes}, the archive device must support the {\tt MTFSF  ioctl} to
    forward space by file marks. If {\it No}, data  must be read to advance the
    position on the device. Default is  {\bf Yes} for non random-access devices. 
 
 \item [Offline On Unmount = {\it Yes|No}]
-   \index[sd]{Offline On Unmount }
+   \index[sd]{Offline On Unmount}
+   \index[sd]{Directive!Offline On Unmount}
    The default for this directive is {\bf No}. If {\bf Yes} the  archive device
    must support the {\tt MTOFFL ioctl} to rewind and  take the volume offline. In
    this case, Bacula will issue the  offline (eject) request before closing the
@@ -762,7 +805,8 @@ default, Bacula will only write  one end of file to terminate the tape.
 
 
 \item [Maximum Volume Size = {\it size}]
-   \index[sd]{Maximum Volume Size }
+   \index[sd]{Maximum Volume Size}
+   \index[sd]{Directive!Maximum Volume Size}
    No more than {\bf size} bytes will be written onto a given volume on the
    archive device.  This directive is used mainly in testing Bacula to
    simulate a small Volume.  It can also be useful if you wish to limit the
@@ -774,7 +818,8 @@ default, Bacula will only write  one end of file to terminate the tape.
    Volume Bytes} defined in the Director's configuration file.
 
 \item [Maximum File Size = {\it size}]
-   \index[sd]{Maximum File Size }
+   \index[sd]{Maximum File Size}
+   \index[sd]{Directive!Maximum File Size}
    No more than {\bf size} bytes will be written into a given logical file
    on the volume.  Once this size is reached, an end of file mark is
    written on the volume and subsequent data are written into the next
@@ -784,7 +829,8 @@ default, Bacula will only write  one end of file to terminate the tape.
    Gigabyte.
 
 \item [Block Positioning = {\it yes|no}]
-   \index[sd]{Block Positioning }
+   \index[sd]{Block Positioning}
+   \index[sd]{Directive!Block Positioning}
    This directive is not normally used (and has not yet been  tested). It will
    tell Bacula not to use block positioning when  it is reading tapes. This can
    cause Bacula to be {\bf extremely}  slow when restoring files. You might use
@@ -793,7 +839,8 @@ default, Bacula will only write  one end of file to terminate the tape.
    hope, Bacula will be able to re-read your tapes. 
 
 \item [Maximum Network Buffer Size = {\it bytes}]
-   \index[sd]{Maximum Network Buffer Size }
+   \index[sd]{Maximum Network Buffer Size}
+   \index[sd]{Directive!Maximum Network Buffer Size}
    where {\it bytes} specifies the initial network buffer  size to use with the
    File daemon.  This size will be adjusted down if it is too large until
    it is accepted by the OS. Please use care in setting this value since if
@@ -813,25 +860,29 @@ default, Bacula will only write  one end of file to terminate the tape.
 
 
 \item [Maximum Spool Size = {\it bytes}]
-   \index[sd]{Maximum Spool Size }
+   \index[sd]{Maximum Spool Size}
+   \index[sd]{Directive!Maximum Spool Size}
    where the bytes specify the maximum spool size for all jobs  that are running.
    The default is no limit. 
 
 \item [Maximum Job Spool Size = {\it bytes}]
-   \index[sd]{Maximum Job Spool Size }
+   \index[sd]{Maximum Job Spool Size}
+   \index[sd]{Directive!Maximum Job Spool Size}
    where the bytes specify the maximum spool size for any one job  that is
    running. The default is no limit. 
    This directive is implemented only in version 1.37 and later.
 
 \item [Spool Directory = {\it directory}]
-   \index[sd]{Spool Directory }
+   \index[sd]{Spool Directory}
+   \index[sd]{Directive!Spool Directory}
    specifies the name of the directory to be used to store  the spool files for
    this device. This directory is also used to store  temporary part files when
    writing to a device that requires mount (DVD).  The default is to use the
    working directory. 
 
 \item [Maximum Part Size = {\it bytes}]
-   \index[sd]{Maximum Part Size }
+   \index[sd]{Maximum Part Size}
+   \index[sd]{Directive!Maximum Part Size}
    This is the maximum size of a volume part file. The default is no limit.
    This directive is implemented only in version 1.37 and later.
 
@@ -859,7 +910,8 @@ apply to removable filesystems such as USB in addition to DVD.
 \begin{description}
 
 \item [Requires Mount = {\it Yes|No}]
-   \index[sd]{Requires Mount }
+   \index[sd]{Requires Mount}
+   \index[sd]{Directive!Requires Mount}
    You must set this directive to {\bf yes} for DVD-writers,  and to {\bf no} for
    all other devices (tapes/files).  This directive indicates if the device
    requires to be mounted to be read,  and if it must be written in a special way.
@@ -867,11 +919,13 @@ apply to removable filesystems such as USB in addition to DVD.
    {\bf Write Part Command}  directives must also be defined. 
 
 \item [Mount Point = {\it directory}]
-   \index[sd]{Mount Point }
+   \index[sd]{Mount Point}
+   \index[sd]{Directive!Mount Point}
    Directory where the device can be mounted. 
 
 \item [Mount Command = {\it name-string}]
-   \index[sd]{Mount Command }
+   \index[sd]{Mount Command}
+   \index[sd]{Directive!Mount Command}
    Command that must be executed to mount the device. Before the command is 
    executed, \%a is replaced with the Archive Device, and \%m with the Mount 
    Point.
@@ -885,7 +939,8 @@ apply to removable filesystems such as USB in addition to DVD.
 \normalsize
 
 \item [Unmount Command = {\it name-string}]
-   \index[sd]{Unmount Command }
+   \index[sd]{Unmount Command}
+   \index[sd]{Directive!Unmount Command}
    Command that must be executed to unmount the device. Before the command  is
    executed, \%a is replaced with the Archive Device, and \%m with the  Mount
    Point.
@@ -899,7 +954,8 @@ apply to removable filesystems such as USB in addition to DVD.
 \normalsize
 
 \item [Write Part Command = {\it name-string}]
-   \index[sd]{Write Part Command }
+   \index[sd]{Write Part Command}
+   \index[sd]{Directive!Write Part Command}
    Command that must be executed to write a part to the device. Before the 
    command is executed, \%a is replaced with the Archive Device, \%m with the 
    Mount Point, \%e is replaced with 1 if we are writing the first part,
@@ -922,7 +978,8 @@ apply to removable filesystems such as USB in addition to DVD.
 
 
 \item [Free Space Command = {\it name-string}]
-   \index[sd]{Free Space Command }
+   \index[sd]{Free Space Command}
+   \index[sd]{Directive!Free Space Command}
    Command that must be executed to check how much free space is left on the 
    device. Before the command is executed,\%a is replaced with the Archive
    Device, \%m with the Mount Point, \%e is replaced with 1 if we are writing
@@ -961,18 +1018,19 @@ apply to removable filesystems such as USB in addition to DVD.
 \begin{description}
 
 \item [Label media = {\it Yes|No}]
-   \index[sd]{Label media }
-   If {\bf Yes}, permits this device to automatically  label blank media without
-   an explicit operator command.  It does so by using an internal algorithm as
-   defined  on the 
-   \ilink{Label Format}{Label} record in each Pool resource.  If
-   this is {\bf No} as by default,  Bacula will label tapes only by specific
-   operator  command ({\bf label} in the Console) or when the tape has been
-   recycled.  The automatic labeling feature is most useful when writing to disk 
-   rather than tape volumes.  
+   \index[sd]{Label media}
+   \index[sd]{Directive!Label media}
+   If {\bf Yes}, permits this device to automatically label blank media
+   without an explicit operator command.  It does so by using an internal
+   algorithm as defined on the \ilink{Label Format}{Label} record in each
+   Pool resource.  If this is {\bf No} as by default, Bacula will label
+   tapes only by specific operator command ({\bf label} in the Console) or
+   when the tape has been recycled.  The automatic labeling feature is most
+   useful when writing to disk rather than tape volumes.
 
 \item [Automatic mount = {\it Yes|No}]
-   \index[sd]{Automatic mount }
+   \index[sd]{Automatic mount}
+   \index[sd]{Directive!Automatic mount}
    If {\bf Yes} (the default), permits the daemon to examine the device to
    determine if it contains a Bacula labeled volume.  This is done
    initially when the daemon is started, and then at the beginning of each
index 0a210a2627b3542c1babfb7fe45e67927c0e99dc..2839c70a5fd7f12615d1032823753b73a1147df0 100644 (file)
@@ -1 +1 @@
-1.38.6-beta5 (14 March 2006)
+1.38.6-beta6 (16 March 2006)