BRU, CRU, SmartRestore, AUTOSCAN, Anytime Verify, and BRUMenus are trademarks of Enhanced Software Technologies, Inc.
X11, The X11 Window System, and the X11 Logo are registered trademarks of The X11 Consortium and the Massachusetts Institute of Technology.
Copyright© 1999 Enhanced Software Technologies,Inc.
XBRU provides a simple, user-friendly graphic interface for BRU.
Figure 1.1 XBRU Main Interface Window
Before installation or use, the BRU GUI (XBRU) requires that BRU version 15.0 or better be installed. Please refer to the "BRU Technical Manual" for complete installation information regarding BRU. XBRU also requires that the non-rewinding device nodes of any tape drives used be listed in etc/brutab. Carefully read "Configuration" (section 2.6) before attempting to use XBRU.
Depending on the directory XBRU is installed into (default is: /usr/local/xbru), this directory should have permissions "rwxrwxrwt"(01777), allowing users to create files/directories, which is required for the scheduler, but preventing them from being able to delete or modify files that they do not own or have write access to.
The BRU GUI is distributed on the same installation media as BRU. When extracted, the installation files will be placed in an 'xbru' subdirectory of the directory where the extraction is performed, i.e. extracting files into /tmp will result in /tmp/xbru.
When accessed, the BRU installation script will request to install the X11 Interface for BRU. Answering "yes" will run the ./installX script in the xbru directory.
NOTE: To install XBRU at a later time, answer "no". When ready to install, access the /xbru subdirectory and enter:
./installXIf the XBRU installation files have been deleted, extract them from the BRU installation media by running:
# cd /tmp
# tar -xvf /dev/<floppy device> ./xbru
It is also possible to obtain XBRU from EST's ftp site:
The file is a BRU archive file and can be installed using the following commands:
# bru -xvf bru4X11_1.12.bru -PA
# ./xbru/installX
NOTE: The version number (1.12 shown) may vary based on purchase date.
To operate, XBRU requires, at minimum, Tcl version 7.6 and Tk version 4.2. If not currently installed, they can be downloaded at:
or
Upon installation, XBRU looks for the executables 'tclshn.n' and 'wishn.n' ("n.n" = version number, i.e. tclsh8.0) in the current path. Although XBRU requires at least version 7.6/4.2 of the Tcl/Tk environment, the release recommended by EST is version 8.0 or higher. This version has several enhancements over previous versions, including a byte-code compiler, that greatly increase execution speed and reduce CPU overhead. Fewer problems have been reported compiling and installing the 8.0 environment compared to the 7.6/4.2 versions, as well.
Although EST does not provide support for installing Tcl or Tk, most of the problems reported stem from not having the full development environment and/or X11 installed. With the proper development environment installed, Tcl/Tk has proven to be very portable.
XBRU uses an internal mechanism to schedule backup jobs. However, it requires that the /usr/local/bin/bruschedule script be run every 5 minutes by cron. Until this is done, no XBRU scheduled backup jobs will run. Consult the system documentation and/or the cron manpages for instructions on configuring this process. The following illustrates a typical example:
# Run BRU's scheduler every 5 minutes
0,5,10,15,20,25,30,35,40,45,50,55 * * * * /usr/local/bin/bruschedule
# Run BRU's Scheduler every 5 minutes (Linux)
*/5 * * * * /usr/local/bin/bruschedule
Most of XBRU's configuration requires editing of the "/etc/brutab" file. In particular, it is necessary to ensure that all non-rewinding tape devices are listed in the brutab. Non-rewinding devices are those that leave the tape at its current position after program operation, as opposed to rewinding to the beginning of the tape (BOT). These are the only tape devices with which XBRU is compatible.
A non-rewinding device is typically labelled the same as a rewinding device, with the exception of having an 'n' included in its designation code. If a rewinding device is listed as "/dev/rStp0", the non-rewinding device would be "/dev/nrStp0". User's that are not certain of device identification should consult the operating system documentation.
Adding a non-rewinding device entry to the /etc/brutab file is not difficult. If the following code sequence is a brutab file:
/dev/st0 devname="SCSI Tape Drive" \
size=4GT seek=0 bufsize=20k shmseg=7 shmmax=200k \
reopen rawtape tape rewind shmcopy
The non-rewinding entry would be generated in this manner:
/dev/nst0 devname="Non-Rewinding SCSI Tape Drive" \For further illustration, several sample brutabs can be found at:
The relevant changes would be the change in the device name ("/dev/st0" to "/dev/nst0"), the change in size (from 4GB to unspecified), the change of the "rewind" flag to "norewind", and the addition of the "noautoscan" flag. The "devname" entry is only to provide a name for the device that can be read by the user and will not affect XBRU's ability to utilize it. It is highly recommended that the "devname" value be set. There are additional entries that MAY need to be entered into the brutab device entry for non-rewinding devices, particularly with remote devices. They are:
Consult the system documentation for information on how these commands should be implemented (hint: try 'man mt' or 'man tape'). If the command sequences are not set, XBRU will make assumptions based on the operating system.
NOTE: The command to rewind a tape to the previous file mark does not work with some devices. In those cases, bfmcmd should be removed. Subsequently, XBRU will use a slower, but more reliable, method of rewinding to the previous file mark.
Some problems have arisen with certain tape devices under Linux. It is highly recommended that any IDE/ATAPI drives being utilized are in SCSI emulation mode with "st0/nst0" instead of "ht0/nht0". If using a parallel or floppy tape drive (TR-3), there may be some problems with the ftape driver if an older version is used. To circumvent this, download the latest drivers at:
XBRU provides a GUI with three shortcut buttons for creating backups: "Full", "Level 1", and "Level 2". These operate using the active settings for backup device, compression, include/exclude patterns, etc. ("Backup Options", Section 3.5). These will override the "Skip Mount Points" setting so any mount points encountered will be backed up. However, XBRU will ask for confirmation if backing up of remote volumes is enabled. See Figure 1.1 for further information.
To launch XBRU, type "xbru" at the command prompt.
Figure 2.1 Backup Interface
Select the "Backup" button or choose "Backup" from the "File" menu to bring up the file selection interface. The box on the left will display the name and contents of the current directory. To change directories, edit the "CD" entry or double-click on the directory entries in the listing. The box on the right will display the current files/directories selected for backup.
Add files or directories to the backup list by highlighting them in the current directory listing and selecting "Add". All entries in the current directory can be added by selecting "Add All". Alternatively, files can be added by simply double-clicking on them. Clicking the right mouse button is equivalent to selecting "Add". A directory cannot be added if a file or directory within that directory is already in the backup list, as this would result in backing up duplicate files. Any subdirectories/files must be removed before the parent directory can be added. To remove, use the mouse to select entries from the list and select "Remove". "Remove All" will clear the selected list.
Both listings support multiple selections. Selecting an item, then <Shift>-selecting another item, will select all items between the two. <Ctrl>-click will select individual items. Selecting "Add"/"Remove" will affect all of the selected items.
XBRU also provides a search function, accessible by clicking on the "Search" button. This button will display a search window where a shell-style pattern can be entered and/or recursive searching (optional) can be initiated. As in shell protocol, the "*" character will match 0 or more characters, "?" matches any single character, and [a-c] or [a,c] will match either a range of characters between 'a' and 'c', or only 'a' or 'c', respectively.
Recursive searches will match the pattern against all files and subdirectories found. Otherwise, the search pattern is only matched against files and directories in the current directory. The pattern entered should match the entire path desired. Examples are as follows:
file | Matches "file" in the current directory |
*file | Matches any paths ending with "file", such as "dir/file", dir/badfile, or "somefile" |
dir/* | Matches any paths beginning with "dir/" |
*.gif | Matches any paths ending with ".gif" |
Backup Definitions allow the user to define a specific set of backup options, schedule selected backup processes to occur at a later time, or quickly retrieve files/directories. The backup interface displays option buttons to "Load" and "Save" backup definitions.
Selecting "Save" will display a prompt for a definition name. Note that there are spaces for multiple users to allow different users to have definitions of the same name. Clicking "Save" will store all relevant information, which includes the current device selection, backup options such as compression and include/exclude pattern settings, and selected files and directories. Once a definition has been saved, a prompt will appear that allows the user to schedule the definition to run at some specific time in the future.
To amend any information in a definition, the changes must be completed, the definition must be saved under the same name, and "overwrite" must be selected at the ensuing prompt. Definitions are stored in files located in a user directory within XBRU's installation directory. Consequently, the user saving the definition MUST have write access to XBRU's install directory. XBRU will create the subdirectory for the user if it does not exist.
Selecting "Load" will present a dialog showing all current definitions. After selecting the desired definition, XBRU will set the device and backup options to the previously saved parameters.
The "Backup Options" interface can be accessed by either selecting the "Options" button from the Backup File Selection window, or by selecting "Backup" from the "Options" menu. "Backup Options" allows a user to select such items as incremental backups, mount point handling, compression settings, logging options, and more.
See the "BRU Technical Manual" for more information on how different options will affect backups.
It is highly recommended that any user initiating the backup process select "Create On-Tape Directory" as an option. This creates a list of files on the tape that XBRU can use to quickly determine what its contents are. Without this option enabled, XBRU must scan the entire tape to retrieve the information. This can be critical for "Restore" operations, requiring that XBRU scan the tape once to get the contents, and once again to restore the selected files. This option does, however, add several minutes to the backup time, so some users may wish to disable it.
To save all settings for future use, select "Save Options" from the "Options" menu.
After selecting at least one file or directory for backup, click the "Continue" button to begin the backup process. This will result in the appearance of several dialog windows designed to handle such things as overwriting/appending to tapes and labeling backups. Another window that will appear is the "Estimate" window. The "Estimate" window will display how many files will be backed up, how large the backup will be in kilobytes, and approximately how many volumes the backup will consist of, provided the tape size has been set. The volume estimation does not, however, take compression into account if it is activated.
At this point, the backup may be completed without any further interaction. Once the estimate is complete, select the "Continue" button to perform the actual backup. If no selection is made within 30 seconds, the "Estimate" window will time out and the backup will proceed.
The next window to appear will be the "Backup Progress" window, which displays a progress meter and various statistics about the backup. This allows the user to visually monitor the backup activity. Once the backup is complete, XBRU will attempt to rewind the tape, if applicable, and verify the backup. The meters will be reset to show the verification progress. When finished, the "Cancel" button in the "Backup Progress" window will change to say "Done" and XBRU's status line will change to say "Ready".
XBRU provides a scheduler for setting up backup definitions to run at later times. The scheduler window is accessed through the dialog window that appears after saving a definition, or by selecting "Scheduler" from the "File" menu.
Figure 3.1 Scheduler Interface
When activated, the scheduler will display a calender with a "Definition" window located in the top right hand corner of the window. This displays a list of all previously saved definitions available to the user. Currently scheduled definitions will appear with an "*" next to them.
To schedule a definition, double-click on the definition name. Select the day(s) of the week that the definition should run, keeping in mind that it is possible to select more than one day of the week. Multiple backups can also be scheduled. An example might be scheduling a definition labelled as "Daily" to perform a backup (Backup Options, Section 3.5) every Monday through Thursday at 6:30pm, then scheduling a backup labelled as "Weekly" to run on Fridays at 6:30pm. A user can also select whether the backup will overwrite or append to the tape in the drive when the definition runs (only applicable to tape devices).
NOTE: "Save" MUST be selected in order for any changes to take effect. Selecting a different definition or closing the window will cause any unsaved changes to be discarded. To unschedule or completely delete any definition(s), highlight the desired definition and select "delete".
Before any files can be selected for restore, XBRU must retrieve the contents of the archive. If the archive was created with the "On-Tape Directory" option, this is simply a matter of reading the file list from the archive. The "On-Tape Directory" is added by selecting "Create On-Tape Directory" from the backup options for XBRU ("Backup Options", section 3.5) or by adding a "-G" to BRU's command line for archives created from the command line (See the "BRU Technical Manual"). If the "On-Tape Directory" is not in the archive, then XBRU must scan the entire archive to get a listing, which can take quite a while. As previously suggested, considerable time can be saved by choosing "Create On-Tape Directory" when initially creating archives.
Figure 4.1 Restore Interface
Once XBRU retrieves the contents of an archive, a listing similar to the one used for selecting files for backup will be displayed. The box on the right will display the contents of the current "directory" (shown as stored on tape). Change directories by double-clicking on the selected directory. Double-click on files to add them to the restore list. Multiple files can be selected by holding down the <Shift> or <Ctrl> key while selecting files. Selecting "Add" will add all selected files.
Once all files/directories have been selected to be restored, click on the "Restore" button. A window will appear displaying each file as it is restored.
Restore options can be accessed by clicking the "Options" button on the "Restore" interface or by selecting "Restore" from the "Options" menu.
The "Restore Options" interface can be used to control features such as selecting which files are overwritten during a restore operation, restoring files to different names (Translate on Restore), and converting absolute pathnames to relative pathnames. See the "BRU Technical Manual" for further details regarding these options.
"Restore" settings can be saved for future use by selecting "Save Options" from the "Options" menu.
Figure 5.1 Listing Interface
XBRU also has options for displaying the contents of archives. Selecting the "List" button from the main display will display a listing interface. Three options are available: BRU's "Header", a "File Names Only" listing, and a "Full Details" listing.
This option displays BRU's archive header record, which lists items such as the archive label, creation date, BRU version and serial number used to create the archive, buffer size, system/machine the archive was created on, and a variety of other pertinent information. This is useful for determining how old the archive on the tape is, where it originated from, etc.
This option displays the "On-Tape Directory" that should be stored within the archive. If the archive was created without an "On-Tape Directory", XBRU will need to scan the entire archive to get the contents. A confirmation prompt will appear before this process takes place, as scanning the entire archive can take quite some time.
This option scans the entire archive, extracting such information as file names, permissions, owners, sizes, modification times, etc. A confirmation prompt will also appear for this process, as BRU must scan the entire archive to retrieve this information.
Figure 6.1 Verification Interface
Selecting the "Verification" button from the main display will display XBRU's "Archive Verification" window. BRU employs two methods for verifying archives.
As archives are created, BRU automatically calculates a checksum for each block of data written to the archive and stores it in the header for that block. Checksum Verification (also known as "Anytime Verify") reads each block of data, recalculates the checksum for that block of data, and compares it to the checksum that was written into the block header. XBRU will list each file as it is verified, along with any errors found. At the end of the operation, the total number of checksum errors found will be displayed. If no errors are found, then the integrity of the backup has been preserved and a user should have no trouble restoring it. One advantage to the Checksum Verification is that it can be done days, weeks, even months later with no loss of accuracy. Checksum Verification also allows for the process to be performed on a system other than the one the archive was created on.
Differences Verification performs the same kind of data-integrity check used by many other backup products. Frequently referred to as "bit-level verification", this mode allows BRU to compare the files in the archive to the files on the hard drive. Any discrepancies, such as changed modification times, content differences, or files in the archive that are not on the disk, will be noted. After BRU has completed the differences listing, it will insert a line stating "***END OF DIFFERENCES ***." If this is the only line that appears, the files in the archive are identical to the files on the hard drive.
XBRU supports the process of writing multiple archives to a single tape. This option is only available for tapes and does not function with disks. This is particularly useful in environments where restoring a single file is a frequent and time-consuming process, as BRU has to read an entire archive during the restore operation. This can result in the amount of time taken to restore a single file being comparable to the amount of time it took to create the backup in the first place.
This time factor can be reduced by splitting the backup into sections. For example, a directory such as "/home" is typically a good candidate for being a separate backup. If a separate archive is created for "/home", BRU only needs to scan that smaller archive during the restoration of any files in it.
Using XBRU to create multiple archives on a tape is a simple process. When creating a backup, XBRU will display a prompt requesting a selection to "Append" or "Overwrite" the tape. Selecting "Append" will create multiple archives on the tape.
Once multiple archives have been created on a single tape, specific archives can be selected with the "Next Archive" and "Prev Archive" options from the "Tape" menu. These options are used to navigate to and from different archives on the tape. When an archive is accessed, listings, verifications, and restores will become operational. When finished with the archive, the tape should be repositioned to the beginning of the archive. Use the "Rewind" button to reset the tape to the first archive.
XBRU also supports a number of other useful tape operations. These options are available from the "Tape" menu.
The extent of this command's functionality is based on the type of tape drive used. For some drives, it will write out fresh block information, allowing the tape to be used with multiple archives. For others, it will write an "End of Recorded Data" (EOD) mark to the beginning of the tape, effectively erasing it. Regardless of any of its proprietary functions, "Erase" will almost certainly DESTROY any existing data on the tape.
Retensioning a tape will forward it all the way to the end of the tape and then rewind it back to the beginning. This is useful for tapes that have been used many times over and may be experiencing write or read errors.
This option is also recommended before writing to any Travan drive (TR-3).
"Rewind" returns a tape to its beginning. This can be useful if a user has been working with multiple archives and wants to move quickly to the beginning of the tape.
XBRU can be configured to forward e-mail to a specified user when scheduled events (i.e. Backups, Restores, Listings) occur. This feature can be activated by running XBRU as root and selecting the "Mail-To:" option from the "Options" menu. A window will appear where a user's name can be specified and events can be selected to trigger the e-mail notification. Use "Save Options" from the "Options" menu to store the settings as "System-Wide defaults".
NOTE: The e-mail notification settings can only be accessed as root.