wmclockmon: rename `DFLAGS` `debug_CFLAGS`
[dockapps.git] / wmifinfo / README
blob7ddee6fe5858059c3bb99dd37292afacdfa53c23
2 INFO
4   name        : wmifinfo
5   author      : Ico Doornekamp
6   email       : wmifinfo@zevv.nl
9 DESCRIPTION
11   wmifinfo is a simple applet showing basic network info for all available
12   interfaces. It shows IP address, netmask, gateway and MAC address. A bit
13   like ifconfig.
15   Runs on Linux and OpenBSD (for now)
17   Left-button click moves to the next interface, right-button click calls
18   ifup/ifdown scripts. These can be set with the -u and -d options. The
19   '%s' variable is replaced with the interface name.
21   example :
23   $ wmifinfo -i ppp0 -u "/sbin/ifup %s" -d "/sbin/ifdown %s"
25   (ifup/ifdown or the wmifinfo binaries should be suid root for this
26   to work)
28   Led color    Meaning
29   -------------------------------------------------------------------
30   red          interface is down
31   yellow       ifup/ifdown script is busy
32   dark green   interface is up, no traffic
33   light green  interface is up, and sending or receiving
39 INSTALLING
41   - If you have a NoWiresNeeded 1148 or Swallow NIC, set ENABLE_NWN_SUPPORT
42     to 'y' in the makefile to enable wlan signal indication for this type of
43     network adapter.
45   - make
47   - make install
51 USAGE
53   usage: wmifinfo [-lh] [-i interface]
54     -d <cmd>         Command to exec for iface-down
55     -i <interface>   Start with given interface, if available
56     -l               LCD display mode
57     -h               Print this help
58     -u <cmd>         Command to exec for iface-up
59     -v               Show version info and exit
62 KNOWN BUGS
64   - The link quality readout of the poldhu/swallow cards is slow and may be
65     unreliable, due to the way this is implemented in the firmware and
66     driver.  (Bas?)
69 THANKS
71   - Peter Stromberg for adding OpenBSD support
72   - Ben Stern for endian-correctness and old-libc support patches
73   - Michael G. Henderson's wmWeather for some example dockapp code.
77 COPYRIGHT
79   Copyright (c) 2004 Ico Doornekamp <ico@pruts.nl>
81   This program is free software; you can redistribute it and/or modify it
82   under the terms of the GNU General Public License as published by the
83   Free Software Foundation; either version 2 of the License, or (at your
84   option) any later version.
86   This program is distributed in the hope that it will be useful,
87   but WITHOUT ANY WARRANTY; without even the implied warranty of
88   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
89   See the GNU General Public License for more details.
91   You should have received a copy of the GNU General Public License along
92   with this program; if not, write to the Free Software Foundation, Inc.,
93   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.