Help/README

   1 SysBars
   2 ~~~~~~~
   3
   4 (c) 2008-2010 Tony Houghton
   5 h@realh.co.uk
   6 http://www.realh.co.uk
   7
   8 This program is free software: you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation, either version 3 of the License, or
  11 (at your option) any later version.
  12
  13 This program is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 Introduction
  22 ------------
  23
  24 SysBars is a ROX and/or GNOME applet, written in python, to provide a simple and
  25 compact view of system resource usage with animated bars on the panel. It
  26 currently has readouts for CPU, RAM and swap usage and disk and network
  27 throughput. Unfortunately the sources of this information vary from platform to
  28 platform and currently only Linux is supported, probably requiring a fairly
  29 recent 2.6 series kernel, but SysBars is designed to be extensible by adding
  30 "plugins" for new types of resource to monitor and "platform" extensions to
  31 support systems other than Linux.
  32
  33 To use it in ROX, just drag the appdir (which you may wish to rename) to your
  34 panel. To use it in GNOME run install.py (requires root privileges) and it
  35 should become available in the list of applets to add to your panel next time
  36 you log in.
  37
  38 Locations
  39 ---------
  40
  41 SysBars' home page is <http://www.realh.co.uk/rox.shtml#sysbars>. It has a
  42 git repository at <http://repo.or.cz/w/SysBars.git>. For a ChangeLog see
  43 <http://repo.or.cz/w/SysBars.git?a=log>.
  44
  45 Plugins
  46 -------
  47
  48 To add a new plugin, just add a python file to the plugins directory. It's
  49 easiest to copy one of the existing plugins, and also check each of the files
  50 it imports for comments on how to derive from the base classes.
  51
  52 Generally a plugin will have to use some platform-specific code and you will
  53 need to edit each platform file to provide any services you need.
  54
  55 Platforms
  56 ---------
  57
  58 Each platform file (belonging in the "platform" directory, surprisingly enough)
  59 must be named after the platform as reported by python's sys.platform variable
  60 (NB Linux is called "linux2" because of the 2.x kernel) with a .py suffix, and
  61 provide the functions needed by each plugin. See the "public API" section at
  62 the end of the linux2 file.
  63