From 37c0c3b94d60e6b3c19c1e9d8088a76493eee012 Mon Sep 17 00:00:00 2001 From: Eric Bollengier Date: Wed, 26 Sep 2012 21:39:24 +0200 Subject: [PATCH] Add labels --- docs/manuals/en/main/dirdconf.tex | 214 +++++++++++++++++++++++++----- 1 file changed, 184 insertions(+), 30 deletions(-) diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex index 3f3b098c..b5ae5178 100644 --- a/docs/manuals/en/main/dirdconf.tex +++ b/docs/manuals/en/main/dirdconf.tex @@ -101,18 +101,21 @@ index and media database redundancy. supplied. \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. \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. \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 @@ -130,7 +133,7 @@ in the graphical user interface. This directive is optional. security reasons. \item [Messages = \lt{}Messages-resource-name\gt{}] - \index[dir]{Messages} + \label{Director:Messages} \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 @@ -139,6 +142,7 @@ in the graphical user interface. This directive is optional. directive is required. \item [Working Directory = \lt{}Directory\gt{}] + \label{Director:WorkingDirectory} \index[dir]{Working Directory} \index[dir]{Directive!Working Directory} This directive is mandatory and specifies a directory in which the Director @@ -160,6 +164,7 @@ in the graphical user interface. This directive is optional. be set to those values. \item [Pid Directory = \lt{}Directory\gt{}] + \label{Director:PidDirectory} \index[dir]{Pid Directory} \index[dir]{Directive!Pid Directory} This directive is mandatory and specifies a directory in which the Director @@ -177,6 +182,7 @@ in the graphical user interface. This directive is optional. Directory} as defined above. This directive is required. \item [Scripts Directory = \lt{}Directory\gt{}] + \label{Director:ScriptsDirectory} \index[dir]{Scripts Directory} \index[dir]{Directive!Scripts Directory} This directive is optional and, if defined, specifies a directory in @@ -187,6 +193,7 @@ in the graphical user interface. This directive is optional. expanded. \item [QueryFile = \lt{}Path\gt{}] + \label{Director:QueryFile} \index[dir]{QueryFile} \index[dir]{Directive!QueryFile} This directive is mandatory and specifies a directory and file in which @@ -196,6 +203,7 @@ in the graphical user interface. This directive is optional. \$HOME} will be properly expanded. This directive is required. \item [Heartbeat Interval = \lt{}time-interval\gt{}] + \label{Director:HeartbeatInterval} \index[dir]{Heartbeat Interval} \index[dir]{Directive!Heartbeat} This directive is optional and if specified will cause the Director to @@ -208,6 +216,7 @@ in the graphical user interface. This directive is optional. \label{DirMaxConJobs} \item [Maximum Concurrent Jobs = \lt{}number\gt{}] + \label{Director:MaximumConcurrentJobs} \index[dir]{Maximum Concurrent Jobs} \index[dir]{Directive!Maximum Concurrent Jobs} \index[general]{Simultaneous Jobs} @@ -225,6 +234,7 @@ in the graphical user interface. This directive is optional. thus avoiding excessive interleaving of the different job blocks. \item [FD Connect Timeout = \lt{}time\gt{}] + \label{Director:FdConnectTimeout} \index[dir]{FD Connect Timeout} \index[dir]{Directive!FD Connect Timeout} where {\bf time} is the time that the Director should continue @@ -232,6 +242,7 @@ in the graphical user interface. This directive is optional. the Director will cancel the job. The default is 30 minutes. \item [SD Connect Timeout = \lt{}time\gt{}] + \label{Director:SdConnectTimeout} \index[dir]{SD Connect Timeout} \index[dir]{Directive!SD Connect Timeout} where {\bf time} is the time that the Director should continue @@ -239,6 +250,7 @@ in the graphical user interface. This directive is optional. the Director will cancel the job. The default is 30 minutes. \item [DirAddresses = \lt{}IP-address-specification\gt{}] + \label{Director:DirAddresses} \index[dir]{DirAddresses} \index[dir]{Address} \index[general]{Address} @@ -283,6 +295,7 @@ not use either a DirPort or a DirAddress directive in the same resource. \item [DirPort = \lt{}port-number\gt{}] + \label{Director:DirPort} \index[dir]{DirPort} \index[dir]{Directive!DirPort} Specify the port (a positive integer) on which the Director daemon will @@ -293,6 +306,7 @@ resource. directive. \item [DirAddress = \lt{}IP-Address\gt{}] + \label{Director:DirAddress} \index[dir]{DirAddress} \index[dir]{Directive!DirAddress} This directive is optional, but if it is specified, it will cause the @@ -305,6 +319,7 @@ resource. should not be used if you specify a DirAddresses (N.B. plural) directive. \item [DirSourceAddress = \lt{}IP-Address\gt{}] + \label{Director:DirSourceAddress} \index[fd]{DirSourceAddress} \index[fd]{Directive!DirSourceAddress} This record is optional, and if it is specified, it will cause the Director @@ -314,6 +329,7 @@ resource. its outgoing connections according to the system routing table (the default). \item[Statistics Retention = \lt{}time\gt{}] + \label{Director:StatisticsRetention} \index[dir]{StatisticsRetention} \index[dir]{Directive!StatisticsRetention} \label{PruneStatistics} @@ -334,11 +350,13 @@ resource. The default is 5 years. \item[VerId = \lt{}string\gt{}] + \label{Director:VerId} \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} \index[dir]{MaximumConsoleConnections} \index[dir]{Directive!MaximumConsoleConnections} \index[dir]{Console} @@ -347,6 +365,7 @@ resource. larger number. \item[MaximumReloadRequests = \lt{}number\gt{}] +\label{Director:MaximumReloadRequests} \index[dir]{MaximumReloadRequests} \index[dir]{Directive!MaximumReloadRequests} \index[dir]{Console} @@ -355,32 +374,33 @@ 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{}] - \index[dir]{SharedStorage} - \index[dir]{Directive!SharedStorage} - - The \texttt{Shared Storage} directive is a Bacula Enterprise feature that - allows you to share volumes between different Storage resources. This - directive should be used \textbf{only} if all \texttt{Media Type} are - correctly set across all Devices. - - The \texttt{Shared Storage} directive should be used when using the SAN - Shared Storage plugin or when accessing from the Director Storage resources - directly to Devices of an Autochanger. - - When sharing volumes between different Storage resources, you will - need also to use the \texttt{reset-storageid} script before using the - \texttt{update slots} command. This script can be scheduled once a day in - an Admin job. - -\begin{verbatim} - $ /opt/bacula/scripts/reset-storageid MediaType StorageName - $ bconsole - * update slots storage=StorageName drive=0 -\end{verbatim} - - Please contact Bacula Systems support to get help on this advanced - configuration. +%\item[SharedStorage = \lt{}yes\vb{}no\gt{}] +% \label{Director:SharedStorage} +% \index[dir]{SharedStorage} +% \index[dir]{Directive!SharedStorage} +% +% The \texttt{Shared Storage} directive is a Bacula Enterprise feature that +% allows you to share volumes between different Storage resources. This +% directive should be used \textbf{only} if all \texttt{Media Type} are +% correctly set across all Devices. +% +% The \texttt{Shared Storage} directive should be used when using the SAN +% Shared Storage plugin or when accessing from the Director Storage resources +% directly to Devices of an Autochanger. +% +% When sharing volumes between different Storage resources, you will +% need also to use the \texttt{reset-storageid} script before using the +% \texttt{update slots} command. This script can be scheduled once a day in +% an Admin job. +% +%\begin{verbatim} +% $ /opt/bacula/scripts/reset-storageid MediaType StorageName +% $ bconsole +% * update slots storage=StorageName drive=0 +%\end{verbatim} +% +% Please contact Bacula Systems support to get help on this advanced +% configuration. \end{description} @@ -442,6 +462,7 @@ the FileSets may be the same). Start of the Job resource. At least one Job resource is required. \item [Name = \lt{}name\gt{}] + \label{Job:Name} \index[dir]{Name} \index[dir]{Directive!Name} The Job name. This name can be specified on the {\bf Run} command in the @@ -455,12 +476,14 @@ the FileSets may be the same). execution. This directive is required. \item [Enabled = \lt{}yes\vb{}no\gt{}] + \label{Job:Enable} \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} \index[dir]{Type} \index[dir]{Directive!Type} The {\bf Type} directive specifies the Job type, which may be one of the @@ -510,6 +533,7 @@ the FileSets may be the same). \label{Level} \item [Level = \lt{}job-level\gt{}] +\label{Job:Level} \index[dir]{Level} \index[dir]{Directive!Level} The Level directive specifies the default Job level to be run. Each @@ -749,6 +773,7 @@ For a {\bf Verify} Job, the Level may be one of the following: \end{description} \item [Accurate = \lt{}yes\vb{}no\gt{}] +\label{Job:Accurate} \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. @@ -770,6 +795,7 @@ For a {\bf Verify} Job, the Level may be one of the following: required information. \item [Verify Job = \lt{}Job-Resource-Name\gt{}] + \label{Job:VerifyJob} \index[dir]{Verify Job} \index[dir]{Directive!Verify Job} If you run a verify job without this directive, the last job run will be @@ -781,6 +807,7 @@ For a {\bf Verify} Job, the Level may be one of the following: written is re-read. \item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}] +\label{Job:JobDefs} \index[dir]{JobDefs} \index[dir]{Directive!JobDefs} If a JobDefs-Resource-Name is specified, all the values contained in the @@ -794,6 +821,7 @@ For a {\bf Verify} Job, the Level may be one of the following: JobDefs is provided in the default bacula-dir.conf file. \item [Bootstrap = \lt{}bootstrap-file\gt{}] +\label{Job:Bootstrap} \index[dir]{Bootstrap} \index[dir]{Directive!Bootstrap} The Bootstrap directive specifies a bootstrap file that, if provided, @@ -814,6 +842,7 @@ For a {\bf Verify} Job, the Level may be one of the following: \label{writebootstrap} \item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}] +\label{Job:WriteBootstrap} \index[dir]{Write Bootstrap} \index[dir]{Directive!Write Bootstrap} The {\bf writebootstrap} directive specifies a file name where Bacula @@ -855,6 +884,7 @@ JobDefs { \ilink{The Bootstrap File}{BootstrapChapter} of this manual. \item [Client = \lt{}client-resource-name\gt{}] +\label{Job:Client} \index[dir]{Client} \index[dir]{Directive!Client} The Client directive specifies the Client (File daemon) that will be used in @@ -866,6 +896,7 @@ JobDefs { This directive is required. \item [FileSet = \lt{}FileSet-resource-name\gt{}] +\label{Job:FileSet} \index[dir]{FileSet} \index[dir]{Directive!FileSet} The FileSet directive specifies the FileSet that will be used in the @@ -876,6 +907,7 @@ JobDefs { this chapter. This directive is required. \item [Base = \lt{}job-resource-name, ...\gt{}] +\label{Job:Base} \index[dir]{Base} \index[dir]{Directive!Base} The Base directive permits to specify the list of jobs that will be used during @@ -883,6 +915,7 @@ 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} \index[dir]{Messages} \index[dir]{Directive!Messages} The Messages directive defines what Messages resource should be used for @@ -893,6 +926,7 @@ chapter}{basejobs} for more information. directive is required. \item [Pool = \lt{}pool-resource-name\gt{}] +\label{Job:Pool} \index[dir]{Pool} \index[dir]{Directive!Pool} The Pool directive defines the pool of Volumes where your data can be @@ -903,6 +937,7 @@ chapter}{basejobs} for more information. section}{PoolResource} of this chapter. This directive is required. \item [Full Backup Pool = \lt{}pool-resource-name\gt{}] +\label{Job:FullBackupPool} \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. @@ -910,6 +945,7 @@ chapter}{basejobs} for more information. directive is optional. \item [Differential Backup Pool = \lt{}pool-resource-name\gt{}] +\label{Job:DifferentialBackupPool} \index[dir]{Differential Backup Pool} \index[dir]{Directive!Differential Backup Pool} The {\it Differential Backup Pool} specifies a Pool to be used for @@ -917,6 +953,7 @@ chapter}{basejobs} for more information. Differential backup. This directive is optional. \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}] +\label{Job:IncrementalBackupPool} \index[dir]{Incremental Backup Pool} \index[dir]{Directive!Incremental Backup Pool} The {\it Incremental Backup Pool} specifies a Pool to be used for @@ -924,6 +961,7 @@ chapter}{basejobs} for more information. Incremental backup. This directive is optional. \item [Schedule = \lt{}schedule-name\gt{}] +\label{Job:Schedule} \index[dir]{Schedule} \index[dir]{Directive!Schedule} The Schedule directive defines what schedule is to be used for the Job. @@ -941,6 +979,7 @@ chapter}{basejobs} for more information. \item [Storage = \lt{}storage-resource-name\gt{}] +\label{Job:Storage} \index[dir]{Storage} \index[dir]{Directive!Storage} The Storage directive defines the name of the storage services where you @@ -953,6 +992,7 @@ chapter}{basejobs} for more information. one or the other, if not an error will result. \item [Max Start Delay = \lt{}time\gt{}] +\label{Job:MaxStartDelay} \index[dir]{Max Start Delay} \index[dir]{Directive!Max Start Delay} The time specifies the maximum delay between the scheduled time and the @@ -964,6 +1004,7 @@ chapter}{basejobs} for more information. which indicates no limit. \item [Max Run Time = \lt{}time\gt{}] +\label{Job:MaxRunTime} \index[dir]{Max Run Time} \index[dir]{Directive!Max Run Time} The time specifies the maximum allowed time that a job may run, counted @@ -976,6 +1017,7 @@ chapter}{basejobs} for more information. \item [Incremental|Differential Max Wait Time = \lt{}time\gt{}] +\label{Job:IncrementalWaitRunTime} \index[dir]{Incremental Wait Run Time} \index[dir]{Differential Wait Run Time} \index[dir]{Directive!Differential Max Wait Time} @@ -983,6 +1025,7 @@ chapter}{basejobs} for more information. \texttt{Incremental|Differential Max Run Time} since bacula 2.3.18. \item [Incremental Max Run Time = \lt{}time\gt{}] +\label{Job:IncrementalMaxRunTime} \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 @@ -990,6 +1033,7 @@ 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} \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 @@ -997,6 +1041,7 @@ 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} \index[dir]{Max Run Sched Time} \index[dir]{Directive!Max Run Sched Time} @@ -1006,6 +1051,7 @@ 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} \index[dir]{Max Wait Time} \index[dir]{Directive!Max Wait Time} The time specifies the maximum allowed time that a job may block waiting @@ -1022,6 +1068,7 @@ during working hours. We can see it like \texttt{Max Start Delay + Max Run \end{figure} \item [Maximum Bandwidth = \lt{}speed\gt{}] +\label{Job:MaximumBandwidth} \index[dir]{Maximum Bandwidth} \index[dir]{Directive!Maximum Bandwidth} @@ -1029,6 +1076,7 @@ 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} \index[dir]{Max Full Interval} \index[dir]{Directive!Max Full Interval} The time specifies the maximum allowed age (counting from start time) of @@ -1041,6 +1089,7 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. \label{PreferMountedVolumes} \item [Prefer Mounted Volumes = \lt{}yes\vb{}no\gt{}] +\label{Job:Prefer Mounted Volumes} \index[dir]{Prefer Mounted Volumes} \index[dir]{Directive!Prefer Mounted Volumes} If the Prefer Mounted Volumes directive is set to {\bf yes} (default @@ -1077,6 +1126,7 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. on different drives. \item [Prune Jobs = \lt{}yes\vb{}no\gt{}] +\label{Job:PruneJobs} \index[dir]{Prune Jobs} \index[dir]{Directive!Prune Jobs} Normally, pruning of Jobs from the Catalog is specified on a Client by @@ -1087,6 +1137,7 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. \item [Prune Files = \lt{}yes\vb{}no\gt{}] +\label{Job:PruneFiles} \index[dir]{Prune Files} \index[dir]{Directive!Prune Files} Normally, pruning of Files from the Catalog is specified on a Client by @@ -1096,6 +1147,7 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. default is {\bf no}. \item [Prune Volumes = \lt{}yes\vb{}no\gt{}] +\label{Job:PruneVolumes} \index[dir]{Prune Volumes} \index[dir]{Directive!Prune Volumes} Normally, pruning of Volumes from the Catalog is specified on a Pool by @@ -1106,6 +1158,7 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. Pool resource. The default is {\bf no}. \item [RunScript \{\lt{}body-of-runscript\gt{}\}] + \label{Job:RunScript} \index[dir]{RunScript} \index[dir]{Directive!Run Script} @@ -1204,6 +1257,7 @@ Console & & & Console command\\ Some character substitutions are not available in all situations. The Job Exit Status code \%e edits the following values: + \index[dir]{Exit Status} \begin{itemize} \item OK @@ -1438,6 +1492,7 @@ 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} \index[dir]{Run Before Job} \index[dir]{Directive!Run Before Job} \index[dir]{Directive!Run Before Job} @@ -1468,6 +1523,7 @@ RunScript { before leaving will be used. \item [Run After Job = \lt{}command\gt{}] +\label{Job:RunAfterJob} \index[dir]{Run After Job} \index[dir]{Directive!Run After Job} The specified {\bf command} is run as an external program if the current @@ -1485,6 +1541,7 @@ RunScript { non-normal status. \item [Run After Failed Job = \lt{}command\gt{}] +\label{Job:RunAfterJob} \index[dir]{Run After Job} \index[dir]{Directive!Run After Job} The specified {\bf command} is run as an external program after the current @@ -1510,6 +1567,7 @@ RunScript { \item [Client Run Before Job = \lt{}command\gt{}] +\label{Job:ClientRunBeforeJob} \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 @@ -1517,6 +1575,7 @@ RunScript { Unix systems as noted above for the {\bf RunScript}. \item [Client Run After Job = \lt{}command\gt{}] + \label{Job:ClientRunAfterJob} \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 @@ -1527,6 +1586,7 @@ RunScript { concerning Windows clients. \item [Rerun Failed Levels = \lt{}yes\vb{}no\gt{}] + \label{Job:RerunFailedLevels} \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 @@ -1545,6 +1605,7 @@ RunScript { trigger a rerun. \item [Spool Data = \lt{}yes\vb{}no\gt{}] + \label{Job:SpoolData} \index[dir]{Spool Data} \index[dir]{Directive!Spool Data} @@ -1568,12 +1629,14 @@ RunScript { automatically set to yes. \item [SpoolData=yes\vb{}no] + \label{Job:SpoolData} \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} \index[dir]{Spool Attributes} \index[dir]{Directive!Spool Attributes} \index[dir]{slow} @@ -1593,6 +1656,7 @@ RunScript { automatically set to yes. \item [SpoolSize={\it bytes}] + \label{Job:SpoolSize} \index[dir]{SpoolSize} \index[dir]{Directive!SpoolSize} where the bytes specify the maximum spool size for this job. @@ -1602,6 +1666,7 @@ RunScript { \item [Where = \lt{}directory\gt{}] + \label{Job:Where} \index[dir]{Where} \index[dir]{Directive!Where} This directive applies only to a Restore job and specifies a prefix to @@ -1615,6 +1680,7 @@ RunScript { \item [Add Prefix = \lt{}directory\gt{}] \label{confaddprefix} + \label{Job:AddPrefix} \index[dir]{AddPrefix} \index[dir]{Directive!AddPrefix} This directive applies only to a Restore job and specifies a prefix to the @@ -1622,6 +1688,7 @@ RunScript { Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later. \item [Add Suffix = \lt{}extention\gt{}] + \label{Job:AddSuffix} \index[dir]{AddSuffix} \index[dir]{Directive!AddSuffix} This directive applies only to a Restore job and specifies a suffix to all @@ -1632,6 +1699,7 @@ RunScript { \texttt{/etc/passwsd.old} \item [Strip Prefix = \lt{}directory\gt{}] + \label{Job:StripPrefix} \index[dir]{StripPrefix} \index[dir]{Directive!StripPrefix} This directive applies only to a Restore job and specifies a prefix to remove @@ -1651,6 +1719,7 @@ RunScript { \end{verbatim} \item [RegexWhere = \lt{}expressions\gt{}] + \label{Job:RegexWhere} \index[dir]{RegexWhere} \index[dir]{Directive!RegexWhere} This directive applies only to a Restore job and specifies a regex filename @@ -1661,6 +1730,7 @@ RunScript { \ilink{this}{useregexwhere}. \item [Replace = \lt{}replace-option\gt{}] + \label{Job:Replace} \index[dir]{Replace} \index[dir]{Directive!Replace} This directive applies only to a Restore job and specifies what happens @@ -1690,6 +1760,7 @@ RunScript { \end{description} \item [Prefix Links=\lt{}yes\vb{}no\gt{}] + \label{Job:PrefixLinks} \index[dir]{Prefix Links} \index[dir]{Directive!Prefix Links} If a {\bf Where} path prefix is specified for a recovery job, apply it @@ -1701,6 +1772,7 @@ RunScript { original locations, all files linked with absolute names will be broken. \item [Maximum Concurrent Jobs = \lt{}number\gt{}] + \label{Job:MaximumConcurrentJobs} \index[dir]{Maximum Concurrent Jobs} \index[dir]{Directive!Maximum Concurrent Jobs} where \lt{}number\gt{} is the maximum number of Jobs from the current @@ -1714,6 +1786,7 @@ RunScript { Director's resource. \item [Reschedule On Error = \lt{}yes\vb{}no\gt{}] + \label{Job:RescheduleOnError} \index[dir]{Reschedule On Error} \index[dir]{Directive!Reschedule On Error} If this directive is enabled, and the job terminates in error, the job @@ -1726,6 +1799,7 @@ RunScript { machines that are not always connected to the network or switched on. \item [Reschedule Interval = \lt{}time-specification\gt{}] + \label{Job:RescheduleInterval} \index[dir]{Reschedule Interval} \index[dir]{Directive!Reschedule Interval} If you have specified {\bf Reschedule On Error = yes} and the job @@ -1736,6 +1810,7 @@ RunScript { rescheduled on error. \item [Reschedule Times = \lt{}count\gt{}] + \label{Job:RescheduleTimes} \index[dir]{Reschedule Times} \index[dir]{Directive!Reschedule Times} This directive specifies the maximum number of times to reschedule the @@ -1743,6 +1818,7 @@ RunScript { indefinite number of times. \item [Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}] +\label{Job:AllowDuplicateJobs} \index[general]{Allow Duplicate Jobs} \begin{figure}[htbp] @@ -1767,6 +1843,7 @@ runs longer than expected because no tapes are available. will be cancelled. \item [Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}] +\label{Job:AllowHigherDuplicates} \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 @@ -1774,6 +1851,7 @@ runs longer than expected because no tapes are available. \item [Cancel Lower Level Duplicates = \lt{}yes\vb{}no\gt{}] +\label{Job:CancelLowerLevelDuplicates} \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 @@ -1784,6 +1862,7 @@ runs longer than expected because no tapes are available. Cancel XXX Duplicate directives will be examined. \item [Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}] +\label{Job:CancelQueuedDuplicates} \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 @@ -1791,6 +1870,7 @@ runs longer than expected because no tapes are available. The default is {\bf no}. \item[Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}] +\label{Job:CancelRunningDuplicates} \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 @@ -1804,6 +1884,7 @@ runs longer than expected because no tapes are available. %% idea to cancel it. \item [Run = \lt{}job-name\gt{}] + \label{Job:Run} \index[dir]{Run} \index[dir]{Directive!Run} \index[dir]{Clone a Job} @@ -1848,6 +1929,7 @@ runs longer than expected because no tapes are available. \label{Priority} \item [Priority = \lt{}number\gt{}] + \label{Job:Priority} \index[dir]{Priority} \index[dir]{Directive!Priority} This directive permits you to control the order in which your jobs will @@ -1900,6 +1982,7 @@ correct order, and that your priority scheme will be respected. \label{AllowMixedPriority} \item [Allow Mixed Priority = \lt{}yes\vb{}no\gt{}] +\label{Job:AllowMixedPriority} \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 @@ -1917,6 +2000,7 @@ correct order, and that your priority scheme will be respected. \label{WritePartAfterJob} \item [Write Part After Job = \lt{}yes\vb{}no\gt{}] +\label{Job:WritePartAfterJob} \index[dir]{Write Part After Job} \index[dir]{Directive!Write Part After Job} This directive is only implemented in version 1.37 and later. @@ -1987,11 +2071,13 @@ be run manually. In general, you specify an action to be taken and when. automatically started. \item [Name = \lt{}name\gt{}] + \label{Schdedule:Name} \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} \index[dir]{Run} \index[dir]{Directive!Run} The Run directive defines when a Job is to be run, and what overrides if @@ -2271,12 +2357,14 @@ one Client resource definition for each machine to be backed up. Start of the Client directives. \item [Name = \lt{}name\gt{}] + \label{Client:Name} \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} \index[dir]{Address} \index[dir]{Directive!FD Address} \index[dir]{File Daemon Address} @@ -2286,18 +2374,21 @@ console run command. This directive is required. This directive is required. \item [FD Port = \lt{}port-number\gt{}] + \label{Client:FdPort} \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} \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} \index[dir]{Password} \index[dir]{Directive!Password} This is the password to be used when establishing a connection with the File @@ -2314,6 +2405,7 @@ console run command. This directive is required. \label{FileRetention} \item [File Retention = \lt{}time-period-specification\gt{}] \label{FileRetention} + \label{Client:FileRetention} \index[dir]{File Retention} \index[dir]{Directive!File Retention} The File Retention directive defines the length of time that Bacula will @@ -2335,9 +2427,9 @@ console run command. This directive is required. The default is 60 days. -\label{JobRetention} \item [Job Retention = \lt{}time-period-specification\gt{}] \label{JobRetention} + \label{Client:JobRetention} \index[dir]{Job Retention} \index[dir]{Directive!Job Retention} The Job Retention directive defines the length of time that Bacula will keep @@ -2365,6 +2457,7 @@ console run command. This directive is required. \label{AutoPrune} \item [AutoPrune = \lt{}yes\vb{}no\gt{}] + \label{Client:AutoPrune} \index[dir]{AutoPrune} \index[dir]{Directive!AutoPrune} If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater) @@ -2375,6 +2468,7 @@ console run command. This directive is required. stored in the backup archives (on Volumes). \item [Maximum Concurrent Jobs = \lt{}number\gt{}] + \label{Client:MaximumConcurrentJobs} \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 @@ -2385,6 +2479,7 @@ console run command. This directive is required. 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} \index[dir]{Maximum Bandwidth Per Job} \index[dir]{Directive!Maximum Bandwidth Per Job} @@ -2412,6 +2507,7 @@ k/s, Kb/s, m/s or Mb/s. % \end{figure} \item [Priority = \lt{}number\gt{}] + \label{Client:Priority} \index[dir]{Priority} \index[dir]{Directive!Priority} The number specifies the priority of this client relative to other clients @@ -2450,12 +2546,14 @@ the Director. specified. \item [Name = \lt{}name\gt{}] + \label{Storage:Name} \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} \index[dir]{Address} \index[dir]{Directive!SD Address} \index[dir]{Storage daemon Address} @@ -2466,7 +2564,9 @@ 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{}] \index[dir]{FDStorageAddress} + \item [FD Storage Address = \lt{}address\gt{}] + \label{Storage:FDStorageAddress} + \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 name}, or an {\bf IP address}. Please note that the \lt{}address\gt{} as @@ -2482,6 +2582,7 @@ the Director. \end{figure} \item [SD Port = \lt{}port\gt{}] + \label{Storage:SdPort} \index[dir]{SD Port} \index[dir]{Directive!SD Port} Where port is the port to use to contact the storage daemon for information @@ -2489,6 +2590,7 @@ the Director. of the Storage daemon's configuration file. The default is 9103. \item [Password = \lt{}password\gt{}] + \label{Storage:Password} \index[dir]{Password} \index[dir]{Directive!Password} This is the password to be used when establishing a connection with the @@ -2502,6 +2604,7 @@ the Director. process, but it is preferable for security reasons to use random text. \item [Device = \lt{}device-name\gt{}] + \label{Storage:Device} \index[dir]{Device} \index[dir]{Directive!Device} This directive specifies the Storage daemon's name of the device @@ -2522,6 +2625,7 @@ the Director. \label{MediaType} \item [Media Type = \lt{}MediaType\gt{}] + \label{Storage:MediaType} \index[dir]{Media Type} \index[dir]{Directive!Media Type} This directive specifies the Media Type to be used to store the data. @@ -2582,6 +2686,7 @@ the Director. \label{Autochanger1} \item [Autochanger = \lt{}yes\vb{}no\gt{}] + \label{Storage:Autochanger} \index[dir]{Autochanger} \index[dir]{Directive!Autochanger} If you specify {\bf yes} for this command (the default is {\bf no}), @@ -2608,6 +2713,7 @@ the Director. details of using autochangers. \item [Maximum Concurrent Jobs = \lt{}number\gt{}] + \label{Storage:MaximumConcurrentJobs} \index[dir]{Maximum Concurrent Jobs} \index[dir]{Directive!Maximum Concurrent Jobs} where \lt{}number\gt{} is the maximum number of Jobs with the current @@ -2624,6 +2730,7 @@ the Director. \item [AllowCompression = \lt{}yes\vb{}no\gt{}] \label{AllowCompression} + \label{Storage:AllowCompression} \index[dir]{AllowCompression} \index[dir]{Directive!AllowCompression} @@ -2634,6 +2741,7 @@ the Director. resource. \item [Heartbeat Interval = \lt{}time-interval\gt{}] + \label{Storage:Heartbeat Interval} \index[dir]{Heartbeat Interval} \index[dir]{Directive!Heartbeat} This directive is optional and if specified will cause the Director to @@ -2746,6 +2854,7 @@ The Pool Resource defined in the Director's configuration file \item [Name = \lt{}name\gt{}] + \label{Pool:Name} \index[dir]{Name} \index[dir]{Directive!Name} The name of the pool. For most applications, you will use the default @@ -2753,6 +2862,7 @@ The Pool Resource defined in the Director's configuration file \label{MaxVolumes} \item [Maximum Volumes = \lt{}number\gt{}] + \label{Pool:MaximumVolumes} \index[dir]{Maximum Volumes} \index[dir]{Directive!Maximum Volumes} This directive specifies the maximum number of volumes (tapes or files) @@ -2763,6 +2873,7 @@ The Pool Resource defined in the Director's configuration file made to disk files do not become too numerous or consume too much space. \item [Pool Type = \lt{}type\gt{}] + \label{Pool:PoolType} \index[dir]{Pool Type} \index[dir]{Directive!Pool Type} This directive defines the pool type, which corresponds to the type of @@ -2779,6 +2890,7 @@ The Pool Resource defined in the Director's configuration file Note, only Backup is current implemented. \item [Storage = \lt{}storage-resource-name\gt{}] +\label{Pool:Storage} \index[dir]{Storage} \index[dir]{Directive!Storage} The Storage directive defines the name of the storage services where you @@ -2791,6 +2903,7 @@ The Pool Resource defined in the Director's configuration file one or the other. If not configuration error will result. \item [Use Volume Once = \lt{}yes\vb{}no\gt{}] + \label{Pool:UseVolumeOnce} \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 @@ -2810,6 +2923,7 @@ The Pool Resource defined in the Director's configuration file using this directive with multiple simultaneous jobs. \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}] + \label{Pool:MaximumVolumeJobs} \index[dir]{Maximum Volume Jobs} \index[dir]{Directive!Maximum Volume Jobs} This directive specifies the maximum number of Jobs that can be written @@ -2835,6 +2949,7 @@ The Pool Resource defined in the Director's configuration file longer be written. \item [Maximum Volume Files = \lt{}positive-integer\gt{}] + \label{Pool:MaximumVolumeFiles} \index[dir]{Maximum Volume Files} \index[dir]{Directive!Maximum Volume Files} This directive specifies the maximum number of files that can be written @@ -2854,6 +2969,7 @@ The Pool Resource defined in the Director's configuration file Volume you must use the {\bf update} command in the Console. \item [Maximum Volume Bytes = \lt{}size\gt{}] + \label{Pool:MaximumVolumeBytes} \index[dir]{Maximum Volume Bytes} \index[dir]{Directive!Maximum Volume Bytes} This directive specifies the maximum number of bytes that can be written @@ -2877,6 +2993,7 @@ The Pool Resource defined in the Director's configuration file Volume you must use the {\bf update} command in the Console. \item [Volume Use Duration = \lt{}time-period-specification\gt{}] + \label{Pool:VolumeUseDuration} \index[dir]{Volume Use Duration} \index[dir]{Directive!Volume Use Duration} The Volume Use Duration directive defines the time period that the @@ -2921,6 +3038,7 @@ The Pool Resource defined in the Director's configuration file \ilink{\bf update volume}{UpdateCommand} command in the Console. \item [Catalog Files = \lt{}yes\vb{}no\gt{}] + \label{Pool:CatalogFiles} \index[dir]{Catalog Files} \index[dir]{Directive!Catalog Files} This directive defines whether or not you want the names of the files @@ -2934,6 +3052,7 @@ The Pool Resource defined in the Director's configuration file \label{PoolAutoPrune} \item [AutoPrune = \lt{}yes\vb{}no\gt{}] + \label{Pool:AutoPrune} \index[dir]{AutoPrune} \index[dir]{Directive!AutoPrune} If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or @@ -2945,6 +3064,7 @@ The Pool Resource defined in the Director's configuration file \label{VolRetention} \item [Volume Retention = \lt{}time-period-specification\gt{}] + \label{Pool:VolumeRetention} \index[dir]{Volume Retention} \index[dir]{Directive!Volume Retention} The Volume Retention directive defines the length of time that {\bf @@ -2991,6 +3111,7 @@ The Pool Resource defined in the Director's configuration file Volume you must use the {\bf update} command in the Console. \item [Action On Purge = \lt{Truncate}] +\label{Pool:ActionOnPurge} \index[dir]{actiononpurge} This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the @@ -3023,6 +3144,7 @@ Job { \label{PoolScratchPool} \item [ScratchPool = \lt{}pool-resource-name\gt{}] + \label{Pool:ScrachPool} \index[dir]{ScrachPool} \index[dir]{Directive!ScrachPool} This directive permits to specify a dedicate \textsl{Scratch} for the @@ -3034,6 +3156,7 @@ Job { \label{PoolRecyclePool} \item [RecyclePool = \lt{}pool-resource-name\gt{}] + \label{Pool:RecyclePool} \index[dir]{RecyclePool} \index[dir]{Directive!RecyclePool} This directive defines to which pool @@ -3054,6 +3177,7 @@ Job { \label{PoolRecycle} \item [Recycle = \lt{}yes\vb{}no\gt{}] + \label{Pool:Recycle} \index[dir]{Recycle} \index[dir]{Directive!Recycle} This directive specifies whether or not Purged Volumes may be recycled. @@ -3083,6 +3207,7 @@ Job { \label{RecycleOldest} \item [Recycle Oldest Volume = \lt{}yes\vb{}no\gt{}] + \label{Pool:RecycleOldestVolume} \index[dir]{Recycle Oldest Volume} \index[dir]{Directive!Recycle Oldest Volume} This directive instructs the Director to search for the oldest used @@ -3107,6 +3232,7 @@ Job { \label{RecycleCurrent} \item [Recycle Current Volume = \lt{}yes\vb{}no\gt{}] + \label{Pool:RecycleCurrentVolume} \index[dir]{Recycle Current Volume} \index[dir]{Directive!Recycle Current Volume} If Bacula needs a new Volume, this directive instructs Bacula to Prune @@ -3130,6 +3256,7 @@ Job { \label{PurgeOldest} \item [Purge Oldest Volume = \lt{}yes\vb{}no\gt{}] + \label{Pool:PurgeOldestVolume} \index[dir]{Purge Oldest Volume} \index[dir]{Directive!Purge Oldest Volume} This directive instructs the Director to search for the oldest used @@ -3159,6 +3286,7 @@ Job { data. The default is {\bf no}. \item [File Retention = \lt{}time-period-specification\gt{}] + \label{Pool:FileRetention} \index[dir]{File Retention} \index[dir]{Directive!File Retention} The File Retention directive defines the length of time that Bacula will @@ -3176,6 +3304,7 @@ Job { \ilink{FileRetention}{FileRetention} \item [Job Retention = \lt{}time-period-specification\gt{}] + \label{Pool:JobRetention} \index[dir]{Job Retention} \index[dir]{Directive!Job Retention} @@ -3192,6 +3321,7 @@ Job { \ilink{JobRetention}{JobRetention} \item [Cleaning Prefix = \lt{}string\gt{}] + \label{Pool:CleaningPrefix} \index[dir]{Cleaning Prefix} \index[dir]{Directive!Cleaning Prefix} This directive defines a prefix string, which if it matches the @@ -3203,6 +3333,7 @@ Job { \label{Label} \item [Label Format = \lt{}format\gt{}] + \label{Pool:LabelFormat} \index[dir]{Label Format} \index[dir]{Directive!Label Format} This directive specifies the format of the labels contained in this @@ -3308,6 +3439,7 @@ defined. \item [Name = \lt{}name\gt{}] + \label{Catalog:Name} \index[dir]{Name} \index[dir]{Directive!Name} The name of the Catalog. No necessary relation to the database server @@ -3316,12 +3448,14 @@ defined. Catalog. This directive is required. \item [password = \lt{}password\gt{}] + \label{Catalog:Password} \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} \index[dir]{DB Name} \index[dir]{Directive!DB Name} This specifies the name of the database. If you use multiple catalogs @@ -3331,12 +3465,14 @@ defined. tables using this name. This directive is required. \item [user = \lt{}user\gt{}] + \label{Catalog:User} \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} \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 @@ -3346,6 +3482,7 @@ defined. MySQL server must reside on the same machine as the Director. \item [DB Address = \lt{}address\gt{}] + \label{Catalog:DBAddress} \index[dir]{DB Address} \index[dir]{Directive!DB Address} This is the host address of the database server. Normally, you would specify @@ -3355,6 +3492,7 @@ defined. This directive is optional. \item [DB Port = \lt{}port\gt{}] + \label{Catalog:DbPort} \index[dir]{DB Port} \index[dir]{Directive!DB Port} This defines the port to be used in conjunction with {\bf DB Address} to @@ -3363,7 +3501,7 @@ defined. directive is optional. %% \item [Multiple Connections = \lt{}yes\vb{}no\gt{}] -%% \index[dir]{Multiple Connections} + %% \index[dir]{Directive!Multiple Connections} %% By default, this directive is set to no. In that case, each job that uses the @@ -3477,6 +3615,7 @@ directives are permitted within the Director's configuration resource: \begin{description} \item [Name = \lt{}name\gt{}] + \label{Console:Name} \index[dir]{Name} \index[dir]{Directive!Name} The name of the console. This name must match the name specified in the @@ -3484,6 +3623,7 @@ Console's configuration resource (much as is the case with Client definitions). \item [Password = \lt{}password\gt{}] + \label{Console:Password} \index[dir]{Password} \index[dir]{Directive!Password} Specifies the password that must be supplied for a named Bacula Console @@ -3500,6 +3640,7 @@ definitions). random text. \item [JobACL = \lt{}name-list\gt{}] + \label{Console:JobAcl} \index[dir]{JobACL} \index[dir]{Directive!JobACL} This directive is used to specify a list of Job resource names that can @@ -3521,6 +3662,7 @@ 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} \index[dir]{ClientACL} \index[dir]{Directive!ClientACL} This directive is used to specify a list of Client resource names that can @@ -3528,42 +3670,49 @@ be accessed by the console. \item [StorageACL = \lt{}name-list\gt{}] + \label{Console:StorageAcl} \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} \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} \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} \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} \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} \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} \index[dir]{WhereACL} \index[dir]{Directive!WhereACL} This directive permits you to specify where a restricted console @@ -3605,18 +3754,21 @@ details. Start of the Counter resource. Counter directives are optional. \item [Name = \lt{}name\gt{}] + \label{Counter:Name} \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} \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} \index[dir]{Maximum} \index[dir]{Directive!Maximum} \index[dir]{Directive!Maximum} @@ -3626,6 +3778,7 @@ 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} \index[dir]{*WrapCounter} \index[dir]{Directive!*WrapCounter} If this value is specified, when the counter is incremented past the @@ -3634,6 +3787,7 @@ 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} \index[dir]{Catalog} \index[dir]{Directive!Catalog} If this directive is specified, the counter and its values will be saved in -- 2.39.5