wmbiff: Bump to version 0.4.33
[dockapps.git] / wmwifi / README
2 Copyright (c) 2006 Jess Mahan <jess@digitalssg.net>
4 -----------------
5 WmWiFi      0.6
6 -----------------
8  It's been a long time since the last release. I know, I know, you've been
9  jonesin' for the next iteration, but over the last year or so, we've had very
10  little complaints and even fewer bug reports, so "if it aint broke don't
11  fix it!".
13  If your reading this, then you are probably running Window Maker, and have a
14  Wifi (wireless) card installed on your Linux box.
16  !!!! BE AWARE !!!!
17  This is my first attempt at writing a Window Maker dockapp, so if this thing
18  destroys your computer, kills your dog, or burns down your house, don't
19  blame me for it. This is very experimental at the moment.
21  This dockapp displays the signal strength, link level, noise level, and
22  bitrate to your current access point. It also displays the current access
23  point's name.
25  I sincerely apologize for any inconveniences or problems with the this
26  version, or previous versions of WmWiFi.
28  Many thanks to the people that actually e-mailed me with bug reports, those
29  bug reports have made this version possible. WmWiFi now works
30  properly (i hope).
32 -----------------
33 Getting Help
34 -----------------
36  If you need help, there is a mailing list at wmwifi@lists.digitalssg.net.
38  Simply subscribe to it by sending a blank e-mail to
39  wmwifi-subscribe@lists.digitalssg.net.
41  When asking a question, please be sure to include the nature of your problem,
42  and the output from the following commands:
44  "cat /proc/net/wireless"
45  "iwconfig"
46  "head -10 /usr/include/linux/wireless.h | grep Version"
48 -----------------
49 Requirements
50 -----------------
52  libXpm          http://freshmeat.net/projects/libxpm
53  libdockapp      ftp://truffula.com/pub/libdockapp-0.4.tgz
55  To compile this, you'll need libdockapp, libxpm, and all the X development
56  libs. Chances are, if you have installed other dockapps, then you will have
57  no problems compiling this.
59  Linux Wireless Extensions.
60  This program relys on the Wireless Extensions being enabled (and working) in
61  the 2.4.X and 2.6.X kernel series. If you can "cat /proc/net/wireless", then
62  this thing will probably work for you. If "cat /proc/net/wireless" returns
63  nothing, then this dockapp wont work.
66 -----------------
67 Building
68 -----------------
70  Yup, you guessed it...
71  If you have met all the *requirements* then just do:
72  ./configure; make; make install
75 -----------------
76 What's New
77 -----------------
79  0.6 -
80  Many thanks to Jeroen Nijhof <jnijhof@nijhofnet.nl> for his contribution
81  of a patch for WmWifi.
83  I decided to only use a couple of lines of code from Jeroen's patch, and
84  implement the rest myself, so that it could better integrate with the
85  "classic" wmwifi. I also wanted to make WmWifi a bit more flexible, whereas
86  Jeroen's version was locked in to a specific look, and foreced the scrolling.
88  WmWifi now features preset "themes", fully customizable colors (for making
89  your own theme). We also now scroll the interface name and essid by default,
90  but this can be turned off with the -s command line switch or by clicking the
91  left mouse button (to retain our classic look and feel).
93  The Backlight turns on when Signal Strength goes below 1%
95 -----------------
96 The "Look"
97 -----------------
99  0.6 -
100  We've got a new look, actually a few of them.
101  You will most likely notice the differences from the old version and the
102  new becuase the font's have changed and now the interface name and essid
103  scroll across the top (which can be disabled).
105  Many thanks to Jeroen Nijhof <jnijhof@nijhofnet.nl> for his contribution of
106  a new theme and the scrolling interface and essid. I decided not to use
107  all of his changes, but did use his fonts.xpm (becuase they are waaay nicer),
108  and a couple lines of code.
110  # wmwifi -tc          # classic theme (Default)
111  # wmwifi -tn          # Jeroen Nijhof's theme
112  # wmwifi -ts          # snow theme
113  # wmwifi -lc <string> # back-light color
114  # wmwifi -fg <string> # foreground color
115  # wmwifi -bg <string> # background color
116  # wmwifi -hi <string> # highlight color
117  # wmwifi -mt <string> # midtone color
118  # wmwifi -s           # turn scrolling text off
120  <string> is an RGB color. for instance:
121  # wmwifi -bg rgb:00/00/00 -fg rgb:ff/ff/ff -hi rgb:c1/c1/c1 -mt rgb:ff/00/00
122  will give you a black background, white foreground/text, grey highlights,
123  and red midtones.
125  If you don't know what an RGB color is, it's basically the same thing as an
126  HTML color, just ditch the '#', and add a '/' every two characters.
128  This version allows you to customize the colors to create your own themes,
129  checkout wmwifi --help for more information.
131  0.5 -
132  This version (0.5) of wmwifi still uses the look introduced by version 0.2.
133  For now, you cannot change the look, and to be honest, there has been
134  no complaints, so if you want a new look or have a kewl design, e-mail me.
136  There were bug reports of the percentages not being displayed correctly,
137  this is my fault, since I assumed that the maximum link quality would
138  always be 92. I had reports of varying link qualities, so in this version
139  it should be fixed (if it's not, you know where to e-mail me). We not
140  get the maximum link quality directly from the wireless extensions in the
141  kernel, rather than assume it's 92.
143  The Link quality of your card is now displayed as a percentage (0% - 100%).
146 -----------------
147 Stuff it does do
148 -----------------
151  WmWiFi now monitors all of you wireless interfaces. So if you have more
152  than one, WmWiFi can now handle it!
154  - Monitors all wireless interfaces attached to your machine
155    (If you have the module(s) loaded)
156  - Displays Link, Level, Noise, Bitrate, and Current Access Point
157    for each interface.
158  - Customizable Colors.
159  - Preset Themes.
160  - Scrolling Interface Name and ESSID
161  - Turn's backlight on when link quality goes below 1%
163  To disable interface and essid scrolling, simply left click (mouse 1).
164  To switch to the next wireless interface, simply middle click (mouse 2).
165  To switch to the next screen, simply right click (mouse 3).
167 -----------------
168 Stuff if doesn't do or can't do
169 -----------------
171  WmWifi cannot properly report the stats from drivers like the prism54 or
172  ndiswrapper drivers. Believe me, I have tried to get these to work, but
173  the stats don't even report correctly from iwconfig, so I am assuming it's
174  not my fault.
176  If you post to the mailing list complaining about wrong stats, and you are
177  using one of those drivers, I'm going to slap you silly, because you didn't
178  read this!
180  I did try and put some code in this version to "auto-learn" your link quality
181  if the maximum cannot be read from the driver, but it's not guaranteed.
183 -----------------
184 Rants / Raves
185 -----------------
187  forward beer, pizza, scotch, smokes, or hate mail to jess@digitalssg.net