XBP Main Window --> Introduction --> The xbp Window -- Menus -- Search Criteria -- Panes -- Special Symbols in Menus and Dialog Boxes --> Customizing xbp ============ Introduction This help topic describes the layout and usage of the main window for the xbp program. For an overview of xbp, see the Tutorial help topic. When you first start xbp, it begins in the default mode, browse the file system. You use this mode to browse for files and directories to back up or for database agent scripts to invoke for backup or restore operations. The other mode in xbp is browse the NetBackup database for items to restore. Note The xbp program does not support AFS restores. Use the Backup, Archive, and Restore interface for AFS restores. ========== xbp Window When you start the X-Windows interface, it is in the Browse file system (backup or archive) mode and shows all directories and files that reside under the directory from which you executed the xbp command. The default date range is from 01/01/70 to the current date. When you switch from backup mode to restore mode, NetBackup normally changes the starting date so that it defaults to the most recent full backup. However, if you type a specific date just before changing modes, your specification is used. If the client belongs to more than one policy, the start date defaults to the last full backup that occurred first. You can open menus from the menu bar to start backup, archive, and restore operations. The text boxes let you enter specific values for finding and selecting directories and files. The lists show information about selected directories and files. ---- Menus The menus in the xbp window enable you to start backup, archive, and restore operations. For options that have an ellipsis (three dots at the end), a dialog appears in which you can provide more information before continuing. When a menu option is in gray rather than black type, it cannot be selected; you have not yet taken the steps that would be a prerequisite to executing the option. -- File Menu The File menu has commands for finding and selecting files for NetBackup operations. You can also browse for and select database scripts. Browse file system (backup or archive) Causes NetBackup to update its Directory Structure pane and the Files pane with directories and files that meet the criteria entered in the Directory to Search box, the Range of Dates boxes, the Filename Filter box, and the Keyword phrase to search for box. Browse backups (restore) Causes NetBackup to build a list of the backups that exist for this client. The completed list appears in a Backup Images pane that opens in the main window. Browse backups (true image restore) Causes NetBackup to build a list of the true image backups that exist for this client. The completed list appears in a Backup Images pane that opens in the main window. Browse archives (restore) Causes NetBackup to build a list of the archives that exist for this client. The completed list appears in a Backup Images pane that opens in the main window. Browse backups (restore raw partitions) Causes NetBackup to build a list of the raw partition backups that exist for this client. The completed list appears in a Backup Images pane that opens in the main window. Browse backups (Auspex FastBackup raw partition) Auspex FastBackup is not supported in NetBackup 5.1. Browse file system for database extension NetBackup offers database extensions that you can use, in conjunction with xbp, to back up and restore many of the most popular databases. These NetBackup for database extensions are separately priced products which must be installed, then configured to work with xbp. See the system administrator's guide for the database extension for details. The Browse File System commands enable the NetBackup for database extension. They cause NetBackup to update its Directory Structure pane and the Files pane to show all directories and files that meet the criteria of the Directory to Search box, the Range of Dates boxes, Filename Filter box, and the Keyword phrase to search for box. Configuration Opens the xbp_config dialog box from which you can specify the master server, the client to browse for restores, the client to restore to, and the policy type of images to browse. Quit Terminates the X-Windows interface. -- Edit Menu The Edit menu has commands to modify your selections. Clear selections for current directory Clears file selections from the Files pane. You must use Discard selections for previous directories to clear the xbp_confirm dialog box. Select all in current directory Selects all the files in the Files pane. Discard selections for previous directories Clears file selections from the xbp_confirm dialog box. Inspect all selections Opens the xbp_viewselect dialog box, which shows you the files that are currently selected. This dialog box has only information and no commands except to close the dialog box or to obtain help. Update Display Rereads your directory tree and updates the Directory Structure pane and the Files pane. This is equivalent to pressing Enter in any of the text boxes. -- View Menu The View menu has commands that modify how NetBackup shows directory and file information in the Directory Structure pane and the Files pane. Brief display of filenames Shows filenames without details. The display starts in brief mode. Verbose display of attributes and filenames Shows file details such as size and file permissions. Indented tree structure Indents items in the Directory Structure pane to showthe hierarchy of the directory tree. You can use either Indented tree structure or Full Pathnames mode, but not both. The default is indented mode. Full Pathnames Shows full pathnames in the Directory Structure pane. You can use either Full Pathnames or Indented tree structure mode (see above), but not both. The X-Windows interface starts in the indented mode. All backup dates for each file Shows all backups for each file in the Files pane. You can execute this command only when the File menu is set to one of the browse backups mode or archives modes (diamond shape to the left of those entries). The choice is unavailable when you browse the file system. The All backup dates for each file and Only most recent backup date choices are mutually exclusive. You can use either but not both. The X-Windows interface starts in the All backup dates for each file mode. Only most recent backup date Shows only the most recent backup of a file in the Files pane. This command is useful if you lose a directory and want to get the most recent copy of all files (which may be spread across many backups). You can execute this command only when the File menu is set to one of the browse backups mode or archives modes (diamond shape to the left of those entries). The choice is unavailable when you are browsing the file system. The All backup dates for each file and Only most recent backup date choices are mutually exclusive. You can use either but not both. The X-Windows interface starts in the All backup dates for each file mode. Resolve Links in Search Directory If you click this command, NetBackup automatically changes any links in your search path so the path points to the actual file or directory. This is the default. Do Not Resolve Links in Search Directory If you click this command, NetBackup searches for the path as you type it in, without resolving links. -- Backup Menu The Backup menu has commands to start a backup or archive of selected files and directories. You can also obtain a progress report on backups or archives. The File menu must be set to a browse file system mode (diamond shape to the left of the command) before you can execute any Backup menu commands, other than the report on progress. If the X-Windows interface is in a restore mode, when you pull down the Backup menu, the backup commands are unavailable. Note If you click Backup selected files and directories or Archive selected files and directories but then close the xbp_confirm dialog box without confirming your selections, you are returned to the main window. Your file selections, however, remain in the xbp_confirm dialog box. This feature is useful if you want to return to the main window to edit your selections. To clear previous file selections, click Discard selections for previous directories on the Edit menu. Backup selected files and directories Starts a backup of the current selections from the Files pane by opening the xbp_confirm dialog box. This dialog box shows the current selections. Click OK to execute the backup. Click Cancel to abort and return to the main window. Backup search directory Starts a backup of the current selection from the Directory Structure pane by opening the xbp_confirm dialog box. This dialog box shows the current selection. Click OK to execute the backup. Click Cancel to abort and return to the main window. Backup database using selected scripts NetBackup offers database extensions that you can use, in conjunction with xbp, to back up and restore many of the most popular databases. These NetBackup for database extensions are separately priced products which must be installed, then configured to work with xbp. See the system administrator's guide for the database extension for details. This command starts a backup of a database by opening the xbp_confirm dialog box. This dialog box shows the scripts you selected from the Files pane. Click OK to execute the backup. Click Cancel to abort and return to the main window. Archive selected files and directories Starts an archive of the current selections from the Files pane by opening the xbp_confirm dialog box. This dialog box shows the current selections. Click OK to execute the backup. Click Cancel to abort and return to the main window. Archive search directory Starts an archive of the current selection from the Directory Structure pane by opening the xbp_confirm dialog box. This dialog box shows the current selection. Click OK to execute the backup. Click Cancel to abort and return to the main window. Report progress of backup Opens the xbp_progress dialog box, which shows the log files pertaining to your backup operations. Report progress of archive Opens the xbp_progress dialog box, which shows the log files pertaining to your archive operations. -- Restore Menu The Restore menu has commands to start a restore of selected files and directories. You can also obtain a progress report on restores. The File menu must be set to a Browse mode (diamond shape to the left of the command) before you can execute any Restore menu commands, other than the report on progress. Otherwise, when you pull down the Restore menu, those choices are unavailable. Note If you click Restore selected files and directories but then close the xbp_confirm dialog box without confirming your selections, you are returned to the main window. Your file selections remain in the xbp_confirm dialog box. This feature is useful if you want to return to the main window to edit your selections. To clear those previous file selections, click Discard selections for previous directories on the Edit menu. Specify Destination Path Opens the xbp_destpath dialog box. This dialog box lets you redirect the restore to a directory other than the one from which they were backed up. If you specify a path that does not exist, NetBackup creates it when restoring the file. Restore selected files and directories In all browse modes except true image restore, this command starts a restore of current selections in the Files pane. In true image restore mode, this command starts a true image restore of the selected directory. In both cases the xbp_confirm dialog box opens to show the current selections. Click OK to execute the backup. Click Cancel to abort and return to the main window. Restore search directory This command starts a restore of the current selection in the Directory Structure pane by opening the xbp_confirm dialog box. This dialog box shows the current selections. Click OK to execute the backup. Click Cancel to abort and return to the main window. This command is not available in Browse backups (true image restore) mode. Restore database using selected scripts These commands start a restore of their respective type of database by opening the xbp_confirm dialog box. This dialog box shows the scripts you selected from the Files pane. Click OK to execute the backup. Click Cancel to abort and return to the main window. NetBackup offers database extensions that you can use, in conjunction with xbp, to back up and restore many of the most popular databases. These NetBackup for database extensions are separately priced products which must be installed and configured to work with xbp. See the NetBackup system administrator's guide for the specific database extension for details. Report progress of restore Opens the xbp_progress dialog box, which shows the log files pertaining to your restore operations. -- Help Menu The Help menu has instructions for using the X-Windows interface. --------------- Search Criteria The search criteria are the constraints for searches performed in the file system or in the NetBackup database. You can change any of the search criteria. When you press the Enter key while positioned in any of the fields, xbp refreshes the display with the results of the new search criteria; therefore, if you change more than one field, press Enter in the last field so xbp will search once only. When you change modes to browse the database, xbp automatically searches the database if there are fewer than 10,000 files in all of the backup images that match the range of dates. If there are 10,000 or more, xbp warns you about the number of files in the search. This warning is based on the total number of files, before considering the pathname or depth limit or filename filter, so it represent a "worst case" warning. You can review and modify the search criteria before continuing. To continue, either use the Update Display command in the Edit menu or press the Enter key in one of the search criteria fields. You can modify the threshold of 10,000 database entries for deferred searching by adding the -browselimit option and argument to the xbp command line, as in the following example: /usr/openv/netbackup/bin/xbp -browselimit 1000000 & - Directory to Search The Directory to Search is the position in the directory tree to begin searching for images. When you first start xbp, this is set to the directory from which you started xbp. You can enter a new directory path or select a directory in the Directory Structure pane. You can use the wildcard characters. If you are backing up or restoring a file path that has a wildcard character used literally (that is, as a non-wildcard character), you must escape the wildcard by using a backslash (\) character. - Range of Dates The two date fields limit the search of the file system or database: * For file system mode, the defaults are "forever" (1970 until the current time). Items that have a modification date within the date range and are in the search path are displayed. * When browsing for restores, the defaults are from the most recent full backup until the current time. Backups that occurred during the date range are displayed. If you change the range of dates and then switch modes, xbp uses the range of dates rather than the default ranges. If you do not enter a time in the Range of Dates fields, xbp uses 00:00:00 for start date time and 23:59:59 for the end date time. Dates use the mm/dd/yyyy format, and times use the 24 hour clock format. The Directory Structure pane and the Files pane will show only those files that meet the date range criteria. The administrator can change the initial browse default to show a smaller range of dates by using the INITIAL_BROWSE_SEARCH_LIMIT option in the server and client /usr/openv/netbackup/bp.conf files. For a backup or archive, enter the range of dates that includes the times when the desired files were last modified. For a restore, enter the range of dates that includes the times when you suspect the desired backups or archives occurred. - Keyword Phrase to Search For When browsing for items to restore (other than database agent restores), a keyword field by which to search for backup images also is displayed. The keyword restricts the search to only those images that have that keyword associated with them (keywords are entering during backups and archives. The keyword can contain the following meta characters, which make searching easier: * - Asterisk (*) matches any string of characters ? - Question mark (?) matches any single character When you back up files, you can specify a keyword to associate with the backup. - Directory Depth The Directory Depth controls how many directories below the current directory are displayed in the xbp window (and searched). It has no effect on the Files pane. Increment or decrement the depth by typing a new value. The default is 2. - Filename Filter The Filename Filter controls which items are displayed in the Files pane. When you start xbp, the Filename Filter box has a value of * and the Files pane shows all files. You can change the filter to limit the files that NetBackup shows. In addition to specific file names, you can use the following types of expressions to filter filenames: * - Asterisk (*) matches any string of characters ? - Question mark (?) matches any single character []- Brackets ([]) specify any of the listed characters. ----- Panes Panes display the results of searches performed by xbp. -- Backup Images Pane A Backup Images pane appears when restoring files and directories. The pane shows the backup images that satisfy the search criteria. The list of backup images starts with the most recent backup or archive. The list contains the following information on each backup: Backed Up Date and time at which the backup occurred. Expires Date and time at which NetBackup expires the backup and removes it from the Backup Images pane. Files Number of files in the backup. KB Size of the backup in kilobytes. Sched Type Shows the type of schedule as follows: - Full Backup - Incr Backup - User Backup - User Archive Policy Backup policy that created the backup. The system administrator configures the policy names, as explained in the NetBackup System Administrator's Guide, Volume I. Keyword Shows the keyword entered by the user when the backup was initiated. When browsing for restores, if you click on a backup ID in the Backup Images pane, the date range will be constrained to that image. You can drag the mouse pointer across multiple backup images to select a range of dates for the Range of Dates fields. This new range of dates will take effect the next time you refresh the display. The rules for selecting backups from the Backup Images pane are: * Selecting a specific backup changes both dates to show the backed up time for the selected backup. * Selecting a range of consecutive backups changes the date boxes to show the oldest and newest times in the selected range. * Selecting another backup cancels previous selections. If the list is longer than the window, a vertical scroll bar appears along the right edge. -- Directory Structure Pane The Directory Structure pane shows the directories that match the search criteria. The number of directories displayed is controlled by the Directory Depth field. You can perform single or double mouse clicks on items in the Directory Structure pane: * A single click refreshes the Files pane. The Directory to Search field is updated, and the Files pane is updated with the files in the Directory to Search path. * A double click refreshes the Directory Structure and Files panes. The Directory to Search field is updated, the directory double-clicked becomes the current directory in the Directory Structure pane, and the Files pane displays the files in the new current directory. -- Files Pane Files that match the search criteria and are in the current directory in the Directory Structure pane are listed in the Files pane. (True image restores apply only to directories; the Files pane will not show regular files when you are doing true image restores.) Files selected in the Files pane are the files that are backed up, restored, or invoked (for database agent scripts). To select a file, click it; to deselect it, click it again. You can select any number of files, contiguous or noncontiguous. You can use Edit menu options to select all or deselect all items in a directory. You can change directories and select other files; all files selected are added to a selection list. To remove files selected in previous directories, click Edit > Discard Selections in Previous Directories. You can view the selected files by clicking Edit > Inspect All Selections. When you initiate a backup, archive, or restore operation, the confirmation dialog lists all of the files that you selected in all directories. ----------------------------------------- Special Symbols in Menus and Dialog Boxes You will encounter the following symbols as you use the menus and dialog boxes: * An ellipsis (...) to the right of a menu item means that when you select the item, a dialog box with additional choices appears. If there is no ellipsis in a menu item, the operation occurs as soon as you select it. * A diamond shape to the left of a menu item means that two or more mutually exclusive modes exist and the mode set by this menu item is currently in effect. For example, if you intend to restore an archived file, you want the diamond to the left of Browse archives (restore). * An underlined letter in a menu label means a keyboard shortcut. For example, on an NCD terminal, pressing ALT in conjunction with a shortcut key opens the associated menu. For example, pressing ALT+V opens the View menu. Note that some terminals may require a key other than ALT. * Once a menu is opened, a letter (by itself) is sufficient to execute a menu item tagged with that letter (pressing i on the View menu changes the Directory Structure pane format to indented). You can use the up and down arrow keys to move the highlight through the various menu items and press Enter to execute the highlighted item. The Escape key closes a menu. The left and right arrow keys open adjacent menus. * If the pointer is over the main window, its shape changes to a wristwatch shape while NetBackup is waiting for an operation to complete. For example, the pointer changes to a wristwatch shape when NetBackup is updating its displays and then changes back to an arrow when the update is complete. =============== Customizing xbp Borders on windows may vary depending on the window manager used at your site (popular examples are twm and mwm). With some window managers, you may have to click the left mouse button to position the window if it does not appear in a few seconds. You can also use your window manager to resize the window. The xbp program has enough space in its text fields to accommodate user-selected fonts up to the 10x20 size. The windows can also fit on a 1024x768 screen with some room for window manager borders. There is no default font. If the XNB resource file is in the X search path, xbp uses the values set in XNB. On some systems, the default font may be too small. On other systems, the default font may have proportional spacing, causing column misalignment on certain fields that have columnar text. You can modify certain aspects of xbp screen appearance to meet personal preferences and hardware constraints by using X Window System resource definitions. The following are the xbp resources you can configure: xbp*fontList: value The fontList resource determines what font will be used in xbp displays. The default font may be too small for many users on some client systems. The "value" for a fontList resource is a font name as installed on your system by the administrator. For example, "9x15" is often installed as a font that is 9 pixels wide and 15 pixels tall. Note that some fields in xbp windows contain text in columns, for which it is desirable to use a fixed-width font. If your X server defaults to usage of variable fonts and you do not know what font name to use, try "fixed". The xbp text fields are large enough to accomodate font sizes up to 10x20. Because the default window sizes are small enough to fit on a 1024x768 screen, you may find that with larger fonts, the verbose display mode forces you to use a horizontal scrollbar to see all the information. Widening the window at runtime with the window manager may eliminate the scrollbar. xbp*geometry: value The "geometry" resource determines the initial size and position of the main window. If you are using a large font and have a very high resolution screen (higher than 1024x768), you may prefer to use a larger window size than the built-in default. Specify the width, then height, with the letter "x" between the width and height. If you are trying to make it use your entire screen, you should remember to allow a few dozen pixels for window manager framing. The xbp windows are sized to be no taller than 740 pixels and no wider than 990 pixels, which leaves some room for window manager borders to fit on a 1024*768 screen size. xbp*title: mytitle The "title" resource determines the text of the label in the titlebar added by your window manager. If you run several instances of the same program simultaneously, it can be helpful to label each one uniquely. -- Command Line Specifications To set resources on the command line, use the options "-fn" or "-font" for the fontList resource, or "-geometry" and "-title" for the geometry and title resources. Following is an example: xbp -font 10x20 -geometry 900x600 -title anytext & Note that if resource files are present, they override command line options. -- XKeysymDB file The xbp program depends upon the /usr/lib/X11/XKeysymDB file to correctly use editing keystrokes such as backspace and delete. The NetBackup installation procedures are designed to install a nominal version of this file if it does not already exist. An existing version of the file is not overwritten, thereby ensuring that user-customized versions of XKeysymDB are not destroyed. Sun systems typically have a version of XKeysymDB that does not define some editing keys. Either you or the administrator must compare your current XKeysymDB file to the NetBackup standard version /usr/openv/netbackup/bin/XKeysymDB on NetBackup server machines. Then do one of the following: * Append the NetBackup version onto the existing one. * Replace the existing one with the NetBackup version. * Edit the existing version to achieve your preferred keyboard support.