initial checkin
[grml-etc.git] / etc / skel / .wmi / szs2.1 / README
1 Welcome to the README of szs2.1.
2
3 This is the first (and last) dot release of the second release of szs, a script
4 for the WMI statusbar.  The name 'szs' is an abbreviation of
5 Statuszeilenskript, german for statusbar script.
6
7 Against szs1st, this release has many more features through its modules.
8 Now it can show:
9 * the bandwidth usage of network interfaces     (bandwidth.py)
10 * the chargingstate of your (laptop-)battery    (battery.py)
11 * the usage of partitions or diskimages         (diskusage.py)
12 * if there are mails in an pop or imap account  (biff.py)
13 * the load average, cpu usage and i/o           (load.py)
14 * the memory and swap usage                     (memory.py)
15 * a `date`-like formatted time string           (clock.py)
16 * freely self configurable bars and texts       (text.py)
17
18 To use all this features, look in the good commented config file.
19 It's named szs.cfg and must be in ~/.wmi or in the same directory as szs.py.
20
21 If you want to build own modules read the following files:
22  module-developer-reference.txt contains a description how to make modules
23  szstoolbox-developer-reference.txt contains the classes/globals of szstoolbox
24
25 I hope the script is usable.
26
27 Much fun,
28 Norman Köhring