wmfu/README

   1 wmfu
   2 =====
   3
   4 wmfu displays all sorts of information about your Linux (laptop) system.
   5 It is designed for WindowMaker, but can also be run in other window managers.
   6 It does not need external custom libraries, but does need a recent kernel,
   7 since it uses ACPI and proc/sys pseudo-filesystems to read system data.
   8
   9 This program is distributed in the hope that it will be useful, but WITHOUT
  10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11 FOR A PARTICULAR PURPOSE.
  12
  13
  14 INSTALL
  15 =======
  16
  17 Just "make" it.  You only need wmfu executable.
  18 "make install [prefix=...]" will build everything and will attempt to install
  19 in the location pointed to by prefix (default: /usr/local).
  20
  21 If build fails on linux, it is probably because it can't find wireless.h
  22 You need to install wireless-tools package.  If you don't have it, or just
  23 don't want to install it, you need 2.6.x kernel sources and you have to modify
  24 linux/system.c to include <linux/wireless.h>
  25
  26
  27 USAGE
  28 =====
  29
  30 MAIN PANEL:
  31                         current time (A)
  32                               v
  33                         +-----------+
  34         drag zone    -> | =  time x | <- close icon
  35                         +-----------+
  36                         | CPU  load%| <- average CPU load (B)
  37                         +-----+-----+
  38       (C) best wlink -> |wifi~|temp°| <- max temperature (D)
  39                         +-----+-----+
  40       battery symbol -> |bat time ac| <- AC/charging symbol
  41                         +-----------+
  42                               ^
  43                 battery estimate and meter (E)
  44
  45 Left click asks more information about a specific topic:
  46
  47 A - TIME PANEL:
  48                         +-----------+
  49                         | dayofweek |
  50                         |  day mon  | <- current date
  51                         |    year   |
  52                         +-----------+
  53                         |   UPTIME  |
  54                         |days hr:min| <- uptime
  55                         +-----------+
  56
  57 B - CPU PANEL (use mouse scroll for up to 8 CPUs):
  58                         +-----------+
  59           cpu number -> |CPUn freq M| <- current frequency in MHz
  60      load percentage -> |load% govnr| <- scaling governor
  61                         +-----------+
  62           cpu number -> |CPUn freq M| <- current frequency
  63      load percentage -> |load% govnr| <- scaling governor
  64                         +-----------+
  65                         | MEM usage%| <- memory
  66                         | SWP usage%| <- swap
  67                         +-----------+
  68
  69 C - NET PANEL (use mouse scroll for up to 8 interfaces):
  70                         +-----------+
  71       interface name -> |ifnam wifi~| <- wlink (only for wireless)
  72                         |essid      | <- ESSID (only for wireless)
  73            ipv4 addr -> |xx.yy.zz.ww|
  74                         +-----------+
  75       interface name -> |ifnam wifi~| <- wlink (only for wireless)
  76                         |essid      | <- ESSID (only for wireless)
  77            ipv4 addr -> |xx.yy.zz.ww|
  78                         +-----------+
  79
  80 D - TEMPERATURE PANEL (use mouse scroll for up to 16 sensors):
  81                         +-----------+
  82          sensor name -> |nam tmp°max| <- current and maximum temperature
  83                         +-----------+
  84          sensor name -> |nam tmp°max| <- current and maximum temperature
  85                         +-----------+
  86          sensor name -> |nam tmp°max| <- current and maximum temperature
  87                         +-----------+
  88          sensor name -> |nam tmp°max| <- current and maximum temperature
  89                         +-----------+
  90          sensor name -> |nam tmp°max| <- current and maximum temperature
  91                         +-----------+
  92
  93 E - BATTERY PANEL:
  94                         +-----------+
  95         battery name -> |name       |
  96                         |status     | <- status: CHARGING/DISCHARGING/STEADY
  97     current capacity -> |load% hr:mn| <- charging/discharging estimate time
  98                meter -> |"""""""""""|
  99         battery name -> |name       |
 100               status -> |status     |
 101     current capacity -> |load% hr:mn| <- charging/discharging estimate time
 102                meter -> |"""""""""""|
 103                         +-----------+
 104
 105
 106 THANKS
 107 ======
 108
 109 wmwifi-0.6      Jess Mahan      dockapp system
 110 gkrellm-2.2.10  Bill Wilson     sensors system
 111 wmifinfo-0.06   Ico Doornekamp  small fonts
 112 wmacpi-1.34     timecop         gradient
 113 wmcpuload-1.0.0 Seiichi SATO    cpu / dockapp
 114 wmfire-1.2.3    Alan Swanson    cpu routine
 115 wmhdplop-0.9.8  Julien Pommier  stuff
 116
 117
 118 TODO
 119 ====
 120
 121 0. optimize for speed
 122 1. implement visible/audible alerts
 123 2. brokenwm for some window managers
 124 3. put additional info in main panel (in place of "CPU" string)
 125 4. more stuff in detail panels: network, calendar (compress date to SA 12 DEC)
 126 5. read HDD temperature (use smartmontools/hddtemp)
 127 6. use iwlib instead of manually scanning wireless interfaces
 128 7. add more systems: BSD etc
 129 8. handle fahrenheit temperatures
 130 9. implement consistent UI: left-click, right-click
 131
 132
 133 Have fun,
 134 Daniel Borca <dborca@yahoo.com>