From: Kern Sibbald Date: Thu, 28 Jul 2005 16:01:26 +0000 (+0000) Subject: Updates X-Git-Tag: Release-1.38.0~238 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=f4b3662a3c8748107fb8c9e879d00ec090556c5e;p=bacula%2Fdocs Updates --- diff --git a/docs/home-page/news.txt b/docs/home-page/news.txt index 00eea323..1d54f208 100644 --- a/docs/home-page/news.txt +++ b/docs/home-page/news.txt @@ -41,12 +41,14 @@ You may contribute by going to the EFF site donation page at: https://secure.eff.org/site/SPageServer?pagename=DON_splash&JServSessionIdr006=h0do7dkvl1.app2a -and clicking on the "Gift Memberships >>" button. You will be -asked to provide "Tribute Information" and to select an eCard +and clicking on the "Gift Memberships >>" button. You will +be asked to provide "Tribute Information" and to select an eCard recipient. Please use "The Bacula Project" as the honored -individual name, and please choose to send an eCard, including -the amount, to Kern Sibbald . It is not -necessary to specify a snail-mail notification address. +individual name, and please choose to send an eCard to Kern +Sibbald <kern at sibbald dot com>. Please do not forget to +include the amount of your donation on the message that goes with +the eCard. It is not necessary to specify a snail-mail +notification address. By correctly sending an eCard, including the donation amount, we can track the total amount donated for this project. @@ -59,7 +61,7 @@ This is a community project, and this can be your way of helping make Bacula an even better product for the good of the whole community. If you have any questions related to this project, please contact -Kern Sibbald . +Kern Sibbald <kern at sibbald dot com>. Kern;;;2005/04/26;;;12:00 diff --git a/docs/manual/autochangerres.tex b/docs/manual/autochangerres.tex index 6dc4897d..6842542e 100644 --- a/docs/manual/autochangerres.tex +++ b/docs/manual/autochangerres.tex @@ -79,7 +79,9 @@ Device { Please note that it is important to include the {\bf Autochanger = yes} directive in each Device definition that belongs to an Autochanger. A device definition -should not belong to more than one Autochanger resource. +should not belong to more than one Autochanger resource. Also, your Device +directive in the Storage resource of the Director's conf file should have +the Autochanger's resource name rather than a name of one of the Devices. If you have a drive that physically belongs to an Autochanger but you don't want to have it automatically used when Bacula references the Autochanger for backups, diff --git a/docs/manual/configure.tex b/docs/manual/configure.tex index 72685f7b..fe185f0d 100644 --- a/docs/manual/configure.tex +++ b/docs/manual/configure.tex @@ -132,7 +132,7 @@ overwhelming, but in reality, it is all pretty logical and straightforward. \begin{description} \item [name] - \index[fd]{name } + \index[fd]{name} A keyword or name consisting of alphanumeric characters, including the hyphen, underscore, and dollar characters. The first character of a {\bf name} must be a letter. A name has a maximum length currently set to 127 @@ -184,10 +184,9 @@ exceed 4 billion and thus require a 64 bit value. \index[dir]{yes or no } Either a {\bf yes} or a {\bf no}. -\item [ - \label{Size1} - size] -\index[dir]{a name } +\label{Size1} +\item [size] +\index[dir]{size } A size specified as bytes. Typically, this is a floating point scientific input format followed by an optional modifier. The floating point input is stored as a 64 bit integer value. If a modifier is present, it must @@ -195,7 +194,6 @@ immediately follow the value with no intervening spaces. The following modifiers are permitted: \begin{description} - \item [k] 1,024 (kilobytes) @@ -213,12 +211,11 @@ modifiers are permitted: \item [gb] 1,000,000,000 (gigabytes) - \end{description} +\end{description} -\item {\bf - \label{Time} - time} -\index[dir]{a name } +\label{Time} +\item [time] +\index[dir]{time} A time or duration specified in seconds. The time is stored internally as a 64 bit integer value, but it is specified in two parts: a number part and a modifier part. The number can be an integer or a floating point number. If it @@ -276,14 +273,11 @@ For example: \end{verbatim} \normalsize -are valid date specifications (beginning with version 1.35.1). +are valid date specifications. -Note! in Bacula version 1.31 and below, the modifier was optional. It is now -mandatory. \end{description} \label{ResTypes} - \subsection*{Resource Types} \index[general]{Types!Resource } \index[general]{Resource Types } diff --git a/docs/manual/dirdconf.tex b/docs/manual/dirdconf.tex index 4abcb4d3..b8ffdbb9 100644 --- a/docs/manual/dirdconf.tex +++ b/docs/manual/dirdconf.tex @@ -35,7 +35,8 @@ machine, Bacula will generate a random password during the configuration process, otherwise it will be left blank. \item \ilink{Job}{JobResource} -- to define the backup/restore Jobs - and to tie together the Client, FileSet and Schedule resources to be used for + and to tie together the Client, FileSet and Schedule resources to be used +for each Job. \item \ilink{JobDefs}{JobDefsResource} -- optional resource for @@ -133,7 +134,8 @@ Directory} as defined above. This directive is required. \item [Scripts Directory = \lt{}Directory\gt{}] \index[dir]{Scripts Directory } - This directive is optional and, if defined, specifies a directory in which the Director + This directive is optional and, if defined, specifies a directory in which +the Director will look for the Python startup script {\bf DirStartup.py}. This directory may be shared by other Bacula daemons. Standard shell expansion of the directory is done when the configuration file is read so that values such @@ -176,20 +178,23 @@ of this manual. \item [FD Connect Timeout = \lt{}time\gt{}] \index[dir]{FD Connect Timeout } - where {\bf time} is the time that the Director should continue attempting to + 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{}] \index[dir]{SD Connect Timeout } - where {\bf time} is the time that the Director should continue attempting to + 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{}] \index[dir]{DirAddresses } Specify the ports and addresses on which the Director daemon will listen for -Bacula Console connections. Probably the simplest way to explain this is to show +Bacula Console connections. Probably the simplest way to explain this is to +show an example: \footnotesize @@ -269,11 +274,12 @@ Director { \addcontentsline{toc}{subsection}{Job Resource} The Job resource defines a Job (Backup, Restore, ...) that Bacula must -perform. Each Job resource definition contains the names of the Clients and -their FileSets to backup or restore, the Schedule for the Job, where the data +perform. Each Job resource definition contains the name of a Client and +a FileSet to backup, the Schedule for the Job, where the data are to be stored, and what media Pool can be used. In effect, each Job resource must specify What, Where, How, and When or FileSet, Storage, -Backup/Restore/Level, and Schedule respectively. +Backup/Restore/Level, and Schedule respectively. Note, the FileSet must +be specified for a restore job for historical reasons, but it is no longer used. Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any job. If you want to backup multiple FileSets on the same Client or multiple @@ -290,7 +296,8 @@ Clients, you must define a Job for each one. The Job name. This name can be specified on the {\bf Run} command in the console program to start a job. If the name contains spaces, it must be specified between quotes. It is generally a good idea to give your job the - same name as the Client that it will backup. This permits easy identification + same name as the Client that it will backup. This permits easy +identification of jobs. When the job actually runs, the unique Job Name will consist of the name you @@ -315,7 +322,8 @@ in the catalog. \item [Restore] \index[dir]{Restore } - Run a restore Job. Normally, you will specify only one Restore job which acts + Run a restore Job. Normally, you will specify only one Restore job which +acts as a sort of prototype that you will modify using the console program in order to perform restores. Although certain basic information from a Restore job is saved in the catalog, it is very minimal compared to the information @@ -340,7 +348,8 @@ Although an Admin job is recorded in the catalog, very little data is saved. \item [Level = \lt{}job-level\gt{}] \index[dir]{Level } - The Level directive specifies the default Job level to be run. Each different + The Level directive specifies the default Job level to be run. Each +different Job Type (Backup, Restore, ...) has a different set of Levels that can be specified. The Level is normally overridden by a different value that is specified in the {\bf Schedule} resource. This directive is not required, but @@ -390,7 +399,8 @@ reset the access time (st\_atime), which Bacula does not use, it will cause st\_ctime to change and hence Bacula will backup the file during an Incremental or Differential backup. In the case of Sophos virus scanning, you can prevent it from resetting the access time (st\_atime) and hence changing -st\_ctime by using the {\bf \verb:--:no-reset-atime} option. For other software, +st\_ctime by using the {\bf \verb:--:no-reset-atime} option. For other +software, please see their manual. When Bacula does an Incremental backup, all modified files that are still on @@ -403,10 +413,14 @@ files from the catalog during an Incremental backup is quite a time consuming process and not currently implemented in Bacula. In addition, if you move a directory rather than copy it, the files in it do not -have their modification time (st\_mtime) or their attribute change time (st\_ctime) -changed. As a conseqence, those files will probably not be backed up by an Incremental -or Differential backup which depend solely on these time stamps. If you move a directory, -and which it to be properly backed up, it is generally preferable to copy it then +have their modification time (st\_mtime) or their attribute change time +(st\_ctime) +changed. As a conseqence, those files will probably not be backed up by an +Incremental +or Differential backup which depend solely on these time stamps. If you move a +directory, +and which it to be properly backed up, it is generally preferable to copy it +then delete the original. \item [Differential] @@ -454,11 +468,16 @@ in the catalog after doing another Full save. However, to remove deleted files from the catalog during a Differential backup is quite a time consuming process and not currently implemented in Bacula. -As noted above, if you move a directory rather than copy it, the files in it do not -have their modification time (st\_mtime) or their attribute change time (st\_ctime) -changed. As a conseqence, those files will probably not be backed up by an Incremental -or Differential backup which depend solely on these time stamps. If you move a directory, -and which it to be properly backed up, it is generally preferable to copy it then +As noted above, if you move a directory rather than copy it, the files in it do +not +have their modification time (st\_mtime) or their attribute change time +(st\_ctime) +changed. As a conseqence, those files will probably not be backed up by an +Incremental +or Differential backup which depend solely on these time stamps. If you move a +directory, +and which it to be properly backed up, it is generally preferable to copy it +then delete the original. \end{description} @@ -519,7 +538,8 @@ Verify VolumeToCatalog modifies the Catalog database while running. \item [DiskToCatalog] \index[dir]{DiskToCatalog } - This level causes Bacula to read the files as they currently are on disk, and + This level causes Bacula to read the files as they currently are on disk, +and to compare the current file attributes with the attributes saved in the catalog from the last backup for the job specified on the {\bf VerifyJob} directive. This level differs from the {\bf Catalog} level described above by @@ -610,7 +630,8 @@ For more details on using this file, please see the chapter entitled \item [FileSet = \lt{}FileSet-resource-name\gt{}] \index[dir]{FileSet } - The FileSet directive specifies the FileSet that will be used in the current + The FileSet directive specifies the FileSet that will be used in the +current Job. The FileSet specifies which directories (or files) are to be backed up, and what options to use (e.g. compression, ...). Only a single FileSet resource may be specified in any one Job. For additional details, see the @@ -619,7 +640,8 @@ For more details on using this file, please see the chapter entitled \item [Messages = \lt{}messages-resource-name\gt{}] \index[dir]{Messages } - The Messages directive defines what Messages resource should be used for this + The Messages directive defines what Messages resource should be used for +this job, and thus how and where the various messages are to be delivered. For example, you can direct some messages to a log file, and others can be sent by email. For additional details, see the @@ -650,19 +672,23 @@ For more details on using this file, please see the chapter entitled \item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}] \index[dir]{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. + 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 resource is optional. \item [Schedule = \lt{}schedule-name\gt{}] \index[dir]{Schedule } The Schedule directive defines what schedule is to be used for the Job. The schedule determines when the Job will be automatically started and what Job - level (i.e. Full, Incremental, ...) is to be run. This directive is optional, + level (i.e. Full, Incremental, ...) is to be run. This directive is +optional, and if left out, the Job can only be started manually. For additional details, see the \ilink{Schedule Resource Chapter}{ScheduleResource} of this - manual. If a Schedule resource is specified, the job will be run according to + manual. If a Schedule resource is specified, the job will be run according +to the schedule specified. If no Schedule resource is specified for the Job, the job must be manually started using the Console program. Although you may specify only a single Schedule resource for any one job, the Schedule @@ -673,7 +699,8 @@ For more details on using this file, please see the chapter entitled \item [Storage = \lt{}storage-resource-name\gt{}] \index[dir]{Storage } - The Storage directive defines the name of the storage services where you want + The Storage directive defines the name of the storage services where you +want to backup the FileSet data. For additional details, see the \ilink{Storage Resource Chapter}{StorageResource2} of this manual. This directive is required. @@ -813,19 +840,25 @@ The Job Exit Status code \%e edits the following values: Bacula checks the exit status of the RunBeforeJob program. If it is non-zero, the job will be error terminated. Lutz Kittler - has pointed out that this can be a simple way to modify your schedules during - a holiday. For example, suppose that you normally do Full backups on Fridays, - but Thursday and Friday are holidays. To avoid having to change tapes between + has pointed out that this can be a simple way to modify your schedules +during + a holiday. For example, suppose that you normally do Full backups on +Fridays, + but Thursday and Friday are holidays. To avoid having to change tapes +between Thursday and Friday when no one is in the office, you can create a - RunBeforeJob that returns a non-zero status on Thursday and zero on all other + RunBeforeJob that returns a non-zero status on Thursday and zero on all +other days. That way, the 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{}] \index[dir]{Run After Job } The specified {\bf command} is run as an external program after the current - job terminates. This directive is not required. The command string must be a - valid program name or name of a shell script. If the exit code of the program + job terminates. This directive is not required. The command string must be +a + valid program name or name of a shell script. If the exit code of the +program run is non-zero, the current Bacula job will terminate in error. Before submitting the specified command to the operating system, Bacula performs character substitution as described above for the {\bf Run Before Job} @@ -875,7 +908,8 @@ ClientRunBeforeJob = "\"C:/Program Files/Software The special characters \&()[]\{\}\^{}=;!'+,`\~{} will need to be quoted if they are part of a filename or argument. - If someone is logged in, a blank ``command'' window running the commands will + If someone is logged in, a blank ``command'' window running the commands +will be present during the execution of the command. Some Suggestions from Phil Stracchino for running on Win32 machines with the @@ -883,7 +917,8 @@ ClientRunBeforeJob = "\"C:/Program Files/Software \begin{enumerate} \item You might want the ClientRunBeforeJob directive to specify a .bat file - which runs the actual client-side commands, rather than trying to run (for + which runs the actual client-side commands, rather than trying to run +(for example) regedit /e directly. \item The batch file should explicitly 'exit 0' on successful completion. \item The path to the batch file should be specified in Unix form: @@ -893,13 +928,15 @@ ClientRunBeforeJob = "\"C:/Program Files/Software rather than DOS/Windows form: ClientRunBeforeJob = - ``c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat'' + +``c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat'' INCORRECT \end{enumerate} The following example of the use of the Client Run Before Job directive was submitted by a user:\\ -You could write a shell script to back up a DB2 database to a FIFO. The shell script is: +You could write a shell script to back up a DB2 database to a FIFO. The shell +script is: \footnotesize \begin{verbatim} @@ -916,19 +953,24 @@ You could write a shell script to back up a DB2 database to a FIFO. The shell sc The following line in the Job resoure in the bacula-dir.conf file: \footnotesize \begin{verbatim} - Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t' '%l'\"" + Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t' +'%l'\"" \end{verbatim} \normalsize - When the job is run, you will get messages from the output of the script stating + When the job is run, you will get messages from the output of the script +stating that the backup has started. Even though the command being run is - backgrounded with \&, the job will block until the "db2 BACKUP DATABASE" command, + backgrounded with \&, the job will block until the "db2 BACKUP DATABASE" +command, thus the backup stalls. - To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to the following: + To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to +the following: \footnotesize \begin{verbatim} - db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log 2>&1 < /dev/null & + db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log +2>&1 < /dev/null & \end{verbatim} \normalsize @@ -938,17 +980,20 @@ It is important to redirect the input and outputs of a backgrounded command to \item [Client Run After Job = \lt{}command\gt{}] \index[dir]{Client Run After Job } - This command is the same as {\bf Run After Job} except that it is run on the + This command is the same as {\bf Run After Job} except that it is run on +the client machine. Note, please see the notes above in {\bf Client Run Before Job} concerning Windows clients. \item [Rerun Failed Levels = \lt{}yes|no\gt{}] \index[dir]{Rerun Failed Levels } - If this directive is set to {\bf yes} (default no), and Bacula detects that a + If this directive is set to {\bf yes} (default no), and Bacula detects that +a previous job at a higher level (i.e. Full or Differential) has failed, the current job level will be upgraded to the higher level. This is particularly useful for Laptops where they may often be unreachable, and if a prior Full - save has failed, you wish the very next backup to be a Full save rather than + save has failed, you wish the very next backup to be a Full save rather +than whatever level it is started as. \item [Spool Data = \lt{}yes|no\gt{}] @@ -964,7 +1009,8 @@ disk file. \item [Spool Attributes = \lt{}yes|no\gt{}] \index[dir]{Spool Attributes } - The default is set to {\bf no}, which means that the File attributes are sent + The default is set to {\bf no}, which means that the File attributes are +sent by the Storage daemon to the Director as they are stored on tape. However, if you want to avoid the possibility that database updates will slow down writing to the tape, you may want to set the value to {\bf yes}, in which @@ -993,7 +1039,8 @@ Bacula wants to restore a file or directory that already exists. You have the \item [always] \index[dir]{always } - when the file to be restored already exists, it is deleted and then replaced by + when the file to be restored already exists, it is deleted and then replaced +by the copy that was backed up. \item [ifnewer] @@ -1049,7 +1096,7 @@ Bacula wants to restore a file or directory that already exists. You have the \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 + 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. @@ -1108,7 +1155,8 @@ Bacula wants to restore a file or directory that already exists. You have the The default priority is 10. - If you want to run concurrent jobs, which is not recommended, you should keep + If you want to run concurrent jobs, which is not recommended, you should +keep these points in mind: \begin{itemize} @@ -1127,7 +1175,8 @@ Bacula wants to restore a file or directory that already exists. You have the is scheduled and queued waiting for the running priority 2 job to terminate. If you then start a second priority 2 job, the waiting priority 1 job will prevent the new priority 2 job from running concurrently with the running - priority 2 job. That is: as long as there is a higher priority job waiting to + priority 2 job. That is: as long as there is a higher priority job waiting +to run, no new lower priority jobs will start even if the Maximum Concurrent Jobs settings would normally allow them to run. This ensures that higher priority jobs will be run as soon as possible. @@ -1206,7 +1255,8 @@ be run manually. In general, you specify an action to be taken and when. \item [Schedule] \index[dir]{Schedule } - Start of the Schedule directives. No {\bf Schedule} resource is required, but + Start of the Schedule directives. No {\bf Schedule} resource is required, +but you will need at least one if you want Jobs to be automatically started. \item [Name = \lt{}name\gt{}] @@ -1264,7 +1314,8 @@ spaces or by separating them with a trailing comma. For example: \item [FullPool=Full] \index[dir]{FullPool } - specifies to use the Pool named {\bf Full} if the job is a full backup, or is + specifies to use the Pool named {\bf Full} if the job is a full backup, or +is upgraded from another type to a full backup. \item [DifferentialPool=Differential] @@ -1483,13 +1534,15 @@ console run command. This directive is required. \item [Address = \lt{}address\gt{}] \index[dir]{Address } - Where the address is a host name, a fully qualified domain name, or a network + Where the address is a host name, a fully qualified domain name, or a +network address in dotted quad notation for a Bacula File server daemon. This directive is required. \item [FD Port = \lt{}port-number\gt{}] \index[dir]{FD Port } - Where the port is a port number at which the Bacula File server daemon can be + 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{}] @@ -1509,7 +1562,8 @@ otherwise it will be left blank. \item [File Retention = \lt{}time-period-specification\gt{}] \index[dir]{File Retention } - The File Retention directive defines the length of time that Bacula will keep + The File Retention directive defines the length of time that Bacula will +keep File records in the Catalog database. When this time period expires, and if {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records that are older than the specified File Retention period. Note, this affects @@ -1645,8 +1699,11 @@ otherwise it will be left blank. This directive specifies the name of the device to be used for the storage. This name is not the physical device name, but the logical device name as defined on the {\bf Name} directive contained in the {\bf Device} -resource definition of the {\bf Storage daemon} configuration file. You can -specify any name you would like (even the device name if you prefer) up to a +resource definition of the {\bf Storage daemon} configuration file or if +the device is an Autochanger, you must put the name as defined on the {\bf Name} +directive contained in the {\bf Autochanger resource definition of the {\bf +Storage daemon}. You can specify any name you would like (even the device name +if you prefer) up to a maximum of 127 characters in length. The physical device name associated with this device is specified in the {\bf Storage daemon} configuration file (as {\bf Archive Device}). Please take care not to define two different Storage @@ -1657,7 +1714,8 @@ required. \item [Media Type = \lt{}MediaType\gt{}] \index[dir]{Media Type } - This directive specifies the Media Type to be used to store the data. This is + This directive specifies the Media Type to be used to store the data. This +is an arbitrary string of characters up to 127 maximum that you define. It can be anything you want. However, it is best to make it descriptive of the storage media (e.g. File, DAT, ''HP DLT8000``, 8mm, ...). In addition, it is @@ -1691,7 +1749,8 @@ you don't try to write data for a DLT onto an 8mm device. \label{Autochanger1} \item [Autochanger = \lt{}yes|no\gt{}] \index[dir]{Autochanger } - If you specify {\bf yes} for this command (the default is {\bf no}), when you + If you specify {\bf yes} for this command (the default is {\bf no}), when +you use the {\bf label} command or the {\bf add} command to create a new Volume, {\bf Bacula} will also request the Autochanger Slot number. This simplifies creating database entries for Volumes in an autochanger. If you forget to @@ -1715,7 +1774,8 @@ chapter for the details of using autochangers. \item [Maximum Concurrent Jobs = \lt{}number\gt{}] \index[dir]{Maximum Concurrent Jobs } - where \lt{}number\gt{} is the maximum number of Jobs with the current Storage + where \lt{}number\gt{} is the maximum number of Jobs with the current +Storage resource that can run concurrently. Note, this directive limits only Jobs for Jobs using this Storage daemon. Any other restrictions on the maximum concurrent jobs such as in the Director, Job, or Client resources will also @@ -1828,7 +1888,8 @@ The Pool Resource defined in the Director's configuration file \item [Pool] \index[dir]{Pool } - Start of the Pool resource. There must be at least one Pool resource defined. + Start of the Pool resource. There must be at least one Pool resource +defined. \item [Name = \lt{}name\gt{}] @@ -1934,7 +1995,8 @@ must use the {\bf update} command in the Console. \item [Volume Use Duration = \lt{}time-period-specification\gt{}] \index[dir]{Volume Use Duration } - The Volume Use Duration directive defines the time period that the Volume can + The Volume Use Duration directive defines the time period that the Volume +can be written beginning from the time of first data write to the Volume. If the time-period specified is zero (the default), the Volume can be written indefinitely. Otherwise, when the time period from the first write to the @@ -1944,15 +2006,19 @@ must use the {\bf update} command in the Console. You might use this directive, for example, if you have a Volume used for Incremental backups, and Volumes used for Weekly Full backups. Once the Full - backup is done, you will want to use a different Incremental Volume. This can - be accomplished by setting the Volume Use Duration for the Incremental Volume - to six days. I.e. it will be used for the 6 days following a Full save, then + backup is done, you will want to use a different Incremental Volume. This +can + be accomplished by setting the Volume Use Duration for the Incremental +Volume + to six days. I.e. it will be used for the 6 days following a Full save, +then a different Incremental volume will be used. Be careful about setting the duration to short periods such as 23 hours, or you might experience problems of Bacula waiting for a tape over the weekend only to complete the backups Monday morning when an operator mounts a new tape. - The use duration is checked and the {\bf Used} status is set only at the end of a + The use duration is checked and the {\bf Used} status is set only at the end +of a job that writes to the particular volume, which means that even though the use duration may have expired, the catalog entry will not be updated until the next job that uses this volume is run. @@ -1969,7 +2035,8 @@ must use the {\bf update} command in the Console. This directive defines whether or not you want the names of the files that were saved to be put into the catalog. The default is {\bf yes}. The advantage of specifying {\bf Catalog Files = No} is that you will have a - significantly smaller Catalog database. The disadvantage is that you will not + significantly smaller Catalog database. The disadvantage is that you will +not be able to produce a Catalog listing of the files backed up 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 @@ -1994,22 +2061,27 @@ must use the {\bf update} command in the Console. Volume Retention period. All File records associated with pruned Jobs are also pruned. The time may be specified as seconds, minutes, hours, days, weeks, months, quarters, or years. The {\bf Volume Retention} applied - independently to the {\bf Job Retention} and the {\bf File Retention} periods + independently to the {\bf Job Retention} and the {\bf File Retention} +periods defined in the Client resource. This means that the shorter period is the one that applies. Note, that when the {\bf Volume Retention} period has been reached, it will prune both the Job and the File records. - The default is 365 days. Note, this directive sets the default value for each + The default is 365 days. Note, this directive sets the default value for +each Volume entry in the Catalog when the Volume is created. The value in the catalog may be later individually changed for each Volume using the Console program. By defining multiple Pools with different Volume Retention periods, you may effectively have a set of tapes that is recycled weekly, another Pool of - tapes that is recycled monthly and so on. However, one must keep in mind that + tapes that is recycled monthly and so on. However, one must keep in mind +that if your {\bf Volume Retention} period is too short, it may prune the last - valid Full backup, and hence until the next Full backup is done, you will not - have a complete backup of your system, and in addition, the next Incremental + valid Full backup, and hence until the next Full backup is done, you will +not + have a complete backup of your system, and in addition, the next +Incremental or Differential backup will be promoted to a Full backup. As a consequence, the minimum {\bf Volume Retention} period should be at twice the interval of your Full backups. This means that if you do a Full backup once a month, the @@ -2106,7 +2178,8 @@ some day, Bacula will recycle a Volume that contains current data. \item [Accept Any Volume = \lt{}yes|no\gt{}] \index[dir]{Accept Any Volume } - This directive specifies whether or not any volume from the Pool may be used + This directive specifies whether or not any volume from the Pool may be +used for backup. The default is {\bf yes} as of version 1.27 and later. If it is {\bf no} then only the first writable volume in the Pool will be accepted for writing backup data, thus Bacula will fill each Volume sequentially in turn @@ -2127,7 +2200,8 @@ and Bacula will continue writing on it until it is full. Then you can remount \item [Cleaning Prefix = \lt{}string\gt{}] \index[dir]{Cleaning Prefix } - This directive defines a prefix string, which if it matches the beginning of + This directive defines a prefix string, which if it matches the beginning +of a Volume name during labeling of a Volume, the Volume will be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will never attempt to use this tape. This is primarily for use with autochangers that accept barcodes @@ -2137,7 +2211,8 @@ cleaning tapes. \item [Label Format = \lt{}format\gt{}] \index[dir]{Label Format } - This directive specifies the format of the labels contained in this pool. The + This directive specifies the format of the labels contained in this pool. +The format directive is used as a sort of template to create new Volume names during automatic Volume labeling. @@ -2224,7 +2299,8 @@ use one database and verify or restore jobs to use another database. \item [Catalog] \index[dir]{Catalog } - Start of the Catalog resource. At least one Catalog resource must be defined. + Start of the Catalog resource. At least one Catalog resource must be +defined. \item [Name = \lt{}name\gt{}] @@ -2249,7 +2325,8 @@ this name. This directive is required. \item [user = \lt{}user\gt{}] \index[dir]{user } - This specifies what user name to use to log into the database. This directive + This specifies what user name to use to log into the database. This +directive is required. \item [DB Socket = \lt{}socket-name\gt{}] @@ -2275,7 +2352,8 @@ by MySQL and is ignored by SQLite if provided. This directive is optional. %% \item [Multiple Connections = \lt{}yes|no\gt{}] %% \index[dir]{Multiple Connections } -%% By default, this directive is set to no. In that case, each job that uses the +%% By default, this directive is set to no. In that case, each job that uses +the %% same Catalog will use a single connection to the catalog. It will be shared, %% and Bacula will allow only one Job at a time to communicate. If you set this %% directive to yes, Bacula will permit multiple connections to the database, @@ -2283,7 +2361,8 @@ by MySQL and is ignored by SQLite if provided. This directive is optional. %% this is no problem. For MySQL, you must be *very* careful to have the %% multi-thread version of the client library loaded on your system. When this %% directive is set yes, each Job will have a separate connection to the -%% database, and the database will control the interaction between the different +%% database, and the database will control the interaction between the +different %% Jobs. This can significantly speed up the database operations if you are %% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL, %% Bacula will automatically enable transactions. This can significantly speed @@ -2391,7 +2470,8 @@ definitions). \item [Password = \lt{}password\gt{}] \index[dir]{Password } - Specifies the password that must be supplied for a named Bacula Console to be + Specifies the password that must be supplied for a named Bacula Console to +be authorized. The same password must appear in the {\bf Console} resource of the Console configuration file. For added security, the password is never actually passed across the network but rather a challenge response hash code @@ -2420,7 +2500,8 @@ for the four jobs named on the JobACL directives, but for no others. \item [ClientACL = \lt{}name-list\gt{}] \index[dir]{ClientACL } - This directive is used to specify a list of Client resource names that can be + 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{}] @@ -2499,7 +2580,8 @@ to the Minimum. \item [*WrapCounter = \lt{}counter-name\gt{}] \index[dir]{*WrapCounter } - If this value is specified, when the counter is incremented past the maximum + If this value is specified, when the counter is incremented past the +maximum and thus reset to the minimum, the counter specified on the {\bf WrapCounter} is incremented. (This is not currently implemented). diff --git a/docs/manual/fileset.tex b/docs/manual/fileset.tex index 05be2827..bf5d0839 100644 --- a/docs/manual/fileset.tex +++ b/docs/manual/fileset.tex @@ -714,7 +714,8 @@ Include { The following is an example of a valid FileSet resource definition. Note, the first Include pulls in the contents of the file {\bf /etc/backup.list} when -Bacula is started (i.e. the @). +Bacula is started (i.e. the @), and that file must have each filename to be +backed up preceded by a {\bf File =} and on a separate line. \footnotesize \begin{verbatim} @@ -726,7 +727,7 @@ FileSet { signature=SHA1 Sparse = yes } - File = @/etc/backup.list + @/etc/backup.list } Include { Options { @@ -763,7 +764,7 @@ FileSet { signature=SHA1 Sparse = yes } - File = @/etc/backup.list + @/etc/backup.list } Include { Options { diff --git a/docs/manual/supporteddrives.tex b/docs/manual/supporteddrives.tex index 56dc41c9..cf170e5d 100644 --- a/docs/manual/supporteddrives.tex +++ b/docs/manual/supporteddrives.tex @@ -35,6 +35,7 @@ unknown: \multicolumn{1}{c| }{\bf Capacity } \\ \hline {- } & {ADIC } & {DLT } & {Adic Scalar 100 DLT } & {100GB } \\ \hline {- } & {ADIC } & {DLT } & {Adic Fastor 22 DLT } & {- } \\ + \hline {FreeBSD 5.4-RELEASE-p1 amd64 } & {Certance} & {LTO } & {AdicCertance CL400 LTO Ultrium 2 } & {200GB } \\ \hline {- } & {- } & {DDS } & {Compaq DDS 2,3,4 } & {- } \\ \hline {- } & {Exabyte } & {- } & {Exabyte drives less than 10 years old } & {- } \\ \hline {- } & {Exabyte } & {- } & {Exabyte VXA drives } & {- } \\ @@ -46,6 +47,7 @@ unknown: \hline {- } & {Overland } & {LTO } & {LoaderXpress LTO } & {- } \\ \hline {- } & {Overland } & {- } & {Neo2000 } & {- } \\ \hline {- } & {OnStream } & {- } & {OnStream drives (see below) } & {- } \\ + \hline {FreeBSD 4.11-Release} & {Quantum } & {SDLT } & {SDLT320 } & {160/320GB } \\ \hline {- } & {Quantum } & {DLT } & {DLT-8000 } & {40/80GB } \\ \hline {Linux } & {Seagate } & {DDS-4 } & {Scorpio 40 } & {20/40GB } \\ \hline {FreeBSD 4.9 STABLE } & {Seagate } & {DDS-4 } & {STA2401LW } & {20/40GB } \\