From fcc4521b154e02e9a62474aa128a7e9972f82c8b Mon Sep 17 00:00:00 2001 From: Kern Sibbald Date: Thu, 2 Jun 2005 16:18:17 +0000 Subject: [PATCH] Commit latest updates --- docs/manual/dirdconf.tex | 200 ++++++++++++++++++++++----------------- docs/manual/thanks.tex | 2 - 2 files changed, 112 insertions(+), 90 deletions(-) diff --git a/docs/manual/dirdconf.tex b/docs/manual/dirdconf.tex index fbe73ea3..6f28738b 100644 --- a/docs/manual/dirdconf.tex +++ b/docs/manual/dirdconf.tex @@ -658,69 +658,91 @@ For more details on using this file, please see the chapter entitled \item [Max Start Delay = \lt{}time\gt{}] \index[dir]{Max Start Delay } - The time specifies the maximum delay between the scheduled time and the actual - start time for the Job. For example, a job can be scheduled to run at - 1:00am, but because other jobs are running, it may wait to run. If the delay - is set to 3600 (one hour) and the job has not begun to run by 2:00am, the job - will be canceled. This can be useful, for example, to prevent jobs from - running during day time hours. The default is 0 which indicates no limit. + The time specifies the maximum delay between the scheduled time and the + actual start time for the Job. For example, a job can be scheduled to + run at 1:00am, but because other jobs are running, it may wait to run. + If the delay is set to 3600 (one hour) and the job has not begun to run + by 2:00am, the job will be canceled. This can be useful, for example, + to prevent jobs from running during day time hours. The default is 0 + which indicates no limit. \item [Max Run Time = \lt{}time\gt{}] \index[dir]{Max Run Time } - The time specifies the maximum allowed time that a job may run, counted from - when the job starts, ({\bf not} necessarily the same as when the job was - scheduled). This directive is implemented only in version 1.33 and later. + The time specifies the maximum allowed time that a job may run, counted + from when the job starts, ({\bf not} necessarily the same as when the + job was scheduled). This directive is implemented in version 1.33 and + later. \item [Max Wait Time = \lt{}time\gt{}] \index[dir]{Max Wait Time } - The time specifies the maximum allowed time that a job may block waiting for a - resource (such as waiting for a tape to be mounted, or waiting for the - storage or file daemons to perform their duties), counted from the when the - job starts, ({\bf not} necessarily the same as when the job was scheduled). - This directive is implemented only in version 1.33 and later. Note, the - implementation is not yet complete, so this directive does not yet work - correctly. + The time specifies the maximum allowed time that a job may block waiting + for a resource (such as waiting for a tape to be mounted, or waiting for + the storage or file daemons to perform their duties), counted from the + when the job starts, ({\bf not} necessarily the same as when the job was + scheduled). This directive is implemented only in version 1.33 and + later. + + + +\item [Incremental Max Wait Time = \lt{}time\gt{}] + \index[dir]{Incremental Max Wait Time } + The time specifies the maximum allowed time that an Incremental backup + job may block waiting for a resource (such as waiting for a tape to be + mounted, or waiting for the storage or file daemons to perform their + duties), counted from the when the job starts, ({\bf not} necessarily + the same as when the job was scheduled). Please note that if there is a + {\bf Max Wait Time} it may also be applied to the job. + +\item [Differential Max Wait Time = \lt{}time\gt{}] + \index[dir]{Differential Max Wait Time } + The time specifies the maximum allowed time that a Differential backup + job may block waiting for a resource (such as waiting for a tape to be + mounted, or waiting for the storage or file daemons to perform their + duties), counted from the when the job starts, ({\bf not} necessarily + the same as when the job was scheduled). Please note that if there is a + {\bf Max Wait Time} it may also be applied to the job. \item [Prune Jobs = \lt{}yes|no\gt{}] \index[dir]{Prune Jobs } - Normally, pruning of Jobs from the Catalog is specified on a Client by Client - basis in the Client resource with the {\bf AutoPrune} directive. If this - directive is specified (not normally) and the value is {\bf yes}, it will - override the value specified in the Client resource. The default is {\bf no}. + Normally, pruning of Jobs from the Catalog is specified on a Client by + Client basis in the Client resource with the {\bf AutoPrune} directive. + If this directive is specified (not normally) and the value is {\bf + yes}, it will override the value specified in the Client resource. The + default is {\bf no}. \item [Prune Files = \lt{}yes|no\gt{}] \index[dir]{Prune Files } - Normally, pruning of Files from the Catalog is specified on a Client by -Client basis in the Client resource with the {\bf AutoPrune} directive. If -this directive is specified (not normally) and the value is {\bf yes}, it -will override the value specified in the Client resource. The default is {\bf -no}. + Normally, pruning of Files from the Catalog is specified on a Client by + Client basis in the Client resource with the {\bf AutoPrune} directive. + If this directive is specified (not normally) and the value is {\bf + yes}, it will override the value specified in the Client resource. The + default is {\bf no}. \item [Prune Volumes = \lt{}yes|no\gt{}] \index[dir]{Prune Volumes } - Normally, pruning of Volumes from the Catalog is specified on a Client by - Client basis in the Client resource with the {\bf AutoPrune} directive. If - this directive is specified (not normally) and the value is {\bf yes}, it - will override the value specified in the Client resource. The default is {\bf - no}. + Normally, pruning of Volumes from the Catalog is specified on a Client + by Client basis in the Client resource with the {\bf AutoPrune} + directive. If this directive is specified (not normally) and the value + is {\bf yes}, it will override the value specified in the Client + resource. The default is {\bf no}. \item [Run Before Job = \lt{}command\gt{}] \index[dir]{Run Before Job } - The specified {\bf command} is run as an external program prior to running - the current Job. Any output sent by the job to standard output will be - included in the Bacula job report. The command string must be a valid program - name or name of a shell script. This directive is not required, but if it is - defined, and if the exit code of the program run is non-zero, the current - Bacula job will be canceled. In addition, the command string is parsed then - fed to the execvp() function, which means that the path will be searched to - execute your specified command, but there is no shell interpretation, as a - consequence, if you invoke complicated commands or want any shell features such as - redirection or piping, you must call a shell script and do it inside that - script. + The specified {\bf command} is run as an external program prior to + running the current Job. Any output sent by the job to standard output + will be included in the Bacula job report. The command string must be a + valid program name or name of a shell script. This directive is not + required, but if it is defined, and if the exit code of the program run + is non-zero, the current Bacula job will be canceled. In addition, the + command string is parsed then fed to the execvp() function, which means + that the path will be searched to execute your specified command, but + there is no shell interpretation, as a consequence, if you invoke + complicated commands or want any shell features such as redirection or + piping, you must call a shell script and do it inside that script. - Before submitting the specified command to the operating system, Bacula - performs character substitution of the following characters: + Before submitting the specified command to the operating system, Bacula + performs character substitution of the following characters: \footnotesize \begin{verbatim} @@ -965,60 +987,61 @@ Bacula wants to restore a file or directory that already exists. You have the \item [Maximum Concurrent Jobs = \lt{}number\gt{}] \index[dir]{Maximum Concurrent Jobs } - where \lt{}number\gt{} is the maximum number of Jobs from the current Job -resource that can run concurrently. Note, this directive limits only Jobs -with the same name as the resource in which it appears. Any other -restrictions on the maximum concurrent jobs such as in the Director, Client, -or Storage resources will also apply in addition to the limit specified here. -The default is set to 1, but you may set it to a larger number. We strongly -recommend that you read the WARNING documented under -\ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's -resource. + where \lt{}number\gt{} is the maximum number of Jobs from the current + Job resource that can run concurrently. Note, this directive limits + only Jobs with the same name as the resource in which it appears. Any + other restrictions on the maximum concurrent jobs such as in the + Director, Client, or Storage resources will also apply in addition to + the limit specified here. The default is set to 1, but you may set it + to a larger number. We strongly recommend that you read the WARNING + documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the + Director's resource. \item [Reschedule On Error = \lt{}yes|no\gt{}] \index[dir]{Reschedule On Error } - If this directive is enabled, and the job terminates in error, the job will -be rescheduled as determined by the {\bf Reschedule Interval} and {\bf -Reschedule Times} directives. If you cancel the job, it will not be -rescheduled. The default is {\bf no} (i.e. the job will not be rescheduled). + If this directive is enabled, and the job terminates in error, the job + will be rescheduled as determined by the {\bf Reschedule Interval} and + {\bf Reschedule Times} directives. If you cancel the job, it will not + be rescheduled. The default is {\bf no} (i.e. the job will not be + rescheduled). -This specification can be useful for portables, laptops, or other machines -that are not always connected to the network or switched on. + 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{}] \index[dir]{Reschedule Interval } - If you have specified {\bf Reschedule On Error = yes} and the job terminates -in error, it will be rescheduled after the interval of time specified by -{\bf time-specification}. See -\ilink{ the time specification formats}{Time} in the Configure -chapter for details of time specifications. If no interval is specified, the -job will not be rescheduled on error. + If you have specified {\bf Reschedule On Error = yes} and the job + terminates in error, it will be rescheduled after the interval of time + specified by {\bf time-specification}. See \ilink{ the time + specification formats}{Time} in the Configure chapter for details of + time specifications. If no interval is specified, the job will not be + rescheduled on error. \item [Reschedule Times = \lt{}count\gt{}] \index[dir]{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. -\label{Priority} + 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. +\label{Priority} \item [Priority = \lt{}number\gt{}] \index[dir]{Priority } - This directive permits you to control the order in which your jobs run by -specifying a positive non-zero number. The higher the number, the lower the -job priority. Assuming you are not running concurrent jobs, all queued jobs -of priority 1 will run before queued jobs of priority 2 and so on, -regardless of the original scheduling order. + This directive permits you to control the order in which your jobs run + by specifying a positive non-zero number. The higher the number, the + lower the job priority. Assuming you are not running concurrent jobs, + all queued jobs of priority 1 will run before queued jobs of priority 2 + and so on, regardless of the original scheduling order. -The priority only affects waiting jobs that are queued to run, not jobs that -are already running. If one or more jobs of priority 2 are already running, -and a new job is scheduled with priority 1, the currently running priority 2 -jobs must complete before the priority 1 job is run. + The priority only affects waiting jobs that are queued to run, not jobs + that are already running. If one or more jobs of priority 2 are already + running, and a new job is scheduled with priority 1, the currently + running priority 2 jobs must complete before the priority 1 job is run. -The default priority is 10. + The default priority is 10. -If you want to run concurrent jobs, which is not recommended, you should keep -these points in mind: + If you want to run concurrent jobs, which is not recommended, you should keep + these points in mind: \begin{itemize} \item To run concurrent jobs, you must set Maximum Concurrent Jobs = 2 in 5 @@ -1056,14 +1079,15 @@ correct order, and that your priority scheme will be respected. If this directive is set to {\bf yes} (default {\bf no}), a new part file will be created after the job is finished. - It should be set to {\bf yes} when writing to devices that require mount (for - example DVD), so you are sure that the current part, containing this job's - data, is written to the device, and that no data is left in the temporary - file on the hard disk. However, on some media, like DVD+R and DVD-R, a lot of - space (about 10Mb) is lost everytime a part is written. So, if you run - several jobs each after another, you could set this directive to {\bf no} for - all jobs, except the last one, to avoid wasting too much space, but to ensure - that the data is written to the medium when all jobs are finished. + It should be set to {\bf yes} when writing to devices that require mount + (for example DVD), so you are sure that the current part, containing + this job's data, is written to the device, and that no data is left in + the temporary file on the hard disk. However, on some media, like DVD+R + and DVD-R, a lot of space (about 10Mb) is lost everytime a part is + written. So, if you run several jobs each after another, you could set + this directive to {\bf no} for all jobs, except the last one, to avoid + wasting too much space, but to ensure that the data is written to the + medium when all jobs are finished. It is ignored with tape and FIFO devices. \end{description} diff --git a/docs/manual/thanks.tex b/docs/manual/thanks.tex index 1bc942ab..d752b18d 100644 --- a/docs/manual/thanks.tex +++ b/docs/manual/thanks.tex @@ -59,8 +59,6 @@ These two are big pluses for Bacula! Thanks to Nic Bellamy for providing the bacula-dir.conf file that he uses to implement daily tape rotation using multiple Pools. -Thanks to Johan Decock for providing numerous corrections to the manual. - Thanks also to Jo Simoens for finding and correcting so many typos and other problems with the manual. -- 2.39.5