From: Eric Bollengier Date: Fri, 28 Sep 2012 14:49:04 +0000 (+0200) Subject: Tweak anchors X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=ed5b190a2d679bb103883f22b3749d026c2de9b7;p=bacula%2Fdocs Tweak anchors --- diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex index a5ba8bbc..4aaac502 100644 --- a/docs/manuals/en/main/dirdconf.tex +++ b/docs/manuals/en/main/dirdconf.tex @@ -83,8 +83,8 @@ way or another. classes of messages to different users or locations (files, ...). \end{itemize} -\section{The Director Resource} \label{DirectorResource4} +\section{The Director Resource} \index[general]{Director Resource} \index[general]{Resource!Director} @@ -100,22 +100,22 @@ index and media database redundancy. Start of the Director resource. One and only one director resource must be supplied. +\label{Director:Name} \item [Name = \lt{}name\gt{}] - \label{Director:Name} \index[dir]{Name} \index[dir]{Directive!Name} The director name used by the system administrator. This directive is required. +\label{Director:Description} \item [Description = \lt{}text\gt{}] - \label{Director:Description} \index[dir]{Description} \index[dir]{Directive!Description} The text field contains a description of the Director that will be displayed in the graphical user interface. This directive is optional. +\label{Director:Password} \item [Password = \lt{}UA-password\gt{}] - \label{Director:Password} \index[dir]{Password} \index[dir]{Directive!Password} Specifies the password that must be supplied for the default Bacula @@ -132,8 +132,8 @@ in the graphical user interface. This directive is optional. process but as noted above, it is better to use random text for security reasons. -\item [Messages = \lt{}Messages-resource-name\gt{}] \label{Director:Messages} +\item [Messages = \lt{}Messages-resource-name\gt{}] \index[dir]{Directive!Messages} The messages resource specifies where to deliver Director messages that are not associated with a specific Job. Most messages are specific to a job and @@ -141,8 +141,8 @@ in the graphical user interface. This directive is optional. there are a few messages that can occur when no job is running. This directive is required. -\item [Working Directory = \lt{}Directory\gt{}] \label{Director:WorkingDirectory} +\item [Working Directory = \lt{}Directory\gt{}] \index[dir]{Working Directory} \index[dir]{Directive!Working Directory} This directive is mandatory and specifies a directory in which the Director @@ -163,8 +163,8 @@ in the graphical user interface. This directive is optional. {\bf {-}{-}with-dir-group} the Working Directory owner and group will be set to those values. -\item [Pid Directory = \lt{}Directory\gt{}] \label{Director:PidDirectory} +\item [Pid Directory = \lt{}Directory\gt{}] \index[dir]{Pid Directory} \index[dir]{Directive!Pid Directory} This directive is mandatory and specifies a directory in which the Director @@ -181,8 +181,8 @@ in the graphical user interface. This directive is optional. not installing Bacula in the system directories, you can use the {\bf Working Directory} as defined above. This directive is required. -\item [Scripts Directory = \lt{}Directory\gt{}] \label{Director:ScriptsDirectory} +\item [Scripts Directory = \lt{}Directory\gt{}] \index[dir]{Scripts Directory} \index[dir]{Directive!Scripts Directory} This directive is optional and, if defined, specifies a directory in @@ -192,8 +192,8 @@ in the graphical user interface. This directive is optional. file is read so that values such as {\bf \$HOME} will be properly expanded. -\item [QueryFile = \lt{}Path\gt{}] \label{Director:QueryFile} +\item [QueryFile = \lt{}Path\gt{}] \index[dir]{QueryFile} \index[dir]{Directive!QueryFile} This directive is mandatory and specifies a directory and file in which @@ -202,8 +202,8 @@ in the graphical user interface. This directive is optional. done when the configuration file is read so that values such as {\bf \$HOME} will be properly expanded. This directive is required. -\item [Heartbeat Interval = \lt{}time-interval\gt{}] \label{Director:HeartbeatInterval} +\item [Heartbeat Interval = \lt{}time-interval\gt{}] \index[dir]{Heartbeat Interval} \index[dir]{Directive!Heartbeat} This directive is optional and if specified will cause the Director to @@ -213,10 +213,10 @@ in the graphical user interface. This directive is optional. (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function. The default value is zero, which means no change is made to the socket. - \label{DirMaxConJobs} -\item [Maximum Concurrent Jobs = \lt{}number\gt{}] + \label{Director:MaximumConcurrentJobs} +\item [Maximum Concurrent Jobs = \lt{}number\gt{}] \index[dir]{Maximum Concurrent Jobs} \index[dir]{Directive!Maximum Concurrent Jobs} \index[general]{Simultaneous Jobs} @@ -233,24 +233,24 @@ in the graphical user interface. This directive is optional. to disk simultaneously, then write one spool file at a time to the volume thus avoiding excessive interleaving of the different job blocks. -\item [FD Connect Timeout = \lt{}time\gt{}] \label{Director:FdConnectTimeout} +\item [FD Connect Timeout = \lt{}time\gt{}] \index[dir]{FD Connect Timeout} \index[dir]{Directive!FD Connect Timeout} where {\bf time} is the time that the Director should continue attempting to contact the File daemon to start a job, and after which the Director will cancel the job. The default is 30 minutes. -\item [SD Connect Timeout = \lt{}time\gt{}] \label{Director:SdConnectTimeout} +\item [SD Connect Timeout = \lt{}time\gt{}] \index[dir]{SD Connect Timeout} \index[dir]{Directive!SD Connect Timeout} where {\bf time} is the time that the Director should continue attempting to contact the Storage daemon to start a job, and after which the Director will cancel the job. The default is 30 minutes. -\item [DirAddresses = \lt{}IP-address-specification\gt{}] \label{Director:DirAddresses} +\item [DirAddresses = \lt{}IP-address-specification\gt{}] \index[dir]{DirAddresses} \index[dir]{Address} \index[general]{Address} @@ -294,8 +294,8 @@ Please note that if you use the DirAddresses directive, you must not use either a DirPort or a DirAddress directive in the same resource. -\item [DirPort = \lt{}port-number\gt{}] \label{Director:DirPort} +\item [DirPort = \lt{}port-number\gt{}] \index[dir]{DirPort} \index[dir]{Directive!DirPort} Specify the port (a positive integer) on which the Director daemon will @@ -305,8 +305,8 @@ resource. directive should not be used if you specify DirAddresses (N.B plural) directive. -\item [DirAddress = \lt{}IP-Address\gt{}] \label{Director:DirAddress} +\item [DirAddress = \lt{}IP-Address\gt{}] \index[dir]{DirAddress} \index[dir]{Directive!DirAddress} This directive is optional, but if it is specified, it will cause the @@ -318,8 +318,8 @@ resource. directive only permits a single address to be specified. This directive should not be used if you specify a DirAddresses (N.B. plural) directive. -\item [DirSourceAddress = \lt{}IP-Address\gt{}] \label{Director:DirSourceAddress} +\item [DirSourceAddress = \lt{}IP-Address\gt{}] \index[fd]{DirSourceAddress} \index[fd]{Directive!DirSourceAddress} This record is optional, and if it is specified, it will cause the Director @@ -328,11 +328,11 @@ resource. specified. If this record is not specified, the Director server will source its outgoing connections according to the system routing table (the default). -\item[Statistics Retention = \lt{}time\gt{}] \label{Director:StatisticsRetention} +\item[Statistics Retention = \lt{}time\gt{}] \index[dir]{StatisticsRetention} - \index[dir]{Directive!StatisticsRetention} \label{PruneStatistics} + \index[dir]{Directive!StatisticsRetention} The \texttt{Statistics Retention} directive defines the length of time that Bacula will keep statistics job records in the Catalog database after the @@ -349,14 +349,14 @@ resource. The default is 5 years. -\item[VerId = \lt{}string\gt{}] \label{Director:VerId} +\item[VerId = \lt{}string\gt{}] \index[dir]{Directive!VerId} where \lt{}string\gt{} is an identifier which can be used for support purpose. This string is displayed using the \texttt{version} command. -\item[MaximumConsoleConnections = \lt{}number\gt{}] \label{Director:MaximumConsoleConnections} +\item[MaximumConsoleConnections = \lt{}number\gt{}] \index[dir]{MaximumConsoleConnections} \index[dir]{Directive!MaximumConsoleConnections} \index[dir]{Console} @@ -364,8 +364,8 @@ resource. could run concurrently. The default is set to 20, but you may set it to a larger number. - \item[MaximumReloadRequests = \lt{}number\gt{}] \label{Director:MaximumReloadRequests} + \item[MaximumReloadRequests = \lt{}number\gt{}] \index[dir]{MaximumReloadRequests} \index[dir]{Directive!MaximumReloadRequests} \index[dir]{Console} @@ -374,8 +374,8 @@ Where \lt{}number\gt{} is the maximum number of \texttt{reload} command that can be done while jobs are running. The default is set to 32 and is usually sufficient. -%\item[SharedStorage = \lt{}yes\vb{}no\gt{}] % \label{Director:SharedStorage} +%\item[SharedStorage = \lt{}yes\vb{}no\gt{}] % \index[dir]{SharedStorage} % \index[dir]{Directive!SharedStorage} % @@ -419,8 +419,8 @@ Director { \end{verbatim} \normalsize -\section{The Job Resource} \label{JobResource} +\section{The Job Resource} \index[general]{Resource!Job} \index[general]{Job Resource} @@ -461,8 +461,8 @@ the FileSets may be the same). \index[dir]{Directive!Job} Start of the Job resource. At least one Job resource is required. -\item [Name = \lt{}name\gt{}] \label{Job:Name} +\item [Name = \lt{}name\gt{}] \index[dir]{Name} \index[dir]{Directive!Name} The Job name. This name can be specified on the {\bf Run} command in the @@ -475,15 +475,15 @@ the FileSets may be the same). specify here followed by the date and time the job was scheduled for execution. This directive is required. -\item [Enabled = \lt{}yes\vb{}no\gt{}] \label{Job:Enable} +\item [Enabled = \lt{}yes\vb{}no\gt{}] \index[dir]{Enable} \index[dir]{Directive!Enable} This directive allows you to enable or disable automatic execution via the scheduler of a Job. -\item [Type = \lt{}job-type\gt{}] \label{Job:Type} +\item [Type = \lt{}job-type\gt{}] \index[dir]{Type} \index[dir]{Directive!Type} The {\bf Type} directive specifies the Job type, which may be one of the @@ -529,11 +529,11 @@ the FileSets may be the same). pruning, if you do not want to do it at the end of each {\bf Backup} Job. Although an Admin job is recorded in the catalog, very little data is saved. \end{description} - \label{Level} -\item [Level = \lt{}job-level\gt{}] + \label{Job:Level} +\item [Level = \lt{}job-level\gt{}] \index[dir]{Level} \index[dir]{Directive!Level} The Level directive specifies the default Job level to be run. Each @@ -772,8 +772,8 @@ For a {\bf Verify} Job, the Level may be one of the following: have been deleted. \end{description} -\item [Accurate = \lt{}yes\vb{}no\gt{}] \label{Job:Accurate} +\item [Accurate = \lt{}yes\vb{}no\gt{}] \index[dir]{Accurate} In accurate mode, the File daemon knowns exactly which files were present after the last backup. So it is able to handle deleted or renamed files. @@ -794,8 +794,8 @@ For a {\bf Verify} Job, the Level may be one of the following: approximately 64 Megabytes of RAM on your File daemon to hold the required information. -\item [Verify Job = \lt{}Job-Resource-Name\gt{}] \label{Job:VerifyJob} +\item [Verify Job = \lt{}Job-Resource-Name\gt{}] \index[dir]{Verify Job} \index[dir]{Directive!Verify Job} If you run a verify job without this directive, the last job run will be @@ -806,8 +806,8 @@ For a {\bf Verify} Job, the Level may be one of the following: verified (most often a {\bf VolumeToCatalog}) so that the tape just written is re-read. -\item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}] \label{Job:JobDefs} +\item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}] \index[dir]{JobDefs} \index[dir]{Directive!JobDefs} If a JobDefs-Resource-Name is specified, all the values contained in the @@ -820,8 +820,8 @@ For a {\bf Verify} Job, the Level may be one of the following: variations such as different Clients. A simple example of the use of JobDefs is provided in the default bacula-dir.conf file. -\item [Bootstrap = \lt{}bootstrap-file\gt{}] \label{Job:Bootstrap} +\item [Bootstrap = \lt{}bootstrap-file\gt{}] \index[dir]{Bootstrap} \index[dir]{Directive!Bootstrap} The Bootstrap directive specifies a bootstrap file that, if provided, @@ -839,10 +839,10 @@ For a {\bf Verify} Job, the Level may be one of the following: For additional details of the {\bf bootstrap} file, please see \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter of this manual. - \label{writebootstrap} -\item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}] + \label{Job:WriteBootstrap} +\item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}] \index[dir]{Write Bootstrap} \index[dir]{Directive!Write Bootstrap} The {\bf writebootstrap} directive specifies a file name where Bacula @@ -883,8 +883,8 @@ JobDefs { For more details on using this file, please see the chapter entitled \ilink{The Bootstrap File}{BootstrapChapter} of this manual. -\item [Client = \lt{}client-resource-name\gt{}] \label{Job:Client} +\item [Client = \lt{}client-resource-name\gt{}] \index[dir]{Client} \index[dir]{Directive!Client} The Client directive specifies the Client (File daemon) that will be used in @@ -895,8 +895,8 @@ JobDefs { \ilink{Client Resource section}{ClientResource2} of this chapter. This directive is required. -\item [FileSet = \lt{}FileSet-resource-name\gt{}] \label{Job:FileSet} +\item [FileSet = \lt{}FileSet-resource-name\gt{}] \index[dir]{FileSet} \index[dir]{Directive!FileSet} The FileSet directive specifies the FileSet that will be used in the @@ -906,16 +906,16 @@ JobDefs { details, see the \ilink{FileSet Resource section}{FileSetResource} of this chapter. This directive is required. -\item [Base = \lt{}job-resource-name, ...\gt{}] \label{Job:Base} +\item [Base = \lt{}job-resource-name, ...\gt{}] \index[dir]{Base} \index[dir]{Directive!Base} The Base directive permits to specify the list of jobs that will be used during Full backup as base. This directive is optional. See the \ilink{Base Job chapter}{basejobs} for more information. -\item [Messages = \lt{}messages-resource-name\gt{}] \label{Job:Messages} +\item [Messages = \lt{}messages-resource-name\gt{}] \index[dir]{Messages} \index[dir]{Directive!Messages} The Messages directive defines what Messages resource should be used for @@ -925,8 +925,8 @@ chapter}{basejobs} for more information. \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This directive is required. -\item [Pool = \lt{}pool-resource-name\gt{}] \label{Job:Pool} +\item [Pool = \lt{}pool-resource-name\gt{}] \index[dir]{Pool} \index[dir]{Directive!Pool} The Pool directive defines the pool of Volumes where your data can be @@ -936,32 +936,32 @@ chapter}{basejobs} for more information. Pools. For additional details, see the \ilink{Pool Resource section}{PoolResource} of this chapter. This directive is required. -\item [Full Backup Pool = \lt{}pool-resource-name\gt{}] \label{Job:FullBackupPool} +\item [Full Backup Pool = \lt{}pool-resource-name\gt{}] \index[dir]{Full Backup Pool} \index[dir]{Directive!Full Backup Pool} The {\it Full Backup Pool} specifies a Pool to be used for Full backups. It will override any Pool specification during a Full backup. This directive is optional. -\item [Differential Backup Pool = \lt{}pool-resource-name\gt{}] \label{Job:DifferentialBackupPool} +\item [Differential Backup Pool = \lt{}pool-resource-name\gt{}] \index[dir]{Differential Backup Pool} \index[dir]{Directive!Differential Backup Pool} The {\it Differential Backup Pool} specifies a Pool to be used for Differential backups. It will override any Pool specification during a Differential backup. This directive is optional. -\item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}] \label{Job:IncrementalBackupPool} +\item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}] \index[dir]{Incremental Backup Pool} \index[dir]{Directive!Incremental Backup Pool} The {\it Incremental Backup Pool} specifies a Pool to be used for Incremental backups. It will override any Pool specification during an Incremental backup. This directive is optional. -\item [Schedule = \lt{}schedule-name\gt{}] \label{Job:Schedule} +\item [Schedule = \lt{}schedule-name\gt{}] \index[dir]{Schedule} \index[dir]{Directive!Schedule} The Schedule directive defines what schedule is to be used for the Job. @@ -978,8 +978,8 @@ chapter}{basejobs} for more information. Chapter}{ScheduleResource} of this manual. -\item [Storage = \lt{}storage-resource-name\gt{}] \label{Job:Storage} +\item [Storage = \lt{}storage-resource-name\gt{}] \index[dir]{Storage} \index[dir]{Directive!Storage} The Storage directive defines the name of the storage services where you @@ -991,8 +991,8 @@ chapter}{basejobs} for more information. the Job resource or in the Pool, but it must be specified in one or the other, if not an error will result. -\item [Max Start Delay = \lt{}time\gt{}] \label{Job:MaxStartDelay} +\item [Max Start Delay = \lt{}time\gt{}] \index[dir]{Max Start Delay} \index[dir]{Directive!Max Start Delay} The time specifies the maximum delay between the scheduled time and the @@ -1003,8 +1003,8 @@ chapter}{basejobs} for more information. to prevent jobs from running during day time hours. The default is 0 which indicates no limit. -\item [Max Run Time = \lt{}time\gt{}] \label{Job:MaxRunTime} +\item [Max Run Time = \lt{}time\gt{}] \index[dir]{Max Run Time} \index[dir]{Directive!Max Run Time} The time specifies the maximum allowed time that a job may run, counted @@ -1016,32 +1016,32 @@ chapter}{basejobs} for more information. and cannot be changed. -\item [Incremental|Differential Max Wait Time = \lt{}time\gt{}] \label{Job:IncrementalWaitRunTime} +\item [Incremental|Differential Max Wait Time = \lt{}time\gt{}] \index[dir]{Incremental Wait Run Time} \index[dir]{Differential Wait Run Time} \index[dir]{Directive!Differential Max Wait Time} Theses directives have been deprecated in favor of \texttt{Incremental|Differential Max Run Time} since bacula 2.3.18. -\item [Incremental Max Run Time = \lt{}time\gt{}] \label{Job:IncrementalMaxRunTime} +\item [Incremental Max Run Time = \lt{}time\gt{}] \index[dir]{Incremental Max Run Time} \index[dir]{Directive!Incremental Max Run Time} The time specifies the maximum allowed time that an Incremental backup job may run, counted from when the job starts, ({\bf not} necessarily the same as when the job was scheduled). -\item [Differential Max Wait Time = \lt{}time\gt{}] \label{Job:DifferentialMaxRunTime} +\item [Differential Max Wait Time = \lt{}time\gt{}] \index[dir]{Differential Max Run Time} \index[dir]{Directive!Differential Max Run Time} The time specifies the maximum allowed time that a Differential backup job may run, counted from when the job starts, ({\bf not} necessarily the same as when the job was scheduled). -\item [Max Run Sched Time = \lt{}time\gt{}] \label{Job:MaxRunSchedTime} +\item [Max Run Sched Time = \lt{}time\gt{}] \index[dir]{Max Run Sched Time} \index[dir]{Directive!Max Run Sched Time} @@ -1050,8 +1050,8 @@ when the job was scheduled. This can be useful to prevent jobs from running during working hours. We can see it like \texttt{Max Start Delay + Max Run Time}. -\item [Max Wait Time = \lt{}time\gt{}] \label{Job:MaxWaitTime} +\item [Max Wait Time = \lt{}time\gt{}] \index[dir]{Max Wait Time} \index[dir]{Directive!Max Wait Time} The time specifies the maximum allowed time that a job may block waiting @@ -1063,20 +1063,20 @@ during working hours. We can see it like \texttt{Max Start Delay + Max Run \begin{figure}[htbp] \centering \includegraphics[width=13cm]{\idir different_time.eps} - \caption{Job time control directives} \label{fig:differenttime} + \caption{Job time control directives} \end{figure} -\item [Maximum Bandwidth = \lt{}speed\gt{}] \label{Job:MaximumBandwidth} +\item [Maximum Bandwidth = \lt{}speed\gt{}] \index[dir]{Maximum Bandwidth} \index[dir]{Directive!Maximum Bandwidth} The speed parameter specifies the maximum allowed bandwidth that a job may use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. -\item [Max Full Interval = \lt{}time\gt{}] \label{Job:MaxFullInterval} +\item [Max Full Interval = \lt{}time\gt{}] \index[dir]{Max Full Interval} \index[dir]{Directive!Max Full Interval} The time specifies the maximum allowed age (counting from start time) of @@ -1086,10 +1086,10 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. upgraded to Full backups automatically. If this directive is not present, or specified as 0, then the age of the previous Full backup is not considered. - \label{PreferMountedVolumes} -\item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}] + \label{Job:Prefer Mounted Volumes} +\item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}] \index[dir]{Prefer Mounted Volumes} \index[dir]{Directive!Prefer Mounted Volumes} If the Prefer Mounted Volumes directive is set to {\bf yes} (default @@ -1125,8 +1125,8 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. pools so that Bacula will be forced to mount Volumes from those Pools on different drives. -\item [Prune Jobs = \lt{}yes\vb{}no\gt{}] \label{Job:PruneJobs} +\item [Prune Jobs = \lt{}yes\vb{}no\gt{}] \index[dir]{Prune Jobs} \index[dir]{Directive!Prune Jobs} Normally, pruning of Jobs from the Catalog is specified on a Client by @@ -1136,8 +1136,8 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. default is {\bf no}. -\item [Prune Files = \lt{}yes\vb{}no\gt{}] \label{Job:PruneFiles} +\item [Prune Files = \lt{}yes\vb{}no\gt{}] \index[dir]{Prune Files} \index[dir]{Directive!Prune Files} Normally, pruning of Files from the Catalog is specified on a Client by @@ -1146,8 +1146,8 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. yes}, it will override the value specified in the Client resource. The default is {\bf no}. -\item [Prune Volumes = \lt{}yes\vb{}no\gt{}] \label{Job:PruneVolumes} +\item [Prune Volumes = \lt{}yes\vb{}no\gt{}] \index[dir]{Prune Volumes} \index[dir]{Directive!Prune Volumes} Normally, pruning of Volumes from the Catalog is specified on a Pool by @@ -1157,8 +1157,8 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. and the value is {\bf yes}, it will override the value specified in the Pool resource. The default is {\bf no}. -\item [RunScript \{\lt{}body-of-runscript\gt{}\}] \label{Job:RunScript} +\item [RunScript \{\lt{}body-of-runscript\gt{}\}] \index[dir]{RunScript} \index[dir]{Directive!Run Script} @@ -1227,8 +1227,8 @@ Console & & & Console command\\ Before submitting the specified command to the operating system, Bacula performs character substitution of the following characters: - \label{character substitution} + \footnotesize \begin{verbatim} %% = % @@ -1491,8 +1491,8 @@ the following: It is important to redirect the input and outputs of a backgrounded command to /dev/null to prevent the script from blocking. -\item [Run Before Job = \lt{}command\gt{}] \label{Job:RunBeforeJob} +\item [Run Before Job = \lt{}command\gt{}] \index[dir]{Run Before Job} \index[dir]{Directive!Run Before Job} \index[dir]{Directive!Run Before Job} @@ -1522,8 +1522,8 @@ RunScript { Thursday job will not run, and on Friday the tape you inserted on Wednesday before leaving will be used. -\item [Run After Job = \lt{}command\gt{}] \label{Job:RunAfterJob} +\item [Run After Job = \lt{}command\gt{}] \index[dir]{Run After Job} \index[dir]{Directive!Run After Job} The specified {\bf command} is run as an external program if the current @@ -1540,8 +1540,8 @@ RunScript { want to run a script after the job has terminated with any non-normal status. -\item [Run After Failed Job = \lt{}command\gt{}] \label{Job:RunAfterJob} +\item [Run After Failed Job = \lt{}command\gt{}] \index[dir]{Run After Job} \index[dir]{Directive!Run After Job} The specified {\bf command} is run as an external program after the current @@ -1566,16 +1566,16 @@ RunScript { \ilink{Tips Chapter}{JobNotification} of this manual. -\item [Client Run Before Job = \lt{}command\gt{}] \label{Job:ClientRunBeforeJob} +\item [Client Run Before Job = \lt{}command\gt{}] \index[dir]{Client Run Before Job} \index[dir]{Directive!Client Run Before Job} This directive is the same as {\bf Run Before Job} except that the program is run on the client machine. The same restrictions apply to Unix systems as noted above for the {\bf RunScript}. -\item [Client Run After Job = \lt{}command\gt{}] \label{Job:ClientRunAfterJob} +\item [Client Run After Job = \lt{}command\gt{}] \index[dir]{Client Run After Job} \index[dir]{Directive!Client Run After Job} The specified {\bf command} is run on the client machine as soon @@ -1585,8 +1585,8 @@ RunScript { Note, please see the notes above in {\bf RunScript} concerning Windows clients. -\item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}] \label{Job:RerunFailedLevels} +\item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}] \index[dir]{Rerun Failed Levels} \index[dir]{Directive!Rerun Failed Levels} If this directive is set to {\bf yes} (default no), and Bacula detects that @@ -1604,8 +1604,8 @@ RunScript { when checking for failed levels, which means that any FileSet change will trigger a rerun. -\item [Spool Data = \lt{}yes\vb{}no\gt{}] \label{Job:SpoolData} +\item [Spool Data = \lt{}yes\vb{}no\gt{}] \index[dir]{Spool Data} \index[dir]{Directive!Spool Data} @@ -1628,15 +1628,15 @@ RunScript { NOTE: When this directive is set to yes, Spool Attributes is also automatically set to yes. -\item [SpoolData=yes\vb{}no] \label{Job:SpoolData} +\item [SpoolData=yes\vb{}no] \index[dir]{SpoolData} \index[dir]{Directive!SpoolData} tells Bacula to request the Storage daemon to spool data to a disk file before writing it to the Volume (normally a tape). -\item [Spool Attributes = \lt{}yes\vb{}no\gt{}] \label{Job:SpoolAttributes} +\item [Spool Attributes = \lt{}yes\vb{}no\gt{}] \index[dir]{Spool Attributes} \index[dir]{Directive!Spool Attributes} \index[dir]{slow} @@ -1655,8 +1655,8 @@ RunScript { NOTE: When Spool Data is set to yes, Spool Attributes is also automatically set to yes. -\item [SpoolSize={\it bytes}] \label{Job:SpoolSize} +\item [SpoolSize={\it bytes}] \index[dir]{SpoolSize} \index[dir]{Directive!SpoolSize} where the bytes specify the maximum spool size for this job. @@ -1665,8 +1665,8 @@ RunScript { later. -\item [Where = \lt{}directory\gt{}] \label{Job:Where} +\item [Where = \lt{}directory\gt{}] \index[dir]{Where} \index[dir]{Directive!Where} This directive applies only to a Restore job and specifies a prefix to @@ -1678,17 +1678,17 @@ RunScript { /tmp/bacula-restores}. This is to prevent accidental overwriting of your files. -\item [Add Prefix = \lt{}directory\gt{}] \label{confaddprefix} \label{Job:AddPrefix} +\item [Add Prefix = \lt{}directory\gt{}] \index[dir]{AddPrefix} \index[dir]{Directive!AddPrefix} This directive applies only to a Restore job and specifies a prefix to the directory name of all files being restored. This will use \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later. -\item [Add Suffix = \lt{}extention\gt{}] \label{Job:AddSuffix} +\item [Add Suffix = \lt{}extention\gt{}] \index[dir]{AddSuffix} \index[dir]{Directive!AddSuffix} This directive applies only to a Restore job and specifies a suffix to all @@ -1698,8 +1698,8 @@ RunScript { Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to \texttt{/etc/passwsd.old} -\item [Strip Prefix = \lt{}directory\gt{}] \label{Job:StripPrefix} +\item [Strip Prefix = \lt{}directory\gt{}] \index[dir]{StripPrefix} \index[dir]{Directive!StripPrefix} This directive applies only to a Restore job and specifies a prefix to remove @@ -1718,8 +1718,8 @@ RunScript { Add Prefix = d: \end{verbatim} -\item [RegexWhere = \lt{}expressions\gt{}] \label{Job:RegexWhere} +\item [RegexWhere = \lt{}expressions\gt{}] \index[dir]{RegexWhere} \index[dir]{Directive!RegexWhere} This directive applies only to a Restore job and specifies a regex filename @@ -1729,8 +1729,8 @@ RunScript { For more informations about how use this option, see \ilink{this}{useregexwhere}. -\item [Replace = \lt{}replace-option\gt{}] \label{Job:Replace} +\item [Replace = \lt{}replace-option\gt{}] \index[dir]{Replace} \index[dir]{Directive!Replace} This directive applies only to a Restore job and specifies what happens @@ -1759,8 +1759,8 @@ RunScript { if the backed up file already exists, Bacula skips restoring this file. \end{description} -\item [Prefix Links=\lt{}yes\vb{}no\gt{}] \label{Job:PrefixLinks} +\item [Prefix Links=\lt{}yes\vb{}no\gt{}] \index[dir]{Prefix Links} \index[dir]{Directive!Prefix Links} If a {\bf Where} path prefix is specified for a recovery job, apply it @@ -1771,8 +1771,8 @@ RunScript { consistent. However, if you wish to later move the files to their original locations, all files linked with absolute names will be broken. -\item [Maximum Concurrent Jobs = \lt{}number\gt{}] \label{Job:MaximumConcurrentJobs} +\item [Maximum Concurrent Jobs = \lt{}number\gt{}] \index[dir]{Maximum Concurrent Jobs} \index[dir]{Directive!Maximum Concurrent Jobs} where \lt{}number\gt{} is the maximum number of Jobs from the current @@ -1785,8 +1785,8 @@ RunScript { documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's resource. -\item [Reschedule On Error = \lt{}yes\vb{}no\gt{}] \label{Job:RescheduleOnError} +\item [Reschedule On Error = \lt{}yes\vb{}no\gt{}] \index[dir]{Reschedule On Error} \index[dir]{Directive!Reschedule On Error} If this directive is enabled, and the job terminates in error, the job @@ -1798,8 +1798,8 @@ RunScript { This specification can be useful for portables, laptops, or other machines that are not always connected to the network or switched on. -\item [Reschedule Interval = \lt{}time-specification\gt{}] \label{Job:RescheduleInterval} +\item [Reschedule Interval = \lt{}time-specification\gt{}] \index[dir]{Reschedule Interval} \index[dir]{Directive!Reschedule Interval} If you have specified {\bf Reschedule On Error = yes} and the job @@ -1809,23 +1809,23 @@ RunScript { time specifications. If no interval is specified, the job will not be rescheduled on error. -\item [Reschedule Times = \lt{}count\gt{}] \label{Job:RescheduleTimes} +\item [Reschedule Times = \lt{}count\gt{}] \index[dir]{Reschedule Times} \index[dir]{Directive!Reschedule Times} This directive specifies the maximum number of times to reschedule the job. If it is set to zero (the default) the job will be rescheduled an indefinite number of times. -\item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}] \label{Job:AllowDuplicateJobs} +\item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}] \index[general]{Allow Duplicate Jobs} \begin{figure}[htbp] \centering \includegraphics[width=13cm]{\idir duplicate-real.eps} - \caption{Allow Duplicate Jobs usage} \label{fig:allowduplicatejobs} + \caption{Allow Duplicate Jobs usage} \end{figure} A duplicate job in the sense we use it here means a second or subsequent job @@ -1842,16 +1842,16 @@ runs longer than expected because no tapes are available. cancelling a job, then the current job (the second one started) will be cancelled. -\item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}] \label{Job:AllowHigherDuplicates} +\item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}] \index[general]{Allow Higher Duplicates} This directive was implemented in version 5.0.0, but does not work as expected. If used, it should always be set to no. In later versions of Bacula the directive is disabled (disregarded). -\item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}] \label{Job:CancelLowerLevelDuplicates} +\item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}] \index[general]{Cancel Lower Level Duplicates} If \textbf{Allow Duplicates Jobs} is set to \textbf{no} and this directive is set to \textbf{yes}, Bacula will choose between duplicated @@ -1861,16 +1861,16 @@ runs longer than expected because no tapes are available. jobs are the same, nothing is done and the other Cancel XXX Duplicate directives will be examined. -\item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}] \label{Job:CancelQueuedDuplicates} +\item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}] \index[general]{Cancel Queued Duplicates} If {\bf Allow Duplicate Jobs} is set to {\bf no} and if this directive is set to {\bf yes} any job that is already queued to run but not yet running will be canceled. The default is {\bf no}. -\item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}] \label{Job:CancelRunningDuplicates} +\item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}] \index[general]{Cancel Running Duplicates} If {\bf Allow Duplicate Jobs} is set to {\bf no} and if this directive is set to {\bf yes} any job that is already running @@ -1883,8 +1883,8 @@ runs longer than expected because no tapes are available. %% If the first one is running for long time, this is probably not a good %% idea to cancel it. -\item [Run = \lt{}job-name\gt{}] \label{Job:Run} +\item [Run = \lt{}job-name\gt{}] \index[dir]{Run} \index[dir]{Directive!Run} \index[dir]{Clone a Job} @@ -1926,10 +1926,10 @@ runs longer than expected because no tapes are available. If you are trying to prioritize jobs by using the clone feature (Run directive), you will find it much easier to do using a RunScript resource, or a RunBeforeJob directive. - \label{Priority} -\item [Priority = \lt{}number\gt{}] + \label{Job:Priority} +\item [Priority = \lt{}number\gt{}] \index[dir]{Priority} \index[dir]{Directive!Priority} This directive permits you to control the order in which your jobs will @@ -1979,10 +1979,10 @@ before your high priority jobs. If you experience this problem, you may avoid it by starting any higher priority jobs a few seconds before lower priority ones. This insures that Bacula will examine the jobs in the correct order, and that your priority scheme will be respected. - \label{AllowMixedPriority} -\item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}] + \label{Job:AllowMixedPriority} +\item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}] \index[dir]{Allow Mixed Priority} This directive is only implemented in version 2.5 and later. When set to {\bf yes} (default {\bf no}), this job may run even if lower @@ -1997,10 +1997,10 @@ correct order, and that your priority scheme will be respected. priority 5 is added to the queue, it will be run as soon as one of the running jobs finishes. However, new priority 10 jobs will not be run until the priority 5 job has finished. - \label{WritePartAfterJob} -\item [Write Part After Job = \lt{}yes\vb{}no\gt{}] + \label{Job:WritePartAfterJob} +\item [Write Part After Job = \lt{}yes\vb{}no\gt{}] \index[dir]{Write Part After Job} \index[dir]{Directive!Write Part After Job} This directive is only implemented in version 1.37 and later. @@ -2039,8 +2039,8 @@ Job { \end{verbatim} \normalsize -\section{The JobDefs Resource} \label{JobDefsResource} +\section{The JobDefs Resource} \index[general]{JobDefs Resource} \index[general]{Resource!JobDefs} @@ -2051,8 +2051,8 @@ concisely define several nearly identical Jobs, each one referencing a JobDefs resource which contains the defaults. Only the changes from the defaults need to be mentioned in each Job. -\section{The Schedule Resource} \label{ScheduleResource} +\section{The Schedule Resource} \index[general]{Resource!Schedule} \index[general]{Schedule Resource} @@ -2070,14 +2070,14 @@ be run manually. In general, you specify an action to be taken and when. required, but you will need at least one if you want Jobs to be automatically started. -\item [Name = \lt{}name\gt{}] \label{Schdedule:Name} +\item [Name = \lt{}name\gt{}] \index[dir]{Name} \index[dir]{Directive!Name} The name of the schedule being defined. The Name directive is required. -\item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}] \label{Schdedule:Run} +\item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}] \index[dir]{Run} \index[dir]{Directive!Run} The Run directive defines when a Job is to be run, and what overrides if @@ -2341,8 +2341,8 @@ bit mask is zero based, and Sunday is the first day of the week (bit zero). \input{fileset} \input{bsplugins} -\section{The Client Resource} \label{ClientResource2} +\section{The Client Resource} \index[general]{Resource!Client} \index[general]{Client Resource} @@ -2357,15 +2357,15 @@ one Client resource definition for each machine to be backed up. \index[dir]{Directive!Client (or FileDaemon)} Start of the Client directives. -\item [Name = \lt{}name\gt{}] \label{Client:Name} +\item [Name = \lt{}name\gt{}] \index[dir]{Name} \index[dir]{Directive!Name} The client name which will be used in the Job resource directive or in the console run command. This directive is required. -\item [Address = \lt{}address\gt{}] \label{Client:Address} +\item [Address = \lt{}address\gt{}] \index[dir]{Address} \index[dir]{Directive!FD Address} \index[dir]{File Daemon Address} @@ -2374,22 +2374,22 @@ console run command. This directive is required. network address in dotted quad notation for a Bacula File server daemon. This directive is required. -\item [FD Port = \lt{}port-number\gt{}] \label{Client:FdPort} +\item [FD Port = \lt{}port-number\gt{}] \index[dir]{FD Port} \index[dir]{Directive!FD Port} Where the port is a port number at which the Bacula File server daemon can be contacted. The default is 9102. -\item [Catalog = \lt{}Catalog-resource-name\gt{}] \label{Client:Catalog} +\item [Catalog = \lt{}Catalog-resource-name\gt{}] \index[dir]{Catalog} \index[dir]{Directive!Catalog} This specifies the name of the catalog resource to be used for this Client. This directive is required. -\item [Password = \lt{}password\gt{}] \label{Client:Password} +\item [Password = \lt{}password\gt{}] \index[dir]{Password} \index[dir]{Directive!Password} This is the password to be used when establishing a connection with the File @@ -2402,11 +2402,11 @@ console run command. This directive is required. The password is plain text. It is not generated through any special process, but it is preferable for security reasons to make the text random. - \label{FileRetention} -\item [File Retention = \lt{}time-period-specification\gt{}] + \label{FileRetention} \label{Client:FileRetention} +\item [File Retention = \lt{}time-period-specification\gt{}] \index[dir]{File Retention} \index[dir]{Directive!File Retention} The File Retention directive defines the length of time that Bacula will @@ -2428,9 +2428,9 @@ console run command. This directive is required. The default is 60 days. -\item [Job Retention = \lt{}time-period-specification\gt{}] \label{JobRetention} \label{Client:JobRetention} +\item [Job Retention = \lt{}time-period-specification\gt{}] \index[dir]{Job Retention} \index[dir]{Directive!Job Retention} The Job Retention directive defines the length of time that Bacula will keep @@ -2455,10 +2455,10 @@ console run command. This directive is required. additional details of time specification. The default is 180 days. - \label{AutoPrune} -\item [AutoPrune = \lt{}yes\vb{}no\gt{}] + \label{Client:AutoPrune} +\item [AutoPrune = \lt{}yes\vb{}no\gt{}] \index[dir]{AutoPrune} \index[dir]{Directive!AutoPrune} If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater) @@ -2468,8 +2468,8 @@ console run command. This directive is required. run a Job. Pruning affects only information in the catalog and not data stored in the backup archives (on Volumes). -\item [Maximum Concurrent Jobs = \lt{}number\gt{}] \label{Client:MaximumConcurrentJobs} +\item [Maximum Concurrent Jobs = \lt{}number\gt{}] \index[dir]{Maximum Concurrent Jobs} \index[dir]{Directive!Maximum Concurrent Jobs} where \lt{}number\gt{} is the maximum number of Jobs with the current Client @@ -2479,8 +2479,8 @@ console run command. This directive is required. Storage resources will also apply in addition to any limit specified here. The default is set to 1, but you may set it to a larger number. -\item [Maximum Bandwidth Per Job = \lt{}speed\gt{}] \label{Client:MaximumBandwidthPerJob} +\item [Maximum Bandwidth Per Job = \lt{}speed\gt{}] \index[dir]{Maximum Bandwidth Per Job} \index[dir]{Directive!Maximum Bandwidth Per Job} @@ -2507,8 +2507,8 @@ k/s, Kb/s, m/s or Mb/s. % \caption{Backup over WAN using FD Storage Address} % \end{figure} -\item [Priority = \lt{}number\gt{}] \label{Client:Priority} +\item [Priority = \lt{}number\gt{}] \index[dir]{Priority} \index[dir]{Directive!Priority} The number specifies the priority of this client relative to other clients @@ -2530,8 +2530,8 @@ Client { \end{verbatim} \normalsize -\section{The Storage Resource} \label{StorageResource2} +\section{The Storage Resource} \index[general]{Resource!Storage} \index[general]{Storage Resource} @@ -2546,15 +2546,15 @@ the Director. Start of the Storage resources. At least one storage resource must be specified. -\item [Name = \lt{}name\gt{}] \label{Storage:Name} +\item [Name = \lt{}name\gt{}] \index[dir]{Name} \index[dir]{Directive!Name} The name of the storage resource. This name appears on the Storage directive specified in the Job resource and is required. -\item [Address = \lt{}address\gt{}] \label{Storage:Address} +\item [Address = \lt{}address\gt{}] \index[dir]{Address} \index[dir]{Directive!SD Address} \index[dir]{Storage daemon Address} @@ -2565,8 +2565,8 @@ the Director. the name but rather a fully qualified machine name or an IP address. This directive is required. - \item [FD Storage Address = \lt{}address\gt{}] \label{Storage:FDStorageAddress} + \item [FD Storage Address = \lt{}address\gt{}] \index[dir]{FDStorageAddress} \index[dir]{Directive!FD Storage Address} \index[dir]{Storage daemon Address} Where the address is a host name, a {\bf fully qualified domain @@ -2582,16 +2582,16 @@ the Director. \caption{Backup over WAN using FD Storage Address} \end{figure} -\item [SD Port = \lt{}port\gt{}] \label{Storage:SdPort} +\item [SD Port = \lt{}port\gt{}] \index[dir]{SD Port} \index[dir]{Directive!SD Port} Where port is the port to use to contact the storage daemon for information and to start jobs. This same port number must appear in the Storage resource of the Storage daemon's configuration file. The default is 9103. -\item [Password = \lt{}password\gt{}] \label{Storage:Password} +\item [Password = \lt{}password\gt{}] \index[dir]{Password} \index[dir]{Directive!Password} This is the password to be used when establishing a connection with the @@ -2604,8 +2604,8 @@ the Director. The password is plain text. It is not generated through any special process, but it is preferable for security reasons to use random text. -\item [Device = \lt{}device-name\gt{}] \label{Storage:Device} +\item [Device = \lt{}device-name\gt{}] \index[dir]{Device} \index[dir]{Directive!Device} This directive specifies the Storage daemon's name of the device @@ -2623,10 +2623,10 @@ the Director. in the Director that point to the same Device in the Storage daemon. Doing so may cause the Storage daemon to block (or hang) attempting to open the same device that is already open. This directive is required. - \label{MediaType} -\item [Media Type = \lt{}MediaType\gt{}] + \label{Storage:MediaType} +\item [Media Type = \lt{}MediaType\gt{}] \index[dir]{Media Type} \index[dir]{Directive!Media Type} This directive specifies the Media Type to be used to store the data. @@ -2684,10 +2684,10 @@ the Director. resource must agree with the value specified in the Device resource in the {\bf Storage daemon's} configuration file. It is also an additional check so that you don't try to write data for a DLT onto an 8mm device. - \label{Autochanger1} -\item [Autochanger = \lt{}yes\vb{}no\gt{}] + \label{Storage:Autochanger} +\item [Autochanger = \lt{}yes\vb{}no\gt{}] \index[dir]{Autochanger} \index[dir]{Directive!Autochanger} If you specify {\bf yes} for this command (the default is {\bf no}), @@ -2713,8 +2713,8 @@ the Director. Autochangers}{AutochangersChapter} manual of this chapter for the details of using autochangers. -\item [Maximum Concurrent Jobs = \lt{}number\gt{}] \label{Storage:MaximumConcurrentJobs} +\item [Maximum Concurrent Jobs = \lt{}number\gt{}] \index[dir]{Maximum Concurrent Jobs} \index[dir]{Directive!Maximum Concurrent Jobs} where \lt{}number\gt{} is the maximum number of Jobs with the current @@ -2729,9 +2729,9 @@ the Director. turn data spooling on as documented in the \ilink{Data Spooling}{SpoolingChapter} chapter of this manual. -\item [AllowCompression = \lt{}yes\vb{}no\gt{}] \label{AllowCompression} \label{Storage:AllowCompression} +\item [AllowCompression = \lt{}yes\vb{}no\gt{}] \index[dir]{AllowCompression} \index[dir]{Directive!AllowCompression} @@ -2741,8 +2741,8 @@ the Director. compression options in FileSets used by jobs which use this storage resource. -\item [Heartbeat Interval = \lt{}time-interval\gt{}] \label{Storage:Heartbeat Interval} +\item [Heartbeat Interval = \lt{}time-interval\gt{}] \index[dir]{Heartbeat Interval} \index[dir]{Directive!Heartbeat} This directive is optional and if specified will cause the Director to @@ -2769,8 +2769,8 @@ Storage { \end{verbatim} \normalsize -\section{The Pool Resource} \label{PoolResource} +\section{The Pool Resource} \index[general]{Resource!Pool} \index[general]{Pool Resource} @@ -2854,16 +2854,16 @@ The Pool Resource defined in the Director's configuration file defined. -\item [Name = \lt{}name\gt{}] \label{Pool:Name} +\item [Name = \lt{}name\gt{}] \index[dir]{Name} \index[dir]{Directive!Name} The name of the pool. For most applications, you will use the default pool name {\bf Default}. This directive is required. - \label{MaxVolumes} -\item [Maximum Volumes = \lt{}number\gt{}] + \label{Pool:MaximumVolumes} +\item [Maximum Volumes = \lt{}number\gt{}] \index[dir]{Maximum Volumes} \index[dir]{Directive!Maximum Volumes} This directive specifies the maximum number of volumes (tapes or files) @@ -2873,8 +2873,8 @@ The Pool Resource defined in the Director's configuration file Volumes, or for File storage where you wish to ensure that the backups made to disk files do not become too numerous or consume too much space. -\item [Pool Type = \lt{}type\gt{}] \label{Pool:PoolType} +\item [Pool Type = \lt{}type\gt{}] \index[dir]{Pool Type} \index[dir]{Directive!Pool Type} This directive defines the pool type, which corresponds to the type of @@ -2890,8 +2890,8 @@ The Pool Resource defined in the Director's configuration file \end{itemize} Note, only Backup is current implemented. -\item [Storage = \lt{}storage-resource-name\gt{}] \label{Pool:Storage} +\item [Storage = \lt{}storage-resource-name\gt{}] \index[dir]{Storage} \index[dir]{Directive!Storage} The Storage directive defines the name of the storage services where you @@ -2903,8 +2903,8 @@ The Pool Resource defined in the Director's configuration file the Job resource or in the Pool, but it must be specified in one or the other. If not configuration error will result. -\item [Use Volume Once = \lt{}yes\vb{}no\gt{}] \label{Pool:UseVolumeOnce} +\item [Use Volume Once = \lt{}yes\vb{}no\gt{}] \index[dir]{Use Volume Once} \index[dir]{Directive!Use Volume Once} This directive if set to {\bf yes} specifies that each volume is to be @@ -2923,8 +2923,8 @@ The Pool Resource defined in the Director's configuration file Please see the notes below under {\bf Maximum Volume Jobs} concerning using this directive with multiple simultaneous jobs. -\item [Maximum Volume Jobs = \lt{}positive-integer\gt{}] \label{Pool:MaximumVolumeJobs} +\item [Maximum Volume Jobs = \lt{}positive-integer\gt{}] \index[dir]{Maximum Volume Jobs} \index[dir]{Directive!Maximum Volume Jobs} This directive specifies the maximum number of Jobs that can be written @@ -2949,8 +2949,8 @@ The Pool Resource defined in the Director's configuration file updated, multiple simultaneous jobs may fail since the Volume can no longer be written. -\item [Maximum Volume Files = \lt{}positive-integer\gt{}] \label{Pool:MaximumVolumeFiles} +\item [Maximum Volume Files = \lt{}positive-integer\gt{}] \index[dir]{Maximum Volume Files} \index[dir]{Directive!Maximum Volume Files} This directive specifies the maximum number of files that can be written @@ -2969,8 +2969,8 @@ The Pool Resource defined in the Director's configuration file what is stored for the Volume. To change the value for an existing Volume you must use the {\bf update} command in the Console. -\item [Maximum Volume Bytes = \lt{}size\gt{}] \label{Pool:MaximumVolumeBytes} +\item [Maximum Volume Bytes = \lt{}size\gt{}] \index[dir]{Maximum Volume Bytes} \index[dir]{Directive!Maximum Volume Bytes} This directive specifies the maximum number of bytes that can be written @@ -2993,8 +2993,8 @@ The Pool Resource defined in the Director's configuration file what is stored for the Volume. To change the value for an existing Volume you must use the {\bf update} command in the Console. -\item [Volume Use Duration = \lt{}time-period-specification\gt{}] \label{Pool:VolumeUseDuration} +\item [Volume Use Duration = \lt{}time-period-specification\gt{}] \index[dir]{Volume Use Duration} \index[dir]{Directive!Volume Use Duration} The Volume Use Duration directive defines the time period that the @@ -3038,8 +3038,8 @@ The Pool Resource defined in the Director's configuration file must use the \ilink{\bf update volume}{UpdateCommand} command in the Console. -\item [Catalog Files = \lt{}yes\vb{}no\gt{}] \label{Pool:CatalogFiles} +\item [Catalog Files = \lt{}yes\vb{}no\gt{}] \index[dir]{Catalog Files} \index[dir]{Directive!Catalog Files} This directive defines whether or not you want the names of the files @@ -3050,10 +3050,10 @@ The Pool Resource defined in the Director's configuration file for each Job (this is often called Browsing). Also, without the File entries in the catalog, you will not be able to use the Console {\bf restore} command nor any other command that references File entries. - \label{PoolAutoPrune} -\item [AutoPrune = \lt{}yes\vb{}no\gt{}] + \label{Pool:AutoPrune} +\item [AutoPrune = \lt{}yes\vb{}no\gt{}] \index[dir]{AutoPrune} \index[dir]{Directive!AutoPrune} If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or @@ -3062,10 +3062,10 @@ The Pool Resource defined in the Director's configuration file pruning causes expired Jobs (older than the {\bf Volume Retention} period) to be deleted from the Catalog and permits possible recycling of the Volume. - \label{VolRetention} -\item [Volume Retention = \lt{}time-period-specification\gt{}] + \label{Pool:VolumeRetention} +\item [Volume Retention = \lt{}time-period-specification\gt{}] \index[dir]{Volume Retention} \index[dir]{Directive!Volume Retention} The Volume Retention directive defines the length of time that {\bf @@ -3111,8 +3111,8 @@ The Pool Resource defined in the Director's configuration file what is stored for the Volume. To change the value for an existing Volume you must use the {\bf update} command in the Console. -\item [Action On Purge = \lt{Truncate}] \label{Pool:ActionOnPurge} +\item [Action On Purge = \lt{Truncate}] \index[dir]{actiononpurge} This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the @@ -3142,10 +3142,10 @@ Job { } } \end{verbatim} - \label{PoolScratchPool} -\item [ScratchPool = \lt{}pool-resource-name\gt{}] + \label{Pool:ScrachPool} +\item [ScratchPool = \lt{}pool-resource-name\gt{}] \index[dir]{ScrachPool} \index[dir]{Directive!ScrachPool} This directive permits to specify a dedicate \textsl{Scratch} for the @@ -3154,10 +3154,10 @@ Job { \ilink{Scratch Pool}{TheScratchPool} section of this manual. This is useful when using multiple storage sharing the same mediatype or when you want to dedicate volumes to a particular set of pool. - \label{PoolRecyclePool} -\item [RecyclePool = \lt{}pool-resource-name\gt{}] + \label{Pool:RecyclePool} +\item [RecyclePool = \lt{}pool-resource-name\gt{}] \index[dir]{RecyclePool} \index[dir]{Directive!RecyclePool} This directive defines to which pool @@ -3175,10 +3175,10 @@ Job { discovers that there are no records left in the catalog and hence marks it as {\bf Purged}. - \label{PoolRecycle} -\item [Recycle = \lt{}yes\vb{}no\gt{}] + \label{Pool:Recycle} +\item [Recycle = \lt{}yes\vb{}no\gt{}] \index[dir]{Recycle} \index[dir]{Directive!Recycle} This directive specifies whether or not Purged Volumes may be recycled. @@ -3205,10 +3205,10 @@ Job { Volumes marked as Purged will be considered to be converted to the Recycled state if the {\bf Recycle} directive is set to {\bf yes}. - \label{RecycleOldest} -\item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}] + \label{Pool:RecycleOldestVolume} +\item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}] \index[dir]{Recycle Oldest Volume} \index[dir]{Directive!Recycle Oldest Volume} This directive instructs the Director to search for the oldest used @@ -3229,11 +3229,11 @@ Job { Volume in the Pool, you will immediately recycle your Volume if you fill it and Bacula needs another one. Thus your backup will be totally invalid. Please use this directive with care. The default is {\bf no}. - \label{RecycleCurrent} -\item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}] + \label{Pool:RecycleCurrentVolume} +\item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}] \index[dir]{Recycle Current Volume} \index[dir]{Directive!Recycle Current Volume} If Bacula needs a new Volume, this directive instructs Bacula to Prune @@ -3253,11 +3253,11 @@ Job { you will immediately recycle your Volume if you fill it and Bacula needs another one. Thus your backup will be totally invalid. Please use this directive with care. The default is {\bf no}. - \label{PurgeOldest} -\item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}] + \label{Pool:PurgeOldestVolume} +\item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}] \index[dir]{Purge Oldest Volume} \index[dir]{Directive!Purge Oldest Volume} This directive instructs the Director to search for the oldest used @@ -3286,8 +3286,8 @@ Job { sure that some day, Bacula will recycle a Volume that contains current data. The default is {\bf no}. -\item [File Retention = \lt{}time-period-specification\gt{}] \label{Pool:FileRetention} +\item [File Retention = \lt{}time-period-specification\gt{}] \index[dir]{File Retention} \index[dir]{Directive!File Retention} The File Retention directive defines the length of time that Bacula will @@ -3304,8 +3304,8 @@ Job { For more information see Client documentation about \ilink{FileRetention}{FileRetention} -\item [Job Retention = \lt{}time-period-specification\gt{}] \label{Pool:JobRetention} +\item [Job Retention = \lt{}time-period-specification\gt{}] \index[dir]{Job Retention} \index[dir]{Directive!Job Retention} @@ -3321,8 +3321,8 @@ Job { For more information see Client side documentation \ilink{JobRetention}{JobRetention} -\item [Cleaning Prefix = \lt{}string\gt{}] \label{Pool:CleaningPrefix} +\item [Cleaning Prefix = \lt{}string\gt{}] \index[dir]{Cleaning Prefix} \index[dir]{Directive!Cleaning Prefix} This directive defines a prefix string, which if it matches the @@ -3331,10 +3331,10 @@ Job { never attempt to use this tape. This is primarily for use with autochangers that accept barcodes where the convention is that barcodes beginning with {\bf CLN} are treated as cleaning tapes. - \label{Label} -\item [Label Format = \lt{}format\gt{}] + \label{Pool:LabelFormat} +\item [Label Format = \lt{}format\gt{}] \index[dir]{Label Format} \index[dir]{Directive!Label Format} This directive specifies the format of the labels contained in this @@ -3400,8 +3400,8 @@ Pool { \end{verbatim} \normalsize -\subsection{The Scratch Pool} \label{TheScratchPool} +\subsection{The Scratch Pool} \index[general]{Scratch Pool} In general, you can give your Pools any name you wish, but there is one important restriction: the Pool named {\bf Scratch}, if it exists behaves @@ -3411,8 +3411,8 @@ it finds an available Volume, it will move it out of the Scratch pool into the Pool currently being used by the job. -\section{The Catalog Resource} \label{CatalogResource} +\section{The Catalog Resource} \index[general]{Resource!Catalog} \index[general]{Catalog Resource} @@ -3439,8 +3439,8 @@ or on a different machine on the network. See below for more details. defined. -\item [Name = \lt{}name\gt{}] \label{Catalog:Name} +\item [Name = \lt{}name\gt{}] \index[dir]{Name} \index[dir]{Directive!Name} The name of the Catalog. No necessary relation to the database server @@ -3448,15 +3448,15 @@ defined. indicating that all catalog data for that Client is maintained in this Catalog. This directive is required. -\item [password = \lt{}password\gt{}] \label{Catalog:Password} +\item [password = \lt{}password\gt{}] \index[dir]{password} \index[dir]{Directive!password} This specifies the password to use when logging into the database. This directive is required. -\item [DB Name = \lt{}name\gt{}] \label{Catalog:DbName} +\item [DB Name = \lt{}name\gt{}] \index[dir]{DB Name} \index[dir]{Directive!DB Name} This specifies the name of the database. If you use multiple catalogs @@ -3465,15 +3465,15 @@ defined. that is known to the server (i.e. you explicitly created the Bacula tables using this name. This directive is required. -\item [user = \lt{}user\gt{}] \label{Catalog:User} +\item [user = \lt{}user\gt{}] \index[dir]{user} \index[dir]{Directive!user} This specifies what user name to use to log into the database. This directive is required. -\item [DB Socket = \lt{}socket-name\gt{}] \label{Catalog:DbSocket} +\item [DB Socket = \lt{}socket-name\gt{}] \index[dir]{DB Socket} \index[dir]{Directive!DB Socket} This is the name of a socket to use on the local host to connect to the @@ -3482,8 +3482,8 @@ defined. will use the default socket. If the DB Socket is specified, the MySQL server must reside on the same machine as the Director. -\item [DB Address = \lt{}address\gt{}] \label{Catalog:DBAddress} +\item [DB Address = \lt{}address\gt{}] \index[dir]{DB Address} \index[dir]{Directive!DB Address} This is the host address of the database server. Normally, you would specify @@ -3492,8 +3492,8 @@ defined. only by MySQL and PostgreSQL and is ignored by SQLite if provided. This directive is optional. -\item [DB Port = \lt{}port\gt{}] \label{Catalog:DbPort} +\item [DB Port = \lt{}port\gt{}] \index[dir]{DB Port} \index[dir]{Directive!DB Port} This defines the port to be used in conjunction with {\bf DB Address} to @@ -3556,8 +3556,8 @@ Catalog \end{verbatim} \normalsize -\section{The Messages Resource} \label{MessagesResource2} +\section{The Messages Resource} \index[general]{Resource!Messages} \index[general]{Messages Resource} @@ -3565,8 +3565,8 @@ For the details of the Messages Resource, please see the \ilink{Messages Resource Chapter}{MessagesChapter} of this manual. -\section{The Console Resource} \label{ConsoleResource1} +\section{The Console Resource} \index[general]{Console Resource} \index[general]{Resource!Console} @@ -3615,16 +3615,16 @@ directives are permitted within the Director's configuration resource: \begin{description} -\item [Name = \lt{}name\gt{}] \label{Console:Name} +\item [Name = \lt{}name\gt{}] \index[dir]{Name} \index[dir]{Directive!Name} The name of the console. This name must match the name specified in the Console's configuration resource (much as is the case with Client definitions). -\item [Password = \lt{}password\gt{}] \label{Console:Password} +\item [Password = \lt{}password\gt{}] \index[dir]{Password} \index[dir]{Directive!Password} Specifies the password that must be supplied for a named Bacula Console @@ -3640,8 +3640,8 @@ definitions). process. However, it is preferable for security reasons to choose random text. -\item [JobACL = \lt{}name-list\gt{}] \label{Console:JobAcl} +\item [JobACL = \lt{}name-list\gt{}] \index[dir]{JobACL} \index[dir]{Directive!JobACL} This directive is used to specify a list of Job resource names that can @@ -3662,58 +3662,58 @@ definitions). With the above specification, the console can access the Director's resources for the four jobs named on the JobACL directives, but for no others. -\item [ClientACL = \lt{}name-list\gt{}] \label{Console:ClientAcl} +\item [ClientACL = \lt{}name-list\gt{}] \index[dir]{ClientACL} \index[dir]{Directive!ClientACL} This directive is used to specify a list of Client resource names that can be accessed by the console. -\item [StorageACL = \lt{}name-list\gt{}] \label{Console:StorageAcl} +\item [StorageACL = \lt{}name-list\gt{}] \index[dir]{StorageACL} \index[dir]{Directive!StorageACL} This directive is used to specify a list of Storage resource names that can be accessed by the console. -\item [ScheduleACL = \lt{}name-list\gt{}] \label{Console:ScheduleAcl} +\item [ScheduleACL = \lt{}name-list\gt{}] \index[dir]{ScheduleACL} \index[dir]{Directive!ScheduleACL} This directive is used to specify a list of Schedule resource names that can be accessed by the console. -\item [PoolACL = \lt{}name-list\gt{}] \label{Console:PoolAcl} +\item [PoolACL = \lt{}name-list\gt{}] \index[dir]{PoolACL} \index[dir]{Directive!PoolACL} This directive is used to specify a list of Pool resource names that can be accessed by the console. -\item [FileSetACL = \lt{}name-list\gt{}] \label{Console:FileSetAcl} +\item [FileSetACL = \lt{}name-list\gt{}] \index[dir]{FileSetACL} \index[dir]{Directive!FileSetACL} This directive is used to specify a list of FileSet resource names that can be accessed by the console. -\item [CatalogACL = \lt{}name-list\gt{}] \label{Console:CatalogAcl} +\item [CatalogACL = \lt{}name-list\gt{}] \index[dir]{CatalogACL} \index[dir]{Directive!CatalogACL} This directive is used to specify a list of Catalog resource names that can be accessed by the console. -\item [CommandACL = \lt{}name-list\gt{}] \label{Console:CommandAcl} +\item [CommandACL = \lt{}name-list\gt{}] \index[dir]{CommandACL} \index[dir]{Directive!CommandACL} This directive is used to specify a list of of console commands that can be executed by the console. -\item [WhereACL = \lt{}string\gt{}] \label{Console:WhereAcl} +\item [WhereACL = \lt{}string\gt{}] \index[dir]{WhereACL} \index[dir]{Directive!WhereACL} This directive permits you to specify where a restricted console @@ -3736,8 +3736,8 @@ the \ilink{Console Configuration}{ConsoleConfChapter} chapter of this manual. -\section{The Counter Resource} \label{CounterResource} +\section{The Counter Resource} \index[general]{Resource!Counter} \index[general]{Counter Resource} @@ -3754,22 +3754,22 @@ details. \index[dir]{Directive!Counter} Start of the Counter resource. Counter directives are optional. -\item [Name = \lt{}name\gt{}] \label{Counter:Name} +\item [Name = \lt{}name\gt{}] \index[dir]{Name} \index[dir]{Directive!Name} The name of the Counter. This is the name you will use in the variable expansion to reference the counter value. -\item [Minimum = \lt{}integer\gt{}] \label{Counter:Minimum} +\item [Minimum = \lt{}integer\gt{}] \index[dir]{Minimum} \index[dir]{Directive!Minimum} This specifies the minimum value that the counter can have. It also becomes the default. If not supplied, zero is assumed. -\item [Maximum = \lt{}integer\gt{}] \label{Counter:Maximum} +\item [Maximum = \lt{}integer\gt{}] \index[dir]{Maximum} \index[dir]{Directive!Maximum} \index[dir]{Directive!Maximum} @@ -3778,8 +3778,8 @@ or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to the 31 power). When the counter is incremented past this value, it is reset to the Minimum. -\item [*WrapCounter = \lt{}counter-name\gt{}] \label{Counter:*WrapCounter} +\item [*WrapCounter = \lt{}counter-name\gt{}] \index[dir]{*WrapCounter} \index[dir]{Directive!*WrapCounter} If this value is specified, when the counter is incremented past the @@ -3787,8 +3787,8 @@ maximum and thus reset to the minimum, the counter specified on the {\bf WrapCounter} is incremented. (This is not currently implemented). -\item [Catalog = \lt{}catalog-name\gt{}] \label{Counter:Catalog} +\item [Catalog = \lt{}catalog-name\gt{}] \index[dir]{Catalog} \index[dir]{Directive!Catalog} If this directive is specified, the counter and its values will be saved in @@ -3796,8 +3796,8 @@ the specified catalog. If this directive is not present, the counter will be redefined each time that Bacula is started. \end{description} -\section{Example Director Configuration File} \label{SampleDirectorConfiguration} +\section{Example Director Configuration File} \index[general]{File!Example Director Configuration} \index[general]{Example Director Configuration File}