From: Kern Sibbald Date: Sun, 26 Jun 2005 18:22:00 +0000 (+0000) Subject: Update docs X-Git-Tag: Release-1.38.0~338 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=e44ff76bd12364f1bd0d229d1886960f22320c02;p=bacula%2Fdocs Update docs --- diff --git a/docs/manual/console.tex b/docs/manual/console.tex index 78fef582..802d1e1a 100644 --- a/docs/manual/console.tex +++ b/docs/manual/console.tex @@ -589,6 +589,25 @@ mounted. If you want to be able to use the drive with another program (e.g. {\bf mt}), you must use the {\bf unmount} command to cause Bacula to completely release (close) the device. +\item [reload] + \index[console]{reload} + The reload command causes the Director to re-read its configuration + file and apply the new values. The new values will take effect + immediately for all new jobs. However, if you change schedules, + be aware that the scheduler pre-schedules jobs up to two hours in + advance, so any changes that are to take place during the next two + hours may be delayed. Jobs that have already been sheduled to run + (i.e. depassed their requested start time) will continue with the + old values. New jobs will use the new values. Each time you issue + a reload command while jobs are running, the prior config values + will queued until all jobs that were running before issuing + the reload terminate, at which time the old config values will + be released from memory. The Directory premits keeping up to + 10 prior set of configurations before it will refuse a reload + command. Once at least one old set of config values has been + released it will again accept new reload commands. + + \item [restore] \index[console]{restore } The restore command allows you to select one or more Jobs (JobIds) to be diff --git a/docs/manual/dvd.tex b/docs/manual/dvd.tex new file mode 100644 index 00000000..2ff3391c --- /dev/null +++ b/docs/manual/dvd.tex @@ -0,0 +1,199 @@ +%% +%% + +\section*{DVD Volumes} +\label{_DVDChapterStart} +\index[general]{DVD Volumes} +\index[general]{Writing DVDs} +\index[general]{DVD Writing} +\index[general]{Volumes!DVD} +\addcontentsline{toc}{section}{DVD Volumes} + +Bacula allows you to specify that you want to write to DVD. However, +this feature is implemented only in version 1.37 or later. +You may in fact write to DVD+RW, DVD+R, DVD-R, or DVD-RW +media. The actual process used by Bacula is to first write +the image to a spool directory, then when the Volume reaches +a certain size or, at your option, at the end of a Job, Bacula +will transfer the image from the spool directory to the +DVD. The actual work of transferring the image is done +by a script {\bf dvd-writepart}, and the heart of that +script is a program called {\bf growisofs} which allows +creating or adding to a DVD ISO filesystem. growisofs is +normally found in the {\bf dvd+rw-tools} package or rpm. +You must have it loaded on your system for DVD writing to +work. + +The fact that Bacula cannot use the OS to write directly +to the DVD makes the whole process a bit more error prone than +writing to say a disk, but nevertheless, it does work if you +use some care to set it up properly. + +The remainder of this chapter explains the various directives that you can +use to control the DVD writing. + +\label{DVDdirectives} + +\subsection*{DVD Specific SD Directives} +\index[general]{Directives!DVD} +\index[general]{DVD Specific SD Directives } +\addcontentsline{toc}{subsection}{DVD Specific SD Directives} + +The following directives are added to the Storage daemon's +Device resource. + +\begin{description} + +\item [Requires Mount = {\it Yes|No}] + \index[sd]{Requires Mount } + You must set this directive to {\bf yes} for DVD-writers, and to {\bf no} for + all other devices (tapes/files). This directive indicates if the device + requires to be mounted to be read, and if it must be written in a special way. + If it set, {\bf Mount Point}, {\bf Mount Command}, {\bf Unmount Command} and + {\bf Write Part Command} directives must also be defined. + +\item [Mount Point = {\it directory}] + \index[sd]{Mount Point } + Directory where the device can be mounted. + +\item [Mount Command = {\it name-string}] + \index[sd]{Mount Command } + Command that must be executed to mount the device. Although the + device is written directly, the mount command is necessary in + order to determine the free space left on the DVD. Before the command is + executed, \%a is replaced with the Archive Device, and \%m with the Mount + Point. + + Most frequently, you will define it as follows: + +\footnotesize +\begin{verbatim} + Mount Command = "/bin/mount -t iso9660 -o ro %a %m" +\end{verbatim} +\normalsize + +\item [Unmount Command = {\it name-string}] + \index[sd]{Unmount Command } + Command that must be executed to unmount the device. Before the command is + executed, \%a is replaced with the Archive Device, and \%m with the Mount + Point. + + Most frequently, you will define it as follows: + +\footnotesize +\begin{verbatim} + Unmount Command = "/bin/umount %m" +\end{verbatim} +\normalsize + +\item [Write Part Command = {\it name-string}] + \index[sd]{Write Part Command } + Command that must be executed to write a part to the device. Before the + command is executed, \%a is replaced with the Archive Device, \%m with the + Mount Point, \%n with the current part number (0-based), and \%v with the + current part filename. + + For a DVD, you will most frequently specify the Bacula supplied {\bf + dvd-writepart} script as follows: + +\footnotesize +\begin{verbatim} + Write Part Command = "/path/dvd-writepart %n %a %v" +\end{verbatim} +\normalsize + + Where {\bf /path} is the path to your scripts install directory, and + dvd-writepart is the Bacula supplied script file. + This command will already be present, but commented out, + in the default bacula-sd.conf file. To use it, simply remove + the comment (#) symbol. + + +\item [Free Space Command = {\it name-string}] + \index[sd]{Free Space Command } + Command that must be executed to check how much free space is left on the + device. Before the command is executed, \%a is replaced with the Archive + Device, \%m with the Mount Point, \%n with the current part number (0-based), + and \%v with the current part filename. + + For a DVD, you will most frequently specify the Bacula supplied {\bf + dvd-freespace} script as follows: + +\footnotesize +\begin{verbatim} + Free Space Command = "/path/dvd-freespace %n %a" +\end{verbatim} +\normalsize + + Where {\bf /path} is the path to your scripts install directory, and + dvd-freespace is the Bacula supplied script file. + If you want to specify your own command, please look at the code in + dvd-freespace to see what output Bacula expects from this command. + This command will already be present, but commented out, + in the default bacula-sd.conf file. To use it, simply remove + the comment (#) symbol. + + If you do not set it, Bacula will expect there is always free space on the + device. + +\end{description} + +In addition to the directives specified above, you must also +specify the other standard Device resource directives. Please see the +sample DVD Device resource in the default bacula-sd.conf file. Be sure +to specify the raw device name for {\bf Archive Device}. It should +be a name such as {\bf /dev/cdrom} or {\bf /media/cdrecorder} or +{\bf /dev/dvd} depending on your system. It will not be a name such +as {\bf /mnt/cdrom}. + + +\subsection*{DVD Specific Director Directives} +\index[general]{Directives!DVD} +\index[general]{DVD Specific Director Directives } +\addcontentsline{toc}{subsection}{DVD Specific Director Directives} + +The following directives are added to the Director's Job resource. + +\label{WritePartAfterJob} +\item [Write Part After Job = \lt{}yes|no\gt{}] + \index[dir]{Write Part After Job } + If this directive is set to {\bf yes} (default {\bf no}), the + Volume written to a temporary spool file for the current Job will + be written to the DVD as 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 a 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} + + + +\label{DVDpoints} +\subsection*{Other Points} +\index[general]{Points!Other } +\index[general]{Other Points } +\addcontentsline{toc}{subsection}{Other Points} + +\begin{itemize} +\item DVD+RW supports only about 1000 overwrites, so every time you + mount the filesystem read/write will count as one write. This can + add up quickly, so it is best to mount your DVD+RW filesystem read-only. +\item Reformating DVD+RW 10-20 time can apparently make the medium + unusable. Normally you should not have to format or reformat + DVD+RW media. If it is necessary, current versions of growisofs will + do so automatically. +\item If you wish to blank your DVD, use the following: +\begin{verbatim} + growisofs -Z /dev/xxx=/dev/zero +\end{verbatim} + where you replace xxx with your DVD device name. +\end{itemize} diff --git a/docs/manual/messagesres.tex b/docs/manual/messagesres.tex index 09eaeeeb..e09f236d 100644 --- a/docs/manual/messagesres.tex +++ b/docs/manual/messagesres.tex @@ -109,7 +109,7 @@ The following is the command I (Kern) use. Note, the whole command should appear on a single line in the configuration file rather than split as is done here for presentation: -{\bf mailcommand = ``/home/kern/bacula/bin/bsmtp -h mail.whitehouse.com -f +{\bf mailcommand = ``/home/kern/bacula/bin/bsmtp -h mail.example.com -f \textbackslash{}''\textbackslash{}(Bacula\textbackslash{}) \%r\textbackslash{}`` -s \textbackslash{}''Bacula: \%t \%e of \%c \%l\textbackslash{}`` \%r'' } @@ -136,7 +136,7 @@ Higher debug levels cause more debug information to be produced. You are requested not to use this record since it will be deprecated. \item [\lt{}destination\gt{} = \lt{}message-type1\gt{}, - \lt{}message-type2\>, ...] + \lt{}message-type2\gt{}, ...] \index[fd]{\lt{}destination\gt{} } Where {\bf destination} may be one of the following: @@ -158,7 +158,7 @@ until the console program connects to the Director. \end{description} \item {\bf \lt{}destination\gt{} = \lt{}address\gt{} = - \lt{}message-type1\gt{}, \lt{}message-type2\>, ...} + \lt{}message-type1\gt{}, \lt{}message-type2\gt{}, ...} \index[console]{\lt{}destination\gt{} } Where {\bf address} depends on the {\bf destination}, which may be one of the @@ -312,15 +312,15 @@ split for this manual: \begin{verbatim} Messages { Name = Standard - mailcommand = "bacula/bin/bsmtp -h mail.whitehouse.com \ + mailcommand = "bacula/bin/bsmtp -h mail.example.com \ -f \"\(Bacula\) %r\" -s \"Bacula: %t %e of %c %l\" %r" - operatorcommand = "bacula/bin/bsmtp -h mail.whitehouse.com \ + operatorcommand = "bacula/bin/bsmtp -h mail.example.com \ -f \"\(Bacula\) %r\" -s \"Bacula: Intervention needed \ for %j\" %r" - MailOnError = security@whitehouse.com = all, !skipped, \ + MailOnError = security@example.com = all, !skipped, \ !terminate append = "bacula/bin/log" = all, !skipped, !terminate - operator = security@whitehouse.com = mount + operator = security@example.com = mount console = all, !skipped, !saved } \end{verbatim} diff --git a/docs/manual/python.tex b/docs/manual/python.tex index 4d599a3b..105c1f16 100644 --- a/docs/manual/python.tex +++ b/docs/manual/python.tex @@ -37,7 +37,7 @@ Scripts Directory} defined, if so, it looks in that directory for a file named {\bf DirStartUp}. If it is found, Bacula will pass this file to Python for execution. -\subsection*{Bacula Evetns} +\subsection*{Bacula Events} \index[general]{Bacula Events} \index[general]{Events} \addcontentsline{toc}{subsection}{Bacula Events} @@ -206,8 +206,8 @@ for the {\bf job} object. \begin{description} \item [Priority] Read or set the Job priority. -Note, that a Job Priority is effective only before -the Job actually starts. +Note, that setting a Job Priority is effective only before +the Job actually starts. (not functional yet) \end{description} The following read-only attributes are available within the Director @@ -226,6 +226,12 @@ for the {\bf job} object. \item [MediaType] \item [JobName] \item [JobStatus] +\item [ConfigFile] +\item [WorkingDir] +\item [Version] tuple consisting of (Version, Build-date) +\item [CatalogRes] tuple consisting of (DBName, Address, User, + Password, Socket, Port) taken from the Catalog resource for + the Job. \end{description} The following write-only attributes are available within the diff --git a/docs/manual/spooling.tex b/docs/manual/spooling.tex index 6d1b2175..7b850a0b 100644 --- a/docs/manual/spooling.tex +++ b/docs/manual/spooling.tex @@ -15,13 +15,13 @@ important purposes. \item It can take a long time for data to come in from the File daemon during an Incremental backup. If it is directly written to tape, the tape will start and stop or shoe-shine as it is often called causing tape wear. By first -writing the data to disk, then writing it to tape, the tape can be kept in -continual motion. + writing the data to disk, then writing it to tape, the tape can be kept in + continual motion. \item While the spooled data is being written to the tape, the despooling process has exclusive use of the tape. This means that you can spool multiple simultaneous jobs to disk, then have them very efficiently despooled one at a -time without having the data blocks from several jobs intermingled, thus -substantially improving the time needed to restore files. + time without having the data blocks from several jobs intermingled, thus + substantially improving the time needed to restore files. \item Writing to a tape can be slow. By first spooling your data to disk, you can often reduce the time the File daemon is running on a system, thus reducing downtime, and/or interference with users.