git.sur5r.net Git - bacula/bacula/blob - bacula/src/qt-console/README

   1
   2 This directory contains the Bacula Admin Tool (bat).
   3
   4 At the current time, the contents of this directory are under
   5 development.  If you want to help, please contact Kern directly.
   6 If you want to build it, you need Qt4 loaded and setup as your
   7 default Qt or with the appropriate Qt Environment variables set.
   8
   9 6/24/07
  10 There is now one dependancy, it is qwt.  It compiles just fine with
  11 either qwt-5.0.2 or qwt-5.0.1.  If you run the command
  12
  13   ./build-depkgs-qt-console
  14
  15 It should download and run the appropriate commands to build and install qwt
  16 for you.  The script will download the package into a subdirectory named
  17 depkgs. Then it will configure, make and install qwt.  The installation will
  18 go into a subdirectory named qwt in the main qt-console directory.
  19
  20 To build bat, you simply enter:
  21
  22   qmake
  23   make
  24
  25 then to execute it
  26
  27   ./bat
  28
  29 The qmake command needs to be entered only if you add a new file, in
  30 which case, you should edit bat.pro.in and add the new filename
  31 in the appropriate place.  In running qmake, it will build a new
  32 Makefile, and there after, you simply use "make". In fact, providing
  33 you edit bat.pro, doing a "make" will automatically call qmake to
  34 rebuild the Makefile.
  35
  36 From the base bacula directory, make Makefiles will generate bat.pro from
  37 bat.pro.in, so only edit bat.pro.in.   It will also overwrite the qt-consoles
  38 bat.conf file.  "make install" will write /etc/bacula/bat.conf.  bat.conf can
  39 include as many director stanza's as you would like in bat.conf.  You may use
  40 this directories bat.conf.example as a template for director stanza's.
  41
  42 Win32 mingw infos for QT4 :
  43  - http://silmor.de/29
  44  - http://doc.qtfr.org/post/2007/04/10/Cross-Compilation-Native-dapplication-Qt-depuis-Linux
  45
  46 Development status as of 05/06/07
  47
  48 Items not implemented:
  49 - Nothing on the brestore page
  50
  51 Design decisions:
  52 - If possible all code for a particular component will be kept in
  53   an appropriate subdirectory.
  54 - All private class variables are named "m_xxx" this makes it very
  55   clear if one is referencing a class variable or a local.
  56 - All signal/slots are connected by explict code (most all are
  57   done in the MainWin constructor), rather than using designer.
  58 - Each page has a separate designer .ui file in a subdirectory.
  59 - All windows are created with designer and have
  60   a name such as xxxForm i.e. the main window is MainForm and kept
  61   in main.ui.
  62
  63 Major projects:
  64 - Implement other restore interfaces such as brestore ...
  65 - Implement a database browser
  66 - Implement a resource (conf file) browser
  67 - Implement a reports page -- e.g. something similar to bweb
  68 - Implement Qt plugins to add new functionality to bat
  69 - Implement a GUI configuration file editor (something like JBacula).
  70 ...
  71
  72 Partially Done:
  73 ===========================
  74 - Implement graphical commands that allow updating most aspects of
  75   the database (i.e. commands for label, update Volume, ...)
  76       still need to be able to edit a pool object
  77
  78 - None of the menu items except About, Select Font, and Quit.
  79     Print and save don't do anything, does save need to??
  80 Done:
  81 ============================
  82 Design/implementation considerations:
  83 - Need icons in front of the Director.
  84 - The console page should be in a DockWidget so it can be removed
  85   from the main window. It is currently in a dock window, but it
  86   does not remove properly -- more research needed.
  87 - Need to figure out a good implementation of adding pages and even
  88   having plugins that load as pages.  Currently the page mechanism
  89   is a bit kludged.
  90
  91 - We need to have multiple Directors
  92 - Each Director should have its own console
  93 - The Console class needs to be a list or be attached to the
  94   currently active Director.
  95 - Will automatically connnect to the first Director in the
  96   conf file. Doesn't know about multiple Directors.
  97
  98 - The Label menu bar item, prints on the shell window what you entered.
  99 - The Run menu bar item, prints on the console window what you entered.
 100 - The Restore menu bar item, brings up dialog, then when OK is
 101   clicked, it goes on to the next dialog, which is meant to be
 102   a tree view, but for the moment does nothing ...  It is a bit
 103   ugly. Cancelling it should get you back to the normal command prompt.
 104
 105 - Implement a restore page that does a directory tree restore selection
 106   much like wx-console does.
 107
 108 Not working:
 109 - The left selection window and the right window (where the console
 110   is) are dockable windows so should be movable once they are properly
 111   clicked.  Well, they sort of move, but then get stuck.  I haven't figured
 112   out what is going on, so for the current time, I am implemeting most
 113   stuff through dialogs.
 114
 115 Items implemented:
 116 - Reads a basic bat.conf (same as documented for the gnome-console
 117    except that the Font part is unimplemented).
 118 - Basic main window structure
 119 - About dialog
 120 - Quit menu item
 121 - The Director name will appear in the Selection tree followed
 122   by Console and Restore.
 123 - Clicking on Console brings forward the console display screen
 124   (default at startup).
 125 - The command line is implemented.
 126 - The status line (below the command line) is implemented.
 127 - Selection of Font is implemented.
 128 - The Font and the window size are saved on exit and restored on
 129   execution of bat.
 130 - The Status menu bar icon is implemented.