<h4>The Clients Interface</h4>
<font size=+1>
-<p>The Clients interface will show a list of clients and to allow the
-user to right click on a client to popup a context sensitive menu. The list of
+<p>The Clients interface will show a list of clients and allow the
+user to right click on a client item to popup a context sensitive menu. The list of
clients is a tree structure and will show a number of attributes from the database
for each client.
<font size=+1>
<p>The Console is the interface that displays all of the text that would
-normally be displayed in bconsole. Use the command window that by default is
-at the bottom of the window to manually enter in any command like would be done
-with bconsole.
+normally be displayed in bconsole. Use the command window at the bottom of
+the interface to manually enter any command as with bconsole.
<p>There are 2 icons in the taskbar which are designed to run console commands.
<h4>The Filesets Interface</h4>
<font size=+1>
-<p>The Filesets interface will show a list of filesets and to allow the
-user to right click on a fileset to popup a context sensitive menu. The list of
-filesets is a tree structure and will show a number of attributes from the database
-for each fileset.
+<p>The Filesets interface will show a list of filesets and allow the
+user to right click on a specific fileset to popup it's context sensitive menu.
+This interface is a tree structure and each item will display a number of
+attributes from the database for each fileset.
<p>The context sensitive menu will allow the user to perform the command status
fileset in the console. The user can also open up a new JobList window with the
<font size=+1>
<p>The <a href=console.html>Console</a> Interface
-<p>The <a href=clients.html>Clients List</a> Interface
+<p>The <a href=clients.html>Clients</a> Interface
+<p>The <a href=filesets.html>FileSets</a> Interface
<p>The <a href=jobs.html>Jobs</a> Interface
-<p>The <a href=joblist.html>Job List</a> Interface
-<p>The <a href=jobplot.html>Job Plot</a> Interface
+<p>The <a href=joblist.html>JobList</a> Interface
+<p>The <a href=jobplot.html>JobPlot</a> Interface
<p>The <a href=media.html>Media</a> Interface
<p>The <a href=storage.html>Storage</a> Interface
<p>The two <a href=restore.html>Restore</a> Interfaces
<h4>What is the BAT.</h4>
-<p>Welcome to the bacula administration tool. The bat is a graphical interface
+<p>Welcome to the Bacula Administration Tool. The bat is the graphical interface
to communicate with and administer the bacula director daemon. If you have been
-using bacula for a while, your familiar with bconsole, the text based interface
+using bacula for a while, you're familiar with bconsole, the text based interface
to administer bacula. With bat, the user can perform any command that can be
run from bconsole, and more.
<p>The bat is bconsole with extra communication capabilities and a set of
graphical user interfaces that utilize those capabilities. A bat programmer is
-able to create interfaces interact with the director in all ways that a user
+able to create interfaces that interact with the director in all ways that a user
can, by executing commands. When a command is entered by an interface, bat
-will type in the command in the console and will often times change the
-visible interface to the console so that the user can read the command as well
-as the resulting output from the director. Bat can also perform requests of the
-daemon, that the user normally would not do. These would be the ability to
-retrieve lists of various resources and also to perform requests of the director
+will type in the command in the console. Often times the interface visible will
+change to the console so that the user can read the command as well as the
+resulting output from the director. Bat can also perform requests of the
+daemon, that the user would not normally do. These requests would include the ability to
+retrieve lists of various resources and to perform instruct the director
to query director daemon's sql server. The director will then forward the
query results to bat.
<font size=+1>
<p>The JobList interface will display a table of job id's which are instances of
-a job being run. The table will display data for each job that is stored in the
+a job being run. The table will display data for each job stored in the
daemons sql backend. The table currently includes the job name, the client name,
the job type, the job level, the number of files, the number of bytes, the status,
-and the flag for whether the jobs files have been purged or not, and the jobs
+and a flag for the jobs files that have been purged or not, and the jobs
fileset.
-<p>The job type will be either "B" for backup or "R" for restore.
+<p>The job type is either "B" for backup or "R" for restore.
-<p>The job level will be "I" for incremental or "F" for full or "D" for differential.
+<p>The job level is one of "I" for incremental or "F" for full or "D" for differential.
<p>A purged value of 1 means that the files for that job have been purged and you
-will not be able to browse for the files backed up with that job id.
+are not be able to browse for the files backed up with that jobid.
-<p>This interface uses a splitter to divide the display of the table and the widgets
+<p>This interface uses a splitter to divide the display of the table and the controls
used to modify the selection criterion. There are 7 drop down boxes that can be used
to filter out the records in the table and to view only the items you are interested
in. There are two limiting spin boxes and related check boxes that can be used to
-limit the number of and the age of the records that will be displayed. These limiting
-widgets begin at default values that can be configured in the Settings->Preferences
-dialog box in the JoList tab.
+limit the number of and the age of the records that are to be displayed. These limiting
+controls begin with default values that can be configured in the Settings->Preferences
+dialog box in the JobList tab.
-<p>Pushing the Refresh button will cause the interface to re-query the database. The
-database will also be requerried every time it comes back to the top of the stack of
-interfaces in the main window. A refresh option also exists in the popup when right
+<p>Pushing the Refresh button causes the interface to re-query the database. The
+database does also get requerried every time it comes back to the top of the stack of
+interfaces in the main window. Another refresh option exists in the popup when right
clicking on the Joblist item in the Page Selector.
-<p>Pushing the Graph button will open up a new Job Plot interface with all of the
-drop downs and limiting widgets in the Job Plot window defaulting to the current
-settings of the widgets in the Job List window.
+<p>Pushing the Graph button opens up a new JobPlot interface. All of the
+drop downs and limiting controls in the JobPlot window default to the current
+settings of the controls in the JobList interface.
<p>There are many options in the context sensitive popup that appear when the user
right clicks on the job table.
<p>Listing console commands can be run to list the jobid, list the files on that jobid,
list the jobmedia for that jobid, and list the volumes used for that jobid. There is
-a preferences item to determine whether a long list or a short list command will be run.
+a preferences item to determine whether a long list or a short list command is run.
It can be found from the menu by following settings - preferences then the miscellaneous
tab.
-<p>Dangerous commands of delete and purge will be preceded by an are you sure dialog
+<p>Dangerous commands of delete and purge are preceded by an "Are You Sure?" dialog
box.
<p>An interface to view the logs that have been stored in the database for the jobid
can be viewed by using the show log for job option.
If the database does not have a log, an popup explaining the modification that
-should be made to the bacula-dir.conf file will come up. The change is to add
+should be made to the bacula-dir.conf file appears. The change is to add
catalog = all to the messages stanza of the messages resource that this job uses.
-<p>Restore from job will open up the Select jobs interface. It will be prepopulated
+<p>Restore from job opens up the Select Jobs interface. It opens prepopulated
with the correct data to open up a standard restore interface displaying the
-filestructure backed up when this job ran. It will only show the files from this job
-if you don't change the widgets in the "Select jobs interface"
+filestructure backed up when the job ran. It displays only the files from this job
+if you don't change the controls in the "Select jobs interface"
-<p>Restore from time will populate the Select jobs interface with the endtime of the job
-populated in the before time entry box. This will cause the daemon to use the before
-time to select the appropriate job id's for the restore. This will be the most recent
+<p>Restore from time populateis the Select Jobs interface with the endtime of the job
+populated in the Before Time entry box. This causes the daemon to use the Before
+Time to select the appropriate job id's for the restore. This contains the most recent
full backup, the most recent differential backup done since the most recent full, and
all the incremental backups done since the most recent full or differential. This job
-set will be the best possible group of jobs to restore what the filesystem looked like
+set is considered the best possible to restore to what the filesystem looked like
after that job ran.
</BODY>
<h1 align="center">Bat User's Guide</h1>
<br>
-<h4>The Job Plot Interface</h4>
+<h4>The JobPlot Interface</h4>
<font size=+1>
-<p>The Job Plot interface will have all of the same selection widgets as the
-Job List interface. It will also have widgets that will effect the plot's
+<p>The JobPlot interface will have all of the same selection widgets as the
+JobList interface. It will also have widgets that will affect the plot's
display. These settings will be saved and used the next time the interface
is opened. The user can change the Graph type to one of sticks, lines, steps
or none. The user can also turn one or both of the plots off with the File
<h4>The Jobs Interface</h4>
<font size=+1>
-<p>The Jobs interface will show the list of job resources. The data displayed
-for each job in this list are the defaults for the resource as defined in
-the bacula-dir configuration file. These defaults are the values that will be
-used when a job is run because it was scheduled to. They are also the values
-that will be filled in by default if the job is run manually.
-
-<p>The context sensitive list that pops up when a job is right clicked will
-include a number of commands as well as two to open up other interfaces.
-
-<p>The user can run a list files command in the console that will display a
-list of job id's that have been run and some associated data. This is similar
+<p>The Jobs interface shows a table of job resources. The data displayed
+for each job in this list are the defaults for the job resource as defined in
+the bacula-dir configuration file. When a job is run due to being scheduled,
+these defaults are the values that will be used. They are also the values
+that are populated by default if the job is run manually.
+
+<p>The context sensitive popup menu includes a number of options. There are
+options to run commands and there is an option to open up a different
+interface.
+
+<p>The user can run a list files command in the console that displays a
+list of jobid's that have been run and some associated data. This is similar
output to what can be seen in the joblist interface.
-<p>The console command list volumes can be run to output a list of volumes that
+<p>The list volumes console command can be run to output a list of volumes that
have this jobs files stored on it.
-<p>The list nextvolume console command will tell the user the next volume that
-will be asked for when this job is run. It will also show a list of past jobs.
+<p>The list nextvolume console command tells the user the next volume that
+will be asked for when the job is run. It also shows a list of past jobs.
<p>There is a preferences item to determine whether a long list or a short list
-command will be run. It can be found from the menu by following settings -
+command is run. It can be found from the menu by following settings -
preferences then the miscellaneous tab.
-<p>There are options to run commands to enable or disable the job as scheduled.
-If disabled, the job will be re-enabled when the director daemon is restarted.
+<p>There are options to run commands to either enable or disable the job as scheduled.
+If disabled, the job is re-enabled when the director daemon is restarted.
-<p>The cancel job command will cancel any running job id's with this job
+<p>The cancel job command is to cancel any running job id's with the job
definition.
-<p>The open joblist option will create a new JobList interface and pre-populate
-the job dropdown list selecting only jobid's run with this jobs resource.
+<p>The open joblist option is to open a new JobList interface and pre-populate
+the job dropdown list with the jobs resource name.
-<p>The run job option will open up the run job interface prepopulating the job
+<p>The run job option is to open the run job interface prepopulating the job
dropdown box with the selected job.
</BODY>
<h4>The Media Interface</h4>
<font size=+1>
-<p>The Media interface will display a tree structure of pools, and under each
-pool branch, will be items representing the volumes in the pool. The display
-will show data that are the values in the database for each volume. With this
+<p>The Media interface displays a tree structure of pools, and under each
+pool branch, are items representing the volumes in the pool. The display
+shows data that are the values in the database for each volume. With this
interface, the user can manage tape volumes and file volumes.
-<p>The context sensitive menu will allow the user to open up other interfaces
+<p>The context sensitive menu allows the user to open up other interfaces
and to perform commands in the console that may be run with the desired media
having been identified. These commands include deleting the volume, purging
the jobs and files backed up on the volume from the catalog, and pruning the
bacula-dir.conf. There is also a command to reset the parameters on the volumes
based on the parameters of the pool resource.
-<p>Other interfaces can be opened up from the context sensitive menu. You can open
-up a Job List interface with the media drop down widget preselecting the jobs
-that have been written to the selected volume. The user can open up the relabel
-dialog box. The user can also open up the Edit a Volume interface which will
-allow the user to modify all user editable data items for the volume.
+<p>Other interfaces can be opened up from the context sensitive menu. The user
+may open up a JobList interface. This interface is opened with the media
+drop down control preselected This shows jobs that have been written to the
+volume. The user can open up the Relabel a Volume dialog box. The user can also open
+up the Edit a Volume interface which allows the user to modify all user
+editable data items for the volume.
</BODY>
</HTML>
<p>Both restore interfaces accomplish the same 3 steps in different ways.
Those steps are to select jobs to restore from, give the user the
-opportunity to select files and directories and then run the restore job.
+opportunity to select files and directories, then indicate details of
+the host and path to restore to and run the job.
<h2>The Standard Restore Interface</h2>
menu to start a restore. They are restore from time or restore from job.
<p>This interface is intended as a high performance restore option.
-It is a server side process. These interfaces assist in user in using the
+It is a server side process. These interfaces assist the user in utilizing the
text based restore capabilities of the standard console. It interprets the text
to display the information in a way that simplifies the restore procedure.
-<p>The Opening interface will allow the user to choose selection criterion to
+<p>The Opening interface allows the user to choose selection criterion to
inform the server how to determine the set of backup job ids to use in the
-restore. This best possible set will be the most recent full backup, the most
+restore. This best possible set is be the most recent full backup, the most
recent differential backup done since the most recent full, and all the
incremental backups done since the most recent full or differential. Then the
-server will use this set of jobs to create a file structure that will be the
+server uses this set of jobs to create a file structure that is the
most recent version of each file found in this job list.
-<p>After the select box OK button has been pushed, a limitation in bat will
-occur that will be resolved in future. The restore process will take control
-of the connection to the server and will not allow any other communication to
+<p>After the select box OK button has been pressed, a limitation in bat
+occurs that will be resolved in the future. The restore process takes control
+of the connection to the server and does not allow any other communication to
the server by any other interface.
-<p>The second interface will allow the user to browse this file structure and
-choose the files and directories to restore. This will be done in an explorer
+<p>The second interface allows the user to browse this file structure and
+choose the files and directories to restore. This is be done in an explorer
type interface with a directory tree on the left. In the right pane of a
-splitter will be a table showing a list of files and directories that are the
+splitter is be a table showing a list of files and directories that are the
contents of the directory selected in the left pane. The user can mark and
unmark either with the buttons on the top or by double clicking on the check
mark icon to toggle whether an item is selected or not. Double clicking an
item which is a directory on a part of the table which is not the check icon
-will open that directory. Clicking on OK will complete the selection process.
+opens that directory. Clicking 'OK' completes the selection process.
-<p>The third step is a drop down interface that appears to be similar to the
-first but is different. It is the Restore Run interface and will run the job
-after allowing the user to inform the bacula server details of what host and
-where to restore the files to.
+<p>The third step is the Restore Run interface. It's purpose is to allow the
+user to inform the bacula server details of the host and path to restore to, the
+replacement rules, when to restore and what priority to give the restore job.
<h2>The Version Browser Restore Interface</h2>
process. The user can have an unlimited number of selection windows open at a
time for viewing the cataloged jobs, directories, files and versions.
-<p>This restore interface is NOT intended to preform major restores of directory
+<p>This restore interface is <b>NOT</b> intended to preform major restores of directory
structures with large numbers of directories and files. It should work, however
-it is a chatty interface and will perform a number of sql queries of the server
-proportional to the number of files and directories selected and the number of
-exceptions to defaults selected. It IS intended to allow the user to browse for
+it is a chatty interface. This is due to the number of sql queries made of the server
+which is proportional to the number of files and directories selected plus the number of
+exceptions to defaults selected. It <b>IS</b> intended to allow the user to browse for
specific files and choose between the different versions of those files that
are available in the catalog to restore.
lastly the fourth widget is for viewing a table of versions of a single file
that has been selected from the file widget.
-<p>The version browser accomplishes the 3 restore steps, but does it a little
-differently.
+<p>The version browser accomplishes the three restore steps differently.
<p>To select jobs and populate the directory tree, press the refresh button.
-The job table will contain selected jobs. The selection criterion of the three
-drop downs and the 2 limits will be used as the filtering criterion for
+The job table contains selected jobs. The selection criterion of the three
+dropdowns and the two limits are used as the filtering criterion for
populating the job table the first time the refresh button is pushed.
After the refresh button has been pushed, the job table has check marks that
-can select and unselect jobs. Re-pressing the refresh button will do one of 2
-things and this is dependent on whether the widgets in the bottom control pane
+can selects and unselects jobs. Re-pressing the refresh button does one of two
+things. What occurs is dependent on if the controls in the bottom pane
display the same data as the previous time the refresh button was pressed. If
-changed the jobs table will be repopulated from the selection criterion. If
-unchanged any jobs that have been unchecked will then be excluded from the
-process of selecting directories, files and versions. The directory tree will
-be immediately repopulated. There is a text label underneath the
-refresh button to inform the user as to which of these two will happen.
+changed the jobs table is repopulated from the selection criterion. If
+unchanged any jobs that have been unchecked are excluded from the
+process of selecting directories, files and versions. The directory tree does get
+repopulated when the refresh button is pushed. There is a text label underneath the
+refresh button to inform the user as to which occurs when refresh is pressed.
<p>The user can browse the directory tree and click on a directory folder which
-will then populate the file table with the files that are contained in the
-selected directory path. Selecting or unselecting a directory will select or
+then populates the file table with the files that are contained in the
+selected directory path. Selecting or unselecting a directory does also select or
unselect all files and all directories in the tree hierarchy beneath it. If
there are any exceptions already selected beneath that directory, those
-exceptions will be deleted.
+exceptions do get deleted.
<p>With the file table populated, the user can unselect a file in a selected
directory and also select a file in an unselected directory.
-<p>With a file selected the version table will populate with all the instances
+<p>With a file selected the version table populates with all the instances
a file has been written to tape. The user can choose a specific version of a
file for restore and override the default which is to restore the most recent
version.
-<p>Pressing the restore button will initiate a procedure of preparing to
+<p>Pressing the restore button initiates a procedure preparing to
perform the restore of the requested files. The same Restore Run interface
-that was the third step in the standard restore will then be displayed. It
-will allow the user to instruct the bacula server of the details of what host
-and what path to restore the files to. This part of the restore will take a
-hold of the connection to the server and not allow any other communication
+that was the third step in the standard restore is then displayed. It
+allows the user to instruct the bacula server of the details of what host
+and what path to restore the files to. This part of the restore does take control
+of the connection to the server and does not allow any other communication
to the server by the other interfaces.
-<p>There are two progress bars that will appear when refreshing or restoring
-to allow the user to understand how much time it may take to complete any tasks
+<p>There are two progress bars that appear when refreshing or after pressing
+Restore. These indicate to the user the time it may take to complete any tasks
that could take a long time period.
</BODY>
<h4>The Storage Interface</h4>
<font size=+1>
-<p>The Storage interface will show a list of storage resoruces and to allow the
+<p>The Storage interface shows a list of storage resoruces and allows the
user to right click on a storage to popup a context sensitive menu. The list of
-storages is a tree structure and will show the storage id and the auto changer
-flag.
+configured storage device resources is a tree structure and shows the storage id
+and the auto changer flag.
-<p>The context sensitive menu will allow the user to perform commands in the
+<p>The context sensitive menu allows the user to perform commands in the
console that may be run with the desired storage having been identified. These
commands include requesting the status of the storage, and to mount, unmount and
release the media in the storage device.
-<p>If the autochanger flag is true, there will be two additional options in the
-context sensitive menu. These are options to run the commands to update slots
+<p>If the autochanger flag is true, two additional options in the context
+sensitive menu are found. These are options to run the command to update slots
and the command to update slots scan.
</BODY>
projects / bacula / bacula / commitdiff