From 30e47539dbed2907115ed6755d2441e477ccde9d Mon Sep 17 00:00:00 2001 From: Kern Sibbald Date: Tue, 29 Aug 2006 15:28:27 +0000 Subject: [PATCH] Apply changes --- docs/manual/console.tex | 124 +++++++++++++++++++++++++----------- docs/manual/consoleconf.tex | 23 ++++--- docs/manual/dirdconf.tex | 117 +++++++++++++++++----------------- docs/manual/dvd.tex | 7 +- docs/manual/filedconf.tex | 8 +-- docs/manual/fileset.tex | 19 ++++++ docs/manual/install.tex | 84 ++++++++++++------------ docs/manual/progs.tex | 12 +++- 8 files changed, 240 insertions(+), 154 deletions(-) diff --git a/docs/manual/console.tex b/docs/manual/console.tex index 29c9c69d..2b47567b 100644 --- a/docs/manual/console.tex +++ b/docs/manual/console.tex @@ -59,6 +59,20 @@ this document. \index[console]{Program!Running the Console} \addcontentsline{toc}{subsection}{Running the Console Program} +The console program can be run with the following options: +\footnotesize +\begin{verbatime} +Usage: bconsole [-s] [-c config_file] [-d debug_level] + -c set configuration file to file + -dnn set debug level to nn + -n no conio + -s no signals + -t test - read configuration and exit + -? print this message. +\end{verbatim} +\normalsize + + After launching the Console program (bconsole), it will prompt you for the next command with an asterisk (*). (Note, in the GNOME version, the prompt is not present; you simply enter the commands you want in the command text box at @@ -165,6 +179,10 @@ order ... \item [current] Used in the restore command. Takes no argument. \item [days] + Used to define the number of days the "list nextvol" command + should consider when looking for jobs to be run. The days keyword + can also be used on the "status dir" command so that it will display + jobs scheduled for the number of days you want. \item [devices] Used in the show command. Takes no arguments. \item [dir | director] @@ -254,17 +272,19 @@ The following commands are currently implemented: \item [{add [pool=\lt{}pool-name\gt{} storage=\lt{}storage\gt{} jobid=\lt{}JobId\gt{}]} ] \index[console]{add} -This command is used to add Volumes to an existing Pool. The Volume names -entered are placed in the Catalog and thus become available for backup -operations. Normally, the {\bf label} command is used rather than this -command because the {\bf label} command labels the physical media (tape) and -does the equivalent of the {\bf add} command. This command affects only the -Catalog and not the physical media (data on Volumes). The physical media must -exist and be labeled before use (usually with the {\bf label} command). This -command can, however, be useful if you wish to add a number of Volumes to the -Pool that will be physically labeled at a later time. It can also be useful -if you are importing a tape from another site. Please see the {\bf label} -command below for the list of legal characters in a Volume name. + This command is not normally used since Bacula will normally + do it automatically as Volumes are labeled. However, if you need it, + this command is used to add Volumes to an existing Pool. The Volume names + entered are placed in the Catalog and thus become available for backup + operations. Normally, the {\bf label} command is used rather than this + command because the {\bf label} command labels the physical media (tape) and + does the equivalent of the {\bf add} command. This command affects only the + Catalog and not the physical media (data on Volumes). The physical media must + exist and be labeled before use (usually with the {\bf label} command). This + command can, however, be useful if you wish to add a number of Volumes to the + Pool that will be physically labeled at a later time. It can also be useful + if you are importing a tape from another site. Please see the {\bf label} + command below for the list of legal characters in a Volume name. \item [autodisplay on/off] \index[console]{autodisplay on/off} @@ -300,9 +320,12 @@ command below for the list of legal characters in a Volume name. (generally within a minute) before it actually terminates, depending on what operations it is doing. -\item [{ create [pool=\lt{}pool-name\gt{}]}] +\item [{create [pool=\lt{}pool-name\gt{}]}] \index[console]{create pool} - This command is used to create a Pool record in the database using the + This command is not normally used as the Pool records are automatically + created by the Director when it starts based on what it finds in + the conf file. If needed, this command can be + to create a Pool record in the database using the Pool resource record defined in the Director's configuration file. So in a sense, this command simply transfers the information from the Pool resource in the configuration file into the Catalog. Normally this @@ -318,7 +341,7 @@ command below for the list of legal characters in a Volume name. it will create it for you. If you want the Pool record to appear in the database immediately, simply use this command to force it to be created. -\item [{ delete [volume=\lt{}vol-name\gt{} pool=\lt{}pool-name\gt{} job +\item [{delete [volume=\lt{}vol-name\gt{} pool=\lt{}pool-name\gt{} job jobid=\lt{}id\gt{}]}] \index[console]{delete} The delete command is used to delete a Volume, Pool or Job record from @@ -335,15 +358,23 @@ command below for the list of legal characters in a Volume name. records (File and JobMedia) will be deleted from the catalog. The full form of this command is: +\begin{verbatim} delete pool=\lt{}pool-name\gt{} +\end{verbatim} or +\begin{verbatim} delete volume=\lt{}volume-name\gt{} pool=\lt{}pool-name\gt{} or +\end{verbatim} +\begin{verbatim} delete JobId=\lt{}job-id\gt{} JobId=\lt{}job-id2\gt{} ... or +\end{verbatim} +\begin{verbatim} delete Job JobId=n,m,o-r,t ... +\end{verbatim} The first form deletes a Pool record from the catalog database. The second form deletes a Volume record from the specified pool in the @@ -391,8 +422,11 @@ delete Job JobId=n,m,o-r,t ... files to be backed up will be listed. Note, it could take quite some time to display them if the backup is large. The full form is: + +\begin{verbatim} estimate job=\lt{}job-name\gt{} listing client=\lt{}client-name\gt{} -fileset=\lt{}fileset-name\gt{} level=\lt{}level-name\gt{} + fileset=\lt{}fileset-name\gt{} level=\lt{}level-name\gt{} +\end{verbatim} Specification of the {\bf job} is sufficient, but you can also override the client, fileset and/or level by specifying them on the estimate @@ -409,9 +443,17 @@ As an example, you might do: \end{verbatim} \normalsize -which will do a full listing of all files to be backed up for the Job {\bf -NightlySave} during an Incremental save and put it in the file {\bf -/tmp/listing}. + which will do a full listing of all files to be backed up for the Job {\bf + NightlySave} during an Incremental save and put it in the file {\bf + /tmp/listing}. Note, the byte estimate provided by this command is + based on the file size contained in the directory item. This can give + wildly incorrect estimates of the actual storage used if there are + sparse files on your systems. Sparse files are often found on 64 bit + systems for certain system files. The size that is returned is the size + Bacula will backup if the sparse option is not specified in the FileSet. + There is currently no way to get an estimate of the real file size that + would be found should the sparse option be enabled. + \item [help] \index[console]{help} @@ -425,8 +467,10 @@ NightlySave} during an Incremental save and put it in the file {\bf This command is used to label physical volumes. The full form of this command is: +\begin{verbatim} label storage=\lt{}storage-name\gt{} volume=\lt{}volume-name\gt{} -slot=\lt{}slot\gt{} + slot=\lt{}slot\gt{} +\end{verbatim} If you leave out any part, you will be prompted for it. The media type is automatically taken from the Storage resource definition that you @@ -532,8 +576,8 @@ update storage=xxx pool=yyy slots=1-5,10 barcodes list jobname= (same as above) - In the above, you can add "limit=nn" to limit the output to - nn jobs. + In the above, you can add "limit=nn" to limit the output to + nn jobs. list jobmedia @@ -567,8 +611,6 @@ update storage=xxx pool=yyy slots=1-5,10 barcodes list nextvol job= days=nnn - - \end{verbatim} \normalsize @@ -1205,10 +1247,10 @@ use \lt{}database-name\gt{} \item [quit] \index[console]{quit} This command terminates the console program. The console program sends the -{\bf quit} request to the Director and waits for acknowledgment. If the -Director is busy doing a previous command for you that has not terminated, it -may take some time. You may quit immediately by issuing the {\bf .quit} -command (i.e. quit preceded by a period). + {\bf quit} request to the Director and waits for acknowledgment. If the + Director is busy doing a previous command for you that has not terminated, it + may take some time. You may quit immediately by issuing the {\bf .quit} + command (i.e. quit preceded by a period). \item [query] \index[console]{query} @@ -1244,9 +1286,16 @@ Choose a query (1-9): \item [wait] \index[console]{wait} The wait command causes the Director to pause until there are no jobs -running. This command is useful in a batch situation such as regression -testing where you wish to start a job and wait until that job completes -before continuing. + running. This command is useful in a batch situation such as regression + testing where you wish to start a job and wait until that job completes + before continuing. This command now has the following options: +\footnotesize +\begin{verbatim} + wait [jobid=nn] [jobuid=unique id] [job=job name] +\end{verbatim} +\normalsize + If specified with a specific JobId, ... the wait command will wait + for that particular job to terminate before continuing. \end{description} \label{dotcommands} @@ -1265,22 +1314,23 @@ is the list of dot commands: \footnotesize \begin{verbatim} .backups job=xxx list backups for specified job +.clients list all client names .defaults client=xxx fileset=yyy list defaults for specified client .die cause the Director to segment fault (for debugging) .dir when in tree mode prints the equivalent to the dir command, but with fields separated by commas rather than spaces. +.exit quit +.filesets list all fileset names +.help help command output .jobs list all job names .levels list all levels -.filesets list all fileset names -.clients list all client names -.pools list all pool names -.types list job types -.msgs return any queued messages .messages get quick messages -.help help command output +.msgs return any queued messages +.pools list all pool names .quit quit .status get status output -.exit quit +.storage return storage resource names +.types list job types \end{verbatim} \normalsize diff --git a/docs/manual/consoleconf.tex b/docs/manual/consoleconf.tex index 1eaa9c16..38d50ba0 100644 --- a/docs/manual/consoleconf.tex +++ b/docs/manual/consoleconf.tex @@ -37,27 +37,26 @@ choose one when you start the {\bf Console} program. \item [Director] \index[console]{Director} - Start of the Director records. + Start of the Director directives. \item [Name = \lt{}name\gt{}] \index[console]{Name} The director name used to select among different Directors, otherwise, this -name is not used. + name is not used. \item [DIRPort = \lt{}port-number\gt{}] \index[dir]{DIRPort} Specify the port to use to connect to the Director. This value will most -likely already be set to the value you specified on the {\bf -\verb:--:with-base-port} option of the {\bf ./configure} command. This port must be -identical to the {\bf DIRport} specified in the {\bf Director} resource of -the -\ilink{Director's configuration}{_ChapterStart40} file. The -default is 9101 so this record is not normally specified. + likely already be set to the value you specified on the {\bf + \verb:--:with-base-port} option of the {\bf ./configure} command. This port must be + identical to the {\bf DIRport} specified in the {\bf Director} resource of + the \ilink{Director's configuration}{_ChapterStart40} file. The + default is 9101 so this directive is not normally specified. \item [Address = \lt{}address\gt{}] \index[dir]{Address} Where the address is a host name, a fully qualified domain name, or a network -address used to connect to the Director. + address used to connect to the Director. \item [Password = \lt{}password\gt{}] \index[dir]{Password} @@ -65,7 +64,7 @@ address used to connect to the Director. Console connection. This password must be identical to the {\bf Password} specified in the {\bf Director} resource of the \ilink{Director's configuration}{_ChapterStart40} file. This -record is required. +directive is required. \end{description} An actual example might be: @@ -93,7 +92,7 @@ the main listing window. \item [ConsoleFont] \index[console]{ConsoleFont} - Start of the ConsoleFont records. + Start of the ConsoleFont directives. \item [Name = \lt{}name\gt{}] \index[console]{Name} @@ -102,7 +101,7 @@ the main listing window. \item [Font = \lt{}Pango Font Name\gt{}] \index[console]{Font} The string value given here defines the desired font. It is specified in the -Pango format. For example, the default specification is: + Pango format. For example, the default specification is: \footnotesize \begin{verbatim} diff --git a/docs/manual/dirdconf.tex b/docs/manual/dirdconf.tex index 98105469..9a41207e 100644 --- a/docs/manual/dirdconf.tex +++ b/docs/manual/dirdconf.tex @@ -212,6 +212,8 @@ of this manual. \item [DirAddresses = \lt{}IP-address-specification\gt{}] \index[dir]{DirAddresses} + \index[dir]{Address} + \index[general]{Address} \index[dir]{Directive!DirAddresses} Specify the ports and addresses on which the Director daemon will listen for Bacula Console connections. Probably the simplest way to explain @@ -219,27 +221,23 @@ of this manual. \footnotesize \begin{verbatim} - DirAddresses = { ip = { - addr = 1.2.3.4; port = 1205;} + DirAddresses = { + ip = { addr = 1.2.3.4; port = 1205;} ipv4 = { addr = 1.2.3.4; port = http;} ipv6 = { addr = 1.2.3.4; port = 1205; - } + } ip = { addr = 1.2.3.4 port = 1205 - } - ip = { - addr = 1.2.3.4 - } - ip = { - addr = 201:220:222::2 - } + } + ip = { addr = 1.2.3.4 } + ip = { addr = 201:220:222::2 } ip = { addr = bluedot.thun.net - } + } } \end{verbatim} \normalsize @@ -256,14 +254,15 @@ Please note that if you use the DirAddresses directive, you must not use either a DirPort or a DirAddress directive in the same resource. -\item [DIRport = \lt{}port-number\gt{}] - \index[dir]{DIRport} - \index[dir]{Directive!DIRport} +\item [DirPort = \lt{}port-number\gt{}] + \index[dir]{DirPort} + \index[dir]{Directive!DirPort} Specify the port (a positive integer) on which the Director daemon will listen for Bacula Console connections. This same port number must be specified in the Director resource of the Console configuration file. The default is 9101, so normally this directive need not be specified. This -directive is not needed if you specify DirAddresses. +directive should not be used if you specify DirAddresses (not plural) +directive. \item [DirAddress = \lt{}IP-Address\gt{}] \index[dir]{DirAddress} @@ -274,8 +273,8 @@ IP-Address}, which is either a domain name or an IP address specified as a dotted quadruple in string or quoted string format. If this directive is not specified, the Director will bind to any available address (the default). Note, unlike the DirAddresses specification noted above, this directive only -permits a single address to be specified. This directive is not needed if you -specify a DirAddresses (not plural). +permits a single address to be specified. This directive should not be used if you +specify a DirAddresses (note plural) directive. \end{description} The following is an example of a valid Director resource definition: @@ -350,32 +349,32 @@ Clients, you must define a Job for each one. \item [Backup] \index[dir]{Backup} Run a backup Job. Normally you will have at least one Backup job for each -client you want to save. Normally, unless you turn off cataloging, most all -the important statistics and data concerning files backed up will be placed -in the catalog. + client you want to save. Normally, unless you turn off cataloging, most all + the important statistics and data concerning files backed up will be placed + in the catalog. \item [Restore] \index[dir]{Restore} - 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 -stored for a Backup job -- for example, no File database entries are -generated since no Files are saved. + 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 stored for a Backup job -- for + example, no File database entries are generated since no Files are + saved. \item [Verify] \index[dir]{Verify} Run a verify Job. In general, {\bf verify} jobs permit you to compare the -contents of the catalog to the file system, or to what was backed up. In -addition, to verifying that a tape that was written can be read, you can -also use {\bf verify} as a sort of tripwire intrusion detection. + contents of the catalog to the file system, or to what was backed up. In + addition, to verifying that a tape that was written can be read, you can + also use {\bf verify} as a sort of tripwire intrusion detection. \item [Admin] \index[dir]{Admin} Run an admin Job. An {\bf Admin} job can be used to periodically run catalog -pruning, if you do not want to do it at the end of each {\bf Backup} Job. -Although an Admin job is recorded in the catalog, very little data is saved. + pruning, if you do not want to do it at the end of each {\bf Backup} Job. + Although an Admin job is recorded in the catalog, very little data is saved. \end{description} \label{Level} @@ -1739,11 +1738,12 @@ console run command. This directive is required. \item [Address = \lt{}address\gt{}] \index[dir]{Address} - \index[dir]{Directive!Address} - 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. + \index[dir]{Directive!FD Address} + \index[dir]{File Daemon Address} + \index[dir]{Client Address} + 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} @@ -1789,17 +1789,17 @@ hours, days, weeks, months, quarters, or years. See the additional details of time specification. The default is 60 days. -\label{JobRetention} +\label{JobRetention} \item [Job Retention = \lt{}time-period-specification\gt{}] \index[dir]{Job Retention} \index[dir]{Directive!Job Retention} The Job Retention directive defines the length of time that Bacula will keep -Job records in the Catalog database. When this time period expires, and if -{\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) Job records -that are older than the specified File Retention period. As with the other -retention periods, this affects only records in the catalog and not data in -your archive backup. + Job records in the Catalog database. When this time period expires, and if + {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) Job records + that are older than the specified File Retention period. As with the other + retention periods, this affects only records in the catalog and not data in + your archive backup. If a Job record is selected for pruning, all associated File and JobMedia records will also be pruned regardless of the File Retention period set. @@ -1822,24 +1822,24 @@ The default is 180 days. \index[dir]{AutoPrune} \index[dir]{Directive!AutoPrune} If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater) -will automatically apply the File retention period and the Job retention -period for the Client at the end of the Job. If you set {\bf AutoPrune = no}, -pruning will not be done, and your Catalog will grow in size each time you -run a Job. Pruning affects only information in the catalog and not data -stored in the backup archives (on Volumes). + will automatically apply the File retention period and the Job retention + period for the Client at the end of the Job. If you set {\bf AutoPrune = no}, + pruning will not be done, and your Catalog will grow in size each time you + run a Job. Pruning affects only information in the catalog and not data + stored in the backup archives (on Volumes). \item [Maximum Concurrent Jobs = \lt{}number\gt{}] \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 -that can run concurrently. Note, this directive limits only Jobs for Clients -with the same name as the resource in which it appears. Any other -restrictions on the maximum concurrent jobs such as in the Director, Job, or -Storage resources will also apply in addition to any limit specified here. -The default is set to 1, but you may set it to a larger number. We strongly -recommend that you read the WARNING documented under -\ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's -resource. + that can run concurrently. Note, this directive limits only Jobs for Clients + with the same name as the resource in which it appears. Any other + restrictions on the maximum concurrent jobs such as in the Director, Job, or + Storage resources will also apply in addition to any limit specified here. + The default is set to 1, but you may set it to a larger number. We strongly + recommend that you read the WARNING documented under + \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's + resource. \item [Priority = \lt{}number\gt{}] \index[dir]{Priority} @@ -1856,7 +1856,7 @@ The following is an example of a valid Client resource definition: \begin{verbatim} Client { Name = Minimatou - Address = minimatou + FDAddress = minimatou Catalog = MySQL Password = very_good } @@ -1888,7 +1888,8 @@ specified in the Job resource and is required. \item [Address = \lt{}address\gt{}] \index[dir]{Address} - \index[dir]{Directive!Address} + \index[dir]{Directive!SD 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 specified here will be transmitted to the File daemon who will then use it to contact the diff --git a/docs/manual/dvd.tex b/docs/manual/dvd.tex index 846133c3..db05f24c 100644 --- a/docs/manual/dvd.tex +++ b/docs/manual/dvd.tex @@ -25,13 +25,16 @@ You must have {\bf dvd+rw-tools} loaded on your system for DVD writing to work. Please note that the original {\bf dvd+rw-tools} package does {\bf NOT} work with Bacula. You must apply a patch which can be found in the {\bf patches} directory of Bacula sources with the name -{\bf dvd+rw-tools-5.21.4.10.8.bacula.patch}. +{\bf dvd+rw-tools-5.21.4.10.8.bacula.patch} for version 5.21 of the tools, +or patch {bf dvd+rw-tools-6.1.bacula.patch} if you have version 6.1 +on your system. Unfortunately, this requires you to build the dvd_rw-tools +from source. 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 a disk or a tape, but nevertheless, it does work if you use some care to set it up properly. However, at the current time -(28 October 2005) we still consider this code to be experimental and of +(26 August 2006) we still consider this code to be experimental and of BETA quality. As a consequence, please do careful testing before relying on DVD backups in production. diff --git a/docs/manual/filedconf.tex b/docs/manual/filedconf.tex index 5b95d36a..e18d9e21 100644 --- a/docs/manual/filedconf.tex +++ b/docs/manual/filedconf.tex @@ -145,8 +145,8 @@ client program. \footnotesize \begin{verbatim} - FDAddresses = { ip = { - addr = 1.2.3.4; port = 1205; } + FDAddresses = { + ip = { addr = 1.2.3.4; port = 1205; } ipv4 = { addr = 1.2.3.4; port = http; } ipv6 = { @@ -157,9 +157,7 @@ client program. addr = 1.2.3.4 port = 1205 } - ip = { - addr = 1.2.3.4 - } + ip = { addr = 1.2.3.4 } ip = { addr = 201:220:222::2 } diff --git a/docs/manual/fileset.tex b/docs/manual/fileset.tex index 30e6c743..72366234 100644 --- a/docs/manual/fileset.tex +++ b/docs/manual/fileset.tex @@ -460,6 +460,25 @@ Change: 2005-11-06 12:36:48.000000000 +0100 exec > /dev/null \end{verbatim} +\item [noatime=yes|no] +\index[dir]{noatime} +\index[dir]{Directive!noatime} + If enabled, and if your Operating System supports the O_NOATIME file + open flag, Bacula will open all files to be backed up with this option. + It makes it possible to read a file without updating the inode atime + (and also without the inode ctime update which happens if you try to set + the atime back to its previous value). It also prevents a race + condition when two programs are reading the same file, but only one does + not want to change the atime. It's most useful for backup programs and + file integrity checkers (and bacula can fit on both categories). + + This option is particularly useful for sites where users are sensitive + to their MailBox file access time. It replaces both the {\bf keepatime} + option without the inconvienences of that option (see below). + + If your Operating System does not support this option, it will be + silently ignored by Bacula. + \item [mtimeonly=yes|no] \index[dir]{mtimeonly} diff --git a/docs/manual/install.tex b/docs/manual/install.tex index fe8fe241..1315cd60 100644 --- a/docs/manual/install.tex +++ b/docs/manual/install.tex @@ -11,15 +11,17 @@ \index[general]{General } \addcontentsline{toc}{subsection}{General} -In general, you will need the Bacula source release, and if you want to run a -Windows client, you will need the Bacula Windows binary release. However, -Bacula needs certain third party packages (such as {\bf SQLite}, {\bf MySQL}, or -{\bf PostgreSQL} -to build properly depending on the options you specify. To simplify your task, -we have combined a number of these packages into two {\bf depkgs} releases -(Dependency Packages). This can vastly simplify your life by providing you -with all the necessary packages rather than requiring you to find them on the -Web, load them, and install them. +In general, you will need the Bacula source release, and if you want to run +a Windows client, you will need the Bacula Windows binary release. +However, Bacula needs certain third party packages (such as {\bf MySQL}, +{\bf PostgreSQL}, or {\bf SQLite} to build properly depending on the +options you specify. Normally, {\bf MySQL} and {\bf PostgreSQL} are +packages that can be installed on your distribution. However, if you do +not have them, to simplify your task, we have combined a number of these +packages into two {\bf depkgs} releases (Dependency Packages). This can +vastly simplify your life by providing you with all the necessary packages +rather than requiring you to find them on the Web, load them, and install +them. \subsection*{Source Release Files} \index[general]{Source Files} @@ -58,6 +60,8 @@ the Bacula CVS. The released files are: \item [winbacula-1.38.0.exe] This file is the 32 bit Windows installer for installing the Windows client (File daemon) on a Windows machine. + Beginning with Bacula version 1.39.20, this executable will + also load the Win32 Director and the Win32 Storage daemon. \end{description} @@ -70,7 +74,8 @@ the Bacula CVS. The released files are: If you are upgrading from one Bacula version to another, you should first carefully read the ReleaseNotes of all versions between your current version and the version to which you are upgrading. If the Bacula catalog database has -been upgraded, you will either need to reinitialize your database starting +been upgraded (as it is almost every major release), +you will either need to reinitialize your database starting from scratch, or save an ASCII copy of your database, then proceed to upgrade it. This is normally done after Bacula is build and installed by: @@ -100,13 +105,17 @@ Finally, please note that in general it is not necessary to do a {\bf make uninstall} before doing an upgrade. In fact, if you do so, you will most likely delete all your conf files, which could be disastrous. The normal procedure during an upgrade is simply: + \begin{verbatim} ./configure (your options) make make install \end{verbatim} -In general none of your existing .conf or .sql files will be overwritten. +In general none of your existing .conf or .sql files will be overwritten, +and you must do both the {\bf make} and {\bf make install} commands, a +{\bf make install} without the preceding {\bf make} will not work. + For additional information on upgrading, please see the \ilink{Upgrading Bacula Versions}{upgrading} in the Tips chapter of this manual. @@ -143,24 +152,18 @@ Although the exact composition of the dependency packages may change from time to time, the current makeup is the following: \addcontentsline{lot}{table}{Dependency Packages} -\begin{longtable}{|l|l|l|l|} +\begin{longtable}{|l|l|l|} \hline \multicolumn{1}{|c| }{\bf 3rd Party Package } & \multicolumn{1}{c| }{\bf -depkgs } & \multicolumn{1}{c| }{\bf depkgs1 } & \multicolumn{1}{c| }{\bf -depkgs-win32 } \\ - \hline {SQLite } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } & -\multicolumn{1}{c| }{- } \\ - \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } & -\multicolumn{1}{c| }{- } \\ - \hline {readline } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{X } & -\multicolumn{1}{c| }{- } \\ - \hline {pthreads } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } & -\multicolumn{1}{c| }{X } \\ - \hline {zlib } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } & -\multicolumn{1}{c| }{X } \\ - \hline {wxWidgets } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } & -\multicolumn{1}{c| }{X } -\\ \hline +depkgs } & \multicolumn{1}{c| }{\bf depkgs1 } \\ + \hline {SQLite } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } \\ + \hline {SQLite3 } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } \\ + \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } \\ + \hline {readline } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{X } \\ + \hline {pthreads } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } \\ + \hline {zlib } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } \\ + \hline {wxWidgets } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } \\ + \hline \end{longtable} @@ -189,9 +192,12 @@ because the {\bf tapeinfo} program that comes with it can often provide you with valuable information about your SCSI tape drive (e.g. compression, min/max block sizes, ...). -The {\bf depkgs-win32} package contains the source code for the pthreads, -zlib, and wxWidgets libraries used by the native Win32 client program. It -will only be needed if you intend to build the Win32 client from source. +The {\bf depkgs-win32} package is deprecated and no longer used in +Bacula version 1.39.x and later. It was previously used to build +the native Win32 client program, but this program is now built on Linux +systems using cross-compiling. All the tools and third party libraries +are automatically downloaded by executing the appropriate scripts. See +src/win32/README.mingw32 for more details. \subsection*{Supported Operating Systems} \label{Systems} @@ -212,7 +218,8 @@ of the QuickStart chapter of this manual. The basic installation is rather simple. \begin{enumerate} -\item Install and build any {\bf depkgs} as noted above. +\item Install and build any {\bf depkgs} as noted above. This + should be unnecessary on most modern Operating Systems. \item Configure and install MySQL or PostgreSQL (if desired). \ilink{Installing and Configuring MySQL Phase I}{_ChapterStart} or \ilink{Installing and Configuring PostgreSQL Phase @@ -230,13 +237,13 @@ The basic installation is rather simple. And you have already installed the additional rpms noted above. \item As an alternative to MySQL and PostgreSQL, configure and install SQLite, - which is part of the {\bf depkgs}. + which is part of the {\bf depkgs} and also available with most modern + Operating Systems. \ilink{Installing and Configuring SQLite}{_ChapterStart33}. SQLite is probably not suited to a fair size production environment because it tends to be slow compared to MySQL and it has few or poor tools for repairing database damage. - \item Detar the Bacula source code preferably into the {\bf bacula} directory discussed above. @@ -369,7 +376,7 @@ In general, you will probably want to supply a more complicated {\bf configure} statement to ensure that the modules you want are built and that everything is placed into the correct directories. -For example, on RedHat, one could use the following: +For example, on Fedora, RedHat, or SuSE one could use the following: \footnotesize \begin{verbatim} @@ -379,7 +386,7 @@ CFLAGS="-g -Wall" \ --sysconfdir=$HOME/bacula/bin \ --with-pid-dir=$HOME/bacula/bin/working \ --with-subsys-dir=$HOME/bacula/bin/working \ - --with-mysql=$HOME/mysql \ + --with-mysql \ --with-working-dir=$HOME/bacula/bin/working \ --with-dump-email=$USER \end{verbatim} @@ -433,8 +440,7 @@ as in: \footnotesize \begin{verbatim} LDFLAGS="-lssl -lcyrpto" \ - ./configure \ - + ./configure \end{verbatim} \normalsize @@ -446,10 +452,10 @@ either the termcap or the ncurses library, but it is unlikely that the {\bf coni package will gobble up prompts. readline is no longer supported after version 1.34. The code within Bacula -remains, so it should be usable, and if users submit patches for it, I will +remains, so it should be usable, and if users submit patches for it, we will be happy to apply them. However, due to the fact that each version of readline seems to be incompatible with previous versions, and that there -are significant differences between systems, I can no longer afford to +are significant differences between systems, we can no longer afford to support it. \subsection*{What Database to Use?} diff --git a/docs/manual/progs.tex b/docs/manual/progs.tex index 652d7c86..38b28e0b 100644 --- a/docs/manual/progs.tex +++ b/docs/manual/progs.tex @@ -918,16 +918,26 @@ Usage: bsmtp [-f from] [-h mailhost] [-s subject] [-c copy] [recipient ...] -dnn set debug level to nn -f set the From: field -h use mailhost:port as the bsmtp server + -l limit the lines accepted to nn -s set the Subject: field -? print this message. \end{verbatim} \normalsize If the {\bf -f} option is not specified, {\bf bsmtp} will use your userid. If -the option is not specified {\bf bsmtp} will use the value in the environment +the option {\bf -h} is not specified {\bf bsmtp} will use the value in the environment variable {\bf bsmtpSERVER} or if there is none {\bf localhost}. By default port 25 is used. +If a line count limit is set with the {\bf -l} option, {\bf bsmtp} will +not send an email with a body text exceeding that number of lines. This +is especially useful for large restore job reports where the list of +files restored might produce very long mails your mail-server would +refuse or crash. However, be aware that you will probably suppress the +job report and any error messages unless you check the log file written +by the Director (see the messages resource in this manual for details). + + {\bf recipients} is a space separated list of email recipients. The body of the email message is read from standard input. -- 2.39.5