From: Dirk H Bartley Date: Sat, 4 Aug 2007 17:51:27 +0000 (+0000) Subject: Further work on help files. X-Git-Tag: Release-7.0.0~5903 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=8a9a742373612eaf394f2f214c7efcf03b766510;p=bacula%2Fbacula Further work on help files. git-svn-id: https://bacula.svn.sourceforge.net/svnroot/bacula/trunk@5283 91ce42f0-d328-0410-95d8-f526ca767f89 --- diff --git a/bacula/src/qt-console/help/clients.html b/bacula/src/qt-console/help/clients.html new file mode 100644 index 0000000000..5d943729f0 --- /dev/null +++ b/bacula/src/qt-console/help/clients.html @@ -0,0 +1,32 @@ + + + +Bat User's Guide + + + + + + + + +

Bat User's Guide

+
+ +

The Clients Interface

+ +

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 +clients is a tree structure and will show a number of attributes from the database +for each client. + +

The context sensitive menu will allow the user to perform commands in the +console that may be run with the desired client having been identified. These +commands include requesting the status of the client, and pruning or purging +jobs and files from the catalog. + +

To understand pruining and purging, please read the bacula docuemtation at +the following url: http://www.bacula.org/rel-manual/Bacula_Console.html + + + diff --git a/bacula/src/qt-console/help/console.html b/bacula/src/qt-console/help/console.html index 8521b0c3e4..e356f4be89 100644 --- a/bacula/src/qt-console/help/console.html +++ b/bacula/src/qt-console/help/console.html @@ -20,7 +20,16 @@ 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. -

An alphabetic list of the commands can be found on the following web url +

There are 2 icons in the taskbar which are designed to run console commands. + +

Use the status +icon in the taskbar to run the status dir command. + +

Use the messages icon in the taskbar to run the messages command. + +

There will be no attempt to document console commands here. An alphabetic list of +the commands can be found on the following web url http://www.bacula.org/rel-manual/Bacula_Console.html diff --git a/bacula/src/qt-console/help/filesets.html b/bacula/src/qt-console/help/filesets.html new file mode 100644 index 0000000000..1025417883 --- /dev/null +++ b/bacula/src/qt-console/help/filesets.html @@ -0,0 +1,28 @@ + + + +Bat User's Guide + + + + + + + + +

Bat User's Guide

+
+ +

The Filesets Interface

+ +

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. + +

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 +Fileset dropdown pre-populated with the selected fileset. + + + diff --git a/bacula/src/qt-console/help/index.html b/bacula/src/qt-console/help/index.html index 38e7ec9a93..f4861d76d5 100644 --- a/bacula/src/qt-console/help/index.html +++ b/bacula/src/qt-console/help/index.html @@ -11,33 +11,42 @@

Bat User's Guide

-
-The User's guide, for the Bacula Administration Tool. + +
The User's guide, for the Bacula Administration Tool.
+

Welcome to the BAT

-

Contents.

+

Contents.

The Console +

The Clients List +

The Jobs Interface +

The Job List +

The Job Plot +

The Media +

The Storage +

The two Restore Interfaces -

Welcome and What is The BAT.

+

What is the BAT.

Welcome to the bacula administration tool. The bat is a 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 -to administer bacula. With bat, the user can use the console class to perform -any command that can be done from bconsole, and more. +to administer bacula. With bat, the user can perform any command that can be +run from bconsole, and more.

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 design interfaces interact with the director in all ways that a user +able to create interfaces interact with the director in all ways that a user can, by executing commands. When a command is entered by the interface, bat will type in the command in the console and will often times change the -interface visible to the console so that the user can see the command as well -as the resulting output from the director. Bat can also do some requests of the +interface visible 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 -to query the sql server the daemon is using and return the results to bat. +to query director daemon's sql server and the director will return the query +results to bat. diff --git a/bacula/src/qt-console/help/joblist.html b/bacula/src/qt-console/help/joblist.html new file mode 100644 index 0000000000..168762dc25 --- /dev/null +++ b/bacula/src/qt-console/help/joblist.html @@ -0,0 +1,77 @@ + + + +Bat User's Guide + + + + + + + + +

Bat User's Guide

+
+ +

The JobList Interface

+ +

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 +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 +fileset. + +

The job type will be either "B" for backup or "R" for restore. + +

The job level will be "I" for incremental or "F" for full or "D" for differential. + +

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. + +

This interface uses a splitter to divide the display of the table and the widgets +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. + +

Pushing the Refresh button will cause the interface to requery 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 +clicking on the Joblist item in the Page Selector. + +

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. + +

There are many options in the context sensitive popup that appears when the user +right clicks on the job table. + +

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. + +

Dangerous commands of delete and purge will be preceeded by an are you sure dialog +box. + +

An interace to view the logs that have been stored in the database for the jobid. +If the database does not have a log, an interface explaining the modification that +should be made to the bacula-dir.conf file will come up. The change is to add +catalog = all to the messages stanza of the messages resourse that this job uses. + +

Restore from job will open up the Select jobs interface. It will be 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" + +

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 +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 +after that job ran. + + + diff --git a/bacula/src/qt-console/help/jobplot.html b/bacula/src/qt-console/help/jobplot.html new file mode 100644 index 0000000000..5a0df420c2 --- /dev/null +++ b/bacula/src/qt-console/help/jobplot.html @@ -0,0 +1,27 @@ + + + +Bat User's Guide + + + + + + + + +

Bat User's Guide

+
+ +

The Job Plot Interface

+ +

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 +display. These settings should 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 +Data and the Byte Data check boxes. The symbol type for each plot's points +can be changed as well. + + + diff --git a/bacula/src/qt-console/help/jobs.html b/bacula/src/qt-console/help/jobs.html new file mode 100644 index 0000000000..6ea46d222f --- /dev/null +++ b/bacula/src/qt-console/help/jobs.html @@ -0,0 +1,50 @@ + + + +Bat User's Guide + + + + + + + + +

Bat User's Guide

+
+ +

The Jobs Interface

+ +

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. + +

The context sensitive list that pops up when a job is right clicked will +include a number of commands as well as 2 to open up other interfaces. + +

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 +output to what can be seen in the joblist interface. + +

The console command list volumes can be run to output a list of volumes that +have this jobs files stored on it. + +

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. + +

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. + +

The cancel job command will cancel any running job id's with this job +definition. + +

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. + +

The run job option will open up the run job interface prepopulating the job +dropdown box with the selected job. + + + diff --git a/bacula/src/qt-console/help/media.html b/bacula/src/qt-console/help/media.html new file mode 100644 index 0000000000..bc8143055e --- /dev/null +++ b/bacula/src/qt-console/help/media.html @@ -0,0 +1,38 @@ + + + +Bat User's Guide + + + + + + + + +

Bat User's Guide

+
+ +

The Media Interface

+ +

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 +interface, the user can manage tape volumes and file volumes. + +

The context sensitive menu will allow 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 +jobs and files on the catalog that meet the selection criterion configured in +bacula-dir.conf. There is also a command to reset the parameters on the volumes +based on the parameters of the pool resource. + +

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. + + + diff --git a/bacula/src/qt-console/help/restore.html b/bacula/src/qt-console/help/restore.html new file mode 100644 index 0000000000..fde18a93a3 --- /dev/null +++ b/bacula/src/qt-console/help/restore.html @@ -0,0 +1,43 @@ + + + +Bat User's Guide + + + + + + + + +

Bat User's Guide

+
+ +

The Two Restore Interfaces

+ +

Both restore interfaces will select jobs to restore from, give the user the +opportunity to select files and directories and then run the restore job. + +

The first or Standard restore is intended as a high performance restore. It +is more of a server side interaction to perform the steps. The Opening interface +will allow the user to choose selection criterion to determine the job set used. +The second interface will allow the user to browse the file structure and choose +the files and directories to restore. The third will run the job. + +

The second restore option is the Version Browser. It is a chatty interface +which will perform many sql queries of the server. It is NOT intended to perfrom +major large sized restores. It is intended to allow the user to search for +specific files and see the different versions of those files that are available +in the catalog to restore. Selecting jobs is done with 3 drop downs in the +lower splitter pane. The top splitter pane has a vertical splitter with 4 +widgets. One for viewing and further subselecting of jobs, one for viewing the +directory tree, one for viewing the list of files in a selected directory and +one for viewing a list of different versions of the selected files that have +records in the catalog. The user can select a directory which will select all +the files and subdirectories. The user can unselect a file in a selected +directory and also select a file in an unselected directory. Lastly the user +can choose to restore a specific version of a file and override the default which +is to restore the most recent version. + + + diff --git a/bacula/src/qt-console/help/storage.html b/bacula/src/qt-console/help/storage.html new file mode 100644 index 0000000000..1e83629bef --- /dev/null +++ b/bacula/src/qt-console/help/storage.html @@ -0,0 +1,33 @@ + + + +Bat User's Guide + + + + + + + + +

Bat User's Guide

+
+ +

The Storage Interface

+ +

The Storage interface will show a list of storage resoruces and to allow 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. + +

The context sensitive menu will allow 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. + +

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 +and the command to update slots scan. + + +